Skip to content

orda-oss/installer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Orda Installer

TUI installer for Orda self-hosted servers. Handles provisioning, configuration, and service management on Linux VMs.

Install

curl -fsSL https://get.orda.chat/install | sh

The bootstrap script detects your architecture, downloads the binary, caches sudo credentials, and starts the installer.

Requirements

  • Linux (amd64 or arm64)
  • sudo access or root

Usage

orda install [OPTIONS]
orda update [--orda-dir PATH]
orda uninstall [--orda-dir PATH] [--yes]
orda status [--orda-dir PATH]

Install

Interactive TUI that walks through server setup:

  1. License key validation
  2. Server registration
  3. Dependency installation (Docker, jq, chrony)
  4. DNS propagation
  5. System user and directory setup
  6. TLS certificate provisioning
  7. Firewall configuration (ufw + fail2ban)
  8. Service configuration and launch
  9. Health check verification
# Standard install
orda install

# Provide license key via flag
orda install --license-key <key>

# Dry run (works on any OS, no system changes)
orda install --dry-run

# Custom install directory
orda install --orda-dir /srv/orda

Update

Pulls the latest Docker images and restarts services.

orda update

Status

Shows container status, health check result, and disk usage.

orda status

Uninstall

Stops services and removes the installation directory.

orda uninstall        # interactive confirmation
orda uninstall --yes  # skip confirmation

What gets installed

Component Description
alacahoyuk Server engine (Rust/Axum, encrypted SQLite)
caddy Reverse proxy with automatic TLS
livekit Voice and video (WebRTC media server)

All services run as Docker containers under a dedicated orda system user.

File layout

/opt/orda/
  .env                 License key, health token, LiveKit credentials
  docker-compose.yml   Service definitions
  Caddyfile            Reverse proxy configuration
  livekit.yaml         LiveKit server configuration
  data/                Encrypted database and server files
  tls/                 TLS certificate and private key
  README.txt           Quick reference (generated on install)

Building from source

# Debug build
cargo build

# Release build (optimized for size)
cargo build --release

# Cross-compile for Linux (static musl binary)
cargo build --release --target x86_64-unknown-linux-musl
cargo build --release --target aarch64-unknown-linux-musl

Support

Orda is built and maintained by a single person. If you find it useful, a donation goes a long way toward keeping the project alive. A donation channel is being set up and will be linked here soon.

If you or your organization are interested in sponsoring or making a larger contribution before the donation channel is live, reach out at hello@joinorda.com.

In the meantime, the best way to support the project is to use it, report bugs, and spread the word. If you have legal expertise, the Privacy Policy and Terms of Service are open for review on GitHub.

Issues

Report bugs and feature requests at github.com/orda-oss/installer/issues.

About

One-command installer for deploying Orda servers. TLS, DNS, firewall, and Docker on a fresh VM.

Resources

License

Stars

Watchers

Forks

Contributors