Быстрый старт с Docker¶
Самый быстрый способ запустить Topolograph - использовать self-hosted образ Docker. В нём собраны веб-приложение, база данных и (опционально) MCP-сервер и Watcher-ы.
Предварительные требования
Установите Docker и Docker Compose. В Windows/macOS Docker Desktop включает и то, и другое.
1. Клонируйте и запустите¶
git clone https://github.com/Vadims06/topolograph-docker.git
cd topolograph-docker
docker-compose pull
docker-compose up -d
Используйте скрипт install.sh:
…или запустите его прямо из GitHub:
curl -O https://raw.githubusercontent.com/Vadims06/topolograph-docker/master/install.sh
chmod +x install.sh
sudo ./install.sh
Дайте ему минуту-другую на запуск, затем откройте:
2. Настройка через .env¶
Конфигурация хранится в файле .env рядом с docker-compose.yml. Самые
полезные переменные:
| Переменная | Назначение |
|---|---|
TOPOLOGRAPH_PORT |
Порт веб-интерфейса (по умолчанию 8080). После перезапуска откройте http://localhost:<port>/. |
DNS |
IP DNS-сервера, используемого для преобразования router ID в имена устройств на графе. |
TOPOLOGRAPH_WEB_API_USERNAME_EMAIL, TOPOLOGRAPH_WEB_API_PASSWORD |
Учётные данные для запросов к REST API. |
TOPOLOGRAPH_WEB_API_AUTHORISED_NETWORKS |
Список разрешённых диапазонов исходных IP-адресов, которым можно обращаться к API. |
TOPOLOGRAPH_API_TOKEN |
Токен для аутентификации запросов к REST API вместо пары логин/пароль. |
MCP_PORT |
Порт для встроенного MCP-сервера (по умолчанию 8000). |
После изменения порта или другого значения примените его заново:
3. Создайте учётные данные по умолчанию¶
Чтобы создать пользователя API из значений вашего .env и загрузить
разрешённые сети в список доступа, один раз отправьте этот запрос:
import requests
res = requests.post('http://localhost:8080/create-default-credentials')
print(res.json())
# {'errors': '', 'status': 'ok'}
Проверьте, что всё сработало:
- Откройте
http://localhost:8080/в браузере. - Перейдите в Login → Local login и войдите с помощью
TOPOLOGRAPH_WEB_API_USERNAME_EMAIL/TOPOLOGRAPH_WEB_API_PASSWORD. - На вкладке API → Authorised source IP ranges должны отображаться
диапазоны из
TOPOLOGRAPH_WEB_API_AUTHORISED_NETWORKS.
Что входит в комплект¶
docker-compose.yml в topolograph-docker может запускать не только
веб-приложение:
- Topolograph - веб-приложение + база данных.
- MCP-сервер по адресу
http://localhost:8000/mcpдля доступа LLM/агентов. - Опционально - OSPF/IS-IS Watcher-ы и стек ELK для мониторинга в реальном времени.
Облачный вариант
Не хотите разворачивать самостоятельно? Облачный экземпляр доступен на topolograph.com. Версия для Docker идеальна, когда ваши LSDB не должны покидать вашу инфраструктуру.