# TeaSpeak WHMCS Module - Quick Installation Guide

## 📋 Requirements

- **WHMCS**: 8.0 or higher
- **PHP**: 8.0 or higher
- **MySQL/MariaDB**: 5.7+ / 10.2+
- **PHP Extensions**: curl, json, pdo_mysql, mbstring

## 🚀 Quick Installation

### Step 1: Upload Files

Upload the module files to your WHMCS installation:

```bash
/path/to/whmcs/modules/servers/teamspeak/
/path/to/whmcs/modules/addons/teamspeak/
```

### Step 2: Activate Addon Module

1. Login to WHMCS Admin Area
2. Navigate to: **Setup > Addon Modules**
3. Find "TeaSpeak Provisioning"
4. Click **Activate**
5. Configure module settings:
   - License Key
   - Server Name
   - Port Range (Min/Max)
   - TSDNS Settings (if applicable)
   - Branding options

### Step 3: Add Server

1. Go to: **Setup > Products/Services > Servers**
2. Click **Add New Server**
3. Fill in details:
   - Name: Your server name
   - Hostname/IP: Your TeamSpeak server IP
   - Type: Select **TeaSpeak Provisioning Server**
   - ServerQuery Port: 10101 (default)
   - Username: ServerQuery username
   - Password: ServerQuery password
4. Click **Test Connection** to verify
5. Save

### Step 4: Create Product

1. Go to: **Setup > Products/Services > Products/Services**
2. Create a new product or edit existing
3. Module Settings:
   - Module: **TeaSpeak Provisioning Server**
   - Select your server from dropdown

### Step 5: Add Custom Fields

Add these custom fields to your product:

**Required:**

1. **Token**
   - Field Name: `Token`
   - Field Type: Text Box
   - Description: Admin Token
   - Show on Order Form: No

2. **Port**
   - Field Name: `Port`
   - Field Type: Text Box
   - Description: Server Port
   - Show on Order Form: No

3. **Subdomain** (only if using TSDNS)
   - Field Name: `Subdomain`
   - Field Type: Text Box
   - Description: TSDNS Subdomain
   - Show on Order Form: Yes
   - Required: Yes

### Step 6: Add Configurable Options

Create a configurable options group with:

1. **Slots**
   - Option Name: `Slots`
   - Option Type: Quantity
   - Description: Number of voice slots

2. **MBots**
   - Option Name: `MBots`
   - Option Type: Quantity
   - Description: Music bot limit

### Step 7: Test

1. Create a test order
2. Check if server is provisioned correctly
3. Test all functions in client area:
   - Start/Stop
   - Reinstall
   - Settings
   - Backups
   - Tokens
   - Bans

## 🎨 Enable Modern Design (Optional)

To use the Bootstrap 5 template:

1. Open `modules/servers/teamspeak/teamspeak.php`
2. Find the `teamspeak_ClientArea` function
3. Change template file:
   ```php
   // From:
   'tabOverviewReplacementTemplate' => 'templates/overview.tpl',
   
   // To:
   'tabOverviewReplacementTemplate' => 'templates/overview_modern.tpl',
   ```

## 🔄 Upgrading from Old Version

1. **Backup everything:**
   ```bash
   cp -r modules/servers/teamspeak /backup/
   cp -r modules/addons/teamspeak /backup/
   mysqldump -u username -p database_name > backup.sql
   ```

2. **Replace files:**
   - Upload new module files
   - Overwrite existing files

3. **Clear cache:**
   - WHMCS Admin > Utilities > System > Clear Cache

4. **Test:**
   - Test existing services
   - Create new test service
   - Verify all functions work

## ⚠️ Important Notes

- Custom field names are **case-sensitive** (`Token`, `Port`, `Subdomain`)
- Configurable option names are **case-sensitive** (`Slots`, `MBots`)
- Make sure ServerQuery port (10101) is accessible
- TSDNS is optional - only configure if needed
- Database structure is compatible with old version

## 🆘 Troubleshooting

### "Port does not exist in custom fields"
- Check custom field "Port" exists
- Field name must be exactly: `Port`
- Assigned to correct product

### "Slots parameter not found"
- Check configurable option "Slots" exists
- Option name must be exactly: `Slots`

### "Could not connect to TeamSpeak server"
- Verify IP address and port
- Check firewall rules
- Verify ServerQuery credentials
- Test connection from WHMCS server:
  ```bash
  telnet YOUR_IP 10101
  ```

### TSDNS not working
- Enable TSDNS in addon module settings
- Verify TSDNS API URL and key
- Check custom field "Subdomain" exists

## 📚 More Information

See `README.md` for detailed documentation.

---

**Version**: 3.0.0  
**Updated by**: Kevin Feiler / AVVGO  
**Original**: planetteaspeak.de