gromy/ms-api repository overview

⁠ms-api

Mail Admin API — REST API служба администрирования Р7-Почтовый сервер.

Контейнер при старте генерирует конфигурацию из переменных окружения (Jinja2), регистрирует экземпляр в кластере и подключается к PostgreSQL. Предназначен для работы в составе стека почтового сервера вместе с ms-psql, ms-frontend и другими компонентами.

• Базовый образ: Debian Bookworm
• HTTP API: порт 48033
• Конфигурация: /opt/r7-mailserver/mailapi/appsettings.json

⁠Быстрый старт

docker run -d \
  --name ms-api \
  --hostname ms-api \
  -p 48033:48033 \
  -e MS_API_DB_HOST=ms-psql \
  -e MS_API_DB_PWD=secret \
  -e MS_API_DOMAIN=mail.example.com \
  -v ms-api-logs:/var/log \
  gromy/ms-api:latest

Минимально необходимо указать параметры подключения к PostgreSQL и домен почтового сервера.

docker run --env-file .env --name ms-api -p 48033:48033 -v ./logs:/var/log gromy/ms-api:latest

⁠Порты

Порт задаётся переменной MS_API_HTTP_PORT (по умолчанию 48033).

⁠Тома

Рекомендуется монтировать том или bind-mount для сохранения логов между перезапусками.

⁠Переменные окружения

⁠PostgreSQL

⁠Домен

⁠Экземпляр службы

⁠Администратор API

⁠HTTP-сервер

⁠Логирование

⁠Пример Docker Compose

services:
  ms-api:
    image: gromy/ms-api:latest
    hostname: ms-api
    env_file: .env
    ports:
      - "48033:48033"
    volumes:
      - api-logs:/var/log
    depends_on:
      ms-psql:
        condition: service_healthy

volumes:
  api-logs:

⁠Связанные образы

⁠Ссылки

• GitLab — ms-api⁠
• Документация переменных окружения: README.md в репозитории