Difference between revisions of "General Tab"

From WHMCS Documentation

(WHMCS System URL)
Line 1: Line 1:
 
<br/><br/>{{General Settings}}
 
<br/><br/>{{General Settings}}
 
+
The majority of this tab is self-explanatory and common to any piece of software.
+
===Company Name===
 
+
Enter your company name as you wish it to appear throughout the WHMCS Admin and Client Areas.
 +
 +
===Email Address===
 +
This is the default email address that will appear as the sender on all of the email that WHMCS sends to you and your customers.
 +
 +
===Domain===
 +
The URL for the domain that hosts your WHMCS installation.
 +
 +
===Logo URL===
 +
The URL for the logo image that will appear in email messages, on invoices, and in the WHMCS Client Area.
 +
 +
===Pay To Text===
 +
The text to display on invoices as the ''Pay To'' details.
 +
 
===WHMCS System URL===
 
===WHMCS System URL===
This setting defines the URL to use to access your WHMCS installation. This is based on the location of the files on your server. If possible, WHMCS attempts to set this value automatically during installation, or prompts you for it if you use the command line for installation. For example, <tt>http://www.example.com/members/</tt>.
+
This setting defines the URL to use to access your WHMCS installation. This is based on the location of the files on your server. If possible, WHMCS attempts to set this value automatically during installation. If you use the command line for installation, WHMCS will prompt you for this value. For example, <tt>http://www.example.com/members/</tt>.
 +
 
 +
We recommend installing an SSL certificate. This will let you enter the SSL URL to enable encrypted connections between WHMCS and your customers and between your staff and the Admin Area. For example, <tt>https://www.example.com/members/</tt>.
 +
 +
===System Theme===
 +
The system theme that you want to use for WHMCS's Client Area. We ship two by default:
 +
 +
* ''Twenty-One'' was introduced in WHMCS 8.1. We recommend that you use this system theme. For more information, see [[New_Twenty-One_Client_Area_Theme New Twenty-One Client Area Theme]].
 +
* ''Six'' was introduced in WHMCS 6.0. We plan to remove this system theme in a future WHMCS version.
 +
 +
In WHMCS 8.1 and higher, when you select a '''System Theme''', WHMCS will validate it for compatibility with the order form templates you use.
 +
 +
