Skip to content

Connect your execution host

Revelion's tools run on a machine you control, called an execution host. The Revelion daemon connects that machine to your organisation and runs each mission's tools in a Docker container.

Before you start

Docker

Docker must be installed and running. On Windows and macOS that usually means Docker Desktop is open; on Linux, that the Docker Engine service is running. Docker's installation guide covers each platform.

The app's setup panel recommends allocating at least 4 GB of memory to Docker. Treat that as guidance rather than a guaranteed minimum.

Supported platforms

Platform Processor
macOS Apple silicon (arm64) or Intel (amd64)
Linux arm64 or amd64
Windows amd64, installed from Windows PowerShell

Network access

The daemon connects out to Revelion over HTTPS on port 443. You don't need to open any inbound port.

Install the daemon

The app generates the install command for you, with your daemon token already in it.

  1. In the app, open Daemons in the sidebar.
  2. In the Install Daemon panel, tick I have Docker installed and running, then select Continue to Install.
  3. Choose macOS, Linux or Windows PowerShell, and copy the command.
  4. Run it in a terminal on your execution host.

The command looks like this, with your token in place of YOUR_DAEMON_TOKEN:

Terminal
curl -fsSL https://raw.githubusercontent.com/RevelionAI/revelion-daemon/main/scripts/install.sh | sh -s -- YOUR_DAEMON_TOKEN
Windows PowerShell
$env:REVELION_TOKEN='YOUR_DAEMON_TOKEN'; irm https://raw.githubusercontent.com/RevelionAI/revelion-daemon/main/scripts/install.ps1 | iex

Run it in Windows PowerShell, not Command Prompt (cmd.exe): irm and iex are PowerShell commands.

Keep your daemon token private

The token connects a machine to your organisation, so treat it like a password. Keep it out of version control, shared scripts and chat. It isn't an API key: API keys are created separately, under Settings → API.

What the installer does

  • Detects your operating system and processor, and downloads the matching daemon.
  • On macOS and Linux, installs revelion to /usr/local/bin. If you can't write to that folder, it uses sudo, which may ask for your password.
  • On Windows, installs to %LOCALAPPDATA%\Revelion and adds that folder to your user PATH, and to the PATH of the PowerShell window it runs in.
  • Saves your token to the daemon's configuration file, .revelion/config.json in your home folder, readable only by your user account.
  • Checks that it can use Docker.
  • If Docker is available, starts the daemon in that terminal window. If it isn't, the installer finishes and tells you how to start the daemon later.

Leave that window open. The daemon runs in the foreground, and closing the window or pressing Ctrl+C stops it.

Check the connection

Open Daemons in the app. Your machine appears once it connects, marked Online, along with whether Docker is running on it.

On the execution host itself, revelion status shows how the daemon is configured:

Terminal
revelion status

It prints something like this:

Output
Status: CONFIGURED
  Token:    abcd...wxyz
  Brain:    <address the daemon connects to>
  Sandbox:  <tool container image>
  Config:   ~/.revelion/config.json

revelion status reads the configuration file; it doesn't test the connection. A machine can show Status: CONFIGURED and still be offline, so use the Daemons page to confirm it's connected.

Other ways to install

Install without starting the daemon

Add --no-start to save your token without starting the daemon:

Terminal
curl -fsSL https://raw.githubusercontent.com/RevelionAI/revelion-daemon/main/scripts/install.sh | sh -s -- YOUR_DAEMON_TOKEN --no-start

Start it later with revelion start.

The Windows installer has no equivalent option: when it finds a token and can use Docker, it starts the daemon. To install without starting, install without a token, as below, and authenticate when you're ready.

Install now, authenticate later

Terminal
curl -fsSL https://raw.githubusercontent.com/RevelionAI/revelion-daemon/main/scripts/install.sh | sh

When you're ready:

Terminal
revelion auth YOUR_DAEMON_TOKEN
revelion start

The Windows installer reads your token from the REVELION_TOKEN environment variable. Clear it first, so a value left over from an earlier attempt isn't used:

Windows PowerShell
Remove-Item Env:\REVELION_TOKEN -ErrorAction SilentlyContinue
irm https://raw.githubusercontent.com/RevelionAI/revelion-daemon/main/scripts/install.ps1 | iex

When you're ready:

Windows PowerShell
revelion auth YOUR_DAEMON_TOKEN
revelion start

The daemon's commands

The daemon accepts four commands:

revelion
revelion auth <token>   Authenticate with your API token
revelion start          Start the daemon
revelion status         Check daemon configuration
revelion version        Print version

The daemon's own help calls your daemon token an "API token". It's the same token that's in the install command.

The first mission takes longer to start

The first time the daemon needs its tool container image, Docker downloads it. Later missions reuse the downloaded image.