Nexus Documentation
Техническая документация платформы Nexus. Здесь собраны инструкции по развёртыванию, настройке компонентов и работе с программным интерфейсом.
Начните здесь
Выберите раздел в зависимости от задачи. Для первоначальной настройки рекомендуем руководство по быстрому старту.
О платформе
Nexus — демонстрационная программная платформа для управления сервисами, интеграциями и распределёнными компонентами инфраструктуры.
Её архитектура предусматривает использование REST API, токенов доступа и асинхронных событий.
Основные компоненты
| Компонент | Назначение |
|---|---|
| Core | Основная логика платформы |
| Gateway | Маршрутизация API-запросов |
| Agent | Управление удалёнными экземплярами |
| Console | Веб-интерфейс администратора |
Быстрый старт
Базовая последовательность действий для развёртывания локального экземпляра Nexus.
-
Подготовьте окружение
Убедитесь, что установлены Docker Engine и Docker Compose.
-
Создайте конфигурацию
Определите переменные окружения и параметры сетевого подключения.
-
Запустите компоненты
Примените конфигурацию и проверьте состояние сервисов.
Пример запуска
docker compose up -d
docker compose ps
docker compose logs --tail=50
После запуска проверьте состояние контейнеров и доступность настроенных портов.
Установка
Требования к окружению и поддерживаемые способы развёртывания платформы.
Системные требования
| Ресурс | Минимум | Рекомендуется |
|---|---|---|
| CPU | 2 vCPU | 4 vCPU |
| RAM | 2 GB | 4 GB |
| Диск | 10 GB | 25 GB SSD |
| ОС | Linux x64 | Ubuntu Server |
Способы развёртывания
Контейнеризация рекомендуется для тестовых и производственных окружений.
docker --version
docker compose version
docker compose up -d
При ручной установке необходимо самостоятельно настроить окружение, сервисы и зависимости.
Конфигурация
Параметры приложения задаются через переменные окружения или конфигурационный файл.
Пример .env
APP_ENV=production
APP_PORT=8080
LOG_LEVEL=info
API_ENABLED=true
API_RATE_LIMIT=100
DATABASE_HOST=localhost
DATABASE_PORT=5432
Параметры
| Параметр | Описание |
|---|---|
APP_PORT |
Порт HTTP-сервера |
LOG_LEVEL |
Уровень журналирования |
API_ENABLED |
Включение API |
API_RATE_LIMIT |
Лимит запросов |
API Reference
Программный интерфейс Nexus использует HTTP и JSON для обмена данными.
https://api.nexus.example/v1
— демонстрационный адрес.
Получение состояния
Эндпоинт GET /status возвращает
текущее состояние экземпляра.
curl https://api.nexus.example/v1/status \
-H "Authorization: Bearer YOUR_TOKEN"
const response = await fetch(
"https://api.nexus.example/v1/status",
{
headers: {
Authorization: "Bearer YOUR_TOKEN"
}
}
);
const data = await response.json();
console.log(data);
import requests
response = requests.get(
"https://api.nexus.example/v1/status",
headers={
"Authorization": "Bearer YOUR_TOKEN"
}
)
print(response.json())
Пример ответа
{
"status": "operational",
"version": "2.4.0",
"services": {
"core": "healthy",
"gateway": "healthy",
"database": "healthy"
}
}
Аутентификация
Доступ к защищённым методам API осуществляется с помощью токенов авторизации.
Bearer Token
Токен передаётся в HTTP-заголовке
Authorization.
Authorization: Bearer YOUR_API_TOKEN
Коды ответа
При отсутствии токена сервер возвращает
401 Unauthorized.
Если прав недостаточно — 403 Forbidden.
Webhooks
Webhooks позволяют получать уведомления о событиях без постоянного опроса API.
Пример события
{
"event": "instance.updated",
"timestamp": "2026-11-18T12:00:00Z",
"data": {
"id": "inst_12345",
"status": "active"
}
}
Типы событий
| Событие | Описание |
|---|---|
instance.created |
Создан экземпляр |
instance.updated |
Изменена конфигурация |
instance.deleted |
Экземпляр удалён |
Коды ошибок
API использует стандартные коды состояния HTTP.
| Код | Значение | Описание |
|---|---|---|
| 200 | OK | Успешный запрос |
| 400 | Bad Request | Неверные параметры |
| 401 | Unauthorized | Нет авторизации |
| 403 | Forbidden | Недостаточно прав |
| 404 | Not Found | Ресурс не найден |
| 429 | Too Many Requests | Превышен лимит |
| 500 | Internal Error | Ошибка сервера |
Структура ошибки
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Requested resource does not exist",
"request_id": "req_84fa2"
}
}
История изменений
Основные изменения и обновления платформы.
Версия 2.4.0
18 ноября 2026 · Stable
Обновлена система маршрутизации запросов. Добавлены новые параметры журналирования и улучшена обработка сетевых ошибок.
Версия 2.3.2
3 октября 2026 · Maintenance
Исправлены ошибки конфигурации и улучшена совместимость с контейнерными окружениями.
Версия 2.3.0
12 августа 2026 · Stable
Добавлены уведомления Webhooks, переработаны методы управления экземплярами.
Частые вопросы
Ответы на распространённые вопросы по использованию платформы.
Какие операционные системы поддерживаются?
Документация ориентирована на Linux x64. Контейнерное окружение позволяет использовать другие совместимые платформы.
Можно ли изменить порт приложения?
Да. Укажите нужное значение переменной
APP_PORT и перезапустите сервис.
Где посмотреть журналы?
При запуске через Docker Compose используйте
команду docker compose logs.
Документация доступна без интернета?
Да. Этот демонстрационный портал полностью автономный и может открываться как локальный HTML-файл.
Поддержка
Справочная информация для пользователей и разработчиков платформы.
Перед обращением
Проверьте конфигурацию, журналы приложения и состояние зависимых сервисов.