Custom Crons Directory - Revision history

SarahK at 21:20, 8 February 2023

2023-02-08T21:20:09Z

SarahK at 21:17, 8 February 2023

2023-02-08T21:17:25Z

Joshua at 20:13, 20 February 2019

2019-02-20T20:13:51Z

PeterB: Update "Remember" info box. - DOCS-6735

2018-09-11T14:08:59Z

Update "Remember" info box. - DOCS-6735

Matt: Created page with "The crons folder may be moved to any place above or below the docroot.
We recommend moving it to a non-public directory above your web root to..."

2015-06-11T14:37:45Z

Created page with "The crons folder may be moved to any place above or below the docroot. <div class="docs-alert-warning">We recommend moving it to a non-public directory above your web root to..."

New page

The crons folder may be moved to any place above or below the docroot.

<div class="docs-alert-warning">We recommend moving it to a non-public directory above your web root to prevent web based access.</div>

The files within the crons directory need to know where to find your WHMCS installation, and your WHMCS installation needs to know where to find the crons directory, so the relocation process involves editing two files.

1. Begin by choosing a new location for your crons directory and move the entire ''/crons/'' folder and contents to it.

2. Open the ''config.php'' file within the crons directory and follow the instructions within it to uncomment the WHMCS path line and provide the full path to your WHMCS installation. For example:

<source lang="php">
$whmcspath = '/home/username/public_html/whmcs/';
</source>

The above example assumes cPanel is being used, where "username" is the account username and "whmcs" is the directory containing the WHMCS installation.

<div class="docs-alert-info">'''REMEMBER:''' If you move the crons directory, when you upgrade WHMCS in future, you will need to update the cron files in your custom folder location and not upload the cron files to the default crons sub-directory or you will lose the benefits of moving them.</div>

3. Open the ''configuration.php'' file within your WHMCS installation root directory and add the following line to the bottom of the file so that WHMCS is able to locate your custom crons directory location and show you the correct paths you need to use for cron and piping command configuration within the admin interface.

<source lang="php">
$crons_dir = '/home/username/whmcs_crons/';
</source>

The above example assumes cPanel is being used, where "username" is the account username and "whmcs_crons" is the custom crons directory.

<div class="docs-alert-danger">If you have existing [[Cron Tasks]] configured before you make this change, you will need to update those to use the new directory path following making these changes.</div>

@@ Line 1: / Line 1: @@
-The crons folder may be moved to any place above or below the docroot.
+By default, the system stores cron-related items in the <tt>/crons/</tt> directory. We recommend moving the crons directory to a custom private directory above your web root. This will prevent web-based access and help to protect your WHMCS installation.
-<div class="docs-alert-warning">We recommend moving it to a non-public directory above your web root to prevent web based access.</div>
+== Moving the Crons Directory ==
 For steps to do this, see [https://help.whmcs.com/m/installation/l/1650302-moving-the-crons-directory Moving the Crons Directory].

← Older revision		Revision as of 21:17, 8 February 2023
Line 3:		Line 3:
	<div class="docs-alert-warning">We recommend moving it to a non-public directory above your web root to prevent web based access.</div>		<div class="docs-alert-warning">We recommend moving it to a non-public directory above your web root to prevent web based access.</div>

−	~~The files within the crons directory need~~ to ~~know where to find your WHMCS installation~~, ~~and your WHMCS installation needs to know where to find the crons directory, so the relocation process involves editing two files.~~	+	For steps to do this, see [https://help.whmcs.com/m/installation/l/1650302-moving-the-crons-directory Moving the Crons Directory].
−
−	~~1. Begin by choosing a new location for your crons directory and move the entire ''~~/~~crons~~/~~'' folder and contents to it~~.
−
−	2. ~~Open the ''config.php'' file within the crons directory and follow the instructions within it to uncomment the WHMCS path line and provide the full path to your WHMCS installation. For example:~~
−
−	~~<source lang="php">~~
−	~~$whmcspath = '~~/~~home~~/~~username~~/~~public_html~~/~~whmcs/';~~
−	~~</source>~~
−
−	~~The above example assumes cPanel is being used, where "username" is the account username and "whmcs" is the directory containing the WHMCS installation.~~
−
−	~~<div class="docs~~-~~alert~~-~~info">'''REMEMBER:''' After moving~~ the crons ~~directory, if you manually upgrade WHMCS in future, you will need to update the cron files in your custom folder location and not upload the cron files to the default crons sub~~-directory ~~or you will lose the benefits of moving them.</div>~~
−
−	3. Open the ''configuration.php'' file within your WHMCS installation root directory and add the following line to the bottom of the file so that WHMCS is able to locate your custom crons directory location and show you the ~~correct paths you need to use for cron and piping command configuration within the admin interface.~~
−
−	~~<source lang="php">~~
−	~~$crons_dir = '/home/username/whmcs_crons/';~~
−	~~</source>~~
−
−	~~The above example assumes cPanel is being used, where "username" is the account username and "whmcs_crons" is the custom crons directory.~~
−
−	~~<div class="docs-alert-danger">If you have existing [[Cron Tasks]~~] ~~or [[Email_Piping#Forwarder_Method\|Email Forwarders]] configured before you make this change, you will need to update those to use the new directory path following making these changes~~.~~</div>~~

← Older revision		Revision as of 20:13, 20 February 2019
Line 25:		Line 25:
	The above example assumes cPanel is being used, where "username" is the account username and "whmcs_crons" is the custom crons directory.		The above example assumes cPanel is being used, where "username" is the account username and "whmcs_crons" is the custom crons directory.

−	<div class="docs-alert-danger">If you have existing [[Cron Tasks]] configured before you make this change, you will need to update those to use the new directory path following making these changes.</div>	+	<div class="docs-alert-danger">If you have existing [[Cron Tasks]] or [[Email_Piping#Forwarder_Method\|Email Forwarders]] configured before you make this change, you will need to update those to use the new directory path following making these changes.</div>