# Документация nodbox

> От первого деплоя до лимитов проекта: что делает платформа и как ею управлять из панели, из редактора с агентом и по API.

Страница в работе: структура готова, тексты страниц пишутся. Главное про платформу собрано на двух страницах: https://nodbox.ru/index.md для инженеров и https://nodbox.ru/agents.md для вайбкодеров.

## Начало работы

Первый деплой и слова, которыми называется всё остальное.

- [Быстрый старт](https://nodbox.ru/docs/start/quickstart.md): От заявки на ранний доступ до работающего адреса: создать проект, подключить код и получить первую версию из панели или фразой агенту.
- [Основные понятия](https://nodbox.ru/docs/start/concepts.md): Проект, приложение, версия, размер, экземпляр: что означают слова, которыми платформа называет свои части.

## Деплой

Откуда платформа берёт код, как собирает его и как возвращает прежнюю версию.

- [Источники кода](https://nodbox.ru/docs/deploy/sources.md): Репозиторий GitHub, GitLab или Bitbucket, архив с папкой проекта, готовый образ из публичного реестра: как подключить каждый.
- [Подключение GitHub, GitLab и Bitbucket](https://nodbox.ru/docs/deploy/git-accounts.md): Как подключить GitHub App, токен GitLab или токен Bitbucket и выбрать репозиторий из списка, приватный или публичный.
- [Сборка без Dockerfile](https://nodbox.ru/docs/deploy/build.md): Как платформа определяет язык, зависимости и команду запуска, и что делать, если сборка не прошла.
- [Настройки сборки и свой Dockerfile](https://nodbox.ru/docs/deploy/build-settings.md): Команды сборки и запуска, корневая папка монорепозитория, версия рантайма, переменные сборки и свой Dockerfile, если автоопределения мало.
- [Автодеплой по push](https://nodbox.ru/docs/deploy/auto-deploy.md): Новая версия на каждый push в выбранную ветку: как включить и выключить автодеплой, вебхук, фильтр путей и пометки, пропускающие деплой.
- [Версии и откат](https://nodbox.ru/docs/deploy/versions.md): История выкладок, причины отказа, отмена идущего деплоя и возврат на одну из последних выкаченных версий.

## Приложение

Тип, настройки, размер, сон и масштаб.

- [Веб-приложения и воркеры](https://nodbox.ru/docs/apps/types.md): Приложение с адресом и фоновый воркер: чем они отличаются, зачем вебу порт и почему у воркера его нет.
- [Переменные и секреты](https://nodbox.ru/docs/apps/env.md): Как задать настройки приложения, чем секрет отличается от обычной переменной и когда изменения вступают в силу.
- [Размеры приложения](https://nodbox.ru/docs/apps/sizes.md): Eco и High: чем они отличаются гарантией процессора, как выбрать размер и сменить его.
- [Порт, протокол и проверка готовности](https://nodbox.ru/docs/apps/runtime.md): Порт приложения, HTTP/1.1 или HTTP/2, путь проверки готовности и таймаут запроса.
- [Сон и пробуждение](https://nodbox.ru/docs/apps/sleep.md): Когда приложение засыпает, как просыпается на первый запрос и почему минуты сна не тарифицируются.
- [Автомасштабирование](https://nodbox.ru/docs/apps/scaling.md): Как платформа добавляет экземпляры под нагрузку и что в этом можно настроить.
- [Остановка и удаление](https://nodbox.ru/docs/apps/lifecycle.md): Как остановить приложение, запустить его снова и удалить вместе с версиями.

## Домены

Адрес приложения и свой домен с сертификатом.

- [Адрес и HTTPS](https://nodbox.ru/docs/domains/address.md): Адрес на домене платформы выдаётся при создании приложения, HTTPS работает на нём сразу.
- [Свой домен](https://nodbox.ru/docs/domains/custom-domain.md): Какие записи добавить у регистратора, как платформа их проверяет и выпускает сертификат.

## Базы данных

Управляемые PostgreSQL, MySQL и Valkey: заказ, размеры, подключение, копии.

- [Управляемый PostgreSQL](https://nodbox.ru/docs/databases/postgres.md): Как заказать и удалить управляемую базу PostgreSQL и как выбрать её размер.
- [Управляемый MySQL](https://nodbox.ru/docs/databases/mysql.md): Как заказать управляемый MySQL, чем отличаются eco и high и как подключить базу к приложению.
- [Управляемый Valkey](https://nodbox.ru/docs/databases/valkey.md): Как заказать управляемый Valkey, совместимый с Redis, подключить его к приложению и что происходит при заполнении памяти.
- [Размеры и цена баз](https://nodbox.ru/docs/databases/presets.md): Пресеты eco и high, поминутное списание, смена размера и почему диск только растёт.
- [Подключение к базе](https://nodbox.ru/docs/databases/connect.md): Внутренний адрес и строка подключения в переменной приложения, публичный адрес для ноутбука и CI: выключен по умолчанию.
- [Копии и восстановление](https://nodbox.ru/docs/databases/backups.md): Как копируются базы и как их восстановить: PostgreSQL и MySQL на момент времени, Valkey из суточного снимка.

## Наблюдаемость

Логи, метрики и состояния: что видно без SSH.

- [Лог сборки](https://nodbox.ru/docs/observability/build-log.md): Живой поток сборки: видно, на какой строке всё сломалось.
- [Логи приложения](https://nodbox.ru/docs/observability/logs.md): Где смотреть логи приложения и конкретной его версии, не подключаясь к серверу.
- [Метрики приложения](https://nodbox.ru/docs/observability/metrics.md): Запросы, время ответа, процессор, память и перезапуски приложения.
- [Состояния приложения](https://nodbox.ru/docs/observability/states.md): Работает, спит, деплой, упало, остановлено: что означает каждое и как платформа их определяет.
- [Лента событий](https://nodbox.ru/docs/observability/events.md): Что происходило с приложением: деплои, откаты, падения, сон и пробуждение.

## Агенты и API

MCP-сервер для агента, консольная утилита, API и права токена.

- [Подключение MCP-сервера](https://nodbox.ru/docs/automation/mcp-setup.md): Как подключить nodbox к редактору с агентом, чтобы агент заказывал деплой, читал логи и делал откат сам.
- [Инструменты MCP](https://nodbox.ru/docs/automation/mcp-tools.md): Что умеет агент через MCP: список инструментов с описанием каждого.
- [Фразы для агента](https://nodbox.ru/docs/automation/prompts.md): Что сказать агенту, чтобы он задеплоил проект, прочитал логи или откатил версию.
- [Справочник CLI](https://nodbox.ru/docs/automation/cli.md): Команды консольной утилиты: те же действия над приложениями, что в панели и по API.
- [API nodbox](https://nodbox.ru/docs/automation/api.md): Публичный API: те же действия, что в панели, запросом из кода или из CI, и защита от повторного заказа.
- [Токены и права](https://nodbox.ru/docs/automation/tokens.md): Права токена: читать, деплоить, менять мощность, удалять. Как выдать токен, посмотреть его последнее использование и отозвать.

## Проект и деньги

Тарификация, тарифы, баланс, лимиты, участники и письма.

- [Тарификация](https://nodbox.ru/docs/project/billing.md): Как считаются деньги по минутам, что тарифицируется и что нет, и что показывает прогноз расхода.
- [Тарифы платформы](https://nodbox.ru/docs/project/plans.md): Тарифы Старт, Про и Команда: чем отличаются и что открывает каждый.
- [Пополнение баланса](https://nodbox.ru/docs/project/topup.md): Пополнение через ЮKassa и автопополнение по порогу.
- [Остановка при нулевом балансе](https://nodbox.ru/docs/project/zero-balance.md): Письма о низком балансе, остановка приложений при нуле, срок хранения и запуск после пополнения.
- [Лимиты и квоты](https://nodbox.ru/docs/project/limits.md): Сколько проектов, приложений и ресурсов доступно, сколько осталось и что происходит при отказе по лимиту.
- [Команда и роли](https://nodbox.ru/docs/project/team.md): Роли доступны на тарифе Команда: как пригласить человека в проект и что разрешено владельцу, разработчику и наблюдателю.
- [Уведомления](https://nodbox.ru/docs/project/notifications.md): Письма о провале деплоя, низком балансе, остановке проекта, зачислении платежа и смене пароля: что приходит и как это настроить.

## Безопасность

Изоляция проектов и защита аккаунта.

- [Изоляция](https://nodbox.ru/docs/security/isolation.md): Своя сеть у каждого проекта, песочница для кода и закрытая входящая сеть: как это устроено.
- [Защита аккаунта](https://nodbox.ru/docs/security/account-protection.md): 2FA или passkey и вход из терминала по коду, который подтверждается в браузере.

## Справка

Границы платформы, разбор частых проблем и ответы на вопросы.

- [Границы платформы](https://nodbox.ru/docs/help/limitations.md): Чего платформа не делает: постоянного диска, задач по расписанию, self-hosted GitLab, превью для pull request.
- [Типичные сбои и что делать](https://nodbox.ru/docs/help/troubleshooting.md): Сборка не прошла, приложение не поднялось, адрес не открывается: куда смотреть и что исправить.
- [Вопросы и ответы](https://nodbox.ru/docs/help/faq.md): Короткие ответы на вопросы, которые возникают в первый день работы с платформой.

## Ссылки

- Страница: https://nodbox.ru/docs/
- Карта продукта для моделей: https://nodbox.ru/llms.txt