For information on developing your own custom system theme, see [https://developers.whmcs.com/themes/ Themes] in our [https://developers.whmcs.com/ Developer Documentation].
 
   
 
   
We recommend installing an SSL certificate. This will let you enter the SSL URL to enable encrypted connections between WHMCS and your customers and between your staff and the admin area. For example, <tt>https://www.example.com/members/</tt>.
 
 
 
===Limit Activity Log===
 
===Limit Activity Log===
The maximum number of System related entries that will be stored in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' or, prior to WHMCS 8.0, '''Utilities > [[Activity_Logs|Activity Log]]'''. System related entries are those where the user shows as '''System''' and associated to '''UserID 0'''.  Entries attributed to specific clients will be kept indefinitely for auditing purposes. Client specific log entries can be pruned via '''Utilities > System > [[System_Utilities#System_Cleanup|System Cleanup]]'''.
+
The maximum number of system-related entries to store in '''Configuration (<i class="fa fa-wrench" aria-hidden="true"></i>) > System Logs''' or, prior to WHMCS 8.0, '''Utilities > [[Activity_Logs|Activity Log]]'''. System-related entries display the '''System''' user and '''UserID 0'''.
 
+
   
 +
<div class="docs-alert-info">
 +
<span class="title">Other Entries</span><br />
 +
Entries for specific clients are stored indefinitely for auditing purposes. You can prune client-specific log entries at '''Utilities > System > [[System_Utilities#System_Cleanup|System Cleanup]]'''.
 +
</div>
 +
 
===Records to Display per Page===
 
===Records to Display per Page===
The number of records that will be displayed on pages such as view all clients, view all invoices etc.  
+
The number of records to display in the '''Clients''' list, lists of invoices, and other lists in WHMCS.
 
+
 
===Maintenance Mode===
 
===Maintenance Mode===
Enabling this option will prevent your customers from accessing the client area and display the error message you can set beneath, useful when performing upgrades or changes you don’t want them to see. As an admin you will still be able to see the client area but your clients will not. Both the API and Hooks will continue to function unobstructed while Maintenance Mode is enabled.
+
Enabling this option will prevent your customers from accessing the Client Area and display the '''Maintenance Mode Message''' (or redirect to another URL, if you enter a '''Maintenance Mode Redirect URL'''.
 
+
 +
<div class="docs-alert-warning">
 +
<span class="title">xyz</span><br />
 +
Admins will still be able to see the client area. Both the API and hooks will continue to function unobstructed while '''Maintenance Mode''' is enabled.
 +
</div>
 +
 +
===Maintenance Mode Message===
 +
If you enable '''Maintenance Mode''', your customers will see the message you enter here in the Client Area.
 +
 
===Maintenance Mode Redirect URL===
 
===Maintenance Mode Redirect URL===
When a URL is entered into this field, clients will be redirected there when maintenance mode is enabled, instead of seeing the maintenance message.
+
When you enter a URL here, clients will be redirected there when '''Maintenance Mode''' is enabled instead of seeing the maintenance message.
 
+
 
===Friendly URLs===
 
===Friendly URLs===
Search Engine [[Friendly_URLs|Friendly URLs]] are where a URL which once was "/knowledgebase.php?action=view&id=1" becomes "/knowledgebase/1/How_do_I_access_my_control_panel.html". You can enable these for the MarketConnect landing pages, announcements, downloads and knowledgebase sections of the WHMCS client area.
+
When you use Search Engine [[Friendly_URLs|Friendly URLs]], for example, a URL that looks like this:
 
+
WHMCS will automatically detect the best option based upon your server environment and highlight it with a green background. A different option can be selected and the status indicator will switch to ''Manual Override'':
+
<div class="source-cli">/knowledgebase.php?action=view&id=1</div>
 
+
* '''Fully Friendly Rewrite''' - Example: http://awesome.host/store/ssl-certificates/dv
+
becomes
* '''Friendly index.php''' - Example: http://awesome.host/index.php/store/ssl-certificates/dv
+
* '''Basic URLs''' - Example: http://awesome.host/index.php?rp=/store/ssl-certificates/dv
+
<div class="source-cli">/knowledgebase/1/How_do_I_access_my_control_panel.html</div>
 
+
A description of the system requirements of the different options is located on the full [[Friendly_URLs#URI_Path_Mode|Friendly URLs documentation page]].
+
You can enable these for the MarketConnect landing pages, announcements, downloads, and knowledgebase sections of the WHMCS Client Area.
 
+
To re-check your environment and reset to the recommended system detected setting, click the small square button of the circular arrow icon.
+
WHMCS will automatically detect the best option based upon your server environment and highlight it with a green background. If you select a different option, the status indicator will switch to ''Manual Override'':
 
+
An Advanced Settings option is also available to further customise how this feature behaves and is described in detail on the on the full [[Friendly_URLs#Advanced_Settings|Friendly URLs documentation page]]. We only recommend changing the advanced settings if you are confident maintaining your own mod_rewrite rules.
+
* '''Fully Friendly Rewrite''' — For example, <tt>http://awesome.host/store/ssl-certificates/dv</tt>
 +
* '''Friendly index.php''' — For example, <tt>http://awesome.host/index.php/store/ssl-certificates/dv</tt>
 +
* '''Basic URLs''' — For example, <tt>http://awesome.host/index.php?rp=/store/ssl-certificates/dv</tt>
 +
 +
For a description of the system requirements of the different options, see [[Friendly_URLs#URI_Path_Mode|Friendly URLs]].
 +
 +
To re-check your environment and reset to the recommended system detected setting, click the refresh button.
 +
 +
An '''Advanced Settings''' option is also available to further customise how this feature behaves. For more information, see [[Friendly_URLs#Advanced_Settings|Friendly URLs]]. We only recommend changing the advanced settings if you are confident maintaining your own <tt>mod_rewrite</tt> rules.

Revision as of 22:02, 20 November 2020



Company Name

Enter your company name as you wish it to appear throughout the WHMCS Admin and Client Areas.

Email Address

This is the default email address that will appear as the sender on all of the email that WHMCS sends to you and your customers.

Domain

The URL for the domain that hosts your WHMCS installation.

Logo URL

The URL for the logo image that will appear in email messages, on invoices, and in the WHMCS Client Area.

Pay To Text

The text to display on invoices as the Pay To details.

WHMCS System URL

This setting defines the URL to use to access your WHMCS installation. This is based on the location of the files on your server. If possible, WHMCS attempts to set this value automatically during installation. If you use the command line for installation, WHMCS will prompt you for this value. For example, http://www.example.com/members/.

We recommend installing an SSL certificate. This will let you enter the SSL URL to enable encrypted connections between WHMCS and your customers and between your staff and the Admin Area. For example, https://www.example.com/members/.

System Theme

The system theme that you want to use for WHMCS's Client Area. We ship two by default:

In WHMCS 8.1 and higher, when you select a System Theme, WHMCS will validate it for compatibility with the order form templates you use.

For information on developing your own custom system theme, see Themes in our Developer Documentation.

Limit Activity Log

The maximum number of system-related entries to store in Configuration () > System Logs or, prior to WHMCS 8.0, Utilities > Activity Log. System-related entries display the System user and UserID 0.

Other Entries
Entries for specific clients are stored indefinitely for auditing purposes. You can prune client-specific log entries at Utilities > System > System Cleanup.

Records to Display per Page

The number of records to display in the Clients list, lists of invoices, and other lists in WHMCS.

Maintenance Mode

Enabling this option will prevent your customers from accessing the Client Area and display the Maintenance Mode Message (or redirect to another URL, if you enter a Maintenance Mode Redirect URL.

xyz
Admins will still be able to see the client area. Both the API and hooks will continue to function unobstructed while Maintenance Mode is enabled.

Maintenance Mode Message

If you enable Maintenance Mode, your customers will see the message you enter here in the Client Area.

Maintenance Mode Redirect URL

When you enter a URL here, clients will be redirected there when Maintenance Mode is enabled instead of seeing the maintenance message.

Friendly URLs

When you use Search Engine Friendly URLs, for example, a URL that looks like this:

/knowledgebase.php?action=view&id=1

becomes

/knowledgebase/1/How_do_I_access_my_control_panel.html

You can enable these for the MarketConnect landing pages, announcements, downloads, and knowledgebase sections of the WHMCS Client Area.

WHMCS will automatically detect the best option based upon your server environment and highlight it with a green background. If you select a different option, the status indicator will switch to Manual Override:

For a description of the system requirements of the different options, see Friendly URLs.

To re-check your environment and reset to the recommended system detected setting, click the refresh button.

An Advanced Settings option is also available to further customise how this feature behaves. For more information, see Friendly URLs. We only recommend changing the advanced settings if you are confident maintaining your own mod_rewrite rules.