Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Modify systemd unit file reference to align with installation instruction #6369

Merged
merged 13 commits into from
Dec 5, 2019
Merged
1 change: 1 addition & 0 deletions changelog.d/6369.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update documentation and variables in user contributed systemd reference file.
17 changes: 17 additions & 0 deletions contrib/systemd/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Setup Synapse with Systemd
This is a setup for managing synapse with the user contributed systemd unit
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved
file. It provides a `matrix-synapse` systemd unit file that should be tailored
to accomidate your installation in accordinance with the installation
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved
instructions provided in [installation instructions](https://github.com/matrix-org/synapse/blob/master/INSTALL.md).
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved

## 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` variablei matches
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved
where you have installed synapse.
3. Under the service section, ensure the `ExecStart` variable matches the
appropriate locations of your installation.
4. Copy the `mastodon-synapse.service` to `/etc/systemd/system/`
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved
5. Start the service: `sudo systemctl start matrix-synapse`
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved
6. Verify the service: `sudo systemctl status matrix-synapse`
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved
7. *optional* Enable the service at boot: `sudo systemctl enable matrix-synapse`
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 6 additions & 2 deletions contrib/systemd/matrix-synapse.service
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@
# systemctl enable matrix-synapse
# systemctl start matrix-synapse
#
# This assumes that Synapse has been installed by a user named
# synapse
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved
#
# This assumes that Synapse has been installed in a virtualenv in
# /opt/synapse/env.
# the user's home directory
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved
# /home/synapse/synapse/env.
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved
#
# **NOTE:** This is an example service file that may change in the future. If you
# wish to use this please copy rather than symlink it.
Expand All @@ -23,7 +27,7 @@ User=synapse
Group=nogroup

WorkingDirectory=/opt/synapse
cgarwood82 marked this conversation as resolved.
Show resolved Hide resolved
ExecStart=/opt/synapse/env/bin/python -m synapse.app.homeserver --config-path=/opt/synapse/homeserver.yaml
ExecStart=/home/synapse/synapse/env/bin/python -m synapse.app.homeserver --config-path=/home/synapse/synapse/homeserver.yaml
SyslogIdentifier=matrix-synapse

# adjust the cache factor if necessary
Expand Down