Palvelimen konfigurointi¶

Oletusarvoista Docker-kuvaa käyttäen kaikki tarvittava konfigurointi voidaan tehdä selaimesta. Käyttöympäristöstä riippuen palvelimen konfigurointia voi olla tarpeen mukauttaa.

Tällä sivulla luetellaan kaikki menetelmät konfiguroinnin 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ä (oikealla puolella viitataan polkuun säilössä, eikä sitä saa muuttaa).

Kun käytetään ympäristömuuttujia,

etuliite jokaiselle asetukselle on GRAMPSWEB_, jotta saadaan ympäristömuuttujan nimi
Käytä kaksoisalaviivoja sisäkkäisille sanakirja-asetuksille, esim. GRAMPSWEB_THUMBNAIL_CACHE_CONFIG__CACHE_DEFAULT_TIMEOUT asettaa arvon THUMBNAIL_CACHE_CONFIG['CACHE_DEFAULT_TIMEOUT'] konfigurointivaihtoehdolle

Huomaa, että ympäristön kautta asetetut konfigurointivaihtoehdot ovat etusijalla verrattuna konfigurointitiedostossa oleviin. 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ä.

Olemassa olevat konfigurointiasetukset¶

Seuraavat konfigurointivaihtoehdot ovat olemassa.

Pakolliset asetukset¶

Avain	Kuvaus
`TREE`	Käytettävän sukupuun 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. Kun käytetään 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 eikä sen näyttönimen, mikä on kestävämpää uudelleennimeämiselle. Pakollinen, jos haluat nimetä puun uudelleen API:n kautta. Hakemiston nimen voi löytää komennolla `GET /api/trees/-` (kenttä `id`).
`SEARCH_INDEX_DB_URI`	Hakemiston tietokannan URL-osoite. Vain `sqlite` tai `postgresql` ovat sallittuja taustajärjestelminä. Oletusarvo on `sqlite:///indexdir/search_index.db`, luoden SQLite-tiedoston hakemistoon `indexdir` suhteessa polkuun, josta skripti ajetaan.
`SEARCH_INDEX_DIR`	Vanhentunut (käytä sen sijaan `SEARCH_INDEX_DB_URI`). Hakemisto, joka sisältää hakemiston. Jos asetettu, kun `SEARCH_INDEX_DB_URI` on asetettu, hakemiston URL-osoite johdetaan muodosta `sqlite:///<SEARCH_INDEX_DIR>/search_index.db`.
`STATIC_PATH`	Polku, josta tarjoillaan staattisia tiedostoja (esim. staattinen verkkosivuston etuosa)
`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 on kielletty. 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. oletusarvo on 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ämiseen. Oletusarvo on `True`. Käytettäessä STARTTLS:ää, aseta tämä `False` ja käytä eri porttia kuin 25.
`EMAIL_USE_SSL`	Boolean, käytetäänkö implisiittistä SSL/TLS:ää SMTP:lle (v3.6.0+). Oletusarvo on `True`, jos `EMAIL_USE_TLS` ei ole nimenomaisesti asetettu. Tyypillisesti käytetään portin 465 kanssa.
`EMAIL_USE_STARTTLS`	Boolean, käytetäänkö eksplisiittistä STARTTLS:ää SMTP:lle (v3.6.0+). Oletusarvo on `False`. Tyypillisesti käytetään portilla 587 tai 25.
`DEFAULT_FROM_EMAIL`	"From" osoite automatisoiduille 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 Grampsin raporttien suorittamisen tulokset tallennetaan
`EXPORT_DIR`	Väliaikainen hakemisto, johon Gramps-tietokannan vientitulokset tallennetaan
`REGISTRATION_DISABLED`	Jos `True`, estetään uusien käyttäjien rekisteröinti (oletusarvo `False`)
`DISABLE_TELEMETRY`	Jos `True`, tilastollinen telemetria on pois päältä (oletusarvo `False`). Katso telemetria lisätietoja varten.
`PILLOW_MAX_IMAGE_PIXELS`	Asettaa PIL.Image.MAX_IMAGE_PIXELS -parametrin, joka osoittaa, kuinka monta pikseliä käsitellyssä kuvassa voi olla. Katso dokumentaatio lisätietoja varten.
`MAX_THUMBNAIL_FILE_BYTES`	Asettaa kovaksi maksimi tiedostokooksi pikkukuville. Oletusarvo on `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äytetään ympäristömuuttujia konfiguroinnissa, boolean-vaihtoehtojen kuten EMAIL_USE_SSL on oltava joko merkkijono true tai false (kirjainkoolla on merkitystä!).

