web_client_location documentation fix #2131

matthewjwolff · 2017-04-17T06:16:23Z

The config option web_client_location is very sparsely documented. In my case, I wanted to see if I could get the matrix homeserver to host the riot.im electron app sources. To remedy the lack in documentation, I

Made the generated homeserver.yaml include information about this field. (synapse/config/server.py)
Changed the Readme portion for Arch Linux users. The AngularJS sdk is not distributed with the synapse package, so running synapse with the default homeserver.yaml will fail on Arch if matrix-synpase is installed from the repo. This is documented on the Arch wiki but not here.
Removed the string substitution from the error message in synapse/app/homeserver.py. The error message implies that it will only be printed if matrix-angular-sdk is not installed. But if matrix-angular-sdk is not installed, the program will crash when trying to perform the string substitution and not print the error message, defeating its purpose. If there's a better way to prevent this error, please enlighten me.

I saw that yall welcome additions to AUTHORS.rst. I feel like this fix isn't big enough for it to be appropriate to put my name next to the real developers. But hey if yall are fine with it I'd be happy to put my name there.

Signed-off-by: Matthew Wolff matthewjwolff@gmail.com

Signed-off-by: Matthew Wolff <matthewjwolff@gmail.com>

matrixbot · 2017-04-17T06:16:25Z

Can one of the admins verify this patch?

matrixbot · 2017-04-17T06:16:25Z

Can one of the admins verify this patch?

matrixbot · 2017-04-17T06:16:25Z

Can one of the admins verify this patch?

Signed-off-by: Matthew Wolff <matthewjwolff@gmail.com>

APwhitehat · 2017-04-17T20:17:29Z

synapse/app/homeserver.py

                "\n"
                "You can also disable hosting of the webclient via the\n"
                "configuration option `web_client`\n"
-                % {"dep": DEPENDENCY_LINKS["matrix-angular-sdk"]}


String substitution could be failing because there is no key "matrix-angular-sdk" in DEPENDENCY_LINKS, see https://github.com/matrix-org/synapse/blob/master/synapse/python_dependencies.py#L76
Also it seems to be put into CONDITIONAL_REQUIREMENTS as "web_client".

I'm sort of new here so I could be wrong. 😛

Yeah that is exactly why the string substitution fails. But I don't understand what the purpose of DEPENDENCY_LINKS is here. It seems to be an empty array whether matrix-angular-sdk is installed or not. Do things get added into that array in the course of server initialization? Maybe the thing that adds DEPENDENCY_LINKS["matrix-angular-sdk"] should occur earlier in server initialization?

The purpose of DEPENDENCY_LINKS seems to be maintaining a list of all external dependencies which needs to be installed via url.
DEPENDENCY_LINKS is not initialized anywhere else afaik.
Also it seems to be static data like REQUIREMENTS & CONDITIONAL_REQUIREMENTS.

For your case you should probably link the "matrix-angular-sdk" from CONDITIONAL_REQUIREMENTS["web_client"]

matthewjwolff · 2017-04-18T16:07:55Z

I liked APwhitehat's suggestion

APwhitehat

I'll recommend you not to mix two different kinds of changes in a single PR.It may cause confusion.
Perhaps indentation fixes in another PR?

matthewjwolff · 2017-04-18T21:24:15Z

I don't know how all those indentation changes got put in.... I definitely didn't mean to touch every file in the project...

Anyways I amended my previous commit to only the changes I originally intended to make. Sorry about that.

erikjohnston · 2017-04-25T16:28:32Z

Looks good! Did you manage to get it to host a riot instance in the end?

matthewjwolff · 2017-04-25T21:58:02Z

I did. And it was literally as easy as web_client_location: "/usr/lib/riot/webapp" (at least with how Arch packages the Riot electron app).

matthewjwolff · 2017-04-25T22:00:16Z

I was going to investigate changing my riot instance so that the default homeserver is my domain instead of whatever Riot has as the default. I think the default is vector.im or matrix.org or something....

erikjohnston · 2017-04-27T14:46:34Z

Cool! Thanks for this :)

@psaavedra

