Server keys

Free keys that connect your server to Neighborly.

Every Neighborly server needs its own key – just like a FiveM license key. Keys are free and tie your server to your account, so you can manage it from the website.

  1. Sign inOpen neighborlymp.com/account and sign in with your Neighborly account.
  2. Open Server keysClick Server keys at the top.
  3. Generate a keyType your server's name, choose where it's hosted and click Generate key.
  4. Copy it right awayThe key starts with nbk_ and is shown only once. Click Copy.
  5. Give it to your serverThe Linux installer and start.bat ask for it. You can also put it into server.json yourself:
    "license": "nbk_0123456789abcdef0123456789abcdef01234567"

Servers you create in the launcher's Host tab get a key automatically – you don't need to do anything.

Managing your keys

ButtonWhat it does
Manage serverAnnouncements, kick players, console commands, restart or stop – right from the website
Lock to this IPThe key only works from the IP your server uses now. Recommended for VPS servers.
Reset IPUse this after moving your server to a new machine.
Custom bannerYour own picture in the server browser – part of Neighborly Club (Resident and up)
Revoke keyThe key stops working immediately. Generate a new one if it leaked.

How many keys can I have?

That depends on your plan – see Neighborly Club. Your plan also sets the maximum players per server.

Treat your key like a password. Anyone with it can run a server in your name. If it leaks, revoke it and generate a new one.