Users & permissions

Inviting someone#

The Users tab is where you bring other people onto a server and decide how much they can do. Everyone you add becomes a subuser of that one server, so the access you grant stays with this server and nothing else you own.

To add someone, open the Users tab and click New User. That takes you to the Create New User page, where you fill in their email address and then choose their permissions. The email field is labelled Email Address and tells you to enter the address of the user you want to invite as a subuser for this server. Addresses can be up to 191 characters, and the person needs a valid address because that is how the panel identifies them. Once you click Invite User, they can sign in and act on the server straight away.

The Users tab also gives you a quick read on everyone already on the server. The header shows a running count such as 2 users next to the New User button, and each row lists the person's email, whether multi-factor authentication is on with an MFA Enabled or MFA Disabled label, and a Permissions number. That number leaves out the always-on websocket connection, so it reflects the permissions the person actually holds.

Choosing permissions#

Permissions live in the Detailed Permissions section of the create and edit forms. They are grouped into categories, and each category is a card with a short description and a grid of individual toggles. You can turn on a single toggle, or use the Select All and Deselect All button on a category to grant or clear that whole group at once. There is also a Select All / Deselect All button at the top of the section that applies to every permission you are allowed to assign.

Toggles for permissions you do not hold yourself appear disabled. The form shows a Permission Restriction notice that spells this out: you can only assign permissions that you currently have access to. Account owners and full admins are not limited this way and can grant everything.

Permission categories#

Each category lines up with an area of the server, and the card description in the panel tells you what the toggles inside it cover. Here is what each one controls and where it shows up.

  • Control covers the power state of the server and sending commands. It opens the Console along with the start, stop, and restart controls.
  • User lets someone manage other subusers on the server through the Users tab, with separate toggles for reading, creating, updating, and deleting subusers. Nobody can edit their own account or hand out a permission they do not already hold.
  • File controls the Files tab and SFTP. Listing a directory, viewing or downloading file contents, creating, editing, deleting, and archiving are each separate toggles, and SFTP access has its own toggle as well. The trash has its own toggles too: viewing what is in the trash and emptying it.
  • Backup opens the Backups tab, with toggles for reading, creating, and deleting backups and for configuring the automated backup schedule. Note that the download and restore toggles are sensitive, because a download exposes every file in the backup and a restore can overwrite the current server files.
  • Allocation covers the port allocations on the Network tab, which the Networking guide walks through. Anyone with access to the server can always see the primary allocation, but viewing the rest, adding allocations, changing the primary and editing allocation notes, and deleting allocations are separate toggles.
  • Startup covers the Startup tab. It splits into viewing and editing startup variables, changing the startup command, changing the Docker image, and the software toggle that controls the game or software the server runs.
  • Database opens the Databases tab. Viewing the database password is its own toggle, so you can let someone rotate a password without letting them read it.
  • Schedule opens the Schedules tab and the tasks inside each schedule.
  • Settings opens the Settings tab. The toggles let someone rename the server or trigger a reinstall.
  • Activity opens the Activity tab so the person can read the server's activity logs.
  • Proxy covers the Proxy Routes tab, which exposes server ports over HTTP and HTTPS, with separate toggles for creating, editing, and deleting routes.
  • Network covers the Private Networks tab. It has a single read toggle that lets someone view this server's private network memberships.
  • Migration covers the Migrate tab for moving a server in from an external host. The read toggle lets someone view migration history and status, and the create toggle lets them start a migration.
  • Health opens the Health tab, where automated health checks and recommendations for the server appear. It has a single read toggle.

You do not have to grant a whole category. Mixing individual toggles within a category is the usual way to give someone just the access they need.

Editing and removing#

You can change someone's permissions or remove them from the server whenever you like, and changes take effect right away. To adjust permissions, click Edit on their row, make your changes, and click Save Changes. To remove someone, click Delete on their row. The panel then opens a confirmation dialog titled Remove username? that warns all access to the server will be removed immediately, and clicking the matching Remove username button does exactly that.

You will not see Edit or Delete buttons on your own row, so you cannot change or remove yourself here. An email address cannot be changed after the invite either. If you need to use a different address for someone, remove their row and add them again with the new email.

Things worth knowing#

Note: You can only grant permissions you already hold yourself, and everything you set up here applies to this one server. Adding someone to this server does not give them any access to your other servers.