Tutorial New TeaSpeak GreenTeaSpeak

FLASHHD

Active Member
Joined
Jul 17, 2018
Messages
18
Reaction score
1
Points
94
GreenTeaSpeak Server Website GreenTeaSpeak Website

Professional Installation Guide​

Welcome to the official GreenTeaSpeak Server installation guide.

This documentation explains how to install and initialize a GreenTeaSpeak Server on a Linux system, including the required startup scripts, administrative token generation, network ports, firewall configuration, and recommended production setup.


1. System Requirements​

Before installing GreenTeaSpeak, make sure your server meets the following requirements.

Recommended System​

  • Operating System: Debian 12 / Ubuntu 22.04 or newer
  • Architecture: x86_64 / AMD64
  • CPU: 1 GHz or faster
  • RAM: 512 MB minimum
  • Disk Space: 500 MB minimum
  • Network: Public IPv4 address recommended
  • Privileges: Root or sudo access
For larger communities, additional CPU, RAM, and network resources may be required.


2. Download GreenTeaSpeak​

Download the appropriate GreenTeaSpeak Server package for your operating system.

After downloading the archive, upload it to your server.

Example:

cd /opt

Extract the GreenTeaSpeak package:

tar -xzf GreenTeaSpeak-linux-x64.tar.gz
Rename or move the extracted directory if required:

mv GreenTeaSpeak greenteaspeak
Enter the GreenTeaSpeak directory:

cd /opt/greenteaspeak
Your installation directory should contain the GreenTeaSpeak server files, including:

GreenTeaSpeakServer
teastart_minimal.sh
teastart.sh

3. Create a Dedicated User​

For security reasons, GreenTeaSpeak should not normally be operated as the root user.

Create a dedicated system account:

adduser --system --group --home /opt/greenteaspeak greenteaspeak
Set the correct ownership:

chown -R greenteaspeak:greenteaspeak /opt/greenteaspeak
Switch to the GreenTeaSpeak account:

su - greenteaspeak
Navigate to the installation directory:

cd /opt/greenteaspeak

4. Make the Startup Scripts Executable​

GreenTeaSpeak provides startup scripts for different stages of the server initialization.

Make both scripts executable:

chmod +x teastart_minimal.sh
chmod +x teastart.sh
You can verify the permissions with:

ls -l teastart_minimal.sh teastart.sh
The scripts should have executable permissions.


5. Initial Server Setup​

5.1 Start​

For the initial GreenTeaSpeak setup, execute:

./teastart_minimal.sh
The minimal startup script is used to initialize the server environment and prepare the initial administrative access.

During the first startup, GreenTeaSpeak may generate the required configuration and server data.

The console can display an administrative ServerAdmin token.

Example:

ServerAdmin token:
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Important​

Save the ServerAdmin token securely.

The token provides administrative access to the server and should never be published or shared publicly.

If the token is displayed only once, losing it may require additional administrative recovery procedures.


6. Start GreenTeaSpeak Normally​

After the initial setup has been completed, GreenTeaSpeak can be started using:

./teastart.sh
The standard startup script is intended for normal server operation.

A successful startup should display information about the running GreenTeaSpeak instance and its configured network services.


7. GreenTeaSpeak Network Ports​

GreenTeaSpeak uses several network ports for different services.

The standard GreenTeaSpeak configuration uses:

Function
Voice communication
Server Query / administrative interface
GreenTeaSpeak service communication
​

Port 9987 – Voice​

9987/UDP
This is the primary voice communication port.

Clients require access to this port to establish voice communication with the server.


Port 10101 – Server Query​

10101/TCP
This port is used for Server Query and administrative communication.

Because Server Query provides powerful administrative capabilities, access to this port should be restricted whenever possible.

Do not expose administrative interfaces unnecessarily to the public Internet.


Port 30303 – GreenTeaSpeak Service​

30303
This port is used by GreenTeaSpeak for its additional server/application communication.

The exact protocol requirements should always correspond to the configuration of the installed GreenTeaSpeak release.

If the server requires both protocols, allow:

30303/TCP
30303/UDP

8. Configure the Firewall​

If your server uses UFW, configure the required ports.

Allow voice communication:

ufw allow 9987/udp
Allow Server Query:

ufw allow 10101/tcp
Allow the GreenTeaSpeak service port:

ufw allow 30303/tcp
If UDP is required by your configuration:

ufw allow 30303/udp
Always allow SSH before enabling UFW on a remote server:

ufw allow 22/tcp
Enable the firewall:

ufw enable
Check the firewall configuration:

ufw status

9. Verify Listening Ports​

After starting GreenTeaSpeak, verify that the expected ports are listening.

Run:

ss -tulpn
You should see the GreenTeaSpeak process associated with the configured ports.

For a more specific check:

ss -lunpt | grep -E '9987|10101|30303'
This allows you to quickly identify whether the required network services are active.


10. Running GreenTeaSpeak as a System Service​

For production servers, manually executing teastart.sh after every reboot is not recommended.

Instead, GreenTeaSpeak should be integrated into systemd.

Create the service:

nano /etc/systemd/system/greenteaspeak.service
Example:

[Unit]
Description=GreenTeaSpeak Server
After=network-online.target
Wants=network-online.target

[Service]
Type=simple
User=greenteaspeak
Group=greenteaspeak
WorkingDirectory=/opt/greenteaspeak
ExecStart=/opt/greenteaspeak/teastart.sh
Restart=on-failure
RestartSec=5

[Install]
WantedBy=multi-user.target
Save the file and reload systemd:

