diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/administration.rst | 1 | ||||
| -rw-r--r-- | doc/administration/cronjobs.rst | 29 |
2 files changed, 30 insertions, 0 deletions
diff --git a/doc/administration.rst b/doc/administration.rst index 7aa2393..706a4cb 100644 --- a/doc/administration.rst +++ b/doc/administration.rst @@ -9,6 +9,7 @@ Administration Guide administration/configuration administration/upgrading administration/backup + administration/cronjobs administration/custom-pages This guide contains information pertaining to the administration of a Fietsboek diff --git a/doc/administration/cronjobs.rst b/doc/administration/cronjobs.rst new file mode 100644 index 0000000..a7d1a95 --- /dev/null +++ b/doc/administration/cronjobs.rst @@ -0,0 +1,29 @@ +Cronjobs +======== + +There are some maintenance jobs that should be done at regular intervals to +keep the instance running smoothly: + +* Old, abandoned uploads should be deleted from the database to free up the + space of the temporary GPX files. +* Tracks that are not present in the cache should have their cache entry + populated by pre-calculating their length/uphill/downhill/… values. This + makes accessing those values faster when a user requests the track's details. + +Fietsboek comes with a script to deal with those jobs: ``fietscron``. You can +run it like this:: + + fietscron -c path_to_config.ini + +You can use any mechanism you like to run this command at pre-defined intervals +(e.g. once an hour). You can find information about this in various sources: + +* https://wiki.archlinux.org/title/Systemd/Timers +* https://wiki.archlinux.org/title/Cron +* https://wiki.gentoo.org/wiki/Cron + +For example, the classic *cron*-way to run ``fietscron`` once per hour would be +to add the following to your *crontab* (using ``crontab -e``):: + + 0 * * * * /path/to/venv/bin/fietscron -c /path/to/settings.ini + |