Quick Start

In this guide, we will start the Super daemon with a minimal configuration and use its REST API to dynamically register and start a demo HTTP server.

1. Minimal Configuration

Create a file named super.toml. We only need to configure the server port.

# super.toml

[server]
host = "127.0.0.1"
port = 9002
# auth_secret = "…"   # optional on loopback; required for non-loopback binds

If you use the repo’s example config, it also binds to port 9002 — keep CLI/API URLs in sync with your super.toml.

2. Start the Daemon (OSS)

Run the daemon in the foreground (default — required under systemd). Layout, config init, and --daemon: Installation — Instance layout and Start by hand.

superd

Without systemd, you may detach with superd --daemon (writes $SUPER_ROOT/run/superd.pid by default). Control programs and stop the daemon the same way either way (super …, super shutdown).

Expected output includes Super Core starting... and the listen address.

docker pull schiplat/super:latest

docker run --rm --name super \
  -p 127.0.0.1:9002:9002 -p 127.0.0.1:8080:8080 \
  schiplat/super:latest

# Host shell for steps 3–4 (matches the baked placeholder until you change it)
export SUPER_TOKEN=CHANGE-ME-BEFORE-EXPOSE

Confirm the daemon is up before continuing:

curl http://127.0.0.1:9002/health
# {"status":"healthy","components":{"manager":"up","persistence":"up","web":"up"}}

3. Create Program via API

Open a new terminal. Pick the example that matches how you run superd:

super add --name demo-web \
  --autostart python3 -m http.server 8080

curl -X POST http://127.0.0.1:9002/api/v1/programs \
  -H "Content-Type: application/json" \
  -d '{
      "name": "demo-web",
      "command": "python3",
      "args": ["-m", "http.server", "8080"],
      "autostart": true,
      "health_check": {
          "type": "tcp",
          "port": 8080
      }
  }'

super --server http://127.0.0.1:9002 --token "$SUPER_TOKEN" add --name demo-web \
  --autostart /usr/local/bin/busybox httpd -f -p 8080

docker exec -e SUPER_TOKEN=CHANGE-ME-BEFORE-EXPOSE super \
  /usr/local/bin/super add --name demo-web \
  --autostart /usr/local/bin/busybox httpd -f -p 8080

curl -X POST http://127.0.0.1:9002/api/v1/programs \
  -H "Authorization: Bearer CHANGE-ME-BEFORE-EXPOSE" \
  -H "Content-Type: application/json" \
  -d '{
      "name": "demo-web",
      "command": "/usr/local/bin/busybox",
      "args": ["httpd", "-f", "-p", "8080"],
      "autostart": true,
      "health_check": {
          "type": "tcp",
          "port": 8080
      }
  }'

On success, the API returns a JSON array with the new program ID.

4. Verify Status

super list
# demo-web should show Running or Healthy

curl http://127.0.0.1:8080
# Python http.server: directory listing HTML
# Docker busybox httpd: often 404 on / — the port is up

5. Dashboard

Open http://127.0.0.1:9002.

OSS: The embedded Dashboard shell loads (process list, logs, stack editor). Optional core auth may prompt for login.

With subscription plugins: The ui plugin adds Pro surfaces (Access Tokens, Notification Settings, hot-reload) when security / notify are also loaded — see Dashboard.

Next Steps

• Installation — binaries, install.sh, instance layout, OS services
• Getting Started — section overview
• A Django application under Super — Gunicorn and Celery against external Postgres and Redis
• API Reference — stop, restart, historical logs
• Configuration — persistent super.toml
• Dependency Orchestration

Appendix: Licensed Plugins 💎

Licensed Super Pro capabilities (Dashboard Pro extensions via ui, token authentication & RBAC, resource isolation, event notifications, operation audit) ship as signed plugin libraries — .so on Linux, .dylib on macOS. They run on the same OSS superd and super binaries; there is no separate “Pro daemon”. Enabling licensed mode only adds three things from your subscription delivery:

$SUPER_ROOT/
├── conf/
│   └── super.toml        # [license].key + auth_secret
└── plugins/              # authorized .so / .dylib (filenames match the signed claims)

$SUPER_ROOT is resolved from the SUPER_ROOT environment variable (then the binary layout, then the working directory).

Install and restart:

# 1. Copy the plugin libraries from your subscription delivery package
cp /path/to/subscription/plugins/* "$SUPER_ROOT/plugins/"

# 2. Add [license].key and auth_secret to conf/super.toml

# 3. Restart superd — it verifies the license, then loads the authorized plugins

First sign-in — with security active, bootstrap an Admin Access Token, then prefer sk-… tokens for day-to-day use:

super login <auth_secret>
super token create admin --role admin
super token list

Next. Day-to-day topics (config, auth, Dashboard) are under Essentials. Licensed governance (RBAC, audit, isolation, notify) is under Advanced Management. You can request a free 90-day Super Pro trial (Portal claim); compare editions in the feature matrix.