systemctl daemon-reload
Enable automatic startup:

systemctl enable greenteaspeak
Start the service:

systemctl start greenteaspeak
Check the status:

systemctl status greenteaspeak
A correctly running service should report:

Active: active (running)

11. Viewing GreenTeaSpeak Logs​

To view the systemd logs:

journalctl -u greenteaspeak
Display the latest entries:

journalctl -u greenteaspeak -n 100
Follow the logs in real time:

journalctl -u greenteaspeak -f
Logs are particularly useful when troubleshooting startup problems, network issues, configuration errors, or unexpected server shutdowns.


12. Connecting to GreenTeaSpeak​

After the server has started successfully, connect using a compatible GreenTeaSpeak client.

Use the server's hostname or public IP address.

Example:

voice.example.com
or:

203.0.113.10
If a custom voice port is configured:

voice.example.com:9987
The client must be able to reach the configured voice port over UDP.


13. First Administrative Login​

During the initial startup using:

./teastart_minimal.sh
GreenTeaSpeak can provide the initial administrative ServerAdmin token.

Use this token with the appropriate GreenTeaSpeak client or administration interface to obtain administrative access.

Security Recommendation​

Treat the ServerAdmin token like a highly privileged credential.

Never:

  • Post it in Discord
  • Upload it to GitHub
  • Include it in screenshots
  • Send it through public chat
  • Store it in publicly accessible configuration files

14. Updating GreenTeaSpeak​

Before updating GreenTeaSpeak, stop the server:

systemctl stop greenteaspeak
Create a complete backup:

tar -czf /opt/greenteaspeak-backup-$(date +%Y-%m-%d).tar.gz /opt/greenteaspeak
Install the new GreenTeaSpeak release according to its release documentation.

After updating, verify ownership:

chown -R greenteaspeak:greenteaspeak /opt/greenteaspeak
Make sure the startup scripts remain executable:

chmod +x /opt/greenteaspeak/teastart_minimal.sh
chmod +x /opt/greenteaspeak/teastart.sh
Start GreenTeaSpeak:

systemctl start greenteaspeak
Then verify:

systemctl status greenteaspeak

15. Backup Strategy​

For production installations, regular backups are strongly recommended.

Important data may include:

  • GreenTeaSpeak configuration
  • Virtual server configuration
  • Server identities
  • Permissions
  • Databases
  • Custom settings
  • Server-specific files
A basic backup can be created with:

tar -czf greenteaspeak-backup.tar.gz /opt/greenteaspeak
For professional deployments, backups should be stored separately from the production server.


16. Troubleshooting​

GreenTeaSpeak does not start​

Check the service:

systemctl status greenteaspeak
Check the logs:

journalctl -u greenteaspeak -n 100 --no-pager
Check the startup script permissions:

ls -l /opt/greenteaspeak/teastart.sh
If necessary:

chmod +x /opt/greenteaspeak/teastart.sh

Clients cannot connect​

Verify that GreenTeaSpeak is running:

systemctl status greenteaspeak
Check the ports:

ss -tulpn
Verify the firewall:

ufw status
Make sure the following ports are correctly configured:

9987/UDP
10101/TCP
30303/TCP/UDP*
Also check whether your hosting provider has an external firewall or security group that blocks incoming traffic.


Server Query cannot be reached​

Check:

ss -lntp | grep 10101
Verify that TCP port 10101 is allowed by the firewall.

For security reasons, consider restricting Server Query access to trusted IP addresses instead of exposing it globally.


17. Recommended Production Architecture​

A professional GreenTeaSpeak installation should follow this structure:

Internet
│
▼
┌──────────────┐
│ Firewall │
└──────┬───────┘
│
┌────────────┼────────────┐
│ │ │
▼ ▼ ▼
UDP 9987 TCP 10101 Port 30303
Voice Server Query Service
│ │ │
└────────────┼────────────┘
▼
┌─────────────────┐
│ GreenTeaSpeak │
│ Server │
└─────────────────┘
│
▼
Dedicated Linux User
greenteaspeak
The recommended startup chain is:

teastart_minimal.sh
│
▼
Initial server initialization
│
▼
ServerAdmin Token
│
▼
Initial configuration
│
▼
teastart.sh
│
▼
Production server
│
▼
systemd

18. Installation Checklist​

Before considering the installation complete, verify:

  • GreenTeaSpeak has been extracted correctly
  • teastart_minimal.sh is executable
  • teastart.sh is executable
  • Initial server initialization completed
  • ServerAdmin token has been stored securely
  • Port 9987/UDP is reachable
  • Port 10101/TCP is configured
  • Port 30303 is configured according to the release
  • Firewall rules are configured
  • GreenTeaSpeak starts successfully
  • systemd is configured for automatic startup
  • Logs have been checked
  • A backup has been created

19. Installation Complete​

Your GreenTeaSpeak Server is now ready for operation.

The recommended production workflow is:

./teastart_minimal.sh
for the initial setup, followed by:

./teastart.sh
for normal operation.

For permanent production deployments, the server should subsequently be managed through systemd.

Your GreenTeaSpeak installation provides the following primary services:

9987 UDP Voice Communication
10101 TCP Server Query / Administration
30303 * GreenTeaSpeak Service Communication
Always verify the exact port and protocol requirements of the GreenTeaSpeak release you are deploying before applying firewall rules.


GreenTeaSpeak​

Modern Voice Communication Infrastructure

GreenTeaSpeak is designed to provide a modern, flexible, and reliable voice communication platform for communities, gaming networks, developers, and professional environments.
 
Top