plugins:cronjobs
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
plugins:cronjobs [2015/06/06 04:50] nuxwin |
plugins:cronjobs [2015/06/10 23:02] (current) ninos [Jailed] |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| <WRAP center round important 60%> | <WRAP center round important 60%> | ||
| - | This documentation is for to the latest version available in our plugins store. For an oldest documentation, see the README file inside the plugin archive. | + | This documentation is for to the latest version available in our plugins store. For an oldest documentation, see the **README** file inside the plugin archive. |
| </WRAP> | </WRAP> | ||
| - | ## Introduction | + | ===== Introduction ===== |
| This plugin provides a cron time-based job scheduler. | This plugin provides a cron time-based job scheduler. | ||
| Line 15: | Line 15: | ||
| Each cron job is added in the crontab file (see crontab(5)) that belongs to the UNIX user under which the cron command must be run. For customers, this is the Web user as created by i-MSCP. | Each cron job is added in the crontab file (see crontab(5)) that belongs to the UNIX user under which the cron command must be run. For customers, this is the Web user as created by i-MSCP. | ||
| - | ## Requirements | + | ===== Requirements ===== |
| - | - i-MSCP version >= 1.2.3 | + | * i-MSCP version >= 1.2.3 |
| - | ### Requirements for jailed cron jobs support | + | ==== Requirements for jailed cron jobs support ==== |
| - | - i-MSCP InstantSSH plugin >= 3.2.0 | + | * i-MSCP InstantSSH plugin >= 3.2.0 |
| - | #### Debian / Ubuntu packages | + | === Debian / Ubuntu packages === |
| - | - msmtp | + | * msmtp |
| You can install this package by executing the following command: | You can install this package by executing the following command: | ||
| - | # aptitude update && aptitude install msmtp | + | # aptitude update && aptitude install msmtp |
| - | Note: The msmtp package is required to allow cron to send email notifications from the jailed environment | + | **Note:** The msmtp package is required to allow cron to send email notifications from the jailed environment |
| - | ## Installation | + | ===== Installation ===== |
| - | 1. Be sure that all requirements as stated in the requirements section are meets | + | - Be sure that all requirements as stated in the requirements section are meets |
| - | 2. Install the InstantSSH plugin if you want jailed cron jobs support | + | - Install the InstantSSH plugin if you want jailed cron jobs support |
| - | 3. Upload the plugin through the plugin management interface | + | - Upload the plugin through the plugin management interface |
| - | 4. Install the plugin through the plugin management interface | + | - Install the plugin through the plugin management interface |
| - | Note: Depending on your system and if support for jailed cron jobs is available, installation can take up to several minutes. Time is needed to build jail. | + | **Note:** Depending on your system and if support for jailed cron jobs is available, installation can take up to several minutes. Time is needed to build jail. |
| - | ## Update | + | ===== Update ===== |
| - | 1. Be sure that all requirements as stated in the requirements section are meets | + | - Be sure that all requirements as stated in the requirements section are meets |
| - | 2. Backup your plugin configuration file if needed | + | - Backup your plugin configuration file if needed |
| - | 3. Upload the plugin through the plugin management interface | + | - Upload the plugin through the plugin management interface |
| - | 4. Restore your plugin configuration file if needed ( compare it with the new version first ) | + | - Restore your plugin configuration file if needed ( compare it with the new version first ) |
| - | 5. Update the plugin list through the plugin management interface | + | - Update the plugin list through the plugin management interface |
| - | Note: Prior any update attempt, do not forget to read the UPDATE file inside the plugin archive. | + | **Note:** Prior any update attempt, do not forget to read the **UPDATE** file inside the plugin archive. |
| - | ## Activation of jailed cron jobs support | + | ===== Activation of jailed cron jobs support ===== |
| If this plugin is already activated and if you want enable support for jailed cron jobs later on, you must follow these instructions: | If this plugin is already activated and if you want enable support for jailed cron jobs later on, you must follow these instructions: | ||
| - | 1. Install the InstantSSH plugin | + | - Install the InstantSSH plugin |
| - | 2. Deactivate this plugin through the plugin management interface | + | - Deactivate this plugin through the plugin management interface |
| - | 3. Re-activate this plugin through the plugin management interface | + | - Re-activate this plugin through the plugin management interface |
| - | ## Cron job types | + | ===== Cron job types ===== |
| Three types of cron jobs are available, which are in order: URL, Jailed and Full. | Three types of cron jobs are available, which are in order: URL, Jailed and Full. | ||
| - | ### URL | + | ==== URL ==== |
| The URL cron jobs are always available. They allow to schedule URL commands executed via GNU Wget. The commands must be valid HTTP(s) URLs. | The URL cron jobs are always available. They allow to schedule URL commands executed via GNU Wget. The commands must be valid HTTP(s) URLs. | ||
| - | Note: When a customer has permission for jailed cron jobs, the URL cron jobs are run inside the jailed environment, else they are run outside the jailed environment. This is by design, and this do not change anything from the customer point of view. | + | **Note:** When a customer has permission for jailed cron jobs, the URL cron jobs are run inside the jailed environment, else they are run outside the jailed environment. This is by design, and this do not change anything from the customer point of view. |
| - | ### Jailed | + | ==== Jailed ==== |
| The jailed cron jobs allow to schedule Shell commands which are run through the Shell interpreter in a jailed | The jailed cron jobs allow to schedule Shell commands which are run through the Shell interpreter in a jailed | ||
| environment. By default the plugin will create a jailed environment which provides: | environment. By default the plugin will create a jailed environment which provides: | ||
| - | - GNU Wget | + | * GNU Wget |
| - | - PHP (CLI) and some PHP modules ( mysqlnd, pdo, gd, intl, json, mcrypt, mysql, mysqli, pdo_mysql, readline ) | + | * PHP (CLI) and some PHP modules ( mysqlnd, pdo, gd, intl, json, mcrypt, mysql, mysqli, pdo_mysql, readline ) |
| - | - Mysql monitor and mysqldump | + | * Mysql monitor and mysqldump |
| - | - A set of common UNIX utilities | + | * A set of common UNIX utilities |
| - | Note: Only one jailed environment is created for all jailed cron jobs. The most important here, is that the cron jobs | + | **Note:** Only one jailed environment is created for all jailed cron jobs. The most important here, is that the cron jobs cannot break the whole system. |
| - | cannot broke the whole system. | + | |
| - | #### Availability | + | === Availability === |
| The jailed cron jobs are available only when the i-MSCP InstantSSH plugin is also installed. This plugin reuses the jail builder library which is provided by the InstantSSH plugin to manage the jailed environment. | The jailed cron jobs are available only when the i-MSCP InstantSSH plugin is also installed. This plugin reuses the jail builder library which is provided by the InstantSSH plugin to manage the jailed environment. | ||
| Line 89: | Line 88: | ||
| The jailed cron jobs doesn't apply to administrators. | The jailed cron jobs doesn't apply to administrators. | ||
| - | ### Full | + | ==== Full ==== |
| The full cron jobs are identical to the jailed cron jobs, excepted the fact that the Shell commands are not run inside a jailed environment. Such cron jobs should be reserved to trusted users. | The full cron jobs are identical to the jailed cron jobs, excepted the fact that the Shell commands are not run inside a jailed environment. Such cron jobs should be reserved to trusted users. | ||
| - | ## Crontab files | + | ===== Crontab files ===== |
| The plugin handles the crontab files automatically. You must note that any manual change made in a crontab file which is under the control of this plugin will be automatically overridden on next processing. Therefore, once that a crontab file is under the control of this plugin, you must use the cron jobs interface provided by this plugin to add, edit or delete a cron job in this file. | The plugin handles the crontab files automatically. You must note that any manual change made in a crontab file which is under the control of this plugin will be automatically overridden on next processing. Therefore, once that a crontab file is under the control of this plugin, you must use the cron jobs interface provided by this plugin to add, edit or delete a cron job in this file. | ||
| Line 99: | Line 98: | ||
| A crontab file is under the control of this plugin as soon as you add a cron task for the user to which it belong to, through the cron jobs interface provided by this plugin. | A crontab file is under the control of this plugin as soon as you add a cron task for the user to which it belong to, through the cron jobs interface provided by this plugin. | ||
| - | ## Interfaces access | + | ===== Interfaces access ===== |
| - | ### Cron jobs permissions interface | + | ==== Cron jobs permissions interface ==== |
| The cron job permissions interface allow to give cron job permissions, either to the resellers in the context of the administrators, or to customers in the context of resellers. | The cron job permissions interface allow to give cron job permissions, either to the resellers in the context of the administrators, or to customers in the context of resellers. | ||
| - | - Administrators can access the cron job permissions interface through the settings menu | + | * Administrators can access the cron job permissions interface through the settings menu |
| - | - Resellers can access the cron job permissions interface through the Customers menu | + | * Resellers can access the cron job permissions interface through the Customers menu |
| - | Note: When cron job permissions are updated, any cron job which doesn't fit with the new permissions are simply deleted. For instance, if the execution frequency of a specific cron job is lower than the new cron jobs frequency limit, the cron job is automatically removed. | + | **Note:** When cron job permissions are updated, any cron job which doesn't fit with the new permissions are simply deleted. For instance, if the execution frequency of a specific cron job is lower than the new cron jobs frequency limit, the cron job is automatically removed. |
| - | ### Cron jobs interface | + | ==== Cron jobs interface ==== |
| The cron jobs interface allows administrators and customers to add, edit and delete cron jobs. | The cron jobs interface allows administrators and customers to add, edit and delete cron jobs. | ||
| - | - Administrators can access the cron jobs interface through the System tools menu | + | * Administrators can access the cron jobs interface through the System tools menu |
| - | - Customers can access the cron jobs interface through the Webtools menu | + | * Customers can access the cron jobs interface through the Webtools menu |
| - | ## Configuration | + | ===== Configuration ===== |
| See the config.php file inside the archive. | See the config.php file inside the archive. | ||
| - | Note: When changing a configuration parameter in the plugin configuration file, do not forget to trigger plugin change by updating the plugin list through the plugin management interface. | + | **Note:** When changing a configuration parameter in the plugin configuration file, do not forget to trigger plugin change by updating the plugin list through the plugin management interface. |
| - | ## Translation | + | ===== License ===== |
| - | You can translate this plugin through the Transifex Localization Platform which is available at | + | i-MSCP CronJobs plugin |
| - | https://www.transifex.com/organization/i-mscp/dashboard/cronjobs | + | |
| + | @author Laurent Declercq <l.declercq@nuxwin.com> | ||
| + | @copyright (C) 2014-2015 Laurent Declercq | ||
| + | @license i-MSCP License <http://www.i-mscp.net/license-agreement.html> | ||
| - | ## License | + | See the **LICENSE** file inside the plugin archive for further details. |
| - | + | ||
| - | i-MSCP CronJobs plugin | + | |
| - | + | ||
| - | @author Laurent Declercq <[email protected]> | + | |
| - | @copyright (C) 2014-2015 Laurent Declercq | + | |
| - | @license i-MSCP License <http://www.i-mscp.net/license-agreement.html> | + | |
| - | + | ||
| - | See the LICENSE file inside the plugin archive for further details. | + | |
/var/www/virtual/i-mscp.net/wiki/htdocs/data/attic/plugins/cronjobs.1433566203.txt.gz · Last modified: 2015/06/06 04:50 by nuxwin
