Installation

This guide walks you through installing Nixopus on your VPS. The installation process downloads the Nixopus CLI and uses it to set up all required services including Docker, PostgreSQL, Redis, and Caddy.

Requirements

Before installing, ensure your server meets these requirements:

Requirement	Minimum	Recommended
Operating System	Ubuntu 20.04+, Debian 11+	Ubuntu 22.04+
CPU	2 cores	4+ cores
RAM	2 GB	4+ GB
Storage	5 GB free	10+ GB free
Access	Root or sudo privileges
Ports	80, 443, 8443, 7443 available
Network	Internet connection	Stable connection

Quick Installation

Run this single command to install Nixopus:

curl -sSL https://install.nixopus.com | bash

This command performs the following steps:

1. Detects your system architecture (amd64, arm64) and operating system
2. Downloads the appropriate Nixopus CLI binary
3. Installs the CLI to /usr/local/bin/nixopus
4. Runs nixopus install to set up all services

Generate Installation Command

Use the interactive generator below to customize your installation with domains, IP addresses, and other options.

Your Install Command

sudo curl -sSL https://install.nixopus.com | bash

Installs:

Nixopus APIDashboardPostgreSQLRedisCaddyDocker

Using default HTTP mode. Host IP will be auto-detected. Add domains for HTTPS or specify Host IP.

Default installation: HTTP mode with auto-detected IP, local PostgreSQL and Redis. Toggle options to customize.

Network

Domain & IP configuration

API Domain

HTTPS endpoint for API

App Domain

HTTPS endpoint for dashboard

Host IP

Server IP (auto-detected if empty)

Database

Database configuration

External Database

If disabled, use local PostgreSQL

Leave disabled to use local Docker database

Options

Installation behavior

Verbose

Dry Run

Force

Timeout

Config File

No Rollback

Skip Health Checks

Health Check Timeout

Admin Email

Admin Password

Skip Nixopus Install

Installation Examples

Default (IP based)

curl -sSL https://install.nixopus.com | bash

Custom IP

curl -sSL https://install.nixopus.com | bash -s -- --host-ip 10.0.0.154

With Domains

sudo nixopus install \
  --api-domain api.example.com \
  --view-domain app.example.com \
  --verbose

CLI Only

curl -sSL https://install.nixopus.com | bash -s -- --skip-nixopus-install

Domain Installation

When using domains, ensure your DNS records point to your server before running the install command. Caddy will automatically obtain SSL certificates.

Accessing Nixopus

After installation completes, open your browser and navigate to:

IP Configuration

Dashboard: http://YOUR_IP:80
API:       http://YOUR_IP:8443

Domain Configuration

Dashboard: https://your-view-domain.com
API:       https://your-api-domain.com

On first access, you will be prompted to create an admin account.

Troubleshooting

Installation Fails

Run with verbose mode to see detailed errors:

sudo nixopus install --verbose

Check that required ports are not in use:

sudo lsof -i :80 -i :443 -i :8443 -i :7443

Verify Docker is installed and running:

docker --version
docker ps

Permission Errors

Ensure you're using sudo:

sudo nixopus install

Or run as root:

su -
nixopus install

Port Conflicts

If ports are already in use, stop the conflicting services or configure Nixopus to use different ports by editing the configuration file at /etc/nixopus/source/helpers/config.prod.yaml.

DNS Issues

For domain based installations, verify your DNS records resolve correctly:

dig +short api.example.com
dig +short app.example.com

Both should return your server's IP address.

Getting Help

If you continue to experience issues, create an issue on GitHub with your operating system version, installation command, and complete error output.

Next Steps

After installation, you can:

• Deploy your first application
• Configure notifications
• Learn CLI commands