Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2131 from matthewjwolff/develop 

web_client_location documentation fix
This commit is contained in:
Erik Johnston 2017-04-27 15:46:40 +01:00 committed by GitHub
parent c84770b877 d4040e9e28
commit bb9246e525
3 changed files with 13 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.rst
View File

@ -354,8 +354,11 @@ ArchLinux
--------- ---------
The quickest way to get up and running with ArchLinux is probably with the community package 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 https://www.archlinux.org/packages/community/any/matrix-synapse/, which should pull in most of
the necessary dependencies. 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 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: defaults to python 3, but synapse currently assumes python 2.7 by default:

4
synapse/app/homeserver.py
View File

@ -25,7 +25,7 @@ import synapse.config.logger
from synapse.config._base import ConfigError from synapse.config._base import ConfigError
from synapse.python_dependencies import ( from synapse.python_dependencies import (
check_requirements, DEPENDENCY_LINKS check_requirements, CONDITIONAL_REQUIREMENTS
) )
from synapse.rest import ClientRestResource from synapse.rest import ClientRestResource
@ -92,7 +92,7 @@ def build_resource_for_web_client(hs):
"\n" "\n"
"You can also disable hosting of the webclient via the\n" "You can also disable hosting of the webclient via the\n"
"configuration option `web_client`\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__) syweb_path = os.path.dirname(syweb.__file__)
webclient_path = os.path.join(syweb_path, "webclient") webclient_path = os.path.join(syweb_path, "webclient")

6
synapse/config/server.py
View File

@ -144,6 +144,12 @@ class ServerConfig(Config):
# Whether to serve a web client from the HTTP/HTTPS root resource. # Whether to serve a web client from the HTTP/HTTPS root resource.
web_client: True 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/...) # The public-facing base URL for the client API (not including _matrix/...)
# public_baseurl: https://example.com:8448/ # public_baseurl: https://example.com:8448/