Skip to content

Start Orpheus and the web interface ​

Download the example stack and create local configuration:

sh
git clone https://github.com/orpheus-agents/orpheus-agents.github.io.git
cd orpheus-agents.github.io/examples/quickstart
python3 init.py

The script creates .env, orpheus.toml and workflows/assistant.md. It generates a database password, Orpheus API key and encryption key. Running it again does not overwrite files.

Fill in the settings ​

  1. Set AGENTBOX_API_KEY and MATTERMOST_BOT_TOKEN in .env.
  2. Find mattermost.base_url in workflows/assistant.md and replace https://chat.example.com with your Mattermost server's HTTPS address. The connector uses this address to exchange messages. AgentBox sandboxes use it to download attachments and upload result files.

The database starts with empty account and profile catalogs. No profile TOML is needed to apply migrations.

sh
docker compose config --quiet
docker compose pull
docker compose up -d db migrate api worker web
curl -fsS http://localhost:9100/ready

Open http://localhost:8085.

In Settings → LLM accounts, create a Codex account in API key mode and enter the provider key. Then open Settings → Profiles and create an active profile named default, select that account and set the model to gpt-6-sol or another model available to your account. Profile settings.

In Settings → Templates, choose Add template and register the codex template you built in your AgentBox project. Leave the tag empty and keep the template active. Registration checks its default tag. See template registration.

Use localhost in the browser: the configured public origin is http://localhost:8085. Opening 127.0.0.1:8085 allows reads but rejects browser writes.

The session list stays empty until the first task. An empty template catalog prevents new sessions.

Check the service status:

sh
docker compose ps -a

The -a flag includes stopped containers so you can check the result of migrate. Compare the statuses with the table:

ServiceExpected result
db, apiHealthy
migrateExited with code 0
worker, webRunning

The API listens on port 8000. The web interface allows local access, including template management. All published ports bind to 127.0.0.1. For a remote server, use an SSH tunnel or configure HTTPS and SSO.

Configuration: compose.yaml.

Next: start the connector.