Installation

Follow these steps in order to set up Cloudsuo locally and deploy it to your server, effectively managing Docker containers and applications:

You need to follow this steps in the same order:

1. Virtual Private Server (VPS)

Virtual Private Server (VPS)

There are multiple VPS providers to choose from:

The upstream project lists the following Linux distributions:

• Ubuntu 24.04 LTS
• Ubuntu 23.10
• Ubuntu 22.04 LTS
• Ubuntu 20.04 LTS
• Ubuntu 18.04 LTS
• Debian 12
• Debian 11
• Debian 10
• Fedora 40
• Centos 9
• Centos 8

Providers

• Hostinger Get 20% Discount using this referral link: Referral Link
• AmericanCloud Receive 20$ credits for free: Referral Link
• Teramont Get 15% discount for free: Referral Link
• Hetzner Get 20€ credits for free with this referral link: Referral Link
• DigitalOcean Get 200$ credits for free with this referral link: Referral Link
• Vultr Referral Link: Referral Link
• Linode
• Scaleway
• Google Cloud
• AWS

Requirements

To ensure a smooth experience with Cloudsuo, your server should have at least 2GB of RAM and 30GB of disk space. This specification helps to handle the resources consumed by Docker during builds and prevents system freezes.

Port Requirements

Before installing Cloudsuo, ensure the following ports are available on your server:

• Port 80: HTTP traffic (used by Traefik)
• Port 443: HTTPS traffic (used by Traefik)
• Port 3000: Cloudsuo web interface

Docker

Cloudsuo utilizes Docker, so it is essential to have Docker installed on your server. If Docker is not already installed, Cloudsuo's installation script will install it automatically. Use the following command to install Cloudsuo:

DOKPLOY_VERSION=canary sh -c 'set -e; [ "$(id -u)" = 0 ] || { echo "Run as root" >&2; exit 1; }; [ "$(uname -s)" = Linux ] || { echo "Linux is required" >&2; exit 1; }; case "$(uname -m)" in x86_64|aarch64|arm64) ;; *) echo "amd64 or arm64 is required" >&2; exit 1;; esac; if { ! command -v curl >/dev/null && ! command -v wget >/dev/null; } || { [ ! -s /etc/ssl/certs/ca-certificates.crt ] && [ ! -s /etc/ssl/cert.pem ]; }; then if command -v apt-get >/dev/null; then apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y curl ca-certificates; elif command -v dnf >/dev/null; then dnf install -y curl ca-certificates; elif command -v yum >/dev/null; then yum install -y curl ca-certificates; elif command -v apk >/dev/null; then apk add --no-cache curl ca-certificates; elif command -v pacman >/dev/null; then pacman -S --noconfirm --needed curl ca-certificates; elif command -v zypper >/dev/null; then zypper --non-interactive install curl ca-certificates; else echo "Unsupported package manager" >&2; exit 1; fi; fi; umask 077; f=$(mktemp); trap '\''rm -f "$f"'\'' EXIT; if command -v curl >/dev/null; then curl -fLsS --retry 3 https://cloudsuo.com/install.sh -o "$f"; else wget -qO "$f" https://cloudsuo.com/install.sh; fi; sh "$f" "$@"' install

See Manual Installation if you want to customize your Cloudsuo installation.

Advanced Installation Options

The current installer accepts only the verified canary release. Stable and version-specific commands below remain unavailable until those releases are published. Network environment variables retain their upstream behavior.

Install Specific Versions

Install Canary Version (Development):

export DOKPLOY_VERSION=canary && curl -sSL https://cloudsuo.com/install.sh | sh

Install Latest Stable:

export DOKPLOY_VERSION=latest && curl -sSL https://cloudsuo.com/install.sh | sh

Install a Specific Version:

Every Cloudsuo release includes its own install.sh as a release asset, which installs exactly that version with the setup it expects. Replace the version tag in the URL with the one you want:

curl -sL https://cloudsuo.com/releases/v0.1.0/install.sh | sh

Custom Network Configuration

