summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDaniel Friesel <derf@finalrewind.org>2021-07-20 22:53:24 +0200
committerDaniel Friesel <derf@finalrewind.org>2021-07-20 22:53:24 +0200
commit7fa4f47bcd76ef4184e1cbf12ca53db73c8e2791 (patch)
tree8e6fc51babd2b291e4a7edcb7970023c282a4467 /README.md
parentbb2e464dd7575d3657c52a5153a22b2f210d2080 (diff)
README: Add update notes.
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/README.md b/README.md
index 697f004..df2eb5d 100644
--- a/README.md
+++ b/README.md
@@ -60,8 +60,12 @@ and set `PERL5LIB=.../local/lib/perl5` before running index.pl or wrap it
with `carton exec hypnotoad index.pl`.
Note that you should provide imprint and privacy policy pages. Depending on
-traffic volume, you may also want to increase the amount of worker processes.
-See the Setup notes below.
+traffic volume, you may also want to increase the amount of worker processes
+and install a caching proxy in front of DBF. See the Setup notes below.
+
+To update your DBF installation, run `git pull`, ensure that all files are
+readable by your www user, and re-run `carton install` or `cpanm --installdeps
+.`.
Installation with Docker
---
@@ -80,6 +84,9 @@ provide imprint and privacy policy pages, see the Setup notes below.
Use `docker run -e DBFAKEDISPLAY_WORKERS=4 ...` and similar to pass environment
variables to the db-infoscreen service.
+To update your Docker installation, fetch a new image from Docker Hub and
+re-start the container.
+
Setup
---
@@ -122,8 +129,7 @@ for a shell script.
DBF will periodically reload `share/zugbildungsplan.json`. You can use your
service supervisor (e.g. `systemctl reload db-infoscreen`) to force an
-immediate reload. You may also ignore the file entirely; it is entirely
-optional.
+immediate reload. You may also ignore the file; it is entirely optional.
System requirements
---