khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-04 10:46:21 +07:00
Code Issues Packages Projects Releases Wiki Activity

added missing 'with' to sentence, wrapped lines

Browse Source
This commit is contained in:
Patric Lenhart
2016-06-22 12:48:42 +02:00
committed by Morris Jobke
parent 8d721e2b9b
commit 2dfea72fe2
1 changed files with 32 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
admin_manual/configuration_server/background_jobs_configuration.rst
View File

@@ -1,10 +1,20 @@
Defining Background Jobs
========================
A system like Nextcloud sometimes requires tasks to be done on a regular basis without the need for user interaction or hindering Nextcloud performance. For that purpose, as a system administrator, you can define background jobs (for example, database clean-ups) which are executed without any need for user interaction.
A system like Nextcloud sometimes requires tasks to be done on a regular basis
without the need for user interaction or hindering Nextcloud performance. For
that purpose, as a system administrator, you can define background jobs (for
example, database clean-ups) which are executed without any need for user
interaction.
These jobs are typically referred to as *cron jobs*. Cron jobs are commands or shell-based scripts that are scheduled to run periodically at fixed times, dates, or intervals. ``cron.php`` is an Nextcloud internal process that runs such background jobs on demand.
These jobs are typically referred to as *cron jobs*. Cron jobs are commands or
shell-based scripts that are scheduled to run periodically at fixed times,
dates, or intervals. ``cron.php`` is an Nextcloud internal process that runs
such background jobs on demand.
Nextcloud plug-in applications register actions with ``cron.php`` automatically to take care of typical housekeeping operations, such as garbage collecting of temporary files or checking for newly updated files using ``filescan()`` for externally mounted file systems.
Nextcloud plug-in applications register actions with ``cron.php`` automatically
to take care of typical housekeeping operations, such as garbage collecting of
temporary files or checking for newly updated files using ``filescan()`` for
externally mounted file systems.
Parameters
----------
@@ -18,12 +28,19 @@ You can choose between the following options:
Cron Jobs
---------
You can schedule cron jobs in three ways -- using AJAX, Webcron, or cron. The default method is to use AJAX. However, the recommended method is to use cron. The following sections describe the differences between each method.
You can schedule cron jobs in three ways -- using AJAX, Webcron, or cron. The
default method is to use AJAX. However, the recommended method is to use cron.
The following sections describe the differences between each method.
AJAX
~~~~
The AJAX scheduling method is the default option. Unfortunately, however, it is also the least reliable. Each time a user visits the Nextcloud page, a single background job is executed. The advantage of this mechanism is that it does not require access to the system nor registration with a third party service. The disadvantage of this mechanism, when compared to the Webcron service, is that it requires regular visits to the page for it to be triggered.
The AJAX scheduling method is the default option. Unfortunately, however, it is
also the least reliable. Each time a user visits the Nextcloud page, a single
background job is executed. The advantage of this mechanism is that it does not
require access to the system nor registration with a third party service. The
disadvantage of this mechanism, when compared to the Webcron service, is that it
requires regular visits to the page for it to be triggered.
.. note:: Especially when using the Activity App or external storages, where new
files are added, updated or deleted one of the two methods below should be
@@ -34,17 +51,21 @@ Webcron
By registering your Nextcloud ``cron.php`` script address at an external webcron
service (for example, easyCron_), you ensure that background jobs are executed
regularly. To use this type of service, your server you must be able to access
your server using the Internet. For example::
regularly. To use this type of service with your server, you must be able to
access your server using the Internet. For example::
URL to call: http[s]://<domain-of-your-server>/nextcloud/cron.php
Cron
~~~~
Using the operating system cron feature is the preferred method for executing regular tasks. This method enables the execution of scheduled jobs without the inherent limitations the Web server might have.
Using the operating system cron feature is the preferred method for executing
regular tasks. This method enables the execution of scheduled jobs without the
inherent limitations the Web server might have.
To run a cron job on a \*nix system, every 15 minutes, under the default Web server user (often, ``www-data`` or ``wwwrun``), you must set up the following cron job to call the **cron.php** script::
To run a cron job on a \*nix system, every 15 minutes, under the default Web
server user (often, ``www-data`` or ``wwwrun``), you must set up the following
cron job to call the **cron.php** script::
# crontab -u www-data -e
*/15 * * * * php -f /var/www/nextcloud/cron.php
@@ -54,7 +75,8 @@ You can verify if the cron job has been added and scheduled by executing::
# crontab -u www-data -l
*/15 * * * * php -f /var/www/nextcloud/cron.php
.. note:: You have to replace the path ``/var/www/nextcloud/cron.php`` with the path to your current Nextcloud installation.
.. note:: You have to replace the path ``/var/www/nextcloud/cron.php`` with the
path to your current Nextcloud installation.
.. note:: On some systems it might be required to call **php-cli** instead of **php**.