Open Source|All improvements go through Pull Requests with automated CI checks before review by@Leo-Galli|Join Discord|Contributing guide
Installer CLI

Installer — CLI reference

All flags, environment variables and exit codes for the automated installer.

Flags

FlagEffect
--yesRun non-interactively with defaults
--preset PATHLoad a JSON preset file
--target DIRDeployment directory (default ./aetheris-deploy)
--web-port NWeb server port
--backend-port NBackend API port
--admin-email / --admin-passwordSuperadmin credentials
--dry-runPrint actions without writing
--skip-checksSkip preflight checks
--skip-depsSkip dependency installation
--no-servicesDo not write service files
--no-app / --no-backend / --no-websiteComponent selection

Environment variables

Every flag has an env equivalent. Flags > env > preset.

VariableDefaultEffect
AETHERIS_INSTALL_TARGET./aetheris-deployDeployment directory
AETHERIS_INSTALL_WEB_PORT3000Web server port
AETHERIS_INSTALL_BACKEND_PORT8000Backend API port
AETHERIS_INSTALL_ADMIN_EMAILadmin@example.comSuperadmin email
AETHERIS_INSTALL_ADMIN_PASSWORDrandomSuperadmin password
AETHERIS_INSTALL_WITH_WEBSITE1Install website
AETHERIS_INSTALL_WITH_APP1Install app
AETHERIS_INSTALL_WITH_BACKEND1Install backend
AETHERIS_INSTALL_WITH_DOCS0Install docs
AETHERIS_INSTALL_WITH_SERVICES1Write service units

Preset files

{
  "target_dir": "./aetheris-deploy",
  "with_website": true,
  "with_app": true,
  "with_backend": true,
  "web_port": 3000,
  "backend_port": 8000,
  "admin_email": "admin@example.com"
}
python -m aetheris_installer --preset presets/dev.json --yes

Exit codes

CodeMeaning
0Success
1Preflight or step failure
2Invalid arguments or preset
3Missing dependency (git, node, python)

Layout written

aetheris-deploy/
├── aetheris-app/
│   ├── .env
│   └── backend/.env
├── aetheris-website/
├── aetheris-docs/          (optional)
└── deploy/
    ├── *.service           (Linux)
    ├── *.plist             (macOS)
    └── *.bat / *.cmd       (Windows)

Uninstall

# Linux
sudo systemctl stop aetheris-web aetheris-backend aetheris-worker
rm -rf ./aetheris-deploy
 
# Windows
schtasks /Delete /TN AetherisWeb /F
rmdir /s /q aetheris-deploy

See also: Installation, Environment variables.