Представляем Livops 2.0! ПромокодCEOдарит 8 000 сумов на ваш счёт.Что нового
Сборка и настройка / Фреймворки и livops.json

Сборка и настройка

Фреймворки и livops.json

Какие фреймворки распознаёт Livops и как управлять командами через файл livops.json в репозитории.

Перед деплоем Livops читает репозиторий и определяет фреймворк. От него зависят команды установки (install), сборки (build) и запуска (start). Их можно изменить в кабинете или в файле livops.json.

Распознаваемые фреймворки

Язык Фреймворки
JavaScript / TypeScript Next.js, Nuxt, Astro, SvelteKit, Remix, React Router, TanStack Start, SolidStart, Qwik, Gatsby, Docusaurus, VitePress, Vite, Create React App, Angular, Vue CLI, Eleventy, Hexo, Node.js-сервер, Telegram-бот (Node)
Python Python-приложение (FastAPI, Django, Flask и другие), Telegram-бот на Python, MkDocs
PHP Laravel, обычный PHP
Ruby Rails, Jekyll
Go, Rust Go, Rust
Java Maven, Gradle
Другое Hugo, Dockerfile, обычный HTML

Если в репозитории есть Dockerfile, используется он. Если ничего не найдено, папка публикуется как статический сайт.

Livops также читает файлы: livops.json, Procfile, Dockerfile, .python-version, runtime.txt, .nvmrc, .node-version.

Django

Для проекта со структурой startproject Livops:

  • запускает python manage.py migrate --noinput перед каждым стартом, чтобы таблицы были созданы (при сборке базы нет, поэтому там migrate не выполняется);
  • выполняет python manage.py collectstatic --noinput при сборке, если в проекте есть django.contrib.staticfiles и задан STATIC_ROOT;
  • задаёт переменную ALLOWED_HOSTS — адреса проекта через запятую, если вы не задали её сами.

Сам Django не читает ALLOWED_HOSTS из окружения. В settings.py:

import os
ALLOWED_HOSTS = os.environ.get("ALLOWED_HOSTS", "").split(",")

При DEBUG = False Django не отдаёт статические файлы. Подключите whitenoise: pip install whitenoise, добавьте "whitenoise.middleware.WhiteNoiseMiddleware" сразу после SecurityMiddleware в MIDDLEWARE и задайте STATIC_ROOT = BASE_DIR / "staticfiles".

livops.json

Положите livops.json в корень репозитория (или в папку проекта). Все поля необязательны: неуказанные берутся из определённых автоматически значений.

{
  "kind": "web",
  "install": "npm ci",
  "build": "npm run build",
  "start": "node dist/server.js",
  "healthPath": "/healthz",
  "memory": 512
}
Поле Значение
kind Тип сервиса: site, web, bot, worker или cron.
install Команда установки зависимостей.
build Команда сборки.
output Папка с результатом сборки для статического сайта (например, dist).
start Команда запуска.
healthPath Путь для проверки работоспособности приложения, начинается с /.
schedule Расписание для cron, см. Cron и воркеры.
memory Память, MiB: 256, 512, 1024 или 2048.
builder dockerfile или preset: чем собирать проект, в котором есть Dockerfile. Читается при создании проекта. По умолчанию Dockerfile используется, если фреймворк не распознан.

Типы

  • site — статический сайт: результат сборки отдаётся как файлы. Бесплатно.
  • web — серверное приложение, отвечающее на HTTP-запросы. Должно слушать порт из переменной PORT.
  • bot — Telegram-бот: работает постоянно, публичный адрес не нужен.
  • worker — фоновый процесс: очередь, подписка и т. п. Публичного адреса нет.
  • cron — команда, запускаемая по расписанию.

Правила

  • Файл читается при каждом деплое, из собираемого коммита. Пока поле указано в файле, файл важнее кабинета; уберите поле — и со следующего деплоя вернётся значение из кабинета (или распознанное).
  • Применяются при каждом деплое: install, build, output, healthPath и schedule.
  • kind, memory и start применяются при создании проекта. Потом они меняются в настройках проекта — от типа и тарифа памяти зависит цена. Если в файле указано другое, об этом будет строка в логе сборки.
  • Если JSON некорректен, файл полностью игнорируется, и деплой идёт с настройками проекта.
  • Неизвестный kind, недопустимое memory, healthPath, который не является путём, или schedule у сервиса не типа cron отбрасываются с предупреждением в логе сборки; остальные поля используются.
  • healthPath — только путь, не хост и не https://: /healthz, /api/ping?full=1.
  • Если memory не указан, берётся значение по умолчанию для типа.

Есть вопрос? — @livops_uz