summary refs log tree commit diff
path: root/contrib/systemd/README.md
diff options
context:
space:
mode:
authorClifford Garwood II <cliff@cigii.com>2019-12-05 08:13:47 -0500
committerAndrew Morgan <1342360+anoadragon453@users.noreply.github.com>2019-12-05 13:13:47 +0000
commitba7af15d4eb88712742edbf129667996cf3a59b3 (patch)
tree153b2b71c6cc3f2cba90c2828839716e8159afa8 /contrib/systemd/README.md
parent1.6.1 (diff)
downloadsynapse-ba7af15d4eb88712742edbf129667996cf3a59b3.tar.xz
Modify systemd unit file reference to align with installation instruction (#6369)
Signed-off-by: Clifford Garwood II cliff@cigii.com
Diffstat (limited to 'contrib/systemd/README.md')
-rw-r--r--contrib/systemd/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/contrib/systemd/README.md b/contrib/systemd/README.md
new file mode 100644
index 0000000000..5d42b3464f
--- /dev/null
+++ b/contrib/systemd/README.md
@@ -0,0 +1,17 @@
+# Setup Synapse with Systemd
+This is a setup for managing synapse with a user contributed systemd unit 
+file. It provides a `matrix-synapse` systemd unit file that should be tailored 
+to accommodate your installation in accordance with the installation 
+instructions provided in [installation instructions](../../INSTALL.md).
+
+## Setup
+1. Under the service section, ensure the `User` variable matches which user
+you installed synapse under and wish to run it as. 
+2. Under the service section, ensure the `WorkingDirectory` variable matches
+where you have installed synapse.
+3. Under the service section, ensure the `ExecStart` variable matches the
+appropriate locations of your installation.
+4. Copy the `matrix-synapse.service` to `/etc/systemd/system/`
+5. Start Synapse: `sudo systemctl start matrix-synapse`
+6. Verify Synapse is running: `sudo systemctl status matrix-synapse`
+7. *optional* Enable Synapse to start at system boot: `sudo systemctl enable matrix-synapse`