diff options
| author | Erik Johnston <erikj@jki.re> | 2017-04-27 15:46:40 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-04-27 15:46:40 +0100 |
| commit | bb9246e52529ee0055a8b756eadb0d2c83b80607 (patch) | |
| tree | 0c6db56e64e72d3152818421e2b4e059233c6c3a | |
| parent | Fix bgupdate error if index already exists (#2167) (diff) | |
| parent | Queried CONDITIONAL_REQUIREMENTS (diff) | |
| download | synapse-bb9246e52529ee0055a8b756eadb0d2c83b80607.tar.xz | |
Merge pull request #2131 from matthewjwolff/develop
web_client_location documentation fix
| -rw-r--r-- | README.rst | 7 | ||||
| -rwxr-xr-x | synapse/app/homeserver.py | 4 | ||||
| -rw-r--r-- | synapse/config/server.py | 6 |
3 files changed, 13 insertions, 4 deletions
diff --git a/README.rst b/README.rst index d090ad86a2..9503ef510a 100644 --- a/README.rst +++ b/README.rst @@ -354,8 +354,11 @@ ArchLinux --------- The quickest way to get up and running with ArchLinux is probably with the community package -https://www.archlinux.org/packages/community/any/matrix-synapse/, which should pull in all -the necessary dependencies. +https://www.archlinux.org/packages/community/any/matrix-synapse/, which should pull in most of +the necessary dependencies. If the default web client is to be served (enabled by default in +the generated config), +https://www.archlinux.org/packages/community/any/python2-matrix-angular-sdk/ will also need to +be installed. Alternatively, to install using pip a few changes may be needed as ArchLinux defaults to python 3, but synapse currently assumes python 2.7 by default: diff --git a/synapse/app/homeserver.py b/synapse/app/homeserver.py index 6f5924d2c7..3457402596 100755 --- a/synapse/app/homeserver.py +++ b/synapse/app/homeserver.py @@ -25,7 +25,7 @@ import synapse.config.logger from synapse.config._base import ConfigError from synapse.python_dependencies import ( - check_requirements, DEPENDENCY_LINKS + check_requirements, CONDITIONAL_REQUIREMENTS ) from synapse.rest import ClientRestResource @@ -92,7 +92,7 @@ def build_resource_for_web_client(hs): "\n" "You can also disable hosting of the webclient via the\n" "configuration option `web_client`\n" - % {"dep": DEPENDENCY_LINKS["matrix-angular-sdk"]} + % {"dep": CONDITIONAL_REQUIREMENTS["web_client"].keys()[0]} ) syweb_path = os.path.dirname(syweb.__file__) webclient_path = os.path.join(syweb_path, "webclient") diff --git a/synapse/config/server.py b/synapse/config/server.py index 1f9999d57a..25e6666238 100644 --- a/synapse/config/server.py +++ b/synapse/config/server.py @@ -144,6 +144,12 @@ class ServerConfig(Config): # Whether to serve a web client from the HTTP/HTTPS root resource. web_client: True + # The root directory to server for the above web client. + # If left undefined, synapse will serve the matrix-angular-sdk web client. + # Make sure matrix-angular-sdk is installed with pip if web_client is True + # and web_client_location is undefined + # web_client_location: "/path/to/web/root" + # The public-facing base URL for the client API (not including _matrix/...) # public_baseurl: https://example.com:8448/ |