Deploy
Vigie runs on one server next to its ClickHouse. You need Docker with Compose v2.
git clone https://github.com/ChronicStone/vigie.git
cd vigie
deploy/install.sh # private, on 127.0.0.1
deploy/install.sh --domain vigie.acme.dev # public, with HTTPS from Caddy
The script writes deploy/.env with fresh secrets, builds and starts the containers, and prints:
- the setup code for the first sign-in, which creates the owner. After that, sign-up is closed.
- the first ingest key, shown once.
- the endpoint to give your apps.
It is safe to run again: it keeps the secrets and the data, and rebuilds after a git pull.
Private or public
| Private | Public | |
|---|---|---|
| Listens on | 127.0.0.1:4310 and :4318 | 443, through Caddy |
| Reach it with | Tailscale, or ssh -L 4310:localhost:4310 | https://vigie.acme.dev |
| Apps send to | http://<host>:4318 on your private network | https://vigie.acme.dev/otlp |
Point the domain's DNS at the server before the public install, so Caddy can get the certificate.
Connect apps
node ace configure @vigiejs/adonis --url=https://vigie.acme.dev
npx @vigiejs/nestjs init --url=https://vigie.acme.dev
On a terminal, the installers open a page in Vigie where someone signed in allows the app, and receive their own key. In CI, pass --key with a key from Settings, Tokens.
Definitions
Keep definitions/ in your app's repository and make it reach the server: a git checkout or a copy in your deploy. Set VIGIE_DEFINITIONS_DIR in deploy/.env to that folder on the host; it is mounted read-only into the container. Changes apply without a restart.
Upgrade
git pull && deploy/install.sh
Tables and columns are created on start. Nothing is dropped.