Difference between revisions of "TCAdmin"

From WHMCS Documentation

(Setting up a TCAdmin Package)
(Adding a TCAdmin Server)
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
== About this Module ==
 +
 +
The TCAdmin module allows you to add and manage TCAdmin servers in WHMCS.
 +
{{Provisioning_Module}}
 
==Adding a TCAdmin Server==
 
==Adding a TCAdmin Server==
  
#Begin by going to Configuration > Servers
+
To add a TCAdmin server:
#Click Add New Server
+
 
#Enter the server name, hostname used to access TCAdmin in the IP address field, select the server type "tcadmin" from the dropdown menu, and enter your TCAdmin username & password
+
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Servers]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Servers'''.
#The other fields can be left blank, simply click Create Server to complete the process
+
# Click '''Add New Server'''.
 +
# Select ''TCAdmin'' from the menu.
 +
# Enter the hostname or IP address.
 +
# Enter the username and password or the access hash.
 +
# Click '''Continue'''.
 +
# Enter the desired additional server details.
 +
# Click '''Save Changes'''.
 +
# In TCAdmin, go to '''System Settings > Plugins > TC_GSAUTO > Configure'''.
 +
# In the '''Billing API Settings''' section, check '''Enable Billing API'''.
 +
# Enter an email address.
 +
# For '''Allowed IPs''', enter your WHMCS installation's IP address.
 +
# Click '''Save'''.
 +
 
 +
== Creating a TCAdmin Product ==
 +
 
 +
You can create a product that provisions accounts on your XPanel server at '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > [[Products_and_Services|Products/Services]]''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''. 
 +
 
 +
=== Product Settings ===
 +
 
 +
Make certain to configure the following settings correctly:
 +
 
 +
* For '''Game ID''', enter the [http://help.tcadmin.com/Game/Voice_Configuration game ID] from within TCAdmin.
 +
* For '''Voice ID''', enter <tt>TEAMSPEAK</tt> if you are configuring a TeamSpeak server.
 +
* For '''Game Datacenter''', enter the [http://help.tcadmin.com/Server_Management datacenter ID] in TCAdmin.
 +
 
 +
=== Required Custom Fields ===
  
==Setting up a TCAdmin Package==
+
When you configure a product, you must also add [[Custom_Fields|product custom fields]] to request the following additional '''required''' information from your users:
  
#Go to Configuration > Products/Services
+
<table class="table table-striped table-condensed">
#Click Create a New Product, choose the product type "Other", enter a name, and click Continue
+
<tr><th>Field Name</th><th>Type</th><th>Options</th></tr>
#Fill out the product related fields such as description, pricing, etc... as normal
+
<tr><td>'''Username'''</td><td>''Text Box''</td><td></td></tr>
#Next, open the Module Settings tab and choose the module TCAdmin from the dropdown menu, the TCA options will then appear
+
<tr><td>'''Password'''</td><td>''Text Box''</td><td></td></tr>
#You then need to configure those settings but certain ones can be left to the user to select on the order form, these are described in more detail below.
+
<tr><td>'''Datacenter'''</td><td>''Drop Down''</td><td>TCXXXXXXX|Friendly Name<br />TCXXXXXXXX|Friendly Name</td></tr>
 +
<tr><td>'''Host Name'''</td><td>''Text Box''</td><td></td></tr>
 +
<tr><td>'''RCON Password'''</td><td>''Text Box''</td><td></td></tr>
 +
<tr><td>'''Private Password'''</td><td>''Text Box''</td><td></td></tr>
 +
</table>
  
* To setup a Teamspeak server, enter "'''TEAMSPEAK'''" in the Voice ID field ''(Please note - all capitals - no quotes)''
+
=== Optional Configurable Options ===
  
===Custom Fields===
+
You can use [[Addons_and_Configurable_Options|configurable options]] to allow your users to choose the number of slots they want, whether they want a public or private server, and whether it should have branding using the following options:
  
There is some additional information you need to request from your users. You can do this with the custom fields. The required fields are as follows:
+
<table class="table table-striped table-condensed">
 +
<tr><th>Option Name</th><th>Values</th></tr>
 +
<tr><td>'''Game Slots'''</td><td>1, 2, 3, 4, etc.</td></tr>
 +
<tr><td>'''Game Private'''</td><td>Yes<br />No</td></tr>
 +
<tr><td>'''Game Additional Slots'''</td><td>1, 2, 3, 4, etc.</td></tr>
 +
<tr><td>'''Game Branded'''</td><td>Yes<br />No</td></tr>
 +
</table>
  
Field Name: Username  - Type: Text Box
+
=== WHMCS Connect ===
Field Name: Password  - Type: Text Box
 
Field Name: Datacenter  - Type: Drop Down  - Field Options: TCXXXXXXX|Friendly Name,TCXXXXXXXX|Friendly Name
 
Field Name: Host Name  - Type: Text Box
 
Field Name: RCON Password  - Type: Text Box
 
Field Name: Private Password  - Type: Text Box
 
  
===Configurable Options===
+
This module does not support [[WHMCS Connect]].
  
You can allow your users to choose the number of slots they want, whether they want a public or private server and whether it should have branding or not with configurable options.  To set these up, go to the Configurable Options tab and setup options as below:
+
==Troubleshooting==
  
Option Name: Game Slots  - Option Values: 1,2,3,4,etc...
+
''N/A''
Option Name: Game Private  - Option Values: Yes, No
 
Option Name: Game Additional Slots  - Option Values: 1,2,3,4,etc...
 
Option Name: Game Branded  - Option Values: Yes, No
 
  
 
{{modules}}
 
{{modules}}

Latest revision as of 20:22, 5 May 2022

About this Module

The TCAdmin module allows you to add and manage TCAdmin servers in WHMCS.

Supported Features

Create Suspend Unsuspend Terminate
Yes Yes Yes Yes
Change Package Change Password Usage Updates Client Area Link
No No No No


Adding a TCAdmin Server

To add a TCAdmin server:

  1. Go to Configuration () > System Settings > Servers or, prior to WHMCS 8.0, Setup > Products/Services > Servers.
  2. Click Add New Server.
  3. Select TCAdmin from the menu.
  4. Enter the hostname or IP address.
  5. Enter the username and password or the access hash.
  6. Click Continue.
  7. Enter the desired additional server details.
  8. Click Save Changes.
  9. In TCAdmin, go to System Settings > Plugins > TC_GSAUTO > Configure.
  10. In the Billing API Settings section, check Enable Billing API.
  11. Enter an email address.
  12. For Allowed IPs, enter your WHMCS installation's IP address.
  13. Click Save.

Creating a TCAdmin Product

You can create a product that provisions accounts on your XPanel server at Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.

Product Settings

Make certain to configure the following settings correctly:

  • For Game ID, enter the game ID from within TCAdmin.
  • For Voice ID, enter TEAMSPEAK if you are configuring a TeamSpeak server.
  • For Game Datacenter, enter the datacenter ID in TCAdmin.

Required Custom Fields

When you configure a product, you must also add product custom fields to request the following additional required information from your users:

Field NameTypeOptions
UsernameText Box
PasswordText Box
DatacenterDrop DownTCXXXXXXX|Friendly Name
TCXXXXXXXX|Friendly Name
Host NameText Box
RCON PasswordText Box
Private PasswordText Box

Optional Configurable Options

You can use configurable options to allow your users to choose the number of slots they want, whether they want a public or private server, and whether it should have branding using the following options:

Option NameValues
Game Slots1, 2, 3, 4, etc.
Game PrivateYes
No
Game Additional Slots1, 2, 3, 4, etc.
Game BrandedYes
No

WHMCS Connect

This module does not support WHMCS Connect.

Troubleshooting

N/A

Server Modules
cPanel/WHM - DirectAdmin - Plesk - Helm 3 - Helm 4 - Ensim - InterWorx - WebsitePanel - Cloudmin
Lxadmin - Virtualmin Pro - XPanel - HyperVM - SolusVM - Cloudmin - WHMSonic - VPS.Net
CentovaCast - SCPanel - MediaCP - GameCP - TCAdmin - Reseller Central - Auto Release - Heart Internet

Registrar Modules
Enom - ResellerClub - Nominet - OpenSRS - ResellOne - OnlineNIC - PlanetDomain - Affordable Domains
TPP Wholesale - TPPInternet - Stargate - Namecheap - NetEarthOne - Bizcn - InternetBS - GMO Internet
12Register - Registercom - DotDNS - WebNIC - Dot.TK - HexoNet - Realtime Register - Registereu
RRPProxy - ResellerCamp - TransIP - Heart Internet - IPMirror - NetRegistry - OVH - VentraIP Wholesale
Email - 101Domain

Fraud Modules
MaxMind - VariLogiX FraudCall - Telesign

Gateway Modules
2CheckOut - AsiaPay - Auth.net Echeck - Authorize.net - Authorize.net CIM - Bank Transfer - BidPay
BluePay - BluePay Echeck - BluePay Remote - Boleto - CashU - CC Avenue - ChronoPay - Direct Debit
EMatters - E-Path - eProcessingNetwork - eWAY Tokens - F2B - Finansbank - GarantiBank - Gate2Shop
Inpay - InternetSecure - IP.Pay - Kuveytturk - Modulo Moip - Mail In Payment - Merchant Partners
Merchant Warrior - IDEALMollie - Moneris - Moneris Vault - Skrill 1-Tap - NaviGate - NETbilling
Netregistry Pay - NoChex - Offline Credit Card - Optimal Payments - PagSeguro - Payflow Pro - Pay Junction
Paymate AU and NZ - Payment Express - PayPal - PayPal Card Payments - PayPal Express Checkout
PayPal Payments - PayPal Payments Pro - PayPoint.net (SecPay) - Payson - Planet Authorize - ProtX VSP Form
PSIGate - Quantum Gateway - Quantum Vault - SagePay - SagePay Tokens v2 - SecurePay
SecurePay AU - Secure Trading - TrustCommerce - USA ePay - WorldPay - WorldPay Invisible