✨Initial Server Setup

This page will help you get your TS3 server set up with our platform if you just purchased a subscription from us.

When you are invited to first manage your new server, you will be prompted to input your server's details as follows:

Server details menu

An explanation of each field follows:

• Label: This is the client-facing name of your server, and what it will be called across the TSManage UI. This is mainly a personal preference choice, you may change it at any time.

• Host: The IP address of your TS3 server. It is advised to always use direct IP connection over hostnames, as the added step of DNS resolution can hinder performance in some circumstances.

• Port: The public-facing connection port of your TS3 server. This is the port that any user would connect through to get into the server.

• Query Port: The serverquery port for your TS3 server. This port defaults to 10011 in most cases. If your host changes it, or disables it, you will need to update it accordingly or request your host to open up serverquery access to your server.

• Virtual Server ID: Necessary in some hosted contexts to distinguish between which virtual TS3 server to target when there may be many on the same *physical* TS3 box. Kind of like virtualization. If you are self-hosting, this can be set to 1. Otherwise, your host should provide this information for you.

• Serverquery Username: TSManage works by connecting to your TS3's serverquery interface directly through a serverquery user. You must create this user and grant it certain permissions (listed below) in order for TSManage to be able to connect to your TS3 server.

• Serverquery Password: The password for the serverquery account that TSManage will use to access your server. It should match the serverquery username.

• Client Nickname: This is what the serverquery user will show up as in your TS3 server to other users. This is personal preference and can be changed without concern.

Required permissions for Serverquery user:

To ensure TSManage can execute the required ServerQuery commands with the appropriate permissions, you'll need to configure both the direct permissions to execute these commands and the corresponding modify powers for actions like adding and removing clients from server groups. Here's a breakdown for setting up the permissions:

• b_serverquery_login - used to log in to the serverquery

• b_virtualserver_select - used by use

• b_client_modify_own_description - used by clientUpdate

• b_virtualserver_client_list - used by whoami

• b_virtualserver_client_dblist - used by clientDbList

• b_virtualserver_servergroup_list - used by serverGroupsByClientId, serverGroupList

• b_virtualserver_client_dbinfo - used by clientDbInfo

• Perms for: serverGroupAddClient

• Perms for: serverGroupDelClient