Palvelimen konfigurointi¶

Oletusarvoista Docker-kuvaa käyttäen kaikki tarvittava konfigurointi voidaan tehdä selaimesta. Kuitenkin, käyttöönotosta riippuen, voi olla tarpeen mukauttaa palvelimen konfigurointia.

Tällä sivulla luetellaan kaikki menetelmät konfiguraation muuttamiseen ja kaikki olemassa olevat konfigurointivaihtoehdot.

Konfigurointitiedosto vs. ympäristömuuttujat¶

Asetusten osalta voit käyttää joko konfigurointitiedostoa tai ympäristömuuttujia.

Kun käytät Docker Compose -pohjaista asetusta, voit sisällyttää konfigurointitiedoston lisäämällä seuraavan luettelokohdan volumes:-avaimen alle grampsweb:-lohkoon:

      - /path/to/config.cfg:/app/config/config.cfg

missä /path/to/config.cfg on polku konfigurointitiedostoon palvelimesi tiedostojärjestelmässä (oikeanpuoleinen viittaa polkuun säilössä, eikä sitä saa muuttaa).

Ympäristömuuttujia käytettäessä,

etuliite jokaisen asetuksen nimelle on GRAMPSWEB_ saadaksesi ympäristömuuttujan nimen
Käytä kaksoisalaviivoja sisäkkäisille sanakirja-asetuksille, esim. GRAMPSWEB_THUMBNAIL_CACHE_CONFIG__CACHE_DEFAULT_TIMEOUT asettaa arvon THUMBNAIL_CACHE_CONFIG['CACHE_DEFAULT_TIMEOUT'] konfiguraatioasetukselle

Huomaa, että ympäristön kautta asetetut konfigurointivaihtoehdot ovat etusijalla konfigurointitiedostossa oleviin verrattuna. Jos molemmat ovat läsnä, ympäristömuuttuja "voittaa".

Ilman etuliitettä olevat ympäristömuuttujat ovat vanhentuneita

Historiallisista syistä joukko asetuksia – TREE, SECRET_KEY, USER_DB_URI, POSTGRES_USER, POSTGRES_PASSWORD, MEDIA_BASE_DIR, SEARCH_INDEX_DIR, EMAIL_HOST, EMAIL_PORT, EMAIL_HOST_USER, EMAIL_HOST_PASSWORD, DEFAULT_FROM_EMAIL, BASE_URL, ja STATIC_PATH – voidaan yhä asettaa ympäristömuuttujan kautta ilman GRAMPSWEB_ etuliitettä. Tämä on vanhentunutta, lokittaa varoituksen käynnistyksessä ja lakkaa toimimasta tulevassa julkaisussa. Käytä aina etuliitteellistä muotoa, esim. GRAMPSWEB_TREE sen sijaan, että käyttäisit TREE.

Huomaa, että tämä koskee vain ympäristömuuttujia. Konfigurointitiedostossa asetusten nimet käytetään aina ilman etuliitettä.

Vanhojen vaihtoehtojen tarkistaminen

Vanhoja konfigurointivaihtoehtoja, joista palvelimesi yhä riippuu – kuten ilman etuliitettä olevat ympäristömuuttujat, SEARCH_INDEX_DIR tai EMAIL_USE_TLS – lokitetaan varoituksina käynnistyksessä. Gramps Web API 3.22:sta alkaen ne listataan myös, yhdessä niiden korvaajien ja version kanssa, jolloin tuki poistetaan, Järjestelmätiedot -sivun yläosassa (johon pääsee käyttäjäkuvakkeesta sovelluksen ylävalikossa), kun olet kirjautunut sisään järjestelmänvalvojana.

Olemassa olevat konfigurointiasetukset¶

Seuraavat konfigurointivaihtoehdot ovat olemassa.

Pakolliset asetukset¶

