Difference between revisions of "TCAdmin"

From WHMCS Documentation

(Setting up a TCAdmin Package)
Line 2: Line 2:
 
==Adding a TCAdmin Server==
 
==Adding a TCAdmin Server==
  
#Begin by going to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Servers''' or, prior to WHMCS 8.0, '''Setup > Products/Services > 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 and 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 inside WHMCS
+
# Click '''Add New Server'''.
#Now login to TCAdmin and go to '''System Settings > Plugins > TC_GSAUTO > Configure'''
+
# Enter the server name.
#Scroll down until you see the '''Billing API Settings''' section and then tick '''Enable Billing API''', enter an email where requested and enter the IP your WHMCS system is installed on into the '''Allowed IPs''' field.
+
# For '''IP Address''', enter the hostname that you use to access TCAdmin.
#Then save to finish.
+
# Select ''tcadmin'' from the menu.
 +
# Enter your TCAdmin username and password.
 +
# Click '''Create Server'''.
 +
# Log in to TCAdmin and go to '''System Settings > Plugins > TC_GSAUTO > Configure'''.
 +
# In the '''Billing API Settings''' section, check '''Enable Billing API'''.
 +
# Enter an email.
 +
# For '''Allowed IPs''', enter your WHMCS installation's IP address.
 +
# Click '''Save'''.
  
 
==Setting up a TCAdmin Package==
 
==Setting up a TCAdmin Package==
  
#Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
+
To set up a TCAdmin package:
#Click '''Create a New Product''', choose the product type '''Other''', enter a name, and click '''Continue'''.
+
 
#Fill out the product related fields such as description, pricing, etc.
+
# Go to '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Settings > Products/Services''' or, prior to WHMCS 8.0, '''Setup > Products/Services > Products/Services'''.
#Next, open the '''Module Settings''' tab and choose the module TCAdmin from the dropdown menu, the TCA options will then appear
+
# Click '''Create a New Product'''
#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.
+
# Select '''Other''' for '''Product Type'''.
* Game ID - Enter the [http://help.tcadmin.com/Game/Voice_Configuration Game ID] from within the TCAdmin Panel
+
# Enter a product name.
* To setup a Teamspeak server, enter "'''TEAMSPEAK'''" in the Voice ID field ''(Please note - all capitals - no quotes)''
+
# Click '''Continue'''.
* Game Datacenter - Enter the [http://help.tcadmin.com/Server_Management Datacenter ID] from within the TCAdmin Panel
+
# Configure the product as desired.
===Custom Fields===
+
# In the '''Module Settings''' tab, choose '''TCAdmin''' as the module.
 +
# Configure the TCAdmin settings that appear, making sure to configure the following settings correctly:
 +
#* '''Game ID''' — Enter the [http://help.tcadmin.com/Game/Voice_Configuration Game ID] from within TCAdmin.
 +
#* For TeamSpeak servers, enter <tt>TEAMSPEAK</tt> for '''Voice ID'''.
 +
#* Game Datacenter Enter the [http://help.tcadmin.com/Server_Management Datacenter ID] in TCAdmin.
  
There is some additional information you need to request from your users.  You can do this with the [[Custom_Fields|product custom fields]].  The required fields are as follows:
+
===Required Custom Fields===
  
Field Name: Username  - Type: Text Box
+
You must also use [[Custom_Fields|product custom fields]] to request the following additional '''required''' information from your users:
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
 
  
 +
<table class="table table-striped table-condensed">
 +
<tr><th>Field Name</th><th>Type</th><th>Options</th></tr>
 +
<tr><td>Username</td><td>Text Box</td><td></td></tr>
 +
<tr><td>Password</td><td>Text Box</td><td></td></tr>
 +
<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>
  
===Configurable Options===
+
===Optional Configurable Options===
  
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 [[Addons_and_Configurable_Options|configurable options]].  To set these up, go to the Configurable Options tab and setup options as below:
+
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:
  
Option Name: Game Slots - Option Values: 1,2,3,4,etc...
+
<table class="table table-striped table-condensed">
Option Name: Game Private - Option Values: Yes, No
+
<tr><th>Option Name</th><th>Values</th></tr>
Option Name: Game Additional Slots - Option Values: 1,2,3,4,etc...
+
<tr><td>Game Slots</td><td>1, 2, 3, 4, etc.</td></tr>
Option Name: Game Branded - Option Values: Yes, No
+
<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>
  
 
{{modules}}
 
{{modules}}

Revision as of 20:01, 28 September 2021

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. Enter the server name.
  4. For IP Address, enter the hostname that you use to access TCAdmin.
  5. Select tcadmin from the menu.
  6. Enter your TCAdmin username and password.
  7. Click Create Server.
  8. Log in to TCAdmin and go to System Settings > Plugins > TC_GSAUTO > Configure.
  9. In the Billing API Settings section, check Enable Billing API.
  10. Enter an email.
  11. For Allowed IPs, enter your WHMCS installation's IP address.
  12. Click Save.

Setting up a TCAdmin Package

To set up a TCAdmin package:

  1. Go to Configuration () > System Settings > Products/Services or, prior to WHMCS 8.0, Setup > Products/Services > Products/Services.
  2. Click Create a New Product
  3. Select Other for Product Type.
  4. Enter a product name.
  5. Click Continue.
  6. Configure the product as desired.
  7. In the Module Settings tab, choose TCAdmin as the module.
  8. Configure the TCAdmin settings that appear, making sure to configure the following settings correctly:
    • Game ID — Enter the Game ID from within TCAdmin.
    • For TeamSpeak servers, enter TEAMSPEAK for Voice ID.
    • Game Datacenter — Enter the Datacenter ID in TCAdmin.

Required Custom Fields

You must also use 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

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