The new Enjin TeamSpeak 3 system fully integrates TeamSpeak 3 a leading voice over IP software with your Enjin website and users. Seamlessly sync your website access, users, forums, tags, channels, automations and much more. Employ the power of the Enjin platform and the Enjin TS3 panel for unprecedented easy management and seamless advanced integration of your TeamSpeak 3 server and website.
Getting Free TeamSpeak 3 Slots
If you have a website on the Advanced or Ultimate plan, you will receive free TeamSpeak 3 slots. Advanced plans receive 10 free slots and Ultimate plans receives N free slots. These slots are free provided your website plan remains active.
Purchasing Extra Slots
You can purchase extra user slots anytime. Any purchased slots will add-on to your current website free plan slots. For example, if you are on the Advanced plan and you purchase 20 more slots. Your server size will be 30 slots (10 free slots from Advanced plan + 20 purchased slots). You can purchase more slots or more days for purchased slots in your Enjin TS3 Panel.
Importance of Syncing Site Users and TS3 Clients
To gain the full power of the integrated Teamspeak 3 system, it is crucial for website users to sync their Teamspeak 3 user accounts together. This will enable you as a site owner complete seamless control over their voice settings and access the combined power of the Enjin platform and Teamspeak 3 system. There are several easy ways (with just 1 click) for users to sync user accounts and they are defined further in this guide.
Teamspeak 3 Website Tray bar Item
If you have an active Teamspeak 3 server on your website, a Teamspeak 3 tray bar item will appear in the global user tray bar in the bottom right of each page for all registered users. The tray bar item when clicked features 2 modes depending if the user account is synced or not with a TS3 account.
Unsynced Accounts are prompted to Sync
Users will be presented with 2 options to sync their accounts. Option 1 is a [Connect to server] button. After the user clicks [connect to server] the user is automatically synced with their TS3 client account. Any access settings that the site user may have acquired via user tags will be assigned within 60 seconds of the sync.
Synced Account Shown Server Status Widget
When an website and TS3 account is synced, the tray bar item display the server status with user and channel data. A small number will also appear in the bottom right of the tray bar icon indicating the number of users currently online in the TS3 server.
You can synchronize various access settings between your TeamSpeak 3 server and user tags on your website.
Adding Server Groups to sync with User Tags
In your admin > users section, click the gear icon to edit the user tag and click ‘TeamSpeak 3 Sync’ tab. In the dropdown select the server group you want tagged users to gain and click [Add Server Group]. Any users who are tagged with this tag and synced will gain the server group access provided here. Any future users tagged with this tag will also gain the server group access added to this tag.
Adding Channels / Groups to sync with User Tag
Click the gear icon to edit the tag and click ‘TeamSpeak 3 Sync’ tab. In the dropdown select the channel and channel group you want tagged users to gain and click Add Channel . Any users who are tagged with this tag and synced will gain the channel group access provided here for the specified channels. Any future users tagged with this tag will also gain the channel group access added to this tag for the select channels.
User Tag Order Dictates which channel group is dominant for the same channel
Since a Teamspeak 3 user may only have 1 channel group assigned per specific channel, there may be a case where a tag provides a user with 2 or more channel groups for the same channel. In this situation the tag that is ordered highest in the list will provide the channel group. By ordering tag order you can assign which channel groups take precedence.
Creating access automations for your TS3 server
Once you have set up various user tags that provide specific server or channel group access you may utilize Enjin’s tag automation features. With tag automations you can automatically have tags assigned or removed from users. Since you can set up various access settings with users and sync them with your TS3 server, tag automations are an invaluable tool for automating voice server access levels and settings.
Setting up a server where only registered site users can automatically join.
You want to create a TeamSpeak 3 server but want only forum, site or specific members to be able to join.
- 1. Set some cryptic long server password that you do NOT remember/write down. The result is nobody except users with the privilege b_virtualserver_join_ignore_password can connect.
- 2. In the TS3 client, create a server group called something like "AllowedUsers" that has b_virtualserver_join_ignore_password set to true (use the Normal or a copy of the Guest group as base to avoid having to put users in multiple server groups).
- 3. Go back to your website and create a user tag and name it ‘TS3 users’. In the edit tag screen go to ‘Teamspeak 3 Sync’, and add ‘AllowedUsers’ server group to the tag.
- 4. On your website create a tag automation that applies ‘Ts3 users’ tag to users via the condition ‘user registered on website’.
That’s it! Now when a new users registers on your website, they will automatically gain the ‘TS3 users’ tag and the ‘AllowedUsers’ server group. Once they sync their account by clicking [connect to server] button in the tray bar or the TS3 status widget they can automatically connect. Alternatively they can place the One-Time privilege key in the connect to server window in the client. This can also be found in the TS3 tray bar item or status widget.
Of course there are infinitely many more possibilities (e.g add a custom TS3 group for users with more than X posts on your forum, etc.). With tag automation everything is easy to accomplish.
User online in TS3 server website indicator
A new permanent user tag called ‘TS3 online user’ has been added to the admin > users section. The tag detects when a user is online in your TS3 server and by default a micro TS3 icon will appear next to the user’s name on the website when they are online.
Growl notification when a user joins a TS3 server
If you are a friend with a user who join a TS3 server, you will see a growl indicating that they have joined a TS3 voice server. Website admins will also see this notification growl for any website users that join the TS3 server.
To turn off these notifications, please visit your user dashboard > account settings > notification area and disable grown notifications for Teamspeak 3.
Enjin TS3 control panel
To control and setup your TS3 server you will need to utilize Enjin’s TS3 control panel.
Accessing Enjin TS3 Panel
Go to your website admin and click the ‘Voice’ tab to access the Enjin TS3 panel for your server.
Displays common and important data about your server.
Connecting to your server
Download the Teamspeak 3 Client (perform the wizard when applicable) and goto connection > connect. In the server Address type in the server hostname found in the server information section of your panel and click connect.
Gaining Server Admin Access with Privilege Key
Use Admin Privilege key to gain server admin access to your TS3 server. You can generate a new privilege key anytime by clicking generate. To use the key, join your Teamspeak 3 server click ‘Permissions’ then ‘Use Privilege key’.
Billing & Server Slots
Displays the amount of free slots you receive from your current website plan, purchased slots and relevant expiry dates.
You can start, restart and stop your TS3 server from this section.
If your TS3 server is online, a server status widget will display with server information, channels and current users.
Client manager - for managing users & access
The client manager displays all the users that are registered on your Teamspeak 3 Server and any assigned website users. You can edit server / channel group access and other settings here. Nickname, is the name of the TS3 user. Unique ID, is the ID provided by TS3 for that user. Assigned User, indicates and allows you to assign / remove website users to a TS3 user. Last Online, displays the last time the user joined the TS3 server.
How to sync a website user to a TS3 user
To enable automatic syncing between your website and server access you must assign or sync a website user to the relevant TS3 user. Click the [Assign] button and select a website user to assign.
How to unassign a website user from a TS3 user
Click the [x] button in the assigned user column to remove website user assignment. Note, any inherited server / channel groups access from user tags will be removed from the TS3 user.
Editing and viewing user permissions
Click the [Edit] button to edit various user settings. You can do the following:
Edit User Description
Set the user client description via this input.
View Server / Channel Group for user
Displays the user’s current server / channel groups. Indicates if the server / channel group was inherited from a user tag on the website or manually provided.
Adding server / channel group access
A user may be given server / channels group access via 2 ways:
- Manually given in the TS3 client or the Enjin TS3 panel.
- Click [Add to server group] or [Add to channel group]
- Inherited from user tags that are synced with a server / channel groups.
- Create user tags in admin > users and go to the TeamSpeak 3 Sync tab to assign server group and channel group to user tag.
Removing server group / channel group access
A user may inherit server / channel group access via 2 ways:
- Manually given in the TS3 client or the Enjin TS3 panel.
- To remove manual access click the [X] button next to the group.
- Access Inherited from synced user tags on the website.
- To remove inherited access, you can remove the user tag from the assigned website user in the admin > users section. Alternatively you can also delete the user tag if required.
To delete a TS3 user from the server click the [x] button and confirm deletion. Only the TS3 user will be deleted. The assigned website user will be unassigned in this situation.
Removing Custom Permissions
This will clear any server groups and channel groups not currently synced with user tags from the selected TS3 users. This is useful to perform when you want to make sure that no access is provided manually but is only directly synced and inherited from user tags.
Channel manager - for managing channels & access
The channel manager displays all the channels on your TS3 server and allows you to create, edit, and move / nest channels. You can also sync user tags with channel groups, view the client list and set channel settings.
Creating Channels and Sub-channels
Click [Create Channel] to create a channel. Created channels will instantly appear in the TS3 client. You can set the channel name, password and topic. To create a sub-channel click [create sub-channel] next to the relevant channel.
Moving / Nesting Channels
You can drag and drop channels anywhere. Click and hold the mouse key at the arrow button and drag the channel either above or nest under another channel. You can create multiple nesting levels just like in the TS3 client.
Click the [Edit] button to edit a channel. You can edit various settings here including syncing tags to groups for each channel and viewing the client list.
Syncing a user tag with a channels & channel groups
Select the channel(s) and click [Sync Channel to Tag] button. Alternatively you can edit the channel and click ‘Synced Tags’ tab. If you have any items synced, the user tags and channel groups will be listed here.
Adding Tag Sync to a channel
Click the [Add Tag Sync] button. Select a user tag and the channel group you wish to sync with. Note, that any users that gain this user tag will automatically receive the channel group access assigned here for this channel. Note, you can only sync 1 channel group per specific channe; per user tag.
Remove Channel Tag Sync
Edit the channel and go to ‘Synced Tags’, click the [x] on the right for the relevant user tag and channel group.
Tag Synced Indicator
If a channel is synced to user tag(s) the channel manager will display ‘Tag Synced’ next to the channel.
Channel Client List
This displays the clients that have access to this channel and any relevant channel groups.
Click the [x] icon to right of each channel to remove it.
Mass Moving Users
Within the channel manager, you have the ability to mass move all users, specific tagged users, or specific users within a channel to any channel you desire. This is great for assembling meetings, or getting everyone together on any certain occasion. You will see this option to the right of each row for each individual channel.
Mass moving includes these options:
- Move all users to current channel
- Move all users from current channel to another channel
- Move all users from another channel to current channel
- Move specific users to this channel
Main Server Settings
Server name, set the main server name. Phonetic Name, set the phonetic name of the server. Global Password, setting a password will force users to enter this password to join server. Reserved Slots, number of slots to reserve for important users. Join Security Level, defaulted to 8, recommended to leave. Public listing, check this if you wish your server to be publicly listed in the TS3 server list.
Set Welcome message text
When users join your TS3 server the welcome message will be displayed. You can set the message and if it should display in the chat or popup as a message.
Set Server Banner
Upload your own server banned and set the URL. By default your website logo and website url is set. You can also set the way the banner appears in the TS3 client.
This will set the small icon that appear in the top right of the client. You can upload your own icon (recommended size 64x64) and set the url.
You can manage TS3 user bans here. Please note, banning a website user will not automatically ban any assigned TS3 users.
Banning a user
Click [Create Ban] to ban a user. You will need the user’s IP address or Unique ID to ban them. You can find the unique ID or Last IP in the ‘Client Manager’ section or in the TS3 client. You may add a ban reason and set Time expiry for the ban.
Click the Time Expiry dropdown in the Create Ban popup to set how long the ban should last. The ban will be automatically lifted when the time expiry is reached.
Banning IP by wildcard
You can apply bans on wildcard IP's using '*' for example 198.1.*.* Please be careful when using wildcard as you can set wide ban on many users.
Click the [x] button on the right of the ban to remove it. The user or IP will be unbanned immediately.
Note on Website User Bans
Banning a website user or IP address on the website will not ban that user or IP on the TS3 server. You must apply the Ban in the ban manager and also be sure to unassign the user from the TS3 user in the ‘Client Manager’
You must have a global server password set for temporary password to work in the server settings page. Adding temporary server passwords allows you to create passwords that will expire after a certain period of time. You can select the channel the user will join once they use the temporary password.
Creating Temporary Passwords
Click [Add Temporary Password] and set the password, description and channel the user will be placed in after inputting the correct password. You can also set the time expiry on the password.
Deleting Temporary Passwords
Click the [x] button to the right of the temporary password. Please note, if you have a global password set the user will still be prompted to enter a password. To remove all passwords to your server, make sure the global password field if blank in the server settings page.
Send Text Message
Send text messages directly to the TS3 server and it’s channels. You can select the destination of the message, channels or the entire server. The message will be delivered immediately.
Creating Manual Backups
Click [Create Backup] and set a description. Your entire server settings will be backed up and saved.
Restoring Server Backups
You can restore manual or automatic backups anytime. Click the [Restore] button next to the relevant backup. Warning, this operation may clear clients and tag sync settings created after the backup date.
Note, users who connected their Enjin account to their TS3 account between the backup date and now will need to click the Sync Account or Connect to Server link on your website to regain their TS3 permissions.
Automatic Server Backups
Automatic backups are performed daily. You may restore from automatic backups by clicking the [Restore] button.
Viewing Server Logs
The log window will display the last 500 entries for the currently selected month. To view another month click the month drop-down to see the last 500 entries for another month.
Downloading Full Logs
To view all the log entries for a current month, select the month to view and click [Download Full Log]
You can enable or disable various logging items. Log Client, Log Query, Log Channel, Log Server and Log Permissions.
Set Domain & Location
Changing Server Domain (hostname)
To edit your TS3 hostname for your server hosted by Enjin, please visit your Enjin admin panel > voice tab > "Set Domain & Location" area. Here, you have the option of either changing your current host name with our .enjinvoice.com sub domains or using your own custom host name provided by your own domain. This will only be provided if you are on the advanced/ultimate plan, and have your domain set up properly with your website. How do you set up your own custom domain with Enjin? Please visit this link: http://wiki.enjin.com/wiki/domains
Changing Server Location
You may change your server physical location in the world anytime. Choose a location and click [Change location]. Note when changing locations any online users will be briefly disconnected till the server migrates to the new location. Current Enjin TS3 locations are:
- US Central
- US East
- US West
TeamSpeak 3 Group Pay
Enjin offers a TeamSpeak 3 group pay module. This module allows your users to contribute payments to your server, allowing the community to help pay for extra slots and/or the expiration of those slots.
To use this module, simply visit your admin panel > modules tab > "Store & Donations" category and create a "Teamspeak 3 group pay" module.
For more information on this module, visit this link.
Q: My plan says I can use Teamspeak 3, but on the voice page, it only says I can use Mumble.
A: We haven't fully implemented our TS3 hosting service. If you are on the Advanced/Ultimate plan, you can create your server by visiting the URL "yourdomain.com/admin/teamspeak/wizard" (replace domain with your own).
Q: I am currently using Mumble, but would like to use TeamSpeak 3 instead. What can I do?
A: You can create your TeamSpeak server at any time by visiting the URL "yourwebsite.com/admin/teamspeak/wizard" (replace domain with your own). Be aware that if/when you do create a Teamspeak server, you will be in-turn deleting your Mumble server.
Q: Some of my users can't connect to my server, what should I do?
A: Try enabling TSDNS within your admin panel > voice tab > Domains section. Wait at least 10 minutes and see if your users have an easier time connecting to the server. Still not working? Contact support with more information on the issue.
Q: Can we integrate 3rd party hosted Teamspeak 3 servers with your admin panel?
A: No, our website to server integration is only available to TeamSpeak servers hosted with Enjin at this time.
Q: I want to switch back to Mumble, how can I do this?
A: Submit a ticket here. We can process this request for you. Be aware that this will require us to delete your Teamspeak server, and you will be required to rebuild your Mumble server. Your Teamspeak server will not be recoverable.