Ваш ключ доступа и подключение к базе данных. Отсутствующее или недопустимое значение останавливает запуск.
Human Plugin один раз при запуске читает конфигурацию из окружения. Чтобы изменить значение, нужно перезапустить контейнер.
Краткий справочник
Минимальный .env для базы данных со значениями по умолчанию, приведёнными ниже:
HUMAN_API_ACCESS_KEY=<your access key>
POSTGRES_ADDRESS_HOST=<database host>
POSTGRES_PASSWORD=<database password>
Ключ доступа
| Переменная | Обязательна | Примечания |
|---|---|---|
HUMAN_API_ACCESS_KEY | Да | Ваш ключ доступа. Связывает установку с Unico и идентифицирует вашу учётную запись. Без пробельных и управляющих символов. Никогда не попадает в логи |
Ключ доступа является секретом. Храните его в вашем хранилище секретов и передавайте в контейнер во время выполнения.
Подключение к базе данных
| Переменная | Обязательна | По умолчанию | Примечания |
|---|---|---|---|
POSTGRES_ADDRESS_HOST | Да | Имя хоста или IP-адрес вашего сервера PostgreSQL | |
POSTGRES_PASSWORD | Да | Без пробельных символов, одинарных кавычек, обратных косых черт и управляющих символов. При наличии любого из них Human Plugin отказывается запускаться, не записывая значение в лог | |
POSTGRES_ADDRESS_PORT | Нет | 5432 | |
POSTGRES_USER | Нет | postgres | Используйте роль, выделенную для Human Plugin |
POSTGRES_DATABASE | Нет | human_plugin | Используйте базу данных, выделенную для Human Plugin |
POSTGRES_SSL_MODE | Нет | require | Используйте disable только тогда, когда PostgreSQL работает на том же хосте или как sidecar |
База данных должна использоваться только Human Plugin. Роли нужно разрешение на создание в ней таблиц: Human Plugin создаёт и обновляет собственные таблицы при запуске, до того как начнёт принимать запросы.
Пароль является секретом. Храните его в вашем хранилище секретов, как и ключ доступа.
Всё остальное
Все остальные значения задаёт образ. Не задавайте другие переменные, если Unico не попросит об этом: они не входят в поддерживаемую конфигурацию.
Пример
docker run -d --name human-plugin --stop-timeout 60 -p 127.0.0.1:8080:8080 \
-e HUMAN_API_ACCESS_KEY \
-e POSTGRES_ADDRESS_HOST=db.internal \
-e POSTGRES_USER=human_plugin \
-e POSTGRES_PASSWORD \
pkg.unico.run/human-plugin-api:latest
-e NAME без значения передаёт переменную из вашей оболочки, поэтому секреты не попадают в командную строку.