From 9c157a630fe4fc136b6d9f14c564d25d3a2f381a Mon Sep 17 00:00:00 2001 From: Ian Renton Date: Fri, 3 Oct 2025 14:41:22 +0100 Subject: [PATCH] README #5 --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index 7bd3a2f..c0d6c93 100644 --- a/README.md +++ b/README.md @@ -45,6 +45,42 @@ The software can take a few seconds to start up, mostly because it is downloadin If you see some errors on startup, check your configuration, e.g. in case you have specified a port for the web server that is already in use by something else. +### systemd configuration + +Create a file at `/etc/systemd/system/spothole.service`. Give it the following content, adjusting for the user you want to run it as and the directory in which you have installed it: + +``` +Unit] +Description=Spothole +After=syslog.target network.target + +[Service] +Type=simple +User=spothole +WorkingDirectory=/home/spothole/spothole +ExecStart=/home/spothole/spothole/.venv/bin/python /home/spothole/spothole/spothole.py --serve-in-foreground +Restart=on-abort + +[Install] +WantedBy=multi-user.target +``` + +Run the following: + +```bash +sudo systemctl daemon-reload +sudo systemctl enable spothole +sudo systemctl start spothole +``` + +Check the service has started up correctly with `sudo journalctl -u spothole -f`. + +### nginx Reverse Proxy configuration + +TODO nginx + +TODO certbot + ### Writing your own client TODO