Difference between revisions of "TCAdmin"

From WHMCS Documentation
(→‎Adding a TCAdmin Server)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
== About this Module ==
 +
 +
The TCAdmin module allows you to add and manage TCAdmin servers in WHMCS.
 
{{Provisioning_Module}}
 
{{Provisioning_Module}}
 
==Adding a TCAdmin Server==
 
==Adding a TCAdmin Server==
Line 4: Line 7:
 
To add a TCAdmin server:
 
To add a TCAdmin server:
  
−
# 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'''.
+
# 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'''.
 
# Click '''Add New Server'''.
 
# Click '''Add New Server'''.
−
# Enter the server name.
+
# Select ''TCAdmin'' from the menu.
−
# For '''IP Address''', enter the hostname that you use to access TCAdmin.
+
# Enter the hostname or IP address.
−
# Select ''tcadmin'' from the menu.
+
# Enter the username and password or the access hash.
−
# Enter your TCAdmin username and password.
+
# Click '''Continue'''.
−
# Click '''Create Server'''.
+
# Enter the desired additional server details.
−
# Log in to TCAdmin and go to '''System Settings > Plugins > TC_GSAUTO > Configure'''.
+
# Click '''Save Changes'''.
 +
# In TCAdmin, go to '''System Settings > Plugins > TC_GSAUTO > Configure'''.
 
# In the '''Billing API Settings''' section, check '''Enable Billing API'''.
 
# In the '''Billing API Settings''' section, check '''Enable Billing API'''.
−
# Enter an email.
+
# Enter an email address.
 
# For '''Allowed IPs''', enter your WHMCS installation's IP address.
 
# For '''Allowed IPs''', enter your WHMCS installation's IP address.
 
# Click '''Save'''.
 
# Click '''Save'''.
  
−
==Setting up a TCAdmin Package==
+
== Creating a TCAdmin Product ==
  
−
To set up a TCAdmin package:
+
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'''. 
  
−
# 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'''.
+
=== Product Settings ===
−
# Click '''Create a New Product'''
+
 
−
# Select '''Other''' for '''Product Type'''.
+
Make certain to configure the following settings correctly:
−
# Enter a product name.
+
 
−
# Click '''Continue'''.
+
* For '''Game ID''', enter the [http://help.tcadmin.com/Game/Voice_Configuration game ID] from within TCAdmin.
−
# Configure the product as desired.
+
* For '''Voice ID''', enter <tt>TEAMSPEAK</tt> if you are configuring a TeamSpeak server.
−
# In the '''Module Settings''' tab, choose '''TCAdmin''' as the module.
+
* For '''Game Datacenter''', enter the [http://help.tcadmin.com/Server_Management datacenter ID] in TCAdmin.
−
# 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.
 
  
−
===Required Custom Fields===
+
=== Required Custom Fields ===
  
−
You must also use [[Custom_Fields|product custom fields]] to request the following additional '''required''' information from your users:
+
When you configure a product, you must also add [[Custom_Fields|product custom fields]] to request the following additional '''required''' information from your users:
  
 
<table class="table table-striped table-condensed">
 
<table class="table table-striped table-condensed">
 
<tr><th>Field Name</th><th>Type</th><th>Options</th></tr>
 
<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>'''Username'''</td><td>''Text Box''</td><td></td></tr>
−
<tr><td>Password</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>'''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>'''Host Name'''</td><td>''Text Box''</td><td></td></tr>
−
<tr><td>RCON Password</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>
+
<tr><td>'''Private Password'''</td><td>''Text Box''</td><td></td></tr>
 
</table>
 
</table>
  
−
===Optional Configurable Options===
+
=== Optional Configurable Options ===
  
 
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:
 
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:
Line 53: Line 53:
 
<table class="table table-striped table-condensed">
 
<table class="table table-striped table-condensed">
 
<tr><th>Option Name</th><th>Values</th></tr>
 
<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 Slots'''</td><td>1, 2, 3, 4, etc.</td></tr>
−
<tr><td>Game Private</td><td>Yes<br />No</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 Additional Slots'''</td><td>1, 2, 3, 4, etc.</td></tr>
−
<tr><td>Game Branded</td><td>Yes<br />No</td></tr>
+
<tr><td>'''Game Branded'''</td><td>Yes<br />No</td></tr>
 
</table>
 
</table>
 +
 +
=== WHMCS Connect ===
 +
 +
This module does not support [[WHMCS Connect]].
 +
 +
==Troubleshooting==
 +
 +
''N/A''
  
 
{{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


Retrieved from "http://3.17.75.209/index.php?title=TCAdmin&oldid=32565"