summaryrefslogtreecommitdiff
path: root/docs/deployment
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2017-04-29 01:13:06 +0100
committerStephen Finucane <stephen@that.guru>2017-04-29 01:17:42 +0100
commitb3d0145df2d6103f9af99b875f4ad9c646429617 (patch)
tree407e4f4819ee87aa195004f928d6ff4391692946 /docs/deployment
parentb1aca0bbc176f680d8773dd2b5bc02aa1a9ad7ce (diff)
downloadpatchwork-b3d0145df2d6103f9af99b875f4ad9c646429617.tar
patchwork-b3d0145df2d6103f9af99b875f4ad9c646429617.tar.gz
docs: Emphasise the cron job
Having talked to a few folks deploying Patchwork, it appears not everyone is aware of/enabling the Patchwork cron job. Emphasise this feature by moving it to its own section. This section is marked as optional, given that it's not truly required but is helpful. Signed-off-by: Stephen Finucane <stephen@that.guru>
Diffstat (limited to 'docs/deployment')
-rw-r--r--docs/deployment/installation.rst37
1 files changed, 20 insertions, 17 deletions
diff --git a/docs/deployment/installation.rst b/docs/deployment/installation.rst
index 1b47223..a77e3a6 100644
--- a/docs/deployment/installation.rst
+++ b/docs/deployment/installation.rst
@@ -430,20 +430,6 @@ Next up, restart the nginx service:
$ sudo systemctl restart nginx
$ sudo systemctl status nginx
-Patchwork uses a cron script to clean up expired registrations and send
-notifications of patch changes (for projects with this enabled). Something like
-this in your crontab should work.
-
-::
-
- # m h dom mon dow command
- */10 * * * * cd patchwork; ./manage.py cron
-
-.. note::
-
- The frequency should be the same as the `NOTIFICATION_DELAY_MINUTES`
- setting, which defaults to 10 minutes.
-
Finally, browse to the instance using your browser of choice.
You may wish to take this opportunity to setup your projects and configure your
@@ -604,9 +590,9 @@ supports incoming mail and writing a little web app.
-------------------------------------------------------------
The `tools` directory of the Patchwork distribution contains a file named
-`post-receive.hook` which is a sample git hook that can be used to
+`post-receive.hook` which is a sample Git hook that can be used to
automatically update patches to the `Accepted` state when corresponding
-commits are pushed via git.
+commits are pushed via Git.
To install this hook, simply copy it to the `.git/hooks` directory on your
server, name it `post-receive`, and make it executable.
@@ -614,6 +600,23 @@ server, name it `post-receive`, and make it executable.
This sample hook has support to update patches to different states depending
on which branch is being pushed to. See the `STATE_MAP` setting in that file.
-If you are using a system other than git, you can likely write a similar hook
+If you are using a system other than Git, you can likely write a similar hook
using `pwclient` to update patch state. If you do write one, please contribute
it.
+
+(Optional) Configure the Patchwork Cron Job
+-------------------------------------------
+
+Patchwork can send notifications of patch changes. Patchwork uses a cron
+management command - ``manage.py cron`` - to send these notifications and to
+clean up expired registrations. To enable this functionality, add the following
+to your crontab::
+
+ # m h dom mon dow command
+ */10 * * * * cd patchwork; ./manage.py cron
+
+.. note::
+
+ The frequency should be the same as the ``NOTIFICATION_DELAY_MINUTES``
+ setting, which defaults to 10 minutes. Refer to the :doc:`configuration
+ guide <configuration>` for mor information.