Avain	Kuvaus
`TREE`	Käytettävän sukupuuyhteyden tietokannan nimi. Näytä saatavilla olevat puut komennolla `gramps -l`. Jos puuta tällä nimellä ei ole, uusi tyhjää puuta luodaan.
`SECRET_KEY`	Salainen avain Flaskille. Salaisuutta ei saa jakaa julkisesti. Sen muuttaminen mitätöi kaikki käyttöoikeustunnukset.
`USER_DB_URI`	Käyttäjä tietokannan URL-osoite. Mikä tahansa SQLAlchemyn kanssa yhteensopiva URL-osoite on sallittu.

Info

Voit luoda turvallisen salaisen avaimen esim. komennolla

python3 -c "import secrets;print(secrets.token_urlsafe(32))"

Valinnaiset asetukset¶

Avain	Kuvaus
`MEDIA_BASE_DIR`	Polku, jota käytetään media-tiedostojen peruskansiona, ohittaen Grampsissa asetetun media-peruskansion. Käytettäessä S3, sen on oltava muotoa `s3://<bucket_name>`
`TREE_ID`	Sukupuun tietokannan hakemiston nimi, jota käytetään yksittäisen puun tilassa (kun `TREE` ei ole asetettu `*`). Kun asetettu, palvelin tunnistaa puun sen hakemiston nimen perusteella sen sijaan, että käyttäisi sen näyttönimeä, mikä on kestävämpää uudelleennimeämisille. Pakollinen, jos haluat nimetä puun uudelleen API:n kautta. Hakemiston nimen voi löytää komennolla `GET /api/trees/-` (kenttä `id`).
`SEARCH_INDEX_DB_URI`	Tietokannan URL-osoite hakemistolle. Vain `sqlite` tai `postgresql` ovat sallittuja taustajärjestelminä. Oletusarvoisesti `sqlite:///indexdir/search_index.db`, luoden SQLite-tiedoston `indexdir`-kansioon suhteessa polkuun, josta skripti ajetaan.
`SEARCH_INDEX_DIR`	Vanhentunut (käytä sen sijaan `SEARCH_INDEX_DB_URI`). Hakemisto, joka sisältää hakemiston. Jos se asetetaan, kun `SEARCH_INDEX_DB_URI` on asettamatta, hakemiston URL-osoite johdetaan muodosta `sqlite:///<SEARCH_INDEX_DIR>/search_index.db`.
`STATIC_PATH`	Polku, josta palveltiin staattisia tiedostoja (esim. staattinen verkkosivuston käyttöliittymä)
`BASE_URL`	Perus URL-osoite, josta API on saavutettavissa (esim. `https://mygramps.mydomain.com/`). Tämä on tarpeen esim. oikeiden salasanan palautuslinkkien rakentamiseen
`CORS_ORIGINS`	Alkuperät, joista CORS-pyynnöt ovat sallittuja. Oletusarvoisesti kaikki ovat kiellettyjä. Käytä `"*"` salliaksesi pyynnöt mistä tahansa verkkotunnuksesta.
`EMAIL_HOST`	SMTP-palvelimen isäntä (esim. salasanan palautus sähköpostien lähettämiseen)
`EMAIL_PORT`	SMTP-palvelimen portti. Oletusarvoisesti 465
`EMAIL_HOST_USER`	SMTP-palvelimen käyttäjänimi
`EMAIL_HOST_PASSWORD`	SMTP-palvelimen salasana
`EMAIL_USE_TLS`	Vanhentunut (käytä sen sijaan `EMAIL_USE_SSL` tai `EMAIL_USE_STARTTLS`). Boolean, käytetäänkö TLS:ää sähköpostien lähettämisessä. Oletusarvoisesti `True`. Käytettäessä STARTTLS:ää, aseta tämä `False` ja käytä porttia, joka ei ole 25.
`EMAIL_USE_SSL`	Boolean, käytetäänkö implisiittistä SSL/TLS:ää SMTP:ssä (v3.6.0+). Oletusarvoisesti `True`, jos `EMAIL_USE_TLS` ei ole nimenomaisesti asetettu. Käytetään yleensä portin 465 kanssa.
`EMAIL_USE_STARTTLS`	Boolean, käytetäänkö eksplisiittistä STARTTLS:ää SMTP:ssä (v3.6.0+). Oletusarvoisesti `False`. Käytetään yleensä portin 587 tai 25 kanssa.
`DEFAULT_FROM_EMAIL`	"Lähettäjä" osoite automaattisille sähköposteille
`THUMBNAIL_CACHE_CONFIG`	Sanakirja, jossa on asetuksia pikkukuvien välimuistille. Katso Flask-Caching mahdollisista asetuksista.
`REQUEST_CACHE_CONFIG`	Sanakirja, jossa on asetuksia pyyntövälimuistille. Katso Flask-Caching mahdollisista asetuksista.
`PERSISTENT_CACHE_CONFIG`	Sanakirja, jossa on asetuksia pysyvälle välimuistille, jota käytetään esim. telemetriassa. Katso Flask-Caching mahdollisista asetuksista.
`CELERY_CONFIG`	Asetukset Celery-taustatehtäväjonolle. Katso Celery mahdollisista asetuksista.
`REPORT_DIR`	Väliaikainen hakemisto, johon Gramps-raporttien suorittamisen tulokset tallennetaan
`EXPORT_DIR`	Väliaikainen hakemisto, johon Gramps-tietokannan vientitulokset tallennetaan
`REGISTRATION_DISABLED`	Jos `True`, estä uusien käyttäjien rekisteröinti (oletusarvo `False`)
`DISABLE_TELEMETRY`	Jos `True`, poista käytöstä tilastollinen telemetria (oletusarvo `False`). Katso telemetria lisätietoja varten.
`PILLOW_MAX_IMAGE_PIXELS`	Asettaa PIL.Image.MAX_IMAGE_PIXELS -parametrin, joka osoittaa, kuinka monta pikseliä käsitelty kuva voi sisältää. Katso dokumentaatio lisätietoja varten.
`MAX_THUMBNAIL_FILE_BYTES`	Asettaa kovaksi maksimi tiedostokooksi pikkukuville. Oletusarvoisesti `50 * 1024 * 1024` (50 MB). Sen nostaminen voi suuresti lisätä muistinkäyttöä ja voi johtaa muistivaurioihin tai tietojen menetykseen, jos suuria tiedostoja purkautuu muistiin.

