Before you begin
You need a Linux or macOS machine withcurl and an internet connection. Use Linux for a production serverhost; macOS is useful for local testing. Windows is not supported yet.
Run setup with an account that can create files in the installation location. On Linux, the account also needs sudo access if setup must install a missing requirement.
Connect your first serverhost
1
Sign in to the dashboard
Open the SimpleCloud Dashboard and sign in.
2
Create or join a network
Create a network, or join an existing one with an invitation code. The dashboard opens the setup wizard when your network does not have a serverhost yet.
3
Configure the serverhost
Choose the operating system, enter a recognizable name, and select how much memory SimpleCloud may use.The memory limit is the capacity available to Minecraft servers on this machine, so leave enough memory for the operating system. Keep Java 21 or newer selected. Setup installs the selected Java versions and other required software.
4
Run the setup command
Open a terminal on the machine and change to the directory that should contain the installation. The command installs into a
simplecloud folder there.Run the command shown in the dashboard and follow any prompts in the terminal.5
Finish setup
Wait for the terminal to show Setup complete. The dashboard automatically detects the serverhost and opens your network.
Add another serverhost
Open Settings > Server Hosts, select Add Host, and run the generated command on the new machine. Use a new command for every serverhost. If you want to use several machines together, continue with Multi-root setup.Install only the CLI
The dashboard command already installs the CLI. To install only the CLI on a Linux or macOS machine, run:Troubleshooting
The shell cannot find sc
The shell cannot find sc
Open a new terminal and try
sc --version again.The setup command has expired
The setup command has expired
Return to the dashboard and generate a new command.
Setup cannot install a requirement
Setup cannot install a requirement
Make sure the machine has internet access. On Linux, use an account that can run
sudo. Then run the setup command again.The serverhost does not appear in the dashboard
The serverhost does not appear in the dashboard
First check whether the terminal reached Setup complete. If it did, check the serverhost status and recent logs:If setup did not finish, fix the error shown in the terminal, generate a new command in the dashboard, and try again from the same parent directory.