Использование базы данных PostgreSQL¶

По умолчанию Gramps Web хранит каждое семейное дерево в своем собственном файле базы данных SQLite. Это не требует дополнительных сервисов, резервное копирование так же просто, как копирование файлов, и это хорошо работает для большинства установок, включая те, которые хостят несколько деревьев.

В качестве альтернативы семейные деревья могут быть размещены на сервере PostgreSQL с помощью аддона SharedPostgreSQL, который хранит все деревья в одной базе данных. Это может иметь смысл, если вы уже используете сервер PostgreSQL и хотите управлять резервным копированием и мониторингом там, или если вы ожидаете, что много пользователей будут редактировать одновременно. PostgreSQL также может хостить базу данных пользователей и индекс поиска, независимо от того, где хранятся семейные деревья.

Аддон PostgreSQL устарел

Устаревший аддон PostgreSQL, который хранит одно семейное дерево на базу данных, больше не поддерживается и не будет поддерживаться в будущих версиях Gramps Web API. Если вы его используете, смотрите Перемещение дерева из аддона PostgreSQL в SharedPostgreSQL.

Настройка сервера PostgreSQL¶

Самый простой вариант — запустить сервер PostgreSQL в контейнере на том же хосте Docker, что и Gramps Web, используя Docker Compose.

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

и также добавьте postgres_data: как ключ в разделе volumes: этого YAML файла. Образ содержит две базы данных, каждая со своим пользователем и паролем: gramps для генеалогических данных и grampswebuser для базы данных пользователей Gramps Web.

Если вы используете свой собственный сервер PostgreSQL, создайте базу данных с именем gramps, в которой настроенный пользователь сможет создавать таблицы, и убедитесь, что установлены необходимые локали для ваших пользователей.

Настройка Gramps Web¶

Новые семейные деревья создаются в базе данных SharedPostgreSQL, когда Gramps Web работает в моде многодеревьев и параметр конфигурации NEW_DB_BACKEND установлен на sharedpostgresql. С вышеуказанной настройкой Docker Compose добавьте следующее под ключом environment: сервиса grampsweb в docker-compose.yml:

      # включить режим многодеревьев
      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

Смотрите Конфигурация для описания всех этих параметров. Обратите внимание, что хост и порт сохраняются с каждым деревом при его создании, поэтому изменение их позже затрагивает только новые деревья.

Создание дерева и импорт данных¶

Чтобы создать новое дерево, выполните POST-запрос к конечной точке /trees/, как описано в Настройка для хостинга нескольких деревьев. Ответ содержит ID нового дерева, который вам нужен для создания учетной записи владельца дерева.

После того как владелец дерева вошел в систему, он может импортировать существующее семейное дерево, например, файл Gramps XML, экспортированный из Gramps Desktop, через веб-интерфейс.

Использование базы данных PostgreSQL для базы данных пользователей¶

База данных пользователей обычно представляет собой файл SQLite, независимо от того, где хранятся семейные деревья. Чтобы использовать PostgreSQL вместо этого, установите параметр конфигурации USER_DB_URI на URL базы данных PostgreSQL. С образом gramps-postgres, указанным выше, используйте его базу данных grampswebuser:

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

Использование базы данных PostgreSQL для индекса поиска¶

Индекс поиска также по умолчанию хранится в SQLite. Чтобы использовать PostgreSQL вместо этого, установите параметр конфигурации SEARCH_INDEX_DB_URI на URL базы данных PostgreSQL. С образом gramps-postgres, указанным выше, вы можете использовать его базу данных gramps, независимо от того, хранятся ли ваши семейные деревья там:

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

Перемещение дерева из аддона PostgreSQL в SharedPostgreSQL¶

Старые установки могут хостить свои семейные деревья с помощью аддона PostgreSQL, который хранит одно дерево на базу данных и устарел. Чтобы узнать, какой аддон использует дерево, посмотрите файл database.txt в подкаталоге дерева в каталоге базы данных Gramps: он содержит 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.