Merge pull request #1672 from williamleuschner/develop
Add README instructions for OpenBSD installation
1 files changed, 30 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 6a22399e19..1140f8e1bc 100644
--- a/README.rst
+++ b/README.rst
@@ -131,6 +131,10 @@ Installing prerequisites on openSUSE::
sudo zypper in python-pip python-setuptools sqlite3 python-virtualenv \
python-devel libffi-devel libopenssl-devel libjpeg62-devel
+Installing prerequisites on OpenBSD::
+ doas pkg_add python libffi py-pip py-setuptools sqlite3 py-virtualenv \
+ libxslt
+
To install the synapse homeserver run::
virtualenv -p python2.7 ~/.synapse
@@ -364,6 +368,32 @@ Synapse can be installed via FreeBSD Ports or Packages contributed by Brendan Mo
- Ports: ``cd /usr/ports/net/py-matrix-synapse && make install clean``
- Packages: ``pkg install py27-matrix-synapse``
+
+OpenBSD
+-------
+
+There is currently no port for OpenBSD. Additionally, OpenBSD's security
+settings require a slightly more difficult installation process.
+
+1) Create a new directory in ``/usr/local`` called ``_synapse``. Also, create a
+ new user called ``_synapse`` and set that directory as the new user's home.
+ This is required because, by default, OpenBSD only allows binaries which need
+ write and execute permissions on the same memory space to be run from
+ ``/usr/local``.
+2) ``su`` to the new ``_synapse`` user and change to their home directory.
+3) Create a new virtualenv: ``virtualenv -p python2.7 ~/.synapse``
+4) Source the virtualenv configuration located at
+ ``/usr/local/_synapse/.synapse/bin/activate``. This is done in ``ksh`` by
+ using the ``.`` command, rather than ``bash``'s ``source``.
+5) Optionally, use ``pip`` to install ``lxml``, which Synapse needs to parse
+ webpages for their titles.
+6) Use ``pip`` to install this repository: ``pip install
+ https://github.com/matrix-org/synapse/tarball/master``
+7) Optionally, change ``_synapse``'s shell to ``/bin/false`` to reduce the
+ chance of a compromised Synapse server being used to take over your box.
+
+After this, you may proceed with the rest of the install directions.
+
NixOS
-----
|
