Skip to content

About

Unofficial installation and management scripts for Calagopus Panel & Wings. Docker-first, ARM-friendly, idempotent.

Resources

Code of conduct

Contributing

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Latest commit

Β 

History

24 Commits

Folders and files

Repository files navigation

🐺 calagopus-installer

Shellcheck Tests License: MIT Bash 4+ GitHub Release GitHub Last Commit GitHub Issues GitHub Stars

Unofficial installation and management scripts for Calagopus Panel & Wings - a modern, Docker-first, ARM-friendly game server panel.

Inspired by pterodactyl-installer, built specifically for Calagopus' Rust-powered architecture.


πŸš€ Quick Start

One-line installer (interactive)

bash <(curl -sSL https://raw.githubusercontent.com/AnAverageBeing/calagopus-installer/main/install.sh)

⚠️ Root required - Some systems need sudo before running this command.

One-line non-interactive (automated)

# Full stack (Panel + Wings)
bash <(curl -sSL https://raw.githubusercontent.com/AnAverageBeing/calagopus-installer/main/install.sh) -- \
  --non-interactive --yes --action install_full --target full --mode docker --channel stable

# Panel only (native binary, without Docker)
bash <(curl -sSL https://raw.githubusercontent.com/AnAverageBeing/calagopus-installer/main/install.sh) -- \
  --non-interactive --yes --action install_panel_native --target panel --mode native --channel stable

# Wings only (Docker)
bash <(curl -sSL https://raw.githubusercontent.com/AnAverageBeing/calagopus-installer/main/install.sh) -- \
  --non-interactive --yes --action install_wings --target wings --mode docker \
  --wings-join-data "your-join-token-here"

✨ Features

Installation & Deployment

  • βœ… Automatic Panel + Wings setup
  • βœ… Full Stack mode (AIO)
  • βœ… Docker & Native binary modes
  • βœ… Non-interactive automation
  • βœ… Idempotent (safe to re-run)

Operations

  • πŸ”„ Update & rollback (channel-aware)
  • πŸ’Ύ Backup & restore with retention
  • πŸ”§ Repair mode (8 auto-fix probes)
  • πŸ“Š Status & health checks
  • πŸͺ΅ Structured logging

Security & Infrastructure

  • πŸ”’ SSL/TLS: Let's Encrypt, self-signed, Cloudflare Origin
  • πŸšͺ Firewall: UFW, firewalld, nftables, iptables
  • πŸ›‘οΈ Secrets auto-redacted from logs
  • πŸ“ Strict file permissions (0600)
  • ⚑ Principle of least privilege

Compatibility

  • 🐧 10+ Linux distros (Ubuntu, Debian, RHEL, Fedora, Arch, etc.)
  • 🦾 Multi-architecture: x86_64, ARM64, armv7, riscv64, ppc64le
  • πŸ₯§ Raspberry Pi 3/4/5 support
  • 🌍 Release channels: stable, beta, nightly
  • βœ… Docker or binary deployment

πŸ“‹ Supported Platforms

Operating Systems

OS Version Support Arch
Ubuntu 22.04, 24.04, 26.04 βœ… Full x86_64, ARM64
Debian 11, 12, 13 βœ… Full x86_64, ARM64
Rocky Linux 8, 9 βœ… Full x86_64, ARM64
AlmaLinux 8, 9 βœ… Full x86_64, ARM64
RHEL 8, 9 βœ… Full x86_64, ARM64
Fedora 38+ βœ… Full x86_64, ARM64
Arch Linux rolling βœ… Full x86_64, ARM64
openSUSE Tumbleweed, Leap 15.5+ βœ… Full x86_64, ARM64
Raspberry Pi OS 11+ βœ… Full ARM64
Other (Docker) Any 🟑 Community All

Architectures

Arch Support Notes
x86_64 / amd64 βœ… Primary target
aarch64 / arm64 βœ… Raspberry Pi 4/5, ARM servers
armv7 βœ… Raspberry Pi 3
riscv64 βœ… Experimental
ppc64le βœ… POWER systems

🎯 Installation Modes

Mode Setup Best For
Docker AIO Panel + Wings in one container Single-node, recommended for most
Docker Standalone Panel only, Wings separate Multi-node, distributed setups
Native Binary Compiled Rust + systemd Minimal footprint, no Docker

Release Channels

Channel Tag Notes
Stable (recommended) :latest / :aio Production-ready, latest release
Beta :latest-pre / :heavy-pre New features, may have bugs
Nightly :nightly / :nightly-aio Development builds, unstable

πŸ“– Usage Guide

Interactive Menu

Run the installer and choose your setup:

sudo bash src/installer.sh

Available options:

# Action Description
1 Install Panel Only (without Docker) Deploy Calagopus Panel using native binaries + systemd
2 Install Panel+Wings (Full Stack) Panel + Wings on one host via AIO Docker image
3 Install Panel Only (Docker) Deploy Calagopus Panel using Docker Compose
4 Install Wings Only Deploy Calagopus Wings node
5 Upgrade Installation Update to latest release on your channel
6 Repair Installation Auto-detect and fix common issues
7 Backup Installation Create full backup bundle (DB + config)
8 Restore Installation Restore from backup
9 Reconfigure Installation Re-run setup wizard
10 Remove Installation Full clean uninstall (containers, files, configs, optionally DB)
11 Show System Status Health overview

CLI Flags

--action <action>           install_panel_native | install_panel_docker | install_wings | install_full | upgrade | repair | backup | restore | remove | status
--target <target>           panel | wings | full
--mode <mode>               docker | native
--channel <channel>         stable | beta | nightly
--non-interactive           Skip all prompts (use defaults)
--yes                       Assume 'yes' to all confirmations
--dry-run                   Show what would happen (no changes)
--verbose / --debug         More logging
--quiet                     Suppress non-error output
--no-color                  Disable colored output
--config <file>             Load config from env file
--wings-join-data <token>   Node join token for Wings
--version                   Show version
--help                      Show help

πŸ› οΈ Post-Install Management

After installation, use the calagopus-installer command:

# Status & Monitoring
calagopus-installer status       # Quick health overview
calagopus-installer doctor       # Deep health check (fails on issues)
calagopus-installer logs -f      # Follow installer logs (tail -f)
calagopus-installer logs 100     # Last 100 lines

# Operations
calagopus-installer upgrade      # Update to latest release
calagopus-installer repair       # Auto-detect and fix issues
calagopus-installer reconfigure  # Re-run setup wizard

# Backup & Restore
calagopus-installer backup       # Create full backup bundle
calagopus-installer restore      # Restore from backup (interactive)

# Cleanup
calagopus-installer remove       # Uninstall (interactive confirmation)
calagopus-installer version      # Show CLI version
calagopus-installer help         # Show help

Scheduled Backups

Configure periodic backups with systemd timers:

# During install, configure:
BACKUP_SCHEDULE=daily       # hourly | daily | weekly | monthly
BACKUP_RETENTION=7          # Keep last N bundles

πŸ”’ Security & Network

Firewall Configuration

Automatic firewall setup with multiple backends:

Backend Distro Default
UFW Debian/Ubuntu/Arch βœ… Preferred
firewalld RHEL/Fedora/SUSE βœ… Preferred
nftables Any ⚠️ Fallback
iptables Any ⚠️ Last resort

Default ports opened:

22        TCP   SSH
8000      TCP   Panel HTTP
8443      TCP   Panel HTTPS
443       TCP   Wings
20000:20100 TCP Game server allocations

SSL/TLS Options

Option Type Best For Requirements
Let's Encrypt ⭐ Auto Production FQDN + ports 80/443
Self-signed Manual Testing/Homelab None (OpenSSL)
Existing Certs Manual Custom setup fullchain.pem + privkey.pem
Cloudflare Origin Auto Cloudflare users Cloudflare account

Auto-renewal configured for Let's Encrypt with proxy reload hook.


πŸ“ Project Structure

calagopus-installer/
β”œβ”€β”€ πŸ“„ install.sh                    curl bootstrap entrypoint
β”œβ”€β”€ πŸ“„ src/
β”‚   β”œβ”€β”€ installer.sh                 Main orchestrator
β”‚   β”œβ”€β”€ lib/                         Core libraries
β”‚   β”‚   β”œβ”€β”€ common.sh                Constants & shared state
β”‚   β”‚   β”œβ”€β”€ log.sh                   Structured logging + redaction
β”‚   β”‚   β”œβ”€β”€ ui.sh                    Terminal UI (colors, menus)
β”‚   β”‚   β”œβ”€β”€ crypto.sh                Secure credential generation
β”‚   β”‚   β”œβ”€β”€ config.sh                Config load/save/validate
β”‚   β”‚   β”œβ”€β”€ system.sh                Host capability detection
β”‚   β”‚   └── trap.sh                  Error handling & cleanup
β”‚   β”œβ”€β”€ os/                          OS detection & per-family setup
β”‚   β”‚   β”œβ”€β”€ detect.sh                Distro detection
β”‚   β”‚   β”œβ”€β”€ debian.sh                Ubuntu/Debian repos
β”‚   β”‚   β”œβ”€β”€ rhel.sh                  RHEL/Rocky/Alma/Fedora
β”‚   β”‚   β”œβ”€β”€ arch.sh                  Arch Linux setup
β”‚   β”‚   └── suse.sh                  openSUSE setup
β”‚   β”œβ”€β”€ dependencies/                Dependency provisioning
β”‚   β”‚   β”œβ”€β”€ manager.sh               Central facade
β”‚   β”‚   β”œβ”€β”€ docker.sh                Docker Engine + Compose
β”‚   β”‚   β”œβ”€β”€ postgres.sh              PostgreSQL
β”‚   β”‚   β”œβ”€β”€ redis.sh                 Redis / Valkey
β”‚   β”‚   β”œβ”€β”€ nginx.sh                 Nginx reverse proxy
β”‚   β”‚   β”œβ”€β”€ caddy.sh                 Caddy reverse proxy
β”‚   β”‚   β”œβ”€β”€ certbot.sh               Let's Encrypt
β”‚   β”‚   └── packages.sh              Helper utilities
β”‚   β”œβ”€β”€ database/                    Database lifecycle
β”‚   β”‚   β”œβ”€β”€ postgres.sh              Provisioning (local/remote)
β”‚   β”‚   └── validate.sh              Connectivity & schema checks
β”‚   β”œβ”€β”€ docker/                      Docker daemon config
β”‚   β”œβ”€β”€ panel/                       Panel installation
β”‚   β”œβ”€β”€ wings/                       Wings installation
β”‚   β”œβ”€β”€ ssl/                         SSL/TLS lifecycle
β”‚   β”œβ”€β”€ proxy/                       Nginx + Caddy config
β”‚   β”œβ”€β”€ firewall/                    UFW/firewalld/nftables
β”‚   β”œβ”€β”€ backup/                      Backup & restore bundles
β”‚   β”œβ”€β”€ update/                      Upgrades & rollback
β”‚   β”œβ”€β”€ repair/                      Auto-repair probes
β”‚   β”œβ”€β”€ uninstall/                   Clean removal
β”‚   └── monitoring/                  Status & health checks
β”œβ”€β”€ πŸ“„ scripts/cli.sh                Installed CLI shim
β”œβ”€β”€ πŸ“„ configs/defaults.env          Default configuration
β”œβ”€β”€ πŸ“„ templates/                    Config templates
β”œβ”€β”€ πŸ“„ tests/                        Bats unit tests
β”œβ”€β”€ πŸ“„ .github/workflows/            CI/CD pipelines
β”œβ”€β”€ πŸ“„ Vagrantfile                   Integration test VMs
└── πŸ“„ LICENSE, CHANGELOG.md, etc.

πŸ§ͺ Development

Prerequisites

bash 4+          # Shell interpreter
shellcheck       # Linting
bats-core        # Unit testing
Vagrant          # Integration testing (optional)

Testing Locally

Quick test with Vagrant:

vagrant up                    # All distributions
vagrant up ubuntu_jammy       # Single distro
vagrant ssh ubuntu_jammy      # SSH into box
sudo /vagrant/src/installer.sh

Available test boxes:

ubuntu_jammy (22.04)  |  ubuntu_noble (24.04)  |  debian_bookworm (12)
debian_trixie (13)    |  rockylinux_9          |  almalinux_9
fedora_40             |  archlinux

Code Quality

# Lint all scripts
find . -type f -name '*.sh' -not -path './.git/*' -exec shellcheck -x {} +

# Run unit tests
bats tests/

Creating a Release

  1. Update CHANGELOG.md with release info
  2. Bump CALAGOPUS_INSTALLER_VERSION in src/lib/common.sh
  3. Commit: git commit -m "Release vX.Y.Z"
  4. Tag: git tag vX.Y.Z
  5. Push & create GitHub release (CI auto-attaches binaries)

πŸ’¬ Support

For installer issues:

πŸ‘‰ Open an issue

For Calagopus support:

πŸ‘‰ Join Discord


πŸ“„ License

MIT - see LICENSE file for details.


πŸ™ Acknowledgements


If you find this helpful, please consider starring the repo!

Report Issue - View Releases - Contributing


Donations

Donations are appreciated!

Bitcoin: bc1qqdhanefhpfht66urta6yws03pc060gmz26k9dt

About

Unofficial installation and management scripts for Calagopus Panel & Wings. Docker-first, ARM-friendly, idempotent.

Resources

Code of conduct

Contributing

Security policy

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages