使用 PostgreSQL 数据库¶

默认情况下，Gramps Web 将每个家谱存储在其自己的 SQLite 数据库文件中。这无需额外的服务，备份也仅仅是复制文件，这对于大多数安装来说都很有效，包括托管多个树的情况。

另外，家谱可以使用 SharedPostgreSQL 附加组件托管在 PostgreSQL 服务器上，这样所有树都存储在一个数据库中。如果您已经运行 PostgreSQL 服务器并希望在此管理备份和监控，或者如果您预计会有许多用户同时编辑，这样做是有意义的。PostgreSQL 还可以独立于家谱存储位置托管用户数据库和搜索索引。

PostgreSQL 附加组件已弃用

较旧的 PostgreSQL 附加组件，每个数据库存储一个家谱，已弃用，并将在未来版本的 Gramps Web API 中不再支持。如果您正在使用它，请参见将树从 PostgreSQL 附加组件移动到 SharedPostgreSQL。

设置 PostgreSQL 服务器¶

最简单的选项是在与 Gramps Web 相同的 Docker 主机上使用 Docker Compose 在容器中运行 PostgreSQL 服务器。

Gramps 需要在 PostgreSQL 服务器上安装语言环境，以便在不同语言中正确排序对象，而默认的 PostgreSQL 镜像不包含任何语言环境。gramps-postgres 镜像添加了这些语言环境。要使用它，请在 docker-compose.yml 中添加以下部分：

  postgres_gramps:
    image: ghcr.io/davidmstraub/gramps-postgres:latest
    restart: unless-stopped
    environment:
      POSTGRES_PASSWORD: postgres_password_admin
      POSTGRES_PASSWORD_GRAMPS: postgres_password_gramps
      POSTGRES_PASSWORD_GRAMPS_USER: postgres_password_gramps_user
    volumes:
      - postgres_data:/var/lib/postgresql/data

并在此 YAML 文件的 volumes: 部分下添加 postgres_data: 作为键。该镜像包含两个数据库，每个数据库都有自己的用户和密码：gramps 用于家谱数据，grampswebuser 用于 Gramps Web 用户数据库。

如果您使用自己的 PostgreSQL 服务器，请创建一个名为 gramps 的数据库，该配置的用户可以在其中创建表，并确保安装了用户所需的语言环境。

配置 Gramps Web¶

当 Gramps Web 以多树模式运行且 NEW_DB_BACKEND 配置选项设置为 sharedpostgresql 时，将在 SharedPostgreSQL 数据库中创建新的家谱。使用上述 Docker Compose 设置，在 docker-compose.yml 中 grampsweb 服务的 environment: 键下添加以下内容：

      # 启用多树模式
      GRAMPSWEB_TREE: "*"
      GRAMPSWEB_MEDIA_PREFIX_TREE: true
      # 在 SharedPostgreSQL 数据库中创建新树
      GRAMPSWEB_NEW_DB_BACKEND: sharedpostgresql
      # PostgreSQL 服务器的主机和端口。主机是上面 PostgreSQL 服务的名称
      GRAMPSWEB_POSTGRES_HOST: postgres_gramps
      GRAMPSWEB_POSTGRES_PORT: 5432
      # 凭据必须与用于 PostgreSQL 容器的凭据一致
      GRAMPSWEB_POSTGRES_USER: gramps
      GRAMPSWEB_POSTGRES_PASSWORD: postgres_password_gramps

有关所有这些选项的描述，请参见配置。请注意，主机和端口在创建每棵树时会被保存，因此稍后更改它们只会影响新树。

创建树并导入数据¶

要创建新树，请按照托管多个树的设置中的说明向 /trees/ 端点发送 POST 请求。响应包含新树的 ID，您需要该 ID 来创建树所有者账户。

一旦树所有者登录，他们可以通过 Web 界面导入现有的家谱，例如从 Gramps Desktop 导出的 Gramps XML 文件。

使用 PostgreSQL 数据库作为用户数据库¶

用户数据库通常是一个 SQLite 文件，无论家谱托管在哪里。要改为使用 PostgreSQL，请将 USER_DB_URI 配置选项设置为 PostgreSQL 数据库 URL。使用上述 gramps-postgres 镜像，请使用其 grampswebuser 数据库：

postgresql://grampswebuser:postgres_password_gramps_user@postgres_gramps:5432/grampswebuser

使用 PostgreSQL 数据库作为搜索索引¶

默认情况下，搜索索引也存储在 SQLite 中。要改为使用 PostgreSQL，请将 SEARCH_INDEX_DB_URI 配置选项设置为 PostgreSQL 数据库 URL。使用上述 gramps-postgres 镜像，您可以使用其 gramps 数据库，无论您的家谱是否也托管在此：

postgresql://gramps:postgres_password_gramps@postgres_gramps:5432/gramps

将树从 PostgreSQL 附加组件移动到 SharedPostgreSQL¶

较旧的安装可能使用 PostgreSQL 附加组件托管其家谱，该组件每个数据库存储一个树，并且已弃用。要找出树使用了哪个附加组件，请查看 Gramps 数据库目录中树的子目录中的文件 database.txt：它包含 postgresql 表示已弃用的 PostgreSQL 附加组件，sharedpostgresql 表示 SharedPostgreSQL。

要在同一安装中将树从 PostgreSQL 附加组件移动到 SharedPostgreSQL，同时保留您的用户账户和媒体文件：

使用可以查看私有记录的账户备份您的家谱为 Gramps XML (.gramps) 文件。
按照配置 Gramps Web 中的说明更改您的配置。您可以继续使用现有的 gramps-postgres 容器。
创建新树并记下其树 ID。
按照迁移现有用户数据库中的说明将现有用户账户分配给新树。
按照迁移现有媒体文件中的说明将媒体文件移动到新树预期的位置。
登录并导入 Gramps XML 文件到新树中。

在检查新树完整之前，请保留 Gramps XML 文件。

如果您要迁移到单独的 Gramps Web 安装，请按照移动到不同的 Gramps Web 实例中的步骤进行操作。

问题¶

如遇问题，请监控 Gramps Web 和 PostgreSQL 服务器的日志输出。在 Docker 的情况下，可以通过以下命令实现：

docker compose logs grampsweb
docker compose logs postgres_gramps

如果您怀疑 Gramps Web（或文档）存在问题，请在 Github 上提交问题。