Customising the Admin Directory - Revision history

SarahK: Redirected page to Getting Started

2023-02-08T20:16:49Z

Redirected page to Getting Started

SarahK: /* Errors */

2023-02-08T18:15:21Z

‎Errors

Joshua: /* Errors */

2021-04-19T19:32:12Z

‎Errors

Matt: /* Renaming Your Admin Directory */

2015-12-09T16:57:02Z

‎Renaming Your Admin Directory

Matt: Remove cron path recommendation as in 6.0, paths should use crons directory

2015-07-06T09:47:18Z

Remove cron path recommendation as in 6.0, paths should use crons directory

Matt at 09:46, 6 July 2015

2015-07-06T09:46:41Z

Matt: /* Errors */

2014-09-02T11:27:55Z

‎Errors

Matt: Created page with "With many web based softwares, users know they can try visiting various common directory names to find admin control panels - for example "admin", "admincp", "manage", etc......"

2014-09-02T11:27:24Z

Created page with "With many web based softwares, users know they can try visiting various common directory names to find admin control panels - for example "admin", "admincp", "manage", etc......"

New page

With many web based softwares, users know they can try visiting various common directory names to find admin control panels - for example "admin", "admincp", "manage", etc...

So customising the location of your WHMCS admin area is one of many steps you can take in order to make the lives of malicious users looking for login forms that little bit harder.

There are some restrictions:

* You cannot move the admin directory outside of the WHMCS folder tree - so you can rename it, but not move it entirely
* The admin directory name may only contain standard a-z 0-9 latin characters as well as dashes(-), underscores(_) and dots(.)

==Renaming Your Admin Directory==

If you choose to rename your admin directory, you need to specify what you have called it within the WHMCS configuration.php file so that WHMCS can still find and use it. To do this, follow the steps below:

# Open the '''configuration.php''' file within your WHMCS installation's root directory
# At the bottom of the file (before the closing PHP tag ?> if one exists), add the following line:<source lang="php">$customadminpath = "mycustomfoldername";</source>
# Replacing mycustomfoldername with the name you wish to use for your admin directory. This should just be the directory name, not a full path.
# If your configuration.php file already contains a custom admin path definition, you can simply update the existing line
# Rename the admin directory to the name you specified in step 2 above

<div class="docs-alert-danger">
<span class="title">Important Note for Upgrading</span><br />
Remember! If you customise the name of your WHMCS admin directory, when it comes to applying updates or patches, it is important to remember to upload any files contained within the default "admin" directory in the distribution zip files to your custom admin directory folder. Failure to do this will result in unexpected behaviour.
</div>

Also note, if you have already setup your cron job, or one has been created for you, you will need to update the path on the cron as well inside your hosting control panel. For example:

php -q /home/username/public_html/secure/'''mycustomfoldername'''/cron.php

==Errors==

Should WHMCS detect a conflict between your settings and the admin directory path you are trying to access, you will see one of the error messages below. Details of how to resolve each one are provided.

'''You are attempting to access the admin area via a directory that is not configured. Please either revert to the default admin directory name, or see our documentation for Customising the Admin Directory</a>'''

Well you've come to the right place! What the above error message means is that you have not yet added the $customadminpath line to your WHMCS configuration.php file, or it has been done incorrectly. Please follow the steps above again. If you continue to experience the error message even after that, revert your admin directory name to the default "admin" name to regain access and contact our support team for assistance.

'''You are attempting to access the admin area via a directory that is different from the one configured. Please refer to the Customising the Admin Directory documentation for instructions on how to update it.'''

Seeing this error message indicates that the directory name you are attempting to access your admin area via is different to the value specified in the $customadminpath variable inside of your WHMCS configuration.php file. Follow the steps above in order to update it.

'''You are attempting to access the admin area via a custom directory, but we have detected the presence of a default "admin" directory too. This could indicate files from a recent update have been uploaded to the default admin path location instead of the custom one, resulting in these files being out of date. Please ensure your custom admin folder contains all the latest files, and delete the default admin directory to continue.'''

This is one of the most common mistakes we see. What this means is that you have a custom admin directory path defined, and are attempting to access your WHMCS installation using it, but WHMCS has also detected the presence of a default "admin" directory too. Typically this indicates that an update has recently been applied and some of the files from that update have been uploaded to the default "admin" directory path. In doing this, it means the files you are using in your custom admin directory are not up-to-date which can lead to unexpected errors and consequences. Please ensure you have uploaded all of the latest files to your custom admin directory location and then delete the default "admin" directory.

