Spremenljivke okolja
Začnite s hitrim začetkom z Dockerjem. Prenosljiva predloga okolja nastane neposredno iz aplikacijske datoteke .env.example. Neobvezne nastavitve po potrebi dodajte v svojo .env. Spodnji primeri uporabljajo izmišljene podatke ponudnikov; zamenjajte jih s svojimi.
Kako nastavitve pridejo do aplikacije
Razdelek Kako nastavitve pridejo do aplikacijeDocker Compose prebere .env za nadomeščanje vrednosti in posreduje samo spremenljivke, navedene v razdelkih environment. Spodnje nastavitve namestitve, pošte in S3 so že povezane. Napredne nastavitve izvajanja potrebujejo izrecno dopolnitev Compose; sam vnos v .env jih ne posreduje vsebniku.
Ob neposrednem zagonu z Node aplikacija prebere .env v korenu repozitorija; obstoječe vrednosti okolja procesa imajo prednost. To so nastavitve aplikacije, ločene od nastavitev produktnega spletnega mesta.
Namestitev in splošne nastavitve
Razdelek Namestitev in splošne nastavitve| Spremenljivka | Privzeta / dovoljena vrednost | Namen |
|---|---|---|
APP_HOST |
Obvezno za Compose | Javno gostiteljsko ime brez sheme in poti, na primer reports.example.org. Uporabljata ga Caddy in izpeljava naslovov aplikacije. |
CADDY_EMAIL |
Obvezno za Compose | Spremljan e-poštni naslov za postopke s potrdili HTTPS. |
POSTGRES_PASSWORD |
Obvezno za Compose | Močno geslo podatkovne zbirke. Uporabite ustvarjeno šestnajstiško vrednost, da se izognete posebnim znakom v povezovalnem URL-ju Compose. Pri že inicializirani zbirki ga ne spreminjajte neodvisno od zbirke. |
ANALYTICS_HASH_SECRET |
Obvezno v produkciji; vsaj 16 znakov | Stalna naključna skrivnost za psevdonimizacijo analitike aplikacije na podlagi privolitve. Ustvarite drugo vrednost kot za geslo zbirke. Ne omogoči analitike spletnega mesta. |
REPORTHUB_TAG |
latest |
Oznaka slike vsebnika. Za nadzorovano uvedbo izberite preverjeno izdajo. |
TZ |
Europe/Ljubljana |
Veljaven časovni pas IANA za aplikacijo in podatkovno zbirko. |
LOG_LEVEL |
Compose/produkcija: info; neposredni razvojni zagon: debug |
Raven dnevnika Winston: error, warn, info, http, verbose, debug ali silly. |
CORS_ALLOWED_ORIGINS |
Prazno | Dodatni izvori brskalnika, ločeni z vejico, s shemo in po potrebi priključkom. Nastavljena izvora uporabniškega vmesnika in javnega API-ja sta že dovoljena. |
NODE_ENV |
Slika Docker: production; neposredni Node: development |
Dovoljeno: development, test, production. Priloženi Compose uporabi privzeto vrednost slike; vnos v gostiteljevo .env ne spremeni načina vsebnika. |
E-pošta in SMTP
Razdelek E-pošta in SMTP| Spremenljivka | Privzeto | Namen |
|---|---|---|
MAIL_DELIVERY_ENABLED |
false |
true omogoči privzeto pošiljanje. Ob vključitvi zagon zahteva SMTP_HOST in SMTP_FROM_EMAIL. |
MAIL_DEFAULT_LANGUAGE |
en |
Privzeti jezik pošte, en ali sl; prednostni jezik prejemnika ga lahko nadomesti. |
SMTP_HOST |
Prazno | Gostiteljsko ime strežnika SMTP. |
SMTP_PORT |
587 |
Pozitivno celo število; uporabite priključek za oddajo pošte pri ponudniku. |
SMTP_SECURE |
false |
true za TLS od začetka povezave; false omogoča pogajanje STARTTLS. Upoštevajte zahteve ponudnika. |
SMTP_USER |
Prazno | Uporabniško ime za prijavo. Če je prazno, povezava ne pošlje prijavnih podatkov SMTP. |
SMTP_PASSWORD |
Prazno | Geslo ponudnika ali aplikacijsko geslo, uporabljeno z uporabniškim imenom. |
SMTP_FROM_EMAIL |
Prazno | Veljaven naslov pošiljatelja, ki ga dovoljuje ponudnik. |
SMTP_FROM_NAME |
Prazno | Neobvezno prikazno ime pošiljatelja. |
Za ponudnika s priključkom 587 in STARTTLS:
MAIL_DELIVERY_ENABLED=trueMAIL_DEFAULT_LANGUAGE=slSMTP_HOST=smtp.example.orgSMTP_PORT=587SMTP_SECURE=falseSMTP_PASSWORD='replace-with-provider-password'SMTP_FROM_NAME=ReportHubZa neposredni TLS na priključku 465 nastavite SMTP_PORT=465 in SMTP_SECURE=true, če tako zahteva ponudnik. Napak pri dostavi ne odpravljajte z izključitvijo preverjanja potrdil.
Aplikacija hrani nastavitve pošte v svoji konfiguraciji. Shranjene nastavitve omogočenega pošiljanja, jezika, priključka in TLS imajo prednost pred privzetimi vrednostmi okolja. Prednost imajo tudi neprazne shranjene nastavitve strežnika in pošiljatelja. Prijavni podatki vedno izvirajo iz SMTP_USER in SMTP_PASSWORD v okolju. Pri obstoječi namestitvi po spremembi .env preverite nastavitve pošte v administraciji; priprava dema izključi pošiljanje v shranjeni konfiguraciji. Pred uporabo potrjevanja, vabil ali obvestil preverite dostavo s preizkusom pošte v aplikaciji.
Lokalna shramba in shramba S3
Razdelek Lokalna shramba in shramba S3Privzeto velja STORAGE_TYPE=local. Priloženi Compose trajno hrani javne datoteke celostne podobe in zasebne datoteke prijav v ločenih mapah nosilca reporthub-files.
| Spremenljivka | Privzeto / obveznost | Namen |
|---|---|---|
STORAGE_TYPE |
local |
Dovoljeno: local ali s3. |
S3_REGION |
Obvezno za S3 | Oznaka regije ponudnika. |
S3_BUCKET |
Obvezno za S3 | Ime obstoječega vedra. |
S3_ENDPOINT |
Obvezno za S3 | Celoten URL storitve s https://. Trenutna izvedba shrambe ga zahteva tudi za AWS S3. |
S3_ACCESS_KEY_ID |
Obvezno za S3 | Dostopni ključ s pravicami za branje, pisanje in brisanje objektov ReportHub. |
S3_SECRET_ACCESS_KEY |
Obvezno za S3 | Skrivnost pripadajočega dostopnega ključa. |
S3_PUBLIC_BASE_URL |
Neobvezno | Javni korenski URL vedra ali ustrezen naslov CDN. ReportHub doda /public/<filename>. Brez nastavitve javne URL-je sestavi iz končne točke, vedra in poti javnega objekta. |
S3_FORCE_PATH_STYLE |
true |
Nastavite false, če ponudnik zahteva naslov vedra v gostiteljskem imenu. Nastavitev velja za SDK; javni osnovni URL prilagodite svojemu javnemu naslovu datotek. |
Primer za ponudnika, združljivega s S3:
STORAGE_TYPE=s3S3_REGION=eu-central-1S3_BUCKET=reporthub-filesS3_ENDPOINT=https://s3.example.orgS3_ACCESS_KEY_ID=replace-with-access-keyS3_SECRET_ACCESS_KEY='replace-with-secret-key'S3_PUBLIC_BASE_URL=https://files.example.org/reporthub-filesS3_FORCE_PATH_STYLE=trueEno vedro lahko vsebuje javne datoteke celostne podobe v public/ in zasebne datoteke prijav v private/. Anonimno branje dovolite samo za javne datoteke celostne podobe; preprečite anonimno izpisovanje vsebine vedra in neposredno branje zasebnih datotek. Fotografije prijav, dokazila Safety in tlorise posredujejo pooblaščene poti aplikacije; fotografije objavljenih prijav Community so dostopne prek javnega API-ja za slike prijav. Ne objavite celotnega vedra. Javni osnovni URL mora kazati na koren vedra, ne na njegovo predpono public/.
Sprememba nastavitev shrambe ne preseli obstoječih datotek. Pred preklopom namestitve s podatki načrtujte in preverite selitev datotek. Varnostno kopirajte tako vedro oziroma lokalne datoteke kot podatkovno zbirko.
Napredne nastavitve izvajanja
Razdelek Napredne nastavitve izvajanjaTe nastavitve delujejo pri neposrednem zagonu z Node. Compose izpelje povezavo do zbirke in naslove ter za preostale nastavitve uporabi privzete vrednosti slike oziroma aplikacije. Za prilagoditev v Dockerju jih izrecno določite v reporthub.environment v dopolnilni datoteki Compose in ohranite ustrezne trajne nosilce.
| Spremenljivka | Privzeto | Namen |
|---|---|---|
DATABASE_URL |
Compose izpelje interni URL PostgreSQL; neposredni Node izpelje lokalno povezavo iz POSTGRES_PASSWORD |
Celoten povezovalni URL Prisma za PostgreSQL. Brez obeh vrednosti neposredni razvojni zagon uporabi lokalne prijavne podatke postgres. Zunaj razvoja uporabite izrecne varne prijavne podatke. |
PUBLIC_API_ORIGIN |
Compose: https://APP_HOST; neposredni Node: http://localhost:8080 |
Absolutni javni izvor API-ja za ustvarjene povezave API/datotek in seznam dovoljenih izvorov. |
FRONTEND_ORIGIN |
Compose: https://APP_HOST; neposredni Node: http://localhost:4200 |
URL uporabniškega vmesnika za ustvarjene povezave in dovoljene zahteve brskalnika. |
TRUST_PROXY |
true v produkciji, sicer false |
Zaupa enemu posredniškemu koraku pri določanju naslova IP odjemalca. Namenjeno Caddyju; pri neposrednem dostopu brez posrednika uporabite false. |
UPLOAD_DIR |
Produkcija: /app/uploads/public; sicer uploads glede na delovno mapo zaledja |
Lokalna mapa javnih datotek celostne podobe. Pri spremembi poti zagotovite trajno hrambo. |
PRIVATE_UPLOAD_DIR |
Produkcija: /app/uploads/private; sicer private-uploads glede na delovno mapo zaledja |
Lokalna mapa zasebnih datotek; nikoli je ne izpostavite z javnim datotečnim strežnikom. |
Priključek zaledja je fiksen: 8080. Nastavitve PORT ni. Omejitve velikosti datotek, trajanje seje in omejitve pogostosti zahtev so določene v kodi, ne s spremenljivkami okolja.
Uveljavite in preverite spremembe
Razdelek Uveljavite in preverite spremembeDatoteko .env hranite zunaj nadzora izvorne kode in omejite njene pravice. Za logične nastavitve uporabite dobesedni vrednosti true / false; prazna neobvezna polja ponudnikov pomenijo nenastavljeno vrednost. Skrivnosti ponudnikov z znaki $ ali # zapišite v enojnih narekovajih, da v zapisu .env za Compose ohranite dobesedno vrednost.
V mapi namestitve:
docker compose config --quietdocker compose up -ddocker compose psdocker compose logs --tail 100 reporthubup -d ob spremembi okolja ponovno ustvari vsebnike; sam restart ne uveljavi novih vrednosti. Dnevnike pregledujte zasebno in pred deljenjem odstranite prijavne podatke. Ne objavljajte izpisa docker compose config brez --quiet, saj lahko vsebuje razrešene skrivnosti. Zaradi spremembe okolja nikoli ne odstranjujte trajnih nosilcev.