Changes in synapse v0.21.0 (2017-05-18) ======================================= No changes since v0.21.0-rc3 Changes in synapse v0.21.0-rc3 (2017-05-17) =========================================== Features: * Add per user rate-limiting overrides (PR matrix-org#2208) * Add config option to limit maximum number of events requested by ``/sync`` and ``/messages`` (PR matrix-org#2221) Thanks to @psaavedra! Changes: * Various small performance fixes (PR matrix-org#2201, matrix-org#2202, matrix-org#2224, matrix-org#2226, matrix-org#2227, matrix-org#2228, matrix-org#2229) * Update username availability checker API (PR matrix-org#2209, matrix-org#2213) * When purging, don't de-delta state groups we're about to delete (PR matrix-org#2214) * Documentation to check synapse version (PR matrix-org#2215) Thanks to @hamber-dick! * Add an index to event_search to speed up purge history API (PR matrix-org#2218) Bug fixes: * Fix API to allow clients to upload one-time-keys with new sigs (PR matrix-org#2206) Changes in synapse v0.21.0-rc2 (2017-05-08) =========================================== Changes: * Always mark remotes as up if we receive a signed request from them (PR matrix-org#2190) Bug fixes: * Fix bug where users got pushed for rooms they had muted (PR matrix-org#2200) Changes in synapse v0.21.0-rc1 (2017-05-08) =========================================== Features: * Add username availability checker API (PR matrix-org#2183) * Add read marker API (PR matrix-org#2120) Changes: * Enable guest access for the 3pl/3pid APIs (PR matrix-org#1986) * Add setting to support TURN for guests (PR matrix-org#2011) * Various performance improvements (PR matrix-org#2075, matrix-org#2076, matrix-org#2080, matrix-org#2083, matrix-org#2108, matrix-org#2158, matrix-org#2176, matrix-org#2185) * Make synctl a bit more user friendly (PR matrix-org#2078, matrix-org#2127) Thanks @APwhitehat! * Replace HTTP replication with TCP replication (PR matrix-org#2082, matrix-org#2097, matrix-org#2098, matrix-org#2099, matrix-org#2103, matrix-org#2014, matrix-org#2016, matrix-org#2115, matrix-org#2116, matrix-org#2117) * Support authenticated SMTP (PR matrix-org#2102) Thanks @DanielDent! * Add a counter metric for successfully-sent transactions (PR matrix-org#2121) * Propagate errors sensibly from proxied IS requests (PR matrix-org#2147) * Add more granular event send metrics (PR matrix-org#2178) Bug fixes: * Fix nuke-room script to work with current schema (PR matrix-org#1927) Thanks @zuckschwerdt! * Fix db port script to not assume postgres tables are in the public schema (PR matrix-org#2024) Thanks @jerrykan! * Fix getting latest device IP for user with no devices (PR matrix-org#2118) * Fix rejection of invites to unreachable servers (PR matrix-org#2145) * Fix code for reporting old verify keys in synapse (PR matrix-org#2156) * Fix invite state to always include all events (PR matrix-org#2163) * Fix bug where synapse would always fetch state for any missing event (PR matrix-org#2170) * Fix a leak with timed out HTTP connections (PR matrix-org#2180) * Fix bug where we didn't time out HTTP requests to ASes (PR matrix-org#2192) Docs: * Clarify doc for SQLite to PostgreSQL port (PR matrix-org#1961) Thanks @benhylau! * Fix typo in synctl help (PR matrix-org#2107) Thanks @HarHarLinks! * ``web_client_location`` documentation fix (PR matrix-org#2131) Thanks @matthewjwolff! * Update README.rst with FreeBSD changes (PR matrix-org#2132) Thanks @feld! * Clarify setting up metrics (PR matrix-org#2149) Thanks @encks!

web_server_root documentation fix

8e780b1

Signed-off-by: Matthew Wolff <matthewjwolff@gmail.com>

Fixed travis build failure

54f9a4c

Signed-off-by: Matthew Wolff <matthewjwolff@gmail.com>

APwhitehat reviewed Apr 17, 2017

View reviewed changes

APwhitehat reviewed Apr 18, 2017

View reviewed changes

Queried CONDITIONAL_REQUIREMENTS

d4040e9

matthewjwolff force-pushed the develop branch from 2babdbb to d4040e9 Compare April 18, 2017 21:22

matthewjwolff changed the title ~~web_server_root documentation fix~~ web_client_location documentation fix Apr 18, 2017

erikjohnston merged commit bb9246e into matrix-org:develop Apr 27, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

web_client_location documentation fix #2131

web_client_location documentation fix #2131

matthewjwolff commented Apr 17, 2017 •

edited

matrixbot commented Apr 17, 2017

matrixbot commented Apr 17, 2017

matrixbot commented Apr 17, 2017

APwhitehat Apr 17, 2017

matthewjwolff Apr 17, 2017

APwhitehat Apr 18, 2017

matthewjwolff commented Apr 18, 2017

APwhitehat left a comment

matthewjwolff commented Apr 18, 2017

erikjohnston commented Apr 25, 2017

matthewjwolff commented Apr 25, 2017

matthewjwolff commented Apr 25, 2017 •

edited

erikjohnston commented Apr 27, 2017

web_client_location documentation fix #2131

web_client_location documentation fix #2131

Conversation

matthewjwolff commented Apr 17, 2017 • edited

matrixbot commented Apr 17, 2017

matrixbot commented Apr 17, 2017

matrixbot commented Apr 17, 2017

APwhitehat Apr 17, 2017

Choose a reason for hiding this comment

matthewjwolff Apr 17, 2017

Choose a reason for hiding this comment

APwhitehat Apr 18, 2017

Choose a reason for hiding this comment

matthewjwolff commented Apr 18, 2017

APwhitehat left a comment

Choose a reason for hiding this comment

matthewjwolff commented Apr 18, 2017

erikjohnston commented Apr 25, 2017

matthewjwolff commented Apr 25, 2017

matthewjwolff commented Apr 25, 2017 • edited

erikjohnston commented Apr 27, 2017

matthewjwolff commented Apr 17, 2017 •

edited

matthewjwolff commented Apr 25, 2017 •

edited