Deploy a Dedicated Server (Automated Setup)
Install SoulFire on a remote Linux server with the Docker setup script.
If you are not sure whether you need a remote setup, read Choose Your Setup first.
Automated setup
This guide installs a SoulFire dedicated server on a remote Linux server. The setup script installs Docker, configures HTTPS, and starts SoulFire.
Get a server
Get a Linux server (VPS) with a public IP address. Debian is recommended, but Ubuntu, Fedora, and Arch also work.
How much RAM you need depends on how many bots you plan to run:
| Bots | RAM | vCPU |
|---|---|---|
| 1–50 | 2 GB | 1 |
| 50–200 | 4 GB | 2 |
| 200–500 | 8 GB | 2 |
| 500–1000 | 16 GB | 4 |
| 1000+ | 32 GB+ | 4+ |
Get 20€ in free credits from Hetzner Cloud. This referral also supports SoulFire development.
When creating your server, choose the Debian image. Save the server's public IP address for the next step.
Connect via SSH
SSH (Secure Shell) lets you run remote commands on the server. Open a terminal on your computer and connect:
ssh root@your-server-ipReplace your-server-ip with the IP address from the previous step.
Enter the server password when SSH asks for it.
You created this password when you created the server, or your provider sent it by email.
On Windows, use PowerShell or Windows Terminal. Both have SSH built in. On macOS/Linux, use the default terminal.
SSH key authentication is safer than password authentication.
Run the setup script
After SSH connects, run this command:
wget -qO /tmp/sf-setup.sh https://raw.githubusercontent.com/soulfiremc-com/SoulFire/main/scripts/soulfire-dedicated-setup.sh && sudo bash /tmp/sf-setup.shThe script asks you about these options:
- System updates and Docker installation, if required
- HTTPS setup with Cloudflared, Traefik, or plain HTTP
- SoulFire deployment with Docker Compose in
/opt/soulfire/
Generate an access token
Run the same command again to open the management menu:
wget -qO /tmp/sf-setup.sh https://raw.githubusercontent.com/soulfiremc-com/SoulFire/main/scripts/soulfire-dedicated-setup.sh && sudo bash /tmp/sf-setup.shSelect Attach to SoulFire console, then run:
generate-token apiCopy the token for the next step.
Connect the GUI client
Install SoulFire on your computer, then open it. Enter these values:
- Server URL: The configured HTTPS URL, such as
https://your-domain.comorhttps://your-server-ip - Access token: The token from the previous step
You are now connected to your dedicated SoulFire server.
Managing your server
Run the setup script again to open the management menu:
wget -qO /tmp/sf-setup.sh https://raw.githubusercontent.com/soulfiremc-com/SoulFire/main/scripts/soulfire-dedicated-setup.sh && sudo bash /tmp/sf-setup.shThe menu has these actions:
- Attach to the SoulFire console to run commands
- View logs of running containers
- Update SoulFire to the latest version
- Reconfigure SSL settings
- Uninstall SoulFire
Further reading
- Docker guide: Manual Docker Compose, Pterodactyl or Pelican, and HTTPS setup
- Dedicated mode guide: Run SoulFire with Java instead of Docker
How is this page?
Last updated on