← Older revision		Revision as of 20:16, 8 February 2023
Line 1:		Line 1:
−	~~Customising the name of your WHMCS admin directory makes it harder for bots and other malicious users to find your admin login url.~~	+	#REDIRECT [[Getting Started]]
−
−	~~==Renaming Your Admin Directory==~~
−
−	~~The WHMCS software requires to know the name of the admin directory in order to function, so if you wish to change it, follow the steps below:~~
−
−	# ~~Open the '''configuration.php''' file within your WHMCS installation's root directory~~
−	~~# At the bottom of the file (before the closing PHP tag ?> if one exists), add the following line:<source lang="php">$customadminpath = "mycustomfoldername";</source>~~
−	~~# Replacing mycustomfoldername with the name you wish to use for your admin directory. This should just be the directory name, not a full path.~~
−	~~# If your configuration.php file already contains a custom admin path definition, you can simply update the existing line~~
−	~~# Rename the admin directory to the name you specified in step 2 above~~
−
−	~~<div class="docs-alert-info">~~
−	* You cannot move the admin directory outside of the WHMCS folder tree - you can rename it, but not move it
−	* The admin directory name may only contain alphanumeric a-z 0-9 latin characters as well as dashes(-) and underscores(_)
−	~~</div>~~
−
−	~~<div class="docs-alert-warning">~~
−	~~<span class="title">Important Note for Upgrading</span><br />~~
−	Remember! If you customise the name of your WHMCS admin directory, when it comes to applying updates or patches, it is important to remember to upload any files contained within the default "admin" directory in the distribution zip files to your custom admin directory folder. Failure to do this will result in unexpected behaviour.
−	~~</div>~~
−
−	~~==Errors==~~
−
−	~~Should WHMCS detect a conflict between your settings and the admin directory path you are trying to access, you will see an error message. For help with troubleshooting these errors, see~~ [~~https://help.whmcs.com/m/troubleshooting/l/1650308-troubleshooting-admin-directory-errors Troubleshooting Admin Directory Errors~~].

← Older revision		Revision as of 18:15, 8 February 2023
Line 23:		Line 23:
	==Errors==		==Errors==

−	Should WHMCS detect a conflict between your settings and the admin directory path you are trying to access, you will see ~~one of the error messages below. Details of how to resolve each one are provided.~~	+	Should WHMCS detect a conflict between your settings and the admin directory path you are trying to access, you will see an error message. For help with troubleshooting these errors, see [https://help.whmcs.com/m/troubleshooting/l/1650308-troubleshooting-admin-directory-errors Troubleshooting Admin Directory Errors].
−
−	~~===You are attempting to access the admin area via a directory that is not configured.===~~
−	~~'''Please either revert to the default admin directory name, or see our documentation for Customising the Admin Directory'''~~
−
−	~~Seeing this~~ error message indicates that you have not yet added the $customadminpath line to your WHMCS configuration.php file, or it has been done incorrectly. Please follow the steps above again. If you continue to experience the error message even after that, revert your admin directory name to the default "admin" name to regain access and contact our support team for assistance.
−
−	~~===You are attempting to access the admin area via a directory that is different from the one configured.===~~
−	~~'''Please refer to the Customising the Admin Directory documentation for instructions on how to update it.'''~~
−
−	Seeing this error message indicates that the directory name you are attempting to access your admin area via is different to the value specified in the $customadminpath variable inside of your WHMCS configuration.php file. Follow the steps above in order to update it.
−
−	~~===You are attempting to access the admin area via a custom directory, but we have detected the presence of a default "admin" directory too~~.~~===~~
−	~~'''This could indicate files from a recent update have been uploaded to the default admin path location instead of the custom one, resulting in~~ these ~~files being out of date. Please ensure your custom admin folder contains all the latest files~~, ~~and delete the default admin directory to continue~~.~~'''~~
−
−	Seeing this error message indicates that you have a custom admin directory path defined, and are attempting to access your WHMCS installation using it, but WHMCS has also detected the presence of a default "admin" directory too. Typically this indicates that an update has recently been applied and some of the files from that update have been uploaded to the default "admin" directory path. In doing this, it means the files you are using in your custom admin directory ~~are not up~~-~~to-date which can lead to unexpected~~ errors ~~and consequences. Please ensure you have uploaded all of the latest files to your custom admin directory location and then delete the default "admin" directory~~.

@@ Line 25: / Line 25: @@
 Should WHMCS detect a conflict between your settings and the admin directory path you are trying to access, you will see one of the error messages below.  Details of how to resolve each one are provided.
-'''You are attempting to access the admin area via a directory that is not configured. Please either revert to the default admin directory name, or see our documentation for Customising the Admin Directory'''
+===You are attempting to access the admin area via a directory that is not configured.===
 Seeing this error message indicates that you have not yet added the $customadminpath line to your WHMCS configuration.php file, or it has been done incorrectly.  Please follow the steps above again. If you continue to experience the error message even after that, revert your admin directory name to the default "admin" name to regain access and contact our support team for assistance.
-'''You are attempting to access the admin area via a directory that is different from the one configured. Please refer to the Customising the Admin Directory documentation for instructions on how to update it.'''
+===You are attempting to access the admin area via a directory that is different from the one configured.===
 Seeing this error message indicates that the directory name you are attempting to access your admin area via is different to the value specified in the $customadminpath variable inside of your WHMCS configuration.php file. Follow the steps above in order to update it.
-'''You are attempting to access the admin area via a custom directory, but we have detected the presence of a default "admin" directory too. This could indicate files from a recent update have been uploaded to the default admin path location instead of the custom one, resulting in these files being out of date. Please ensure your custom admin folder contains all the latest files, and delete the default admin directory to continue.'''
+===You are attempting to access the admin area via a custom directory, but we have detected the presence of a default "admin" directory too.===
 Seeing this error message indicates that you have a custom admin directory path defined, and are attempting to access your WHMCS installation using it, but WHMCS has also detected the presence of a default "admin" directory too.  Typically this indicates that an update has recently been applied and some of the files from that update have been uploaded to the default "admin" directory path.  In doing this, it means the files you are using in your custom admin directory are not up-to-date which can lead to unexpected errors and consequences.  Please ensure you have uploaded all of the latest files to your custom admin directory location and then delete the default "admin" directory.

@@ Line 13: / Line 13: @@
 <div class="docs-alert-info">
 * You cannot move the admin directory outside of the WHMCS folder tree - you can rename it, but not move it
-* The admin directory name may only contain standard a-z 0-9 latin characters as well as dashes(-), underscores(_) and dots(.)
+* The admin directory name may only contain alphanumeric a-z 0-9 latin characters as well as dashes(-) and underscores(_)
 </div>

@@ Line 16: / Line 16: @@
 </div>
-<div class="docs-alert-danger">
+<div class="docs-alert-warning">
 <span class="title">Important Note for Upgrading</span><br />
 Remember! If you customise the name of your WHMCS admin directory, when it comes to applying updates or patches, it is important to remember to upload any files contained within the default "admin" directory in the distribution zip files to your custom admin directory folder. Failure to do this will result in unexpected behaviour.
 </div>
 ==Errors==

@@ Line 1: / Line 1: @@
-With many web based softwares, users know they can try visiting various common directory names to find admin control panels - for example "admin", "admincp", "manage", etc...
+Customising the name of your WHMCS admin directory makes it harder for bots and other malicious users to find your admin login url.
 ==Renaming Your Admin Directory==
-If you choose to rename your admin directory, you need to specify what you have called it within the WHMCS configuration.php file so that WHMCS can still find and use it.  To do this, follow the steps below:
+The WHMCS software requires to know the name of the admin directory in order to function, so if you wish to change it, follow the steps below:
 # Open the '''configuration.php''' file within your WHMCS installation's root directory
@@ Line 17: / Line 10: @@
 # If your configuration.php file already contains a custom admin path definition, you can simply update the existing line
 # Rename the admin directory to the name you specified in step 2 above
 <div class="docs-alert-danger">
@@ Line 33: / Line 31: @@
 '''You are attempting to access the admin area via a directory that is not configured. Please either revert to the default admin directory name, or see our documentation for Customising the Admin Directory'''
-Well you've come to the right place!  What the above error message means is that you have not yet added the $customadminpath line to your WHMCS configuration.php file, or it has been done incorrectly.  Please follow the steps above again. If you continue to experience the error message even after that, revert your admin directory name to the default "admin" name to regain access and contact our support team for assistance.
+Seeing this error message indicates that you have not yet added the $customadminpath line to your WHMCS configuration.php file, or it has been done incorrectly.  Please follow the steps above again. If you continue to experience the error message even after that, revert your admin directory name to the default "admin" name to regain access and contact our support team for assistance.
 '''You are attempting to access the admin area via a directory that is different from the one configured. Please refer to the Customising the Admin Directory documentation for instructions on how to update it.'''
@@ Line 41: / Line 39: @@
 '''You are attempting to access the admin area via a custom directory, but we have detected the presence of a default "admin" directory too. This could indicate files from a recent update have been uploaded to the default admin path location instead of the custom one, resulting in these files being out of date. Please ensure your custom admin folder contains all the latest files, and delete the default admin directory to continue.'''
-This is one of the most common mistakes we see.  What this means is that you have a custom admin directory path defined, and are attempting to access your WHMCS installation using it, but WHMCS has also detected the presence of a default "admin" directory too.  Typically this indicates that an update has recently been applied and some of the files from that update have been uploaded to the default "admin" directory path.  In doing this, it means the files you are using in your custom admin directory are not up-to-date which can lead to unexpected errors and consequences.  Please ensure you have uploaded all of the latest files to your custom admin directory location and then delete the default "admin" directory.
+Seeing this error message indicates that you have a custom admin directory path defined, and are attempting to access your WHMCS installation using it, but WHMCS has also detected the presence of a default "admin" directory too.  Typically this indicates that an update has recently been applied and some of the files from that update have been uploaded to the default "admin" directory path.  In doing this, it means the files you are using in your custom admin directory are not up-to-date which can lead to unexpected errors and consequences.  Please ensure you have uploaded all of the latest files to your custom admin directory location and then delete the default "admin" directory.