summary refs log tree commit diff
path: root/contrib
diff options
context:
space:
mode:
authorErik Johnston <erikj@jki.re>2018-04-20 13:02:24 +0100
committerGitHub <noreply@github.com>2018-04-20 13:02:24 +0100
commitbdb7714d133f8e835c0e933802890acd979143ca (patch)
treec2db3eedeb8fa8e3965fe55910486521cdc43fda /contrib
parentMerge pull request #3093 from matrix-org/rav/response_cache_wrap (diff)
parentDocument contrib directory (diff)
downloadsynapse-bdb7714d133f8e835c0e933802890acd979143ca.tar.xz
Merge pull request #3125 from matrix-org/erikj/add_contrib_docs
Document contrib directory
Diffstat (limited to 'contrib')
-rw-r--r--contrib/README.rst10
-rw-r--r--contrib/systemd/synapse.service4
2 files changed, 14 insertions, 0 deletions
diff --git a/contrib/README.rst b/contrib/README.rst
new file mode 100644
index 0000000000..c296c55628
--- /dev/null
+++ b/contrib/README.rst
@@ -0,0 +1,10 @@
+Community Contributions
+=======================
+
+Everything in this directory are projects submitted by the community that may be useful
+to others. As such, the project maintainers cannot guarantee support, stability
+or backwards compatibility of these projects. 
+
+Files in this directory should *not* be relied on directly, as they may not
+continue to work or exist in future. If you wish to use any of these files then
+they should be copied to avoid them breaking from underneath you.
diff --git a/contrib/systemd/synapse.service b/contrib/systemd/synapse.service
index 3f037055b9..b81ce3915d 100644
--- a/contrib/systemd/synapse.service
+++ b/contrib/systemd/synapse.service
@@ -2,6 +2,9 @@
 # (e.g. https://www.archlinux.org/packages/community/any/matrix-synapse/ for ArchLinux)
 # rather than in a user home directory or similar under virtualenv.
 
+# **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.
+
 [Unit]
 Description=Synapse Matrix homeserver
 
@@ -12,6 +15,7 @@ Group=synapse
 WorkingDirectory=/var/lib/synapse
 ExecStart=/usr/bin/python2.7 -m synapse.app.homeserver --config-path=/etc/synapse/homeserver.yaml
 ExecStop=/usr/bin/synctl stop /etc/synapse/homeserver.yaml
+# EnvironmentFile=-/etc/sysconfig/synapse  # Can be used to e.g. set SYNAPSE_CACHE_FACTOR 
 
 [Install]
 WantedBy=multi-user.target