VPS Setup

Prerequisites

Java 21 or newer installed
A valid SunGuard license key. See Get your license key.

Step 1: Upload required files

Transfer the following files to your VPS:

server.jar (SunGuard server file)
license.txt (contains your license key)

You can use scp or an FTP client like FileZilla. Example using scp:

scp server.jar license.txt user@your-vps-ip:/home/user/

Step 2: Start the SunGuard server

Navigate to the directory containing server.jar and license.txt, then run:

SERVER_PORT=25595 java -Dterminal.jline=false -Dterminal.ansi=true -jar server.jar

Replace 25595 with your desired port, and make sure the port is open in your firewall. If Java 21+ is not installed, you can install it with:

sudo apt update
sudo apt install openjdk-21-jdk -y

Step 3: Verify local access

Check that the server is running correctly:

curl http://localhost:25595

Step 4: Expose to the internet with Nginx (optional)

Install Nginx:

sudo apt install nginx -y

Create a new config file:

sudo nano /etc/nginx/sites-available/sunguard

Paste the following:

server {
    listen 80;
    server_name yourdomain.com;

    location / {
        proxy_pass http://localhost:25595;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
    }
}

Enable the site and restart Nginx:

sudo ln -s /etc/nginx/sites-available/sunguard /etc/nginx/sites-enabled/
sudo systemctl restart nginx

SunGuard is now available at http://yourdomain.com.

Step 5: Run on port 80 directly (alternative)

If you’re not using Nginx:

SERVER_PORT=80 java -Dterminal.jline=false -Dterminal.ansi=true -jar server.jar

Port 80 must be free and not used by other services like Nginx or Apache.

Step 6: Configure the firewall (if needed)

sudo ufw allow 80/tcp
sudo ufw allow 25595/tcp
sudo ufw reload

Step 7: Keep SunGuard running after you disconnect

screen
tmux

sudo apt install screen -y
screen -S sunguard
SERVER_PORT=25595 java -Dterminal.jline=false -Dterminal.ansi=true -jar server.jar

Detach with CTRL + A, then D. Resume with:

screen -r sunguard

sudo apt install tmux -y
tmux new -s sunguard
SERVER_PORT=25595 java -Dterminal.jline=false -Dterminal.ansi=true -jar server.jar

Detach with CTRL + B, then D. Resume with:

tmux attach -t sunguard

🎉 SunGuard is now running on your VPS. You can manage it manually or configure a systemd service for auto-start. If you’d rather not manage a server, consider SunGuard Managed Hosting.

Getting Started

Guides

Prerequisites

Step 1: Upload required files

Step 2: Start the SunGuard server

Step 3: Verify local access

Step 4: Expose to the internet with Nginx (optional)

Step 5: Run on port 80 directly (alternative)

Step 6: Configure the firewall (if needed)

Step 7: Keep SunGuard running after you disconnect

​Prerequisites

​Step 1: Upload required files

​Step 2: Start the SunGuard server

​Step 3: Verify local access

​Step 4: Expose to the internet with Nginx (optional)

​Step 5: Run on port 80 directly (alternative)

​Step 6: Configure the firewall (if needed)

​Step 7: Keep SunGuard running after you disconnect

Prerequisites

Step 1: Upload required files

Step 2: Start the SunGuard server

Step 3: Verify local access

Step 4: Expose to the internet with Nginx (optional)

Step 5: Run on port 80 directly (alternative)

Step 6: Configure the firewall (if needed)

Step 7: Keep SunGuard running after you disconnect