Difference between revisions of "Customising the Admin Directory"

From WHMCS Documentation

(Errors)
(Redirected page to Getting Started)
 
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].
 

Latest revision as of 20:16, 8 February 2023

Redirect to: