Documentation

Documentation

Installation, configuration and operations guides for the self-hosted Menelaus Orchestrator — built for secure on-premise and fully offline deployments.

Self-hosted OrchestratorBundled stack:Django 5Python 3.11PostgreSQL 15Redis 7.2On-premise & offline-ready
Browse the docs

Everything to run Menelaus yourself

Installation & setup

Deploy the Orchestrator with Docker on Linux or Windows — online, or fully offline from local image files.

Configuration

Every environment variable that drives the Orchestrator — generated by profile, then tuned by hand.

Updates & maintenance

Move between releases safely, keeping your media and database volumes intact through every upgrade.

Security & hardening

Encryption keys, HTTPS, session binding and the browser headers that keep the console locked down.

Orchestrator distribution

What ships inside the on-premise package and how the services fit together behind nginx.

Support & community

Get unblocked fast — official support channels, the community Discord, and the Python RPA team.

Coming soon

AI Agents

Architecture, tool calling, memory and escalation rules for autonomous agents.

Documentation in progress
Coming soon

IDP & Documents

Extract, classify and validate data from any document type at scale.

Documentation in progress
Quickstart

Install the Orchestrator with Docker

The distribution is self-contained — load the images, generate your environment file, and bring the stack up. No internet access required.

01
Check Docker
Confirm Docker CE and Compose are present, or install them from packages (online) or local .deb files (offline).
02
Load the images
Copy the .tar images to the server and load them. Expect six images once the distribution is fully loaded.
03
Generate the .env
Run the env-vars script with the "domain" or "ip" profile, then set the DB password, timezone and crypto key.
04
Launch the stack
Bring the services up with Docker Compose, copy the .env into the container and restart.
05
Initialize the database
Exec into the container and run the Python database scripts. The Orchestrator is now ready.

Never delete or replace the original .env or docker-compose-deploy.yaml after installation.

Full Linux, Windows & offline steps in the Administration Guide
bash · install.sh
# 1. Verify Docker is installed
docker --version
docker-compose --version

# 2. Load the distribution images (offline-friendly)
sudo chmod 666 /var/run/docker.sock
docker load -i orchestrator.tar
docker images                 # expect 6 images

# 3. Generate environment variables
./cloudorc_create_env_vars.sh domain   # or: ip

# 4. Launch the Orchestrator
docker-compose -f docker-compose-deploy.yaml up -d
System requirements
CPUDual-coreQuad-core or higher
RAM4 GB8 GB or higher
Storage20 GB50 GB+ SSD
OSUbuntu 18.04+or Windows 10+
DockerCE 19.03+Compose 1.24+
NetworkPorts 80 / 443Static IP recommended
Configuration

Environment variables

New installs generate the .env from the domain or ip profile. For existing servers, add only the missing variables — never regenerate the file or change keys and credentials unless support asks you to.

Core settings

  • SECRET_KEY
  • ALLOWED_HOSTS_LIST
  • TIME_ZONE
  • ON_PREMISE
  • LOG_LEVEL

HTTPS & proxy

  • SSL redirect
  • Proxy headers
  • Secure cookies
  • HSTS

Database & Redis

  • DB name / user / password
  • DB host / port
  • Redis URL
  • Celery results

Email (SMTP)

  • SMTP host
  • SMTP port
  • SMTP user
  • SMTP password

Encryption & licensing

  • AES_KEY
  • CRYPTO_KEY
  • HARDWARE_ID
  • API key

Sessions & headers

  • Idle timeout
  • Active sessions / user
  • IP & user-agent binding
  • CSP / XSS headers

Do not change SECRET_KEY, AES_KEY, CRYPTO_KEY, HARDWARE_ID or database credentials on a running install. Restart services after any change.

Every variable, default and description in the Environment Variables Guide
Updates & maintenance

Two upgrade paths

v1.1.1 and newer

Standard update

A rolling update: stop the stack, swap in the new images, drop non-essential volumes (keeping media and postgres), then restart.

  • Stop containers
  • Swap images
  • Preserve media + postgres volumes
  • Restart & verify
Below v1.1.1

Major upgrade update

Crosses major dependency bumps (Django 5, Python 3.11, PostgreSQL 15, Redis 7.2) — a full backup is required before you start.

  • Back up DB (db_backup.sh)
  • Back up media (media_backup.sh)
  • Load new images
  • Restore & verify

Running Menelaus on your own infrastructure?

The on-premise package ships with everything for a secure, offline install. Our team and the community Discord are here when you need a hand.