https://valoryx.org/ru/docs/reference/ Recent content in Справочник on Valoryx Hugo ru https://valoryx.org/ru/docs/reference/api/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/ru/docs/reference/api/ Справочник REST API DocPlatform предоставляет RESTful JSON API по адресу /api/v1/. Все endpoints требуют аутентификации, если не указано иное. Базовый URL http://localhost:3000/api/v1 Аутентификация Большинство endpoints требуют JWT access token в заголовке Authorization: Authorization: Bearer eyJhbGciOiJSUzI1NiIs... Получите токены через endpoints входа или OIDC. Жизненный цикл токенов Токен Срок жизни Назначение Access token 15 минут Аутентификация API Refresh token 30 дней Получение новых access token Endpoints аутентификации Регистрация POST /api/v1/auth/register Создание новой учетной записи. https://valoryx.org/ru/docs/reference/cli/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/ru/docs/reference/cli/ Справочник CLI DocPlatform предоставляет 5 команд CLI для управления сервером, инициализации workspace, диагностики и обслуживания. Глобальные параметры Эти параметры применяются ко всем командам: Флаг Описание --help, -h Показать справку для любой команды --version, -v Вывести информацию о версии docplatform serve Запуск HTTP-сервера. docplatform serve [flags] Флаги Флаг По умолчанию Описание --port 3000 Порт HTTP-сервера (переопределяет переменную окружения PORT) --host 0.0.0.0 Адрес HTTP-сервера (переопределяет переменную окружения HOST) --data-dir .docplatform Путь к директории данных (переопределяет переменную окружения DATA_DIR) Поведение Загружает переменные окружения из файла . https://valoryx.org/ru/docs/reference/troubleshooting/ Mon, 01 Jan 0001 00:00:00 +0000 https://valoryx.org/ru/docs/reference/troubleshooting/ Устранение неполадок В этом руководстве рассмотрены распространенные проблемы и их решения. Для получения диагностической информации всегда начинайте с: docplatform doctor Запуск сервера Сервер не запускается: “address already in use” Причина: Другой процесс использует настроенный порт. Решение: # Find what's using port 3000 lsof -i :3000 # macOS/Linux ss -tlnp | grep 3000 # Linux # Option 1: Stop the other process # Option 2: Use a different port docplatform serve --port 8080 Сервер не запускается: “permission denied” Причина: Процесс не имеет прав чтения/записи к директории данных.