aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/systemd.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/systemd.md b/docs/systemd.md
new file mode 100644
index 0000000..8804573
--- /dev/null
+++ b/docs/systemd.md
@@ -0,0 +1,28 @@
+### Service config for systemd
+The file chibisafe-example.service is to be moved to `/etc/systemd/system/chibisafe.service`
+
+You will need to edit the parameters:
+- `User` to be the username/uid of your chibisafe instance
+- `WorkingDirectory` to the **FULL** path to your chibisafe, `/home/chibisafe/chibisafe` for example.
+- `EnvironmentFile` the same as the above, with the addition of `/.env`, `/home/chibisafe/chibisafe/.env`
+
+### If you are using n/nvm you will also need to update the path to npm in `ExecStart`
+- For n this will likely be `/home/username/n/bin/npm`
+- You can also find this by running `whereis npm` in your terminal and copy the path from the output.
+
+Example below.
+
+```[Unit]
+Description=chibisafe, easy to use file uploader
+After=network.target
+
+[Service]
+Type=simple
+User=chibisafe
+WorkingDirectory=/home/chibisafe/chibisafe
+EnvironmentFile=/home/chibisafe/chibisafe/.env
+ExecStart=/usr/bin/npm run start
+Restart=always
+
+[Install]
+WantedBy=multi-user.target```