Difference between revisions of "TCAdmin Specific Configuration"

From AWBS Wiki
Jump to: navigation, search
(→‎Setup the TCAdmin Server(s))
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
This document is written assuming you have the TCAdmin Server setup already.  If you need assistance with this, please contact [http://www.tcadmin.com/billing TCAdmin Support] (Click on the "Get Support" link once you are logged into submit tickets.)
 +
 +
More information about TCAdmin can be found in the [http://esupport.tcadmin.com/index.php?_m=knowledgebase&_a=view TCAdmin Knowledgebase], and the [http://clientforums.tcadmin.com/ TCAdmin Forums]
 +
 +
The TCAdmin module requires '''OUTGOING''' port 8082 '''OPEN''' on the firewall of your AWBS Server.
 +
''Note: If you have changed the TCAdmin Control port in your TCAdmin Server, then that port needs
 +
to be open instead.
 +
 
=== Setup Server Group(s) ===
 
=== Setup Server Group(s) ===
  
Line 14: Line 22:
 
*'''Server Name:''' Enter a server name for your reference in AWBS. Do not use spaces.
 
*'''Server Name:''' Enter a server name for your reference in AWBS. Do not use spaces.
 
*'''Server Group:''' Assign the server to the correct server group.
 
*'''Server Group:''' Assign the server to the correct server group.
−
*'''Server Type:''' TCAdmin (or TCAdmin 11)
+
*'''Server Type:''' TCAdmin
−
*'''Server IP:''' Enter the server's IP address
+
*'''Server IP:''' Enter the server's IP address (Some servers require this to be the hostname instead. eg - my.tcadmin.com)
 
*'''Server URL:''' Enter the url to the server. Example: ''<nowiki>http://my.TCAdminserver.com</nowiki>''
 
*'''Server URL:''' Enter the url to the server. Example: ''<nowiki>http://my.TCAdminserver.com</nowiki>''
 
*'''Server CP:''' Enter the url given to customers to login to their TCAdmin account control panel. Example: ''<nowiki>http://my.TCAdminserver.com</nowiki>''
 
*'''Server CP:''' Enter the url given to customers to login to their TCAdmin account control panel. Example: ''<nowiki>http://my.TCAdminserver.com</nowiki>''
Line 21: Line 29:
 
*'''Default NS1:''' Enter your TCAdmin nameserver 1 here <NOT REQUIRED>
 
*'''Default NS1:''' Enter your TCAdmin nameserver 1 here <NOT REQUIRED>
 
*'''Default NS2:''' Enter your TCAdmin nameserver 2 here <NOT REQUIRED>
 
*'''Default NS2:''' Enter your TCAdmin nameserver 2 here <NOT REQUIRED>
−
*'''Server User:''' Enter the TCAdmin username here. (Reseller account username or root)
+
*'''Server User:''' Enter the TCAdmin username here. (Must be an Admin user)
−
*'''Server Access Key:''' Paste the Server Access Key obtained in WHM when logged in as the user listed in the 'Server User' field. Do not paste the remarks at the top and bottom of the server access key.
+
*'''Server Password:''' Enter the TCAdmin Password for the above user here.
 +
*'''Control Port:''' The control port for TCAdmin, Typically 8082 or 80
 
*'''Update hosting list IP(s):''' Check if you are changing an existing TCAdmin server's IP address. This will update all existing hosting packages assigned to this server.
 
*'''Update hosting list IP(s):''' Check if you are changing an existing TCAdmin server's IP address. This will update all existing hosting packages assigned to this server.
 
*'''Update hosting list Servers:''' Check if you are changing the server's servername. This will update all existing hosting packages assigned to this server.
 
*'''Update hosting list Servers:''' Check if you are changing the server's servername. This will update all existing hosting packages assigned to this server.
Line 28: Line 37:
  
 
=== Configure your Hosting Package Types ===
 
=== Configure your Hosting Package Types ===
 +
 +
*Configure types for hosting packages. Each type will display a web page for ordering.
 +
*Use additional types to create multiple hosting order pages. Most people use the types to group their various hosting plan types, ''i.e. East Coast Servers, West Coast Servers.''
 +
*'''User Group:''' Should be Default unless you want this page only viewable by a different user group. ''(not the public)''
 +
*'''Server Group:''' Select the correct server group.
 +
*'''Description:''' Enter what you want displayed as the title on the web page with this type of hosting
 +
*'''Details1 Name - Details6 Name:''' Enter display text for the various specs for the plan type. This set of specs willl be used for all hosting plans in this type.
 +
 +
''Hint: Once you have added and saved a Hosting Package Type, you can click to view/edit it again and see the correct link to use on your menu for this web page.''
  
 
=== Configure your Hosting Plans ===
 
=== Configure your Hosting Plans ===
 +
 +
*'''Visible:''' Check if you want this plan to display on the web page.
 +
*'''Default Plan:''' Check if this is the default plan for the type. Each type needs to have one default plan.
 +
*'''Default Term:''' Enter the default term you want to display when your customers order. If you have other terms, they will get a selection to change it. Make sure the default term is a configured and available term for the plan.
 +
*'''Upgrade Group:''' Set the upgrade group. All plans in this group number will show up as selections when the customer chooses to upgrade their plan. All plans in the same group should be in the same server group for the auto upgrade/downgrade to function properly.
 +
*'''Package Name:''' Name the plan as you desire. Do not use any spaces.
 +
*'''Package Type:''' Select the correct package type for this plan.
 +
*'''Server Package:''' Not Required, Any name will work
 +
*'''Package Desc:''' Enter the plan description as you wish it to appear on the web page for ordering.
 +
*'''Reset BW on all existing user hosting:''' Not checked in TCAdmin
 +
*'''Reseller Plan:''' Not available for TCAdmin
 +
*'''Pricing:''' Enter prices for all terms you want to offer. Leave the fields blank if you don't want to offer them. Enter 0.00 if you want to offer them for free.
 +
*Check the Free Domain checkbox if you want to offer a free domain name with this plan/term. ''(Select available tlds for free domains in the system setup, TLD Setup/Pricing page by checking the Free Option checkbox beside the tld)''
 +
*Assign the correct Activation Email Template. Be sure to either add a new email template or edit the existing Hosting Activation email template as desired to give your customers all necessary information they need when their account is activated.
 +
*Complete the Package Display Text section with the plan's specs.
  
 
==== Game Server Hosting Packages ====
 
==== Game Server Hosting Packages ====
 +
 +
Edit/View the package(s) created in [[#Configure_your_Hosting_Plans|Configure your Hosting Plans]]
 +
 +
At the bottom of each page you should see '''Package Specifics (Needed by some Server CP's)'''
 +
 +
The following details will need to be entered for your TCAdmin to setup correctly:
 +
 +
*'''Main Game ID:''' This is the Main ID of the game that this plan should create, if you are going to allow them to change servers this should be the default game. The ID can be found in TCAdmin (System Settings -> Supported Games)
 +
*'''Number of Slots:''' Number of slots for this Game Server package.
 +
*'''Private Game:''' Does the game require a private password or not.
 +
*'''Skip Setup Page:''' When the servers are created, an email will be sent to the client to finish the setup, if you do not want this, you can set it to skip the setup page.
 +
*'''Game Datacenter:''' Enter the main Datacenter from your TCAdmin which controls your Game Servers. (Found in TCAdmin System Settings -> Datacenters)
 +
 +
''The above settings are the bare minimum that needs to be set in order to setup a Game Server via TCAdmin.  You can also make use of the following Optional Items:''
 +
 +
*'''Additional Slots:''' The game will be created with the number of slots specified, but you may wish them to add more slots, this is the number of additional Slots
 +
*'''Branded Game:''' Is the game to be branded
 +
*'''Additional Game Arguments:''' Any command line Arguments
 +
*'''Max At Once:''' Max number of game servers the client can use at once
 +
*'''Game Switch ID 1....25:''' You can set up to 25 different games for them to choose between this is the ID
 +
*'''Game Switch Slots 1....25:''' As above but how many slots that game can use.
  
 
==== Teamspeak (Voice) Packages ====
 
==== Teamspeak (Voice) Packages ====
 +
 +
Edit/View the package(s) created in [[#Configure_your_Hosting_Plans|Configure your Hosting Plans]]
 +
 +
At the bottom of each page you should see '''Package Specifics (Needed by some Server CP's)'''
 +
 +
The following details will need to be entered for your TCAdmin to setup correctly:
 +
 +
*'''Voice Server ID:''' Enter the word TEAMSPEAK into this box.
 +
*'''Voice Server Slots:''' Number of slots for this Teamspeak package.
 +
*'''Voice Server Private:''' If you want this to be listed as a 'Clan' Server select TRUE.
 +
*'''Voice Datacenter:''' Enter the main Datacenter from your TCAdmin which controls your Voice Servers. eg - TC0428708447606

Latest revision as of 13:07, August 26, 2008

This document is written assuming you have the TCAdmin Server setup already. If you need assistance with this, please contact TCAdmin Support (Click on the "Get Support" link once you are logged into submit tickets.)

More information about TCAdmin can be found in the TCAdmin Knowledgebase, and the TCAdmin Forums 

The TCAdmin module requires OUTGOING port 8082 OPEN on the firewall of your AWBS Server. 
Note: If you have changed the TCAdmin Control port in your TCAdmin Server, then that port needs
to be open instead.

Setup Server Group(s)

See Hosting Configuration page

Setup the TCAdmin Server(s)

Go to Server Setup and click Add New. Enter information asked for in the New Server Wizard. When you have completed adding all TCAdmin servers, go back to the server groups page and assign the correct default server. (Save the groups even if they show the correct default server)

Below are some details for your assistance:

  • Server Name: Enter a server name for your reference in AWBS. Do not use spaces.
  • Server Group: Assign the server to the correct server group.
  • Server Type: TCAdmin
  • Server IP: Enter the server's IP address (Some servers require this to be the hostname instead. eg - my.tcadmin.com)
  • Server URL: Enter the url to the server. Example: http://my.TCAdminserver.com
  • Server CP: Enter the url given to customers to login to their TCAdmin account control panel. Example: http://my.TCAdminserver.com
  • Server Cost: Enter your cost for this server. Used for reports only.
  • Default NS1: Enter your TCAdmin nameserver 1 here <NOT REQUIRED>
  • Default NS2: Enter your TCAdmin nameserver 2 here <NOT REQUIRED>
  • Server User: Enter the TCAdmin username here. (Must be an Admin user)
  • Server Password: Enter the TCAdmin Password for the above user here.
  • Control Port: The control port for TCAdmin, Typically 8082 or 80
  • Update hosting list IP(s): Check if you are changing an existing TCAdmin server's IP address. This will update all existing hosting packages assigned to this server.
  • Update hosting list Servers: Check if you are changing the server's servername. This will update all existing hosting packages assigned to this server.
  • Delete Record: Only check this box if you are deleting this server. Caution: DO NOT delete a server that has plans and user packages assigned!

Configure your Hosting Package Types

  • Configure types for hosting packages. Each type will display a web page for ordering.
  • Use additional types to create multiple hosting order pages. Most people use the types to group their various hosting plan types, i.e. East Coast Servers, West Coast Servers.
  • User Group: Should be Default unless you want this page only viewable by a different user group. (not the public)
  • Server Group: Select the correct server group.
  • Description: Enter what you want displayed as the title on the web page with this type of hosting
  • Details1 Name - Details6 Name: Enter display text for the various specs for the plan type. This set of specs willl be used for all hosting plans in this type.

Hint: Once you have added and saved a Hosting Package Type, you can click to view/edit it again and see the correct link to use on your menu for this web page.

Configure your Hosting Plans

  • Visible: Check if you want this plan to display on the web page.
  • Default Plan: Check if this is the default plan for the type. Each type needs to have one default plan.
  • Default Term: Enter the default term you want to display when your customers order. If you have other terms, they will get a selection to change it. Make sure the default term is a configured and available term for the plan.
  • Upgrade Group: Set the upgrade group. All plans in this group number will show up as selections when the customer chooses to upgrade their plan. All plans in the same group should be in the same server group for the auto upgrade/downgrade to function properly.
  • Package Name: Name the plan as you desire. Do not use any spaces.
  • Package Type: Select the correct package type for this plan.
  • Server Package: Not Required, Any name will work
  • Package Desc: Enter the plan description as you wish it to appear on the web page for ordering.
  • Reset BW on all existing user hosting: Not checked in TCAdmin
  • Reseller Plan: Not available for TCAdmin
  • Pricing: Enter prices for all terms you want to offer. Leave the fields blank if you don't want to offer them. Enter 0.00 if you want to offer them for free.
  • Check the Free Domain checkbox if you want to offer a free domain name with this plan/term. (Select available tlds for free domains in the system setup, TLD Setup/Pricing page by checking the Free Option checkbox beside the tld)
  • Assign the correct Activation Email Template. Be sure to either add a new email template or edit the existing Hosting Activation email template as desired to give your customers all necessary information they need when their account is activated.
  • Complete the Package Display Text section with the plan's specs.

Game Server Hosting Packages

Edit/View the package(s) created in Configure your Hosting Plans

At the bottom of each page you should see Package Specifics (Needed by some Server CP's)

The following details will need to be entered for your TCAdmin to setup correctly:

  • Main Game ID: This is the Main ID of the game that this plan should create, if you are going to allow them to change servers this should be the default game. The ID can be found in TCAdmin (System Settings -> Supported Games)
  • Number of Slots: Number of slots for this Game Server package.
  • Private Game: Does the game require a private password or not.
  • Skip Setup Page: When the servers are created, an email will be sent to the client to finish the setup, if you do not want this, you can set it to skip the setup page.
  • Game Datacenter: Enter the main Datacenter from your TCAdmin which controls your Game Servers. (Found in TCAdmin System Settings -> Datacenters)

The above settings are the bare minimum that needs to be set in order to setup a Game Server via TCAdmin. You can also make use of the following Optional Items:

  • Additional Slots: The game will be created with the number of slots specified, but you may wish them to add more slots, this is the number of additional Slots
  • Branded Game: Is the game to be branded
  • Additional Game Arguments: Any command line Arguments
  • Max At Once: Max number of game servers the client can use at once
  • Game Switch ID 1....25: You can set up to 25 different games for them to choose between this is the ID
  • Game Switch Slots 1....25: As above but how many slots that game can use.

Teamspeak (Voice) Packages

Edit/View the package(s) created in Configure your Hosting Plans

At the bottom of each page you should see Package Specifics (Needed by some Server CP's)

The following details will need to be entered for your TCAdmin to setup correctly:

  • Voice Server ID: Enter the word TEAMSPEAK into this box.
  • Voice Server Slots: Number of slots for this Teamspeak package.
  • Voice Server Private: If you want this to be listed as a 'Clan' Server select TRUE.
  • Voice Datacenter: Enter the main Datacenter from your TCAdmin which controls your Voice Servers. eg - TC0428708447606
Retrieved from "https://www.awbswiki.com/index.php?title=TCAdmin_Specific_Configuration&oldid=805"