Docs›Start›Quickstart

Quickstart

Core running, one server connected and a first alert delivered. About ten minutes, one machine.

Start Core

Download the sample Compose file, set an admin password and a JWT secret in a .env file next to it, then bring it up.

curl -fsSL -o orion-compose.yaml \
  https://raw.githubusercontent.com/sunday-studio/orion/main/deploy/examples/core-console-compose.yaml
docker compose -f orion-compose.yaml up -d

Done when http://localhost:8999 shows the sign-in page

Connect a server

Run the installer on any Linux or macOS machine you want to watch, and point it at your Core.

curl -fsSL https://github.com/sunday-studio/orion/releases/latest/download/orion-agent-installer.sh | bash -s -- \
  --core-url http://orion-core.local:8999

Check it from that machine with orion-agent status. The server appears in the Console within a minute.

Done when the server shows as Up under Servers

Add a monitor

Open Monitors, choose New monitor, pick HTTP, enter a URL and save. The first check runs straight away.

Done when the monitor shows a green check

Add an alert channel

Open Alerts, Channels and add a webhook or an email channel. Use Send test to confirm it arrives, then route your monitors to it.

Done when the test message arrives

You are running Orion

Everything lives on your machine, in one SQLite file. Good next steps: send logs from an app, back up the database and learn the concepts.

Was this page helpful? YesNo Thanks, noted.