Skip to content

Установка ​

Выберите один способ. Docker Compose — самый короткий путь: он одновременно запускает PostgreSQL, API, worker и веб-интерфейс.

СпособТребования
Docker ComposeDocker Engine, Compose 2.20+, Linux/amd64
KubernetesНастроенный контекст kubectl, Helm 3.8+, StorageClass
Физический сервер / VMLinux с systemd, работающий PostgreSQL 17, nginx, Go версии из go.mod, Node.js 22.12+, npm

Во всех способах используются Bash, Git и OpenSSL.

Подготовка конфигурации ​

Для новой установки выберите опубликованный тег в Releases и выполните:

bash
RELEASE_TAG='REPLACE_WITH_RELEASE_TAG'
git clone --branch "$RELEASE_TAG" --depth 1 https://github.com/nixys/nxs-anomaly.git
cd nxs-anomaly
bash deploy/quickstart/prepare.sh "$RELEASE_TAG"

Скрипт создаст пароли и готовые файлы в .local/. Сохраните этот каталог: повторная подготовка не меняет пароль существующей БД. Если этот checkout уже подготовлен, пропустите шаг. Если планируете использовать Telegram или email, заполните .local/delivery.env до запуска.

Docker Compose ​

Из корня checkout выполните:

bash
docker compose --project-name nxs-anomaly \
  --env-file .local/credentials.env --env-file .local/compose.env \
  -f .local/compose.yaml up -d --wait --wait-timeout 180

Откройте http://localhost:3100. Войдите как admin с паролем из .local/credentials.env. Если порт занят, измените его в .local/compose.env и используйте новый порт в URL.

Kubernetes ​

Используйте новый namespace и релиз с именем nxs-anomaly. Укажите в STORAGE_CLASS класс, доступный в кластере (список: kubectl get storageclass), затем выполните:

bash
STORAGE_CLASS='REPLACE_WITH_STORAGE_CLASS'
. .local/credentials.env

kubectl create namespace nxs-anomaly
kubectl -n nxs-anomaly create secret generic nxs-anomaly-env \
  --from-env-file=.local/credentials.env \
  --from-env-file=.local/delivery.env \
  --from-env-file=.local/kubernetes.env

helm install nxs-anomaly oci://ghcr.io/nixys/nxs-anomaly \
  --version "$(cat VERSION)" --namespace nxs-anomaly \
  --values deploy/quickstart/kubernetes-values.yaml \
  --set-string postgresql.auth.password="$POSTGRES_PASSWORD" \
  --set-string postgresql.persistence.storageClass="$STORAGE_CLASS" \
  --wait --timeout 5m
kubectl -n nxs-anomaly port-forward service/nxs-anomaly-frontend 3100:8080

Оставьте port-forward работающим. Откройте http://localhost:3100 и войдите как admin с паролем из .local/credentials.env.

On-premise: физический сервер или виртуальная машина ​

Для установки без контейнеров выполните следующие команды из корня публичного Community checkout. PostgreSQL должен уже работать и принимать подключения с парольной аутентификацией на 127.0.0.1:5432; команды создадут новую БД и служебную учётную запись.

bash
go build -mod=vendor -trimpath \
  -ldflags="-s -w -X github.com/nixys/nxs-anomaly/internal/server.Version=v$(cat VERSION)" \
  -o .local/nxs-anomaly ./cmd/nxs-anomaly
(cd frontend && npm ci && npm run build)

sudo useradd --system --create-home --home-dir /var/lib/nxs-anomaly \
  --shell /usr/sbin/nologin nxs-anomaly
sudo install -m 0755 .local/nxs-anomaly /usr/local/bin/nxs-anomaly
sudo install -d -m 0755 /var/www/nxs-anomaly
sudo cp -a frontend/dist/. /var/www/nxs-anomaly/
sudo chmod -R a+rX /var/www/nxs-anomaly

. .local/credentials.env

sudo -u postgres psql -v ON_ERROR_STOP=1 -v db_password="$POSTGRES_PASSWORD" <<'SQL'
CREATE ROLE nxs_anomaly WITH LOGIN PASSWORD :'db_password';
CREATE DATABASE nxs_anomaly OWNER nxs_anomaly;
SQL

sudo install -d -m 0700 /etc/nxs-anomaly
sudo install -m 0600 .local/credentials.env .local/delivery.env \
  .local/on-premise.env /etc/nxs-anomaly/

sudo install -m 0644 deploy/quickstart/nxs-anomaly-*.service /etc/systemd/system/

sudo systemctl daemon-reload
sudo systemctl enable --now nxs-anomaly-api nxs-anomaly-worker

sudo install -m 0644 deploy/quickstart/nginx.conf /etc/nginx/conf.d/nxs-anomaly.conf
sudo nginx -t
sudo systemctl enable --now nginx
sudo systemctl reload nginx

Откройте http://localhost:3100 и войдите как admin с паролем из .local/credentials.env.

Для удалённой VM или Docker-хоста откройте туннель на своей рабочей станции:

bash
ssh -L 3100:127.0.0.1:3100 user@your-server

Следующие шаги ​

Для ознакомления эти инструкции используют локальный HTTP. Прежде чем открывать сервис извне, настройте HTTPS и контроль доступа, а также резервное копирование.

nxs-anomaly · Documentation