Linux VPS – 24/7

One command installs a server that never sleeps.

Works on Debian 11+ and Ubuntu 20.04+. You need a VPS with a public IP and a user with sudo.

  1. Get a server keyOpen My account → Server keys, type a name and click Generate key. Copy the key – it's shown only once.
  2. Connect to your VPSUse SSH (for example Bitvise, PuTTY or the terminal) and log in.
  3. Run the installerPaste this one line and press Enter:
    curl -fsSL https://neighborlymp.com/install.sh | sudo bash
  4. Paste your keyThe installer asks for your server key and a name. Paste the key with a right-click and press Enter.
  5. That's itThe server is installed as a system service. It starts on boot, restarts if it ever crashes and shows up in the server browser within a minute.

The installer opens the game port in ufw if you use it. If your VPS provider has its own firewall in their control panel, allow TCP 47130 there too.

Everyday commands

sudo systemctl status neighborly      # is it running?
sudo journalctl -u neighborly -f      # live log
sudo systemctl restart neighborly     # restart
echo "players" | sudo tee -a /opt/neighborly/data/console.cmd   # run a console command

You can also do all of this from the website: My account → Server keys → Manage server lets you send announcements, kick players, run console commands and restart the server.

Several servers on one VPS

Run the installer again with a different name, then change the port in that server's server.json:

curl -fsSL https://neighborlymp.com/install.sh | sudo bash -s -- roleplay

Each server needs its own key and its own port.

Updating

Run the install line again. Your world, settings and key are kept.

Files

PathWhat's inside
/opt/neighborly/server.jsonSettings and your server key
/opt/neighborly/data/The whole world – back this folder up
/opt/neighborly/data/backups/Automatic backups every 6 hours
/opt/neighborly/mods/Server mods