Перейти к содержимому

Веб-установка ​

Запустите Sayrud из бинарного файла, через Docker Compose или Kubernetes и откройте http://server-address:2830/setup. До установки главная страница также перенаправляет сюда.

Установка состоит из четырёх шагов: проверка, база данных, администратор и завершение. Язык можно изменить в правом верхнем углу.

Подтверждение доступа ​

Если токен установки не задан, при запуске в журналах появляются Setup token: и ссылка на установку с токеном. Скопируйте токен на страницу и нажмите «Проверить». При удалённом развёртывании замените localhost в ссылке реальным адресом.

Способ развёртыванияГде смотреть журналы
Запуск на переднем планеТекущий терминал
systemdsudo journalctl -u sayrud -n 100 --no-pager
Docker Composedocker compose logs --tail=100 sayrud
Kuberneteskubectl -n sayrud logs deployment/sayrud --tail=100

Если задан SAYRUD_SETUP_TOKEN, введите его значение. В инструкции для K8s используется этот способ; токен находится в локальном файле, из которого создан Secret.

Собственный токен должен содержать не менее 16 символов без учёта пробелов и дефисов. Его можно создать командой openssl rand -hex 24. При проверке регистр, пробелы и дефисы не учитываются.

Если токен не фиксирован, перезапуск процесса во время установки создаёт новый токен. Возьмите его из последних журналов. Передавайте токен и содержащую его ссылку только тому, кто выполняет установку; после создания администратора интерфейсы установки закрываются.

Настройка баз данных ​

При новой установке укажите следующие данные:

СлужбаПоля
PostgreSQLХост, порт, имя базы данных, имя пользователя, пароль, режим SSL
RedisАдрес в формате хост:порт, а также необязательные имя пользователя и пароль

Подключения выполняются из процесса Sayrud, а не с компьютера, на котором открыт браузер. Конфигурация Docker Compose использует postgres и redis:6379; K8s — имена Service внутри кластера или доступные внешние домены.

PostgreSQL предлагает режимы SSL «Без шифрования», «С шифрованием», «С шифрованием и проверкой CA» и «С шифрованием и проверкой CA и имени хоста». Выберите режим согласно требованиям сервиса базы данных. Для проверки сертификатов среда выполнения также должна доверять соответствующему CA.

Нажмите «Проверить подключение», убедитесь, что соединения с PostgreSQL и Redis успешны, затем нажмите «Сохранить и продолжить».

Создание администратора ​

Укажите электронную почту, имя пользователя, пароль и его подтверждение, затем нажмите «Завершить установку».

Будет создан первый системный администратор и выполнен автоматический вход. Нажмите «Начать работу», чтобы перейти в приложение.

После установки проверьте создание проектов, редактирование записей и загрузку вложений, а также сохранность конфигурации и файлов при выбранном способе развёртывания. Параметры сайта, регистрацию пользователей, способы входа и модели ИИ можно изменить в панели администратора.

Подготовка конфигурации заранее ​

Если параметры подключения поступают из системы управления конфигурацией, можно заранее подготовить sayrud.yaml. Ниже приведена конфигурация с локальным хранилищем; сначала замените пароль подключения и auth.secret_key:

yaml
postgres:
  dsn: "postgres://sayrud:[email protected]:5432/sayrud?sslmode=disable"
redis:
  address: "127.0.0.1:6379"
  username: ""
  password: ""
auth:
  secret_key: "REPLACE_WITH_BASE64_KEY"
storage:
  type: local
  local:
    path: ./data/storage

Создайте auth.secret_key этой командой и укажите её полный вывод в конфигурации:

sh
openssl rand -base64 32

При ручном составлении URL PostgreSQL специальные символы в пароле, например @, : и /, нужно кодировать для URL. При вводе через мастер программа делает это сама.

Поместите файл по пути, указанному в аргументах запуска. Остальные параметры описаны в примере конфигурации. После изменения конфигурации перезапустите программу.

Решение проблем ​

Страница установки не появляется ​

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

Токен установки недействителен ​

Проверьте, не перезапускался ли процесс во время установки. Если SAYRUD_SETUP_TOKEN не задан, используйте токен из последних журналов. В K8s проверьте, что Pod использует нужный Secret, и оставьте одну реплику на время первой установки. Повторные ошибки включают ограничение числа попыток; проверьте токен перед повторным вводом.

Ошибка проверки подключения к базе данных ​

Проверьте, создана ли база, верны ли учётные данные и доступен ли адрес с хоста или Pod приложения. В контейнере 127.0.0.1 указывает на сам контейнер. Если подключение успешно, но сохранение не удаётся, проверьте права на миграцию схемы.

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

Ошибка прав при сохранении конфигурации ​

Мастер сначала записывает временный файл в каталоге конфигурации, затем сохраняет его как sayrud.yaml, поэтому каталог должен быть доступен для записи. Проверьте монтирования только для чтения, ConfigMap, Secret и соответствие UID/GID процесса владельцу тома. Образы Docker и K8s используют 10001:10001.

Конфигурация сохранена, но требуется перезапуск ​

Проверьте журналы, устраните последующую ошибку инициализации служб и перезапустите программу с тем же путём конфигурации. Сохранённый файл будет прочитан повторно; удалять его и переустанавливать приложение не нужно.

После пересоздания контейнера снова появляется страница установки ​

Проверьте, смонтирован ли каталог конфигурации в /home/app/config, используется ли исходная база PostgreSQL и не изменились ли имя проекта Compose или PVC в K8s. Сначала восстановите исходные конфигурацию и данные, прежде чем начинать новую установку.