サーバー構成¶
デフォルトのDockerイメージを使用すると、すべての必要な構成をブラウザから行うことができます。ただし、デプロイメントによっては、サーバー構成をカスタマイズする必要がある場合があります。
このページでは、構成を変更するためのすべての方法と、すべての既存の構成オプションをリストします。
構成ファイルと環境変数¶
設定には、構成ファイルまたは環境変数のいずれかを使用できます。
Docker Composeベースのセットアップを使用する場合、grampsweb:ブロックのvolumes:キーの下に次のリスト項目を追加することで構成ファイルを含めることができます。
- /path/to/config.cfg:/app/config/config.cfg
/path/to/config.cfgはサーバーのファイルシステム内の構成ファイルへのパスです（右側はコンテナ内のパスを指し、変更してはいけません）。
環境変数を使用する場合、
- 各設定名の先頭に
GRAMPSWEB_を付けて環境変数名を取得します - ネストされた辞書設定にはダブルアンダースコアを使用します。例えば、
GRAMPSWEB_THUMBNAIL_CACHE_CONFIG__CACHE_DEFAULT_TIMEOUTは、THUMBNAIL_CACHE_CONFIG['CACHE_DEFAULT_TIMEOUT']構成オプションの値を設定します
環境を介して設定された構成オプションは、構成ファイル内のものよりも優先されることに注意してください。両方が存在する場合、環境変数が「勝ちます」。
プレフィックスなしの環境変数は非推奨です
歴史的な理由から、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、およびSTATIC_PATHの一部の設定は、GRAMPSWEB_プレフィックスなしで環境変数を介して設定することができます。これは非推奨であり、起動時に警告がログに記録され、将来のリリースで機能しなくなります。常にプレフィックス付きの形式を使用してください。例えば、TREEの代わりにGRAMPSWEB_TREEを使用してください。
これは環境変数にのみ関係します。構成ファイル内では、設定名は常にプレフィックスなしで使用されます。
既存の構成設定¶
以下の構成オプションが存在します。
必須設定¶
| キー | 説明 |
|---|---|
TREE |
使用する家系図データベースの名前。利用可能なツリーはgramps -lで表示されます。この名前のツリーが存在しない場合は、新しい空のものが作成されます。 |
SECRET_KEY |
Flaskのための秘密鍵。秘密は公開されてはいけません。これを変更すると、すべてのアクセストークンが無効になります。 |
USER_DB_URI |
ユーザーデータベースのデータベースURL。SQLAlchemyと互換性のある任意のURLが許可されます。 |
Info
安全な秘密鍵を生成するには、次のコマンドを使用できます。
python3 -c "import secrets;print(secrets.token_urlsafe(32))"
オプション設定¶
| キー | 説明 |
|---|---|
MEDIA_BASE_DIR |
メディアファイルのベースディレクトリとして使用するパス。Grampsで設定されたメディアベースディレクトリを上書きします。S3を使用する場合、s3://<bucket_name>の形式である必要があります。 |
TREE_ID |
シングルツリーモードで使用する家系図データベースのディレクトリ名（TREEが*に設定されていない場合）。設定されると、サーバーは表示名ではなくディレクトリ名でツリーを識別します。これは名前変更に対してより堅牢です。APIを介してツリーの名前を変更したい場合は必須です。ディレクトリ名はGET /api/trees/-（idフィールド）を介して見つけることができます。 |
SEARCH_INDEX_DB_URI |
検索インデックスのデータベースURL。バックエンドとしてはsqliteまたはpostgresqlのみが許可されます。デフォルトはsqlite:///indexdir/search_index.dbで、スクリプトが実行されるパスに対して相対的にindexdirフォルダ内にSQLiteファイルを作成します。 |
SEARCH_INDEX_DIR |
非推奨（代わりにSEARCH_INDEX_DB_URIを使用してください）。検索インデックスを含むディレクトリ。SEARCH_INDEX_DB_URIが未設定のときに設定されると、検索インデックスURLはsqlite:///<SEARCH_INDEX_DIR>/search_index.dbとして導出されます。 |
STATIC_PATH |
静的ファイルを提供するためのパス（例：静的Webフロントエンド） |
BASE_URL |
APIにアクセスできるベースURL（例：https://mygramps.mydomain.com/）。これは、正しいパスワードリセットリンクを構築するために必要です。 |
CORS_ORIGINS |
CORSリクエストが許可されるオリジン。デフォルトでは、すべてが禁止されています。"*"を使用して、任意のドメインからのリクエストを許可します。 |
EMAIL_HOST |
SMTPサーバーホスト（例：パスワードリセットメールを送信するため） |
EMAIL_PORT |
SMTPサーバーポート。デフォルトは465です。 |
EMAIL_HOST_USER |
SMTPサーバーユーザー名 |
EMAIL_HOST_PASSWORD |
SMTPサーバーパスワード |
EMAIL_USE_TLS |
非推奨（代わりにEMAIL_USE_SSLまたはEMAIL_USE_STARTTLSを使用してください）。ブール値、メール送信にTLSを使用するかどうか。デフォルトはTrueです。STARTTLSを使用する場合は、これをFalseに設定し、ポート25とは異なるポートを使用します。 |
EMAIL_USE_SSL |
ブール値、SMTPに対して暗黙のSSL/TLSを使用するかどうか（v3.6.0+）。EMAIL_USE_TLSが明示的に設定されていない場合、デフォルトはTrueです。通常はポート465で使用されます。 |
EMAIL_USE_STARTTLS |
ブール値、SMTPに対して明示的なSTARTTLSを使用するかどうか（v3.6.0+）。デフォルトはFalseです。通常はポート587または25で使用されます。 |
DEFAULT_FROM_EMAIL |
自動メールの「From」アドレス |
THUMBNAIL_CACHE_CONFIG |
サムネイルキャッシュの設定を含む辞書。可能な設定についてはFlask-Cachingを参照してください。 |
REQUEST_CACHE_CONFIG |
リクエストキャッシュの設定を含む辞書。可能な設定についてはFlask-Cachingを参照してください。 |
PERSISTENT_CACHE_CONFIG |
テレメトリなどに使用される永続キャッシュの設定を含む辞書。可能な設定についてはFlask-Cachingを参照してください。 |
CELERY_CONFIG |
Celeryバックグラウンドタスクキューの設定。可能な設定についてはCeleryを参照してください。 |
REPORT_DIR |
Grampsレポートの出力が保存される一時ディレクトリ |
EXPORT_DIR |
Grampsデータベースのエクスポート出力が保存される一時ディレクトリ |
REGISTRATION_DISABLED |
Trueの場合、新しいユーザー登録を禁止します（デフォルトはFalse）。 |
DISABLE_TELEMETRY |
Trueの場合、統計テレメトリを無効にします（デフォルトはFalse）。詳細についてはtelemetryを参照してください。 |
PILLOW_MAX_IMAGE_PIXELS |
処理された画像が含むことができるピクセル数を示すPIL.Image.MAX_IMAGE_PIXELSパラメータを設定します。詳細についてはdocsを参照してください。 |
MAX_THUMBNAIL_FILE_BYTES |
サムネイルの最大ファイルサイズを設定します。デフォルトは50 * 1024 * 1024（50 MB）です。これを上げると、メモリ使用量が大幅に増加し、大きなファイルがメモリ内で解凍されると、メモリ不足のクラッシュやデータ損失を引き起こす可能性があります。 |
Info
構成のために環境変数を使用する場合、EMAIL_USE_SSLのようなブールオプションは、trueまたはfalse（大文字と小文字を区別します）のいずれかでなければなりません！
PostgreSQLバックエンドデータベース専用の設定¶
これは、GrampsデータベースをPostgreSQLアドオンと連携させるように設定した場合に必要です。
| キー | 説明 |
|---|---|
POSTGRES_USER |
データベース接続のユーザー名 |
POSTGRES_PASSWORD |
データベースユーザーのパスワード |
複数のツリーをホストするために関連する設定¶
以下の設定は、複数のツリーをホストする際に関連します。
| キー | 説明 |
|---|---|
MEDIA_PREFIX_TREE |
各ツリーのメディアファイルに別々のサブフォルダを使用するかどうかを示すブール値。デフォルトはFalseですが、マルチツリーセットアップではTrueを使用することを強く推奨します。 |
NEW_DB_BACKEND |
新しく作成された家系図に使用するデータベースバックエンド。sqlite、postgresql、またはsharedpostgresqlのいずれかでなければなりません。デフォルトはsqliteです。 |
POSTGRES_HOST |
SharedPostgreSQLバックエンドを使用したマルチツリーセットアップで新しいツリーを作成するために使用されるPostgreSQLサーバーのホスト名 |
POSTGRES_PORT |
SharedPostgreSQLバックエンドを使用したマルチツリーセットアップで新しいツリーを作成するために使用されるPostgreSQLサーバーのポート |
OIDC認証のための設定¶
これらの設定は、外部プロバイダーとOpenID Connect（OIDC）認証を使用する場合に必要です。詳細な設定手順と例についてはOIDC Authenticationを参照してください。
| キー | 説明 |
|---|---|
OIDC_ENABLED |
OIDC認証を有効にするかどうかを示すブール値。デフォルトはFalseです。 |
OIDC_ISSUER |
OIDCプロバイダーの発行者URL（カスタムOIDCプロバイダー用） |
OIDC_CLIENT_ID |
OAuthクライアントID（カスタムOIDCプロバイダー用） |
OIDC_CLIENT_SECRET |
OAuthクライアントシークレット（カスタムOIDCプロバイダー用） |
OIDC_NAME |
プロバイダーのカスタム表示名。デフォルトは「OIDC」です。 |
OIDC_SCOPES |
OAuthスコープ。デフォルトは「openid email profile」です。 |
OIDC_USERNAME_CLAIM |
ユーザー名に使用するクレーム。デフォルトは「preferred_username」です。 |
OIDC_OPENID_CONFIG_URL |
オプション：OpenID Connect構成エンドポイントへのURL（標準の/.well-known/openid-configurationを使用しない場合） |
OIDC_DISABLE_LOCAL_AUTH |
ローカルのユーザー名/パスワード認証を無効にするかどうかを示すブール値。デフォルトはFalseです。 |
OIDC_AUTO_REDIRECT |
プロバイダーが1つだけ設定されている場合に自動的にOIDCにリダイレクトするかどうかを示すブール値。デフォルトはFalseです。 |
組み込みのOIDCプロバイダー¶
組み込みプロバイダー（Google、Microsoft）には、次の設定を使用します。
| キー | 説明 |
|---|---|
OIDC_GOOGLE_CLIENT_ID |
Google OAuthのクライアントID |
OIDC_GOOGLE_CLIENT_SECRET |
Google OAuthのクライアントシークレット |
OIDC_MICROSOFT_CLIENT_ID |
Microsoft OAuthのクライアントID |
OIDC_MICROSOFT_CLIENT_SECRET |
Microsoft OAuthのクライアントシークレット |
OIDCロールマッピング¶
これらの設定を使用すると、アイデンティティプロバイダーからのOIDCグループ/ロールをGramps Webユーザーロールにマッピングできます。
| キー | 説明 |
|---|---|
OIDC_ROLE_CLAIM |
ユーザーのグループ/ロールを含むOIDCトークン内のクレーム名。デフォルトは「groups」です。 |
OIDC_GROUP_ADMIN |
Grampsの「Admin」ロールにマッピングされるOIDCプロバイダーからのグループ/ロール名 |
OIDC_GROUP_OWNER |
Grampsの「Owner」ロールにマッピングされるOIDCプロバイダーからのグループ/ロール名 |
OIDC_GROUP_EDITOR |
Grampsの「Editor」ロールにマッピングされるOIDCプロバイダーからのグループ/ロール名 |
OIDC_GROUP_CONTRIBUTOR |
Grampsの「Contributor」ロールにマッピングされるOIDCプロバイダーからのグループ/ロール名 |
OIDC_GROUP_MEMBER |
Grampsの「Member」ロールにマッピングされるOIDCプロバイダーからのグループ/ロール名 |
OIDC_GROUP_GUEST |
Grampsの「Guest」ロールにマッピングされるOIDCプロバイダーからのグループ/ロール名 |
AI機能専用の設定¶
これらの設定は、チャットやセマンティック検索などのAI駆動の機能を使用する場合に必要です。
| キー | 説明 |
|---|---|
LLM_BASE_URL |
OpenAI互換のチャットAPIのベースURL。デフォルトはNoneで、OpenAI APIを使用します。 |
LLM_MODEL |
OpenAI互換のチャットAPIに使用するモデル。未設定の場合（デフォルト）、チャットは無効になります。v3.6.0以降、AIアシスタントはツール呼び出し機能を持つPydantic AIを使用します。 |
VECTOR_EMBEDDING_MODEL |
セマンティック検索のベクトル埋め込みに使用するモデル。ローカルモデルを使用する場合、これはSentence Transformersモデル名である必要があります。リモートAPIを使用する場合（VECTOR_EMBEDDING_BASE_URLを参照）、これはリモートプロバイダーに渡されるモデル名です。未設定の場合（デフォルト）、セマンティック検索とチャットは無効になります。 |
VECTOR_EMBEDDING_BASE_URL |
リモートOpenAI互換の埋め込みAPIのベースURL（例：Ollama、OpenAI、LiteLLM）。未設定の場合（デフォルト）、ローカルのSentence Transformersモデルが使用されます。詳細についてはリモート埋め込みAPIの使用を参照してください。 |
VECTOR_EMBEDDING_API_KEY |
認証されたリモート埋め込みプロバイダーのAPIキー。VECTOR_EMBEDDING_BASE_URLが設定されていて、プロバイダーが認証を必要とする場合にのみ必要です。 |
LLM_MAX_CONTEXT_LENGTH |
LLMに提供される家系図コンテキストの文字数制限。デフォルトは50000です。 |
LLM_SYSTEM_PROMPT |
LLMチャットアシスタントのカスタムシステムプロンプト（v3.6.0+）。未設定の場合、デフォルトの系譜最適化プロンプトが使用されます。 |
例の構成ファイル¶
本番用の最小限の構成ファイルは次のようになります。 ```python TREE="My Family Tree" BASE_URL="https://mytree.example.com" SECRET_KEY="..." # あなたの秘密鍵 USER_DB_URI="sqlite:////path/to/users.sqlite" EMAIL_HOST="mail.example.com" EMAIL_PORT=465 EMAIL_USE_SSL=True # ポート465のために暗黙のSSLを使用 EMAIL_HOST_USER="gramps@example.com" EMAIL_HOST_PASSWORD="..." # あなたのSMTPパスワード DEFAULT_FROM_EMAIL="gramps@example.com"