Info

Kun käytät ympäristömuuttujia konfiguroinnissa, boolean-vaihtoehtojen, kuten EMAIL_USE_SSL, on oltava joko merkkijono true tai false (kirjaimellisesti!).

Asetukset PostgreSQL-tietokannoille¶

Nämä asetukset ovat pakollisia, jos sukupuutasi isännöidään PostgreSQL-tietokannassa käyttäen SharedPostgreSQL-lisäosaa.

Avain	Kuvaus
`POSTGRES_USER`	Käyttäjänimi tietokantayhteydelle
`POSTGRES_PASSWORD`	Salasana tietokannan käyttäjälle

Asetukset, jotka ovat tärkeitä useiden puiden isännöinnissä¶

Seuraavat asetukset ovat tärkeitä, kun isännöidään useita puita.

Avain	Kuvaus
`MEDIA_PREFIX_TREE`	Boolean, käytetäänkö erillistä alikansiota jokaisen puun media-tiedostoille. Oletusarvoisesti `False`, mutta suositellaan vahvasti käytettäväksi `True` usean puun asetuksessa
`NEW_DB_BACKEND`	Tietokannan taustajärjestelmä, jota käytetään uusille sukupuuille. Sen on oltava joko `sqlite` tai `sharedpostgresql`. Oletusarvoisesti `sqlite`. Arvo `postgresql` on yhä hyväksyttävä, mutta vanhentunut, koska PostgreSQL-taustajärjestelmä poistetaan tulevassa versiossa.
`POSTGRES_HOST`	PostgreSQL-palvelimen isäntänimi, jota käytetään uusien puiden luomiseen, kun käytetään usean puun asetusta SharedPostgreSQL-taustajärjestelmällä
`POSTGRES_PORT`	PostgreSQL-palvelimen portti, jota käytetään uusien puiden luomiseen, kun käytetään usean puun asetusta SharedPostgreSQL-taustajärjestelmällä

