Update docs and drop AI workspace docs
This commit is contained in:
@@ -1,30 +1,28 @@
|
||||
# Deploy
|
||||
|
||||
Практичный минимум для запуска `ignis-core` как `systemd`-сервиса.
|
||||
Минимальный `systemd`-деплой для `ignis-core`.
|
||||
|
||||
В папке:
|
||||
В каталоге:
|
||||
|
||||
- `ignis-core.service` -- шаблон unit-файла
|
||||
- `ignis-core.env.example` -- пример переменных окружения
|
||||
- `ignis-core.service` — unit-файл;
|
||||
- `ignis-core.env.example` — пример env-конфига.
|
||||
|
||||
## Предположения
|
||||
## Предполагаемая раскладка
|
||||
|
||||
Ниже используется такая раскладка:
|
||||
- код: `/opt/ignis/ignis-core`
|
||||
- env: `/etc/ignis-core/ignis-core.env`
|
||||
- пользователь: `ignis`
|
||||
- SQLite: `/var/lib/ignis-core/ignis.db`
|
||||
|
||||
- код проекта: `/opt/ignis/ignis-core`
|
||||
- env-файл: `/etc/ignis-core/ignis-core.env`
|
||||
- Unix-пользователь: `ignis`
|
||||
- SQLite БД: `/var/lib/ignis-core/ignis.db`
|
||||
Если у вас другие пути, поправьте unit и env-файл.
|
||||
|
||||
Если у вас другие пути, просто поправьте unit и env-файл.
|
||||
|
||||
## 1. Подготовить пользователя
|
||||
## 1. Создать системного пользователя
|
||||
|
||||
```bash
|
||||
sudo useradd --system --home /opt/ignis --shell /usr/sbin/nologin ignis
|
||||
```
|
||||
|
||||
## 2. Разложить проект
|
||||
## 2. Разложить проект и зависимости
|
||||
|
||||
```bash
|
||||
sudo mkdir -p /opt/ignis
|
||||
@@ -45,12 +43,12 @@ sudo chmod 640 /etc/ignis-core/ignis-core.env
|
||||
sudo chown root:ignis /etc/ignis-core/ignis-core.env
|
||||
```
|
||||
|
||||
Что важно заполнить обязательно:
|
||||
Минимум, который надо заполнить руками:
|
||||
|
||||
- `IGNIS_API_KEY`
|
||||
- `SCAN_NETWORK`
|
||||
|
||||
Для домашней сети лучше задавать `SCAN_NETWORK` явно, особенно если на хосте есть VPN или несколько интерфейсов.
|
||||
Для машин с VPN или несколькими интерфейсами `SCAN_NETWORK` лучше задавать явно.
|
||||
|
||||
## 4. Установить unit
|
||||
|
||||
@@ -60,7 +58,7 @@ sudo systemctl daemon-reload
|
||||
sudo systemctl enable --now ignis-core.service
|
||||
```
|
||||
|
||||
## 5. Проверка
|
||||
## 5. Проверить запуск
|
||||
|
||||
```bash
|
||||
sudo systemctl status ignis-core.service
|
||||
@@ -79,6 +77,7 @@ sudo systemctl restart ignis-core.service
|
||||
|
||||
## Замечания
|
||||
|
||||
- `StateDirectory=ignis-core` в unit создаёт `/var/lib/ignis-core` автоматически.
|
||||
- `StateDirectory=ignis-core` в unit создаёт `/var/lib/ignis-core`.
|
||||
- По умолчанию сервис слушает `0.0.0.0:8000`.
|
||||
- Если нужен reverse proxy, его проще ставить перед `ignis-core`, а сам сервис оставить на локальном порту.
|
||||
- Reverse proxy проще ставить перед сервисом, а не внутрь него.
|
||||
- Перед обновлением backend-контракта полезно перегенерировать `openapi.json` и прогнать `unittest`.
|
||||
|
||||
Reference in New Issue
Block a user