MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-11-13 21:41:30 +01:00
Code Issues Projects Releases Wiki Activity

web_server_root documentation fix

Browse source 
Signed-off-by: Matthew Wolff <matthewjwolff@gmail.com>
This commit is contained in:
Matthew Wolff 2017-04-17 00:44:05 -05:00
parent 78f0ddbfad
commit 8e780b113d
No known key found for this signature in database
GPG key ID: C805B448ADCE0850
3 changed files with 12 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
README.rst
View file

@ -335,8 +335,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:

3
synapse/app/homeserver.py
View file

@ -88,11 +88,10 @@ def build_resource_for_web_client(hs):
"the location of the source to serve via the configuration\n" "the location of the source to serve via the configuration\n"
"option `web_client_location`\n\n" "option `web_client_location`\n\n"
"To install the `matrix-angular-sdk` via pip, run:\n\n" "To install the `matrix-angular-sdk` via pip, run:\n\n"
" pip install '%(dep)s'\n" " pip install matrix-angular-sdk\n"
"\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"]}
) )
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/