Asetukset vain PostgreSQL-taustatietokannalle¶

Tämä on tarpeen, jos olet konfiguroinut Gramps-tietokannan toimimaan PostgreSQL-lisäosan kanssa.

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

Asetukset, jotka liittyvät useiden puiden isännöimiseen¶

Seuraavat asetukset ovat tärkeitä useiden puiden isännöimisessä.

Avain	Kuvaus
`MEDIA_PREFIX_TREE`	Boolean, käytetäänkö erillistä alikansiota jokaisen puun media tiedostoille. Oletusarvo on `False`, mutta suositellaan vahvasti käyttämään `True` usean puun asetuksessa
`NEW_DB_BACKEND`	Tietokannan taustajärjestelmä, jota käytetään uusille sukupuulle. Sen on oltava yksi seuraavista: `sqlite`, `postgresql` tai `sharedpostgresql`. Oletusarvo on `sqlite`.
`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, käytetäänkö OIDC-todennusta. Oletusarvo on `False`.
`OIDC_ISSUER`	OIDC-palveluntarjoajan myöntäjä URL-osoite (muille OIDC-palveluntarjoajille)
`OIDC_CLIENT_ID`	OAuth-asiakastunnus (muille OIDC-palveluntarjoajille)
`OIDC_CLIENT_SECRET`	OAuth-asiakassalaisuus (muille OIDC-palveluntarjoajille)
`OIDC_NAME`	Mukautettu näyttönimi tarjoajalle. Oletusarvo on "OIDC"
`OIDC_SCOPES`	OAuth-alueet. Oletusarvo on "openid email profile"
`OIDC_USERNAME_CLAIM`	Vaade, jota käytetään käyttäjänimenä. Oletusarvo on "preferred_username"
`OIDC_OPENID_CONFIG_URL`	Valinnainen: URL-osoite OpenID Connect -konfiguraatiopisteeseen (jos ei käytetä standardia `/.well-known/openid-configuration`)
`OIDC_DISABLE_LOCAL_AUTH`	Boolean, estetäänkö paikallinen käyttäjänimi/salasana-todennus. Oletusarvo on `False`
`OIDC_AUTO_REDIRECT`	Boolean, ohjataanko automaattisesti OIDC:hen, kun vain yksi tarjoaja on konfiguroitu. Oletusarvo on `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-roolien kartoitus¶

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

Avain	Kuvaus
`OIDC_ROLE_CLAIM`	Vaade Nimi OIDC-tunnuksessa, joka sisältää käyttäjän ryhmät/roolit. Oletusarvo on "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. Oletusarvo on `None`, mikä käyttää OpenAI API:ta.
`LLM_MODEL`	Malli, jota käytetään OpenAI-yhteensopivassa keskustelu-API:ssa. Jos ei asetettu (oletusarvo), keskustelu on pois päältä. Versiosta v3.6.0 alkaen AI-avustaja käyttää Pydantic AI:ta työkalukutsukyvykkyyksillä.
`VECTOR_EMBEDDING_MODEL`	Malli, jota käytetään semanttisen haun vektoriupotuksille. Kun käytetään paikallista mallia, tämän on oltava Sentence Transformers mallin nimi. Kun käytetään etä-API:a (katso `VECTOR_EMBEDDING_BASE_URL`), tämä on malli, joka välitetään etäpalveluntarjoajalle. Jos ei asetettu (oletusarvo), semanttinen haku ja keskustelu ovat pois päältä.
`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ä upotustarjoajille. Tarvitaan vain, kun `VECTOR_EMBEDDING_BASE_URL` on asetettu ja tarjoaja vaatii todennusta.
`LLM_MAX_CONTEXT_LENGTH`	Merkkiraja sukupuun kontekstille, joka annetaan LLM:lle. Oletusarvo on 50000.
`LLM_SYSTEM_PROMPT`	Mukautettu järjestelmäkehotus LLM-keskusteluavustajalle (v3.6.0+). Jos ei asetettu, käytetään oletusarvoista sukututkimukseen optimoitua 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 avain USER_DB_URI="sqlite:////path/to/users.sqlite" EMAIL_HOST="mail.example.com" EMAIL_PORT=465 EMAIL_USE_SSL=True # Käytä implisiittistä SSL:ää portille 465 EMAIL_HOST_USER="gramps@example.com" EMAIL_HOST_PASSWORD="..." # SMTP-salasana DEFAULT_FROM_EMAIL="gramps@example.com"