If you need to customize the Docker Swarm network configuration (useful to avoid CIDR conflicts with cloud provider VPCs):

export DOCKER_SWARM_INIT_ARGS="--default-addr-pool 172.20.0.0/16 --default-addr-pool-mask-length 24"
curl -sSL https://cloudsuo.com/install.sh | sh

Manual Advertise Address

If the script cannot detect your server's IP automatically, or you want the Swarm to use a specific interface (e.g. a VPN/WireGuard IP), specify it manually:

curl -sSL https://cloudsuo.com/install.sh | sudo ADVERTISE_ADDR=192.168.1.100 sh

Kernels Without IPVS Support

Docker Swarm's default service discovery requires IPVS support in the kernel. Some minimal or appliance-style distributions (e.g. ZimaOS and other Buildroot-based images) ship kernels without it. On those systems, install with DNSRR endpoint mode:

curl -sSL https://cloudsuo.com/install.sh | sudo ENDPOINT_MODE=dnsrr sh

See Services Can't Reach Each Other (Missing IPVS Kernel Modules) for how to detect this situation and its trade-offs.

Proxmox LXC Support

Updating Cloudsuo

To update your Cloudsuo installation to the latest version:

DOKPLOY_VERSION=canary sh -c 'set -e; [ "$(id -u)" = 0 ] || { echo "Run as root" >&2; exit 1; }; [ "$(uname -s)" = Linux ] || { echo "Linux is required" >&2; exit 1; }; case "$(uname -m)" in x86_64|aarch64|arm64) ;; *) echo "amd64 or arm64 is required" >&2; exit 1;; esac; if { ! command -v curl >/dev/null && ! command -v wget >/dev/null; } || { [ ! -s /etc/ssl/certs/ca-certificates.crt ] && [ ! -s /etc/ssl/cert.pem ]; }; then if command -v apt-get >/dev/null; then apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -y curl ca-certificates; elif command -v dnf >/dev/null; then dnf install -y curl ca-certificates; elif command -v yum >/dev/null; then yum install -y curl ca-certificates; elif command -v apk >/dev/null; then apk add --no-cache curl ca-certificates; elif command -v pacman >/dev/null; then pacman -S --noconfirm --needed curl ca-certificates; elif command -v zypper >/dev/null; then zypper --non-interactive install curl ca-certificates; else echo "Unsupported package manager" >&2; exit 1; fi; fi; umask 077; f=$(mktemp); trap '\''rm -f "$f"'\'' EXIT; if command -v curl >/dev/null; then curl -fLsS --retry 3 https://cloudsuo.com/install.sh -o "$f"; else wget -qO "$f" https://cloudsuo.com/install.sh; fi; sh "$f" "$@"' install update

Update to Specific Version:

Use the install.sh from that version's GitHub release:

curl -sL https://cloudsuo.com/releases/v0.1.0/install.sh | sh -s update

Completing the Setup

After running the installation script, Cloudsuo and its dependencies will be set up on your server. Here's how to finalize the setup and start using Cloudsuo:

Accessing Cloudsuo

Open your web browser and navigate to http://your-ip-from-your-vps:3000. You will be directed to the initial setup page where you can configure the administrative account for Cloudsuo.

Initial Configuration

1. Create an Admin Account: Fill in the necessary details to set up your administrator account. This account will be the admin account for Cloudsuo.

Secure Your Installation

After setting up your admin account, it's crucial to secure your Cloudsuo installation by enabling HTTPS.

To configure a domain with SSL/TLS certificates for your Cloudsuo panel, please refer to the Domains section where you'll find detailed instructions for different SSL configurations including Let's Encrypt, Cloudflare, and custom certificates.

Disable access via ip:port (Optional but Recommended)

To enhance security, it's advisable to restrict access to Cloudsuo via the server's IP address and port.

Once you have verified that your domain is working correctly, you can disable IP:port access by running this command on the server:

docker service update --publish-rm "published=3000,target=3000,mode=host" dokploy

To further secure your installation, consider reading the Security recommendations section.