Asetukset OIDC-todennusta varten¶

Nämä asetukset ovat tarpeen, jos haluat käyttää OpenID Connect (OIDC) -todennusta ulkoisten tarjoajien kanssa. Yksityiskohtaisia asennusohjeita ja esimerkkejä varten katso OIDC-todennus.

Avain	Kuvaus
`OIDC_ENABLED`	Boolean, otetaanko OIDC-todennus käyttöön. Oletusarvoisesti `False`.
`OIDC_ISSUER`	OIDC-palveluntarjoajan myöntäjä URL-osoite (muille kuin vakio OIDC-palveluntarjoajille)
`OIDC_CLIENT_ID`	OAuth-asiakastunnus (muille kuin vakio OIDC-palveluntarjoajille)
`OIDC_CLIENT_SECRET`	OAuth-asiakassalaisuus (muille kuin vakio OIDC-palveluntarjoajille)
`OIDC_NAME`	Mukautettu näyttönimi tarjoajalle. Oletusarvoisesti "OIDC"
`OIDC_SCOPES`	OAuth-alueet. Oletusarvoisesti "openid email profile"
`OIDC_USERNAME_CLAIM`	Vaatimus, jota käytetään käyttäjänimenä. Oletusarvoisesti "preferred_username"
`OIDC_OPENID_CONFIG_URL`	Valinnainen: URL-osoite OpenID Connect -konfiguraatiopisteeseen (jos ei käytetä vakiota `/.well-known/openid-configuration`)
`OIDC_PKCE`	Boolean, käytetäänkö PKCE:tä. Jos ei asetettu, PKCE:tä käytetään, kun tarjoajan löytöasiakirja listaa `S256`. Katso PKCE
`OIDC_DISABLE_LOCAL_AUTH`	Boolean, estetäänkö paikallinen käyttäjänimi/salasana-todennus. Oletusarvoisesti `False`
`OIDC_AUTO_REDIRECT`	Boolean, ohjataanko automaattisesti OIDC:hen, kun vain yksi tarjoaja on määritetty. Oletusarvoisesti `False`

Sisäänrakennetut OIDC-palveluntarjoajat¶

Sisäänrakennettuja tarjoajia (Google, Microsoft) varten käytä näitä asetuksia:

Avain	Kuvaus
`OIDC_GOOGLE_CLIENT_ID`	Asiakastunnus Google OAuth:lle
`OIDC_GOOGLE_CLIENT_SECRET`	Asiakassalaisuus Google OAuth:lle
`OIDC_MICROSOFT_CLIENT_ID`	Asiakastunnus Microsoft OAuth:lle
`OIDC_MICROSOFT_CLIENT_SECRET`	Asiakassalaisuus Microsoft OAuth:lle
`OIDC_GOOGLE_PKCE`	Boolean, PKCE-asetus Googlelle, katso PKCE
`OIDC_MICROSOFT_PKCE`	Boolean, PKCE-asetus Microsoftille, katso PKCE

OIDC-roolien kartoitus¶

Nämä asetukset mahdollistavat OIDC-ryhmien/roolien kartoittamisen identiteettipalveluntarjoajastasi Gramps Web -käyttäjärooleihin:

Avain	Kuvaus
`OIDC_ROLE_CLAIM`	Vaatimuksen nimi OIDC-tunnuksessa, joka sisältää käyttäjän ryhmät/roolit. Oletusarvoisesti "groups"
`OIDC_GROUP_ADMIN`	Ryhmän/roolin nimi OIDC-palveluntarjoajastasi, joka vastaa Grampsin "Admin" -roolia
`OIDC_GROUP_OWNER`	Ryhmän/roolin nimi OIDC-palveluntarjoajastasi, joka vastaa Grampsin "Owner" -roolia
`OIDC_GROUP_EDITOR`	Ryhmän/roolin nimi OIDC-palveluntarjoajastasi, joka vastaa Grampsin "Editor" -roolia
`OIDC_GROUP_CONTRIBUTOR`	Ryhmän/roolin nimi OIDC-palveluntarjoajastasi, joka vastaa Grampsin "Contributor" -roolia
`OIDC_GROUP_MEMBER`	Ryhmän/roolin nimi OIDC-palveluntarjoajastasi, joka vastaa Grampsin "Member" -roolia
`OIDC_GROUP_GUEST`	Ryhmän/roolin nimi OIDC-palveluntarjoajastasi, joka vastaa Grampsin "Guest" -roolia

Asetukset vain AI-ominaisuuksia varten¶

Nämä asetukset ovat tarpeen, jos haluat käyttää AI-pohjaisia ominaisuuksia, kuten keskustelua tai semanttista hakua.

Avain	Kuvaus
`LLM_BASE_URL`	Perus URL-osoite OpenAI-yhteensopivalle keskustelu-API:lle. Oletusarvoisesti `None`, joka käyttää OpenAI API:a.
`LLM_MODEL`	Malli, jota käytetään OpenAI-yhteensopivassa keskustelu-API:ssa. Jos ei asetettu (oletusarvo), keskustelu on pois käytöstä. Vasta v3.6.0:sta alkaen AI-avustaja käyttää Pydantic AI:ta työkalukutsumahdollisuuksilla.
`VECTOR_EMBEDDING_MODEL`	Malli, jota käytetään semanttisten hakujen vektoriupotuksille. Käytettäessä paikallista mallia, tämän on oltava Sentence Transformers -mallin nimi. Käytettäessä etä-API:a (katso `VECTOR_EMBEDDING_BASE_URL`), tämä on mallin nimi, joka välitetään etäpalveluntarjoajalle. Jos ei asetettu (oletusarvo), semanttinen haku ja keskustelu ovat pois käytöstä.
`VECTOR_EMBEDDING_BASE_URL`	Perus URL-osoite etä OpenAI-yhteensopivalle upotustyökalulle (esim. Ollama, OpenAI, LiteLLM). Jos ei asetettu (oletusarvo), käytetään paikallista Sentence Transformers -mallia. Katso Etäupotustyökalun käyttäminen lisätietoja varten.
`VECTOR_EMBEDDING_API_KEY`	API-avain todennetuille etäupotuspalveluntarjoajille. Tarvitaan vain, kun `VECTOR_EMBEDDING_BASE_URL` on asetettu ja palveluntarjoaja vaatii todennusta.
`LLM_MAX_CONTEXT_LENGTH`	Merkkiraja sukupuun kontekstille, joka annetaan LLM:lle. Oletusarvoisesti 50000.
`LLM_SYSTEM_PROMPT`	Mukautettu järjestelmäkehotus LLM-keskusteluavustajalle (v3.6.0+). Jos ei asetettu, käytetään oletusarvoista sukututkimusoptimoitua kehotusta.

Esimerkkikonfigurointitiedosto¶

Minimalistinen konfigurointitiedosto tuotantoa varten voisi näyttää tältä: ```python TREE="My Family Tree" BASE_URL="https://mytree.example.com" SECRET_KEY="..." # salainen avaimenasi USER_DB_URI="sqlite:////path/to/users.sqlite" EMAIL_HOST="mail.example.com" EMAIL_PORT=465 EMAIL_USE_SSL=True # Käytä implisiittistä SSL:ää portissa 465 EMAIL_HOST_USER="gramps@example.com" EMAIL_HOST_PASSWORD="..." # SMTP-salasanasi DEFAULT_FROM_EMAIL="gramps@example.com"