Оформление
Установка и эксплуатация
Здесь собраны инструкции для оператора сервера: установка, хранение файлов, резервные копии, восстановление и обновление. Перед командами проверьте, к какому серверному комплекту относится сценарий.
Если вы впервые устанавливаете NGENSIA, идите по порядку: подготовить сервер → установить конфигурацию → проверить первый вход → настроить домен → настроить копии → проверить восстановление. Если система уже работает, не начинайте установку заново: выберите нужную операцию в таблице ниже.
Пять слов, которые встретятся в инструкциях
| Термин | Простыми словами |
|---|---|
| Серверный комплект | Папка с командами запуска и настройками. Она должна подходить к выбранной версии приложения |
| Образ приложения | Готовая упакованная версия NGENSIA. Docker запускает её в контейнере |
| Digest | Точный отпечаток образа. Он помогает убедиться, что запускается именно проверенная сборка, а не другой файл с похожим названием |
| Постоянный том (volume) | Место для базы или файлов, которое не должно исчезнуть при замене контейнера |
| Миграция | Изменение структуры базы для новой версии. Поэтому возврат старого образа не всегда означает безопасный откат |
Команды выполняются в терминале Linux-сервера через SSH, не в адресной строке браузера и не в консоли Groovy. Путь /opt/ngensia/deploy в примерах замените своим каталогом комплекта. Заглавные слова вроде TARGET_VERSION — места для ваших значений, не готовые параметры.
Какой комплект нужен
На 13 октября 2026 года новый установщик с командами install, backup-run, расписанием копий и управлением версиями существует как локальный кандидат. Его включение в поставляемый комплект и действующие серверные образы ещё не подтверждено. Публикация этой документации не обновляет установщик на вашем сервере.
| Сценарий | Что проверить до начала |
|---|---|
| Установка с конфигурацией и первым Superuser | Получен проверенный комплект с install и пакетом конфигурации |
backup-config, backup-run, backup-fetch, расписание | Комплект содержит эти команды и согласованный operations.py |
release-add, history, update, rollback | Комплект поддерживает управление версиями; образ и инфраструктурные файлы совместимы |
init, restore, recover, start, stop, status, backup, команды storage | Они есть в прежнем комплекте; это не означает поддержку новых сценариев выше |
Если комплект не подходит
Не выполняйте новые команды до подтверждения комплекта сопровождающим. Не копируйте отдельно operations.py, не подменяйте рабочий ngensia.sh и не меняйте контрольные суммы для обхода проверки. Статьи нового сценария ниже — руководство для его приёмки, а не подтверждение готового выпуска.
Выберите сценарий
| Задача | Инструкция |
|---|---|
| Выдали новый сервер, не знаю, с чего начать | SSH, права, Docker, Compose и Python — с нуля |
| Новая установка с нашей конфигурацией | Установка |
| Первый вход и настройка рабочих процессов | После установки |
| Где хранить вложения | Диск · S3 |
| Сохранить систему | Резервная копия · Расписание |
| Вернуть данные | Восстановление · Авария сервера |
| Перейти на новый выпуск | Обновление · Откат |
| Открыть сайт сотрудникам | Домен и HTTPS |
Из чего состоит установка
Linux и Docker подготавливаются отдельно по инструкции для нового сервера, а не устанавливаются из архива приложения.
Linux, Docker Compose, PostgreSQL 17, приложение и HTTPS-прокси Caddy. У базы и файлов — постоянные тома. Внутреннее соединение с PostgreSQL защищено TLS. Миграции выполняются отдельной ролью; web-приложение не должно изменять схему.
В инструкции предполагается доступ инженера к Docker. Это административный доступ к серверу, а не роль Superuser внутри продукта. Единственный экземпляр приложения — штатная конфигурация; горизонтальное масштабирование не описывается как поддержанное.
Граница готовности
Наличие реализации и локальная репетиция не заменяют приёмку поставляемого комплекта, вашего сервера, конкретного S3-провайдера, реального расписания systemd и восстановления после полной потери инфраструктуры.
Перед изменениями
Проверьте имя окружения и Compose-проекта, согласуйте окно, сохраните проверенный комплект и доступ к внешней копии. DEV, STAGE и production должны иметь разные базы, секреты и префиксы хранилищ.
Параметры установки · Контроль состояния · Фоновые обработчики