megabitusdev/megabitus-server repository overview

⁠Megabitus Server Docker Image

Образ предназначен для запуска на своем сервере узла замеров сервиса megabitus.com⁠.

⁠Требования к серверу

• Оперативная память: рекомендуется 16GB;
• Пропускной канал: минимум 1 Gbps;
• Для сервера должен быть выделен отдельный поддомен и белый IP-адрес;
• Не должен быть занят порт, указанный в переменной окружения PORT.

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

• HOST — Домен, на котором будет располагаться сервер;
• INTERFACE — Интерфейс, на котором будет располагаться сервер;
• PORT — Номер порта;
• SSL — Признак использования SSL (true/false). Если используется SSL и установлен порт отличный от 443, то нужно обязательно разместить существующий SSL сертификат в каталоге /app/certs;
• TLS_CERT_FILE — Путь к файлу с сертификатом (не обязательно);
• TLS_KEY_FILE — Путь к файлу с приватным ключом (не обязательно);
• TOKEN — Токен для получения состояния узла (не обязательно);
• CUSTOM_ENDPOINT — Дополнительный адрес для получения состояния узла (не обязательно);
• CUSTOM_CONTENT — Дополнительный контент для получения состояния узла (не обязательно);
• API_URL — Адрес API-сервиса (не обязательно);
• DEBUG — Признак отладки (true/false).

Также рекомендуется вынести каталог /app/certs, в котором храниться автоматически полученный HTTPS-сертификат. Сюда же можно положить существующий сертификат. В этом случае система будет работать с ним.

⁠Пример docker-compose.yml

services:
    node:
        image: megabitusdev/megabitus-server
        ports:
            - "${NODE_PORT}:${NODE_PORT}"
        volumes:
            - ./certs:/app/certs
        restart: always
        environment:
            - HOST=${NODE_URL}
            - INTERFACE=${NODE_INTERFACE}
            - PORT=${NODE_PORT}
            - SSL=${NODE_SSL}
            - TLS_CERT_FILE=${NODE_TLS_CERT_FILE}
            - TLS_KEY_FILE=${NODE_TLS_KEY_FILE}
            - TOKEN=${NODE_TOKEN}
            - CUSTOM_ENDPOINT=${NODE_CUSTOM_ENDPOINT}
            - CUSTOM_CONTENT=${NODE_CUSTOM_CONTENT}
            - API_URL=${NODE_API_URL}
            - DEBUG=${NODE_DEBUG}