Richard van der Hoff
13828f7d58
Update docs/ACME.md
...
Co-Authored-By: anoadragon453 <1342360+anoadragon453@users.noreply.github.com>
2019-02-05 16:46:28 +00:00
Andrew Morgan
ffcbd80982
Actually add ACME docs
2019-02-05 15:50:18 +00:00
Andrew Morgan
cbdc01cc3b
Convert ACME docs to md
2019-02-05 15:38:27 +00:00
Andrew Morgan
08b26afeee
Move ACME docs to docs/ACME.rst and link from UPGRADE.
2019-02-05 15:33:23 +00:00
Krithin Sitaram
98df67a8de
Remove mention of lt-cred-mech in the sample coturn config. ( #4333 )
...
* Remove mention of lt-cred-mech in the sample coturn config.
See https://github.com/coturn/coturn/pull/262 for more context.
Also clean up some minor formatting issues while I'm here.
* Add changelog.
Signed-off-by: Krithin Sitaram <krithin@gmail.com>
2018-12-28 23:31:49 +00:00
Neil Johnson
d2f7c4e6b1
create support user ( #4141 )
...
Allow for the creation of a support user.
A support user can access the server, join rooms, interact with other users, but does not appear in the user directory nor does it contribute to monthly active user limits.
2018-12-14 18:20:59 +00:00
Richard van der Hoff
de8772a655
Do a GC after each test to fix logcontext leaks ( #4227 )
...
* Some words about garbage collections and logcontexts
* Do a GC after each test to fix logcontext leaks
This feels like an awful hack, but...
* changelog
2018-11-27 13:00:33 +11:00
Aaron Raimist
f6cbef6332
Add a note saying you need to manually reclaim disk space
...
People keep asking why their database hasn't gotten smaller after using this API.
Signed-off-by: Aaron Raimist <aaron@raim.ist>
2018-11-18 12:38:04 -06:00
Travis Ralston
0f5e51f726
Add config variables for enabling terms auth and the policy name ( #4142 )
...
So people can still collect consent the old way if they want to.
2018-11-06 10:32:34 +00:00
Travis Ralston
22a2004428
Update documentation and templates for new consent
2018-10-12 17:53:14 -06:00
Travis Ralston
1ca2744621
Merge pull request #3734 from matrix-org/travis/worker-docs
...
Reference that the federation_reader needs the HTTP replication port set
2018-08-23 07:51:46 -06:00
Erik Johnston
764030cf63
Merge pull request #3659 from matrix-org/erikj/split_profiles
...
Allow profile updates to happen on workers
2018-08-22 11:35:55 +01:00
Travis Ralston
dd0ac1614c
Reference that the federation_reader needs the HTTP replication port set
2018-08-21 23:35:50 -06:00
Amber Brown
c334ca67bb
Integrate presence from hotfixes ( #3694 )
2018-08-18 01:08:45 +10:00
Erik Johnston
782689bd40
Merge branch 'develop' of github.com:matrix-org/synapse into erikj/split_profiles
2018-08-17 14:15:48 +01:00
Travis Ralston
a8ffc27db7
Update the admin register documentation to return a real user ID
...
Presumably this is the intention anyways. I've also updated the domain part to be something more along the lines of what people might expect.
2018-08-17 02:46:25 -06:00
Erik Johnston
5c6226707d
Update docs/workers.rst
2018-08-09 10:37:42 +01:00
Erik Johnston
f81f421086
Update workers.rst with new paths
2018-08-07 10:51:35 +01:00
Erik Johnston
0b0b24cb82
Merge branch 'develop' of github.com:matrix-org/synapse into erikj/client_apis_move
2018-07-23 13:21:15 +01:00
Erik Johnston
4fc52b1037
Update docs/workers.rst
2018-07-23 13:20:43 +01:00
Amber Brown
e1a237eaab
Admin API for creating new users ( #3415 )
2018-07-20 22:41:13 +10:00
Matthew Hodgson
9570aa82eb
update doc for deactivate API
2018-06-26 10:42:50 +01:00
Amber Brown
304bb22c1d
Fix metric documentation tables ( #3341 )
2018-06-06 15:52:37 +10:00
Richard van der Hoff
617afee069
Merge pull request #3340 from ArchangeGabriel/patch-1
...
doc/postgres.rst: fix display of the last command block
2018-06-05 17:45:17 +01:00
Bruno Pagani
b50f18171d
doc/postgres.rest: fix displaying of the last command block
...
Also indent all of them with 4 spaces.
2018-06-04 22:41:52 +00:00
Richard van der Hoff
c2c3092cce
code_style.rst: formatting
2018-05-31 16:11:34 +01:00
Amber Brown
febe0ec8fd
Run Prometheus on a different port, optionally. ( #3274 )
2018-05-31 19:04:50 +10:00
Richard van der Hoff
757ed27258
Let users leave the server notice room after joining
...
They still can't reject invites, but we let them leave it.
2018-05-25 11:07:21 +01:00
Richard van der Hoff
9bf4b2bda3
Allow overriding the server_notices user's avatar
...
probably should have done this in the first place, like @turt2live suggested.
2018-05-23 17:43:30 +01:00
Richard van der Hoff
e206b2c9ac
consent_tracking.md: clarify link
2018-05-23 15:57:10 +01:00
Richard van der Hoff
2df8c3139a
minor post-review tweaks
2018-05-23 15:39:52 +01:00
Richard van der Hoff
cd8ab9a0d8
mention public_baseurl
2018-05-23 14:43:09 +01:00
Richard van der Hoff
1cbb8e5a33
fix wrapping
2018-05-23 13:58:28 +01:00
Richard van der Hoff
052d08a6a5
Using the manhole to send server notices
2018-05-23 13:55:39 +01:00
Richard van der Hoff
5ad1149f38
Notes on the manhole
2018-05-23 13:47:34 +01:00
Richard van der Hoff
563606b8f2
consent_tracking: formatting etc
2018-05-23 12:37:39 +01:00
Richard van der Hoff
2574ea3dc8
server_notices.md: fix link
2018-05-23 12:34:34 +01:00
Richard van der Hoff
833db2d922
consent tracking docs
2018-05-23 12:32:38 +01:00
Richard van der Hoff
e7598b666b
Some docs about server notices
2018-05-23 11:14:23 +01:00
Richard van der Hoff
7b36d06a69
Add a 'has_consented' template var to consent forms
...
fixes #3260
2018-05-22 14:58:34 +01:00
Neil Johnson
2725223f08
Merge branch 'master' into develop
2018-05-18 14:07:50 +01:00
rubo77
616da9eb1d
postgres.rst: Add instructions how to setup the postgres user and clarify the final step
2018-05-17 11:48:56 +02:00
Richard van der Hoff
47815edcfa
ConsentResource to gather policy consent from users
...
Hopefully there are enough comments and docs in this that it makes sense on its
own.
2018-05-15 15:11:59 +01:00
Richard van der Hoff
13decdbf96
Revert "Merge pull request #3066 from matrix-org/rav/remove_redundant_metrics"
...
We aren't ready to release this yet, so I'm reverting it for now.
This reverts commit d1679a4ed7
, reversing
changes made to e089100c62
.
2018-04-09 12:59:12 +01:00
Richard van der Hoff
551422051b
Merge pull request #2886 from turt2live/travis/new-worker-docs
...
Add a blurb explaining the main synapse worker
2018-04-05 17:33:09 +01:00
Richard van der Hoff
518f6de088
Remove redundant metrics which were deprecated in 0.27.0.
2018-04-04 19:46:28 +01:00
Travis Ralston
88964b987e
Merge remote-tracking branch 'matrix-org/develop' into travis/new-worker-docs
2018-04-04 08:46:56 -06:00
Travis Ralston
204fc98520
Document the additional routes for the event_creator worker
...
Fixes https://github.com/matrix-org/synapse/issues/3018
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-04-04 08:46:17 -06:00
Travis Ralston
301b339494
Move the mention of the main synapse worker higher up
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-04-04 08:45:51 -06:00
Erik Johnston
873aea7168
Merge pull request #3002 from matrix-org/rav/purge_doc
...
Update purge_history_api.rst
2018-03-15 13:31:54 +00:00
Richard van der Hoff
0ad5125814
Update purge_history_api.rst
...
clarify that `purge_history` will not purge state
2018-03-15 11:05:42 +00:00
Travis Ralston
c33c1ceddd
OCD: Make the event_creator routes regex a code block
...
All the others are code blocks, so this one should be to (currently it is a blockquote).
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-03-14 11:09:08 -06:00
Richard van der Hoff
e48c7aac4d
Add transactional API to history purge
...
Make the purge request return quickly, and allow scripts to poll for updates.
2018-03-12 16:22:55 +00:00
Richard van der Hoff
20f40348d4
Factor run_in_background out from preserve_fn
...
It annoys me that we create temporary function objects when there's really no
need for it. Let's factor the gubbins out of preserve_fn and start using it.
2018-03-08 11:50:11 +00:00
Richard van der Hoff
f8bfcd7e0d
Provide a means to pass a timestamp to purge_history
2018-03-05 14:37:23 +00:00
Travis Ralston
923d9300ed
Add a blurb explaining the main synapse worker
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-02-17 21:53:46 -07:00
Erik Johnston
c0c9327fe0
Merge pull request #2854 from matrix-org/erikj/event_create_worker
...
Create a worker for event creation
2018-02-13 18:07:10 +00:00
Erik Johnston
059d3a6c8e
Update docs
2018-02-13 17:53:56 +00:00
Richard van der Hoff
8fd1a32456
Fix typos in purge api & doc
...
* It's supposed to be purge_local_events, not ..._history
* Fix the doc to have valid json
2018-02-13 13:09:39 +00:00
Erik Johnston
32c7b8e48b
Update workers docs to include http port
2018-02-12 17:21:23 +00:00
Richard van der Hoff
10b34dbb9a
Merge pull request #2858 from matrix-org/rav/purge_updates
...
delete_local_events for purge_room_history
2018-02-09 14:11:00 +00:00
Richard van der Hoff
74fcbf741b
delete_local_events for purge_history
...
Add a flag which makes the purger delete local events
2018-02-09 13:07:41 +00:00
Erik Johnston
f133228cb3
Add note in docs/workers.rst
2018-02-07 10:34:31 +00:00
Travis Ralston
3af53c183a
Add admin api documentation for list media endpoint
...
Signed-off-by: Travis Ralston <travpc@gmail.com>
2018-01-31 08:15:59 -07:00
Richard van der Hoff
ee7a1cabd8
document metrics changes
2018-01-16 13:04:01 +00:00
Richard van der Hoff
68ca864141
Add config option to disable media_repo on main synapse
...
... to stop us doing the cache cleanup jobs on the master.
2017-11-22 16:20:27 +00:00
Richard van der Hoff
a0c6688976
Improve documentation of workers
...
Fixes https://github.com/matrix-org/synapse/issues/2554
2017-11-21 18:28:13 +00:00
Richard van der Hoff
7e6fa29cb5
Remove preserve_context_over_{fn, deferred}
...
Both of these functions ae known to leak logcontexts. Replace the remaining
calls to them and kill them off.
2017-11-14 11:22:42 +00:00
Matthew Hodgson
2ac6deafb7
simplify instructions for regenerating user_dir
2017-11-04 19:34:59 +00:00
Richard van der Hoff
1189be43a2
Factor _AccountHandler proxy out to ModuleApi
...
We're going to need to use this from places that aren't password auth, so let's
move it to a proper class.
2017-11-02 14:36:11 +00:00
David Baker
b19d9e2174
Merge pull request #2624 from matrix-org/rav/password_provider_notify_logout
...
Notify auth providers on logout
2017-11-02 10:55:17 +00:00
Richard van der Hoff
bc8a5c0330
Notify auth providers on logout
...
Provide a hook by which auth providers can be notified of logouts.
2017-11-01 16:51:51 +00:00
Richard van der Hoff
4c8f94ac94
Allow password_auth_providers to return a callback
...
... so that they have a way to record access tokens.
2017-11-01 16:51:03 +00:00
Richard van der Hoff
3cd6b22c7b
Let password auth providers handle arbitrary login types
...
Provide a hook where password auth providers can say they know about other
login types, and get passed the relevant parameters
2017-11-01 16:43:57 +00:00
Richard van der Hoff
1650eb5847
DB schema interface for password auth providers
...
Provide an interface by which password auth providers can register db schema
files to be run at startup
2017-10-31 14:01:53 +00:00
Richard van der Hoff
ebda45de4c
Start some documentation on password providers
...
Document the existing interface, before I start adding new stuff.
2017-10-31 10:47:52 +00:00
Matthew Hodgson
e51c2bcaef
move url_previews to MD as RST does my head in
2017-10-29 20:47:17 +00:00
Richard van der Hoff
1eb300e1fc
Document import rules
2017-10-26 11:55:41 +01:00
Richard van der Hoff
f7f6bfaae4
code_style: more formatting
2017-10-26 11:55:41 +01:00
Richard van der Hoff
351cc35342
code_style.rst: a couple of tidyups
2017-10-26 10:29:26 +01:00
Erik Johnston
ffba978077
Merge branch 'release-v0.24.0' of github.com:matrix-org/synapse
2017-10-23 13:13:53 +01:00
Ander Punnar
b2e02084b8
make it absolutely clear that Purge History API does not remove all traces of events and message contents
...
because this topic pops up too often
#890 #1621 #1730 #2260 #2315 and so on
2017-10-14 13:25:42 +03:00
Matthew Hodgson
64665b57d0
oops
2017-10-13 14:26:07 +01:00
Matthew Hodgson
931fc43cc8
fix copyright to companies which actually exist(ed)
2017-10-13 13:54:31 +01:00
Paul Tötterman
8b16b43b7f
Document known to work postgres version
2017-09-01 16:52:45 +03:00
Sean Enck
719aec4064
clarify metric setup to use 'scrape_configs' section of yaml and use an array for target
2017-04-21 11:03:32 -04:00
Richard van der Hoff
cea7839911
Document some of the admin APIs ( #2143 )
...
I haven't (yet) documented all of the user-list APIs introduced in
https://github.com/matrix-org/synapse/pull/1784 because the API shape seems
very odd, given the functionality.
2017-04-21 11:55:07 +01:00
Erik Johnston
82301b6c29
Remove last reference to worker_replication_url
2017-04-12 10:21:02 +01:00
Erik Johnston
6f65e2f90c
Update replication docs
2017-04-11 16:21:12 +01:00
Erik Johnston
323634bf8b
Update workers docs
2017-04-11 16:19:52 +01:00
Erik Johnston
62b89daac6
Merge branch 'develop' of github.com:matrix-org/synapse into erikj/repl_tcp_server
2017-04-04 09:46:16 +01:00
Erik Johnston
142b6b4abf
Merge pull request #2011 from matrix-org/matthew/turn_allow_guests
...
add setting (on by default) to support TURN for guests
2017-03-31 14:37:09 +01:00
Erik Johnston
07a32d192c
Merge pull request #1961 from benhylau/patch-1
...
Clarify doc for SQLite to PostgreSQL port
2017-03-31 14:13:26 +01:00
Erik Johnston
b4276a3896
Add a brief list of commands to docs
2017-03-31 11:34:45 +01:00
Erik Johnston
bfcf016714
Fix up docs
2017-03-31 11:19:24 +01:00
Erik Johnston
31e0fe9031
Fix indentation in docs/
2017-03-30 13:54:15 +01:00
Richard van der Hoff
f9b4bb05e0
Fix the logcontext handling in the cache wrappers ( #2077 )
...
The cache wrappers had a habit of leaking the logcontext into the reactor while
the lookup function was running, and then not restoring it correctly when the
lookup function had completed. It's all the fault of
`preserve_context_over_{fn,deferred}` which are basically a bit broken.
2017-03-30 13:22:24 +01:00
Erik Johnston
7450693435
Initial TCP protocol implementation
...
This defines the low level TCP replication protocol
2017-03-30 12:54:46 +01:00
Richard van der Hoff
a4cb21659b
log_contexts.rst: fix formatting of Note block
...
Apparently the github RST renderer doesn't like Note blocks.
2017-03-20 12:01:26 +00:00
Richard van der Hoff
d78d08981a
log_contexts.rst: fix typos
2017-03-18 22:47:37 +00:00
Richard van der Hoff
d2d146a314
Logcontext docs
2017-03-17 23:59:28 +00:00
Matthew Hodgson
e0ff66251f
add setting (on by default) to support TURN for guests
2017-03-15 12:22:18 +00:00
Benedict Lau
92312aa3e6
Clarify doc for SQLite to PostgreSQL port
2017-03-01 01:30:11 -05:00
Richard van der Hoff
11940d462a
Merge remote-tracking branch 'origin/master' into develop
2017-02-20 09:14:43 +00:00
Richard van der Hoff
6184f6fcbc
Update metrics-howto.rst
2017-02-19 23:06:45 +00:00
Richard van der Hoff
e556aefe0a
Update metrics-howto.rst
2017-02-19 23:06:08 +00:00
Richard van der Hoff
7efb38d1dd
Update metrics-howto.rst
2017-02-19 22:55:48 +00:00
Daniel Dent
fdbd90e25d
Update CAPTCHA_SETUP.rst X-Forwarded-For docs
...
It looks like CAPTCHA_SETUP.rst contains information relevant to an old version of Synapse, but Synapse now has a different approach to configuring use of the X-Forwarded-For header.
2017-02-08 21:21:02 -08:00
Richard van der Hoff
83333498a5
fix doc for purge_media_cache
...
purge_media_cache takes its arg from a query-param, not the POST body, for some
reason.
2017-01-20 12:15:50 +00:00
Richard van der Hoff
971edd04af
rename CAPTCHA_SETUP
...
this is rst so name it accordingly
2016-12-01 12:08:03 +00:00
Paul "LeoNerd" Evans
89e3e39d52
Fix copypasto error in metric rename table in docs
2016-11-03 17:04:13 +00:00
Paul "LeoNerd" Evans
1d4d518b50
Add details of renamed metrics
2016-10-31 15:06:52 +00:00
Paul "LeoNerd" Evans
159434a133
Remove long-deprecated instructions about promethesus console; also fix for modern config file format
2016-10-28 13:58:27 +01:00
Matthew Hodgson
64527f94cc
mention client_reader worker
2016-09-17 14:15:10 +01:00
Matthew Hodgson
58d6c93103
PR feedback
2016-08-19 19:16:55 +01:00
Matthew Hodgson
b7ffa0e2cd
quick guide to synapse scalability via workers
2016-08-19 18:55:57 +01:00
Erik Johnston
3c3246c078
Use correct path
2016-07-28 15:08:37 +01:00
Erik Johnston
367b594183
Add some basic admin API docs
2016-07-28 14:56:09 +01:00
Richard van der Hoff
1238203bc4
code_style.rst: add link to sphinx examples
2016-07-01 09:36:51 +01:00
Richard van der Hoff
41f072fd0e
code_style.rst: *fix* link to google style
2016-07-01 09:09:40 +01:00
Richard van der Hoff
5a6ef20ef6
code_style.rst: add link to google style
2016-07-01 09:08:35 +01:00
Rick Cogley
56ec5869c9
Update turn-howto.rst to use git clone (2)
...
Not logical to use svn checkout against a github repo, so changed to git clone.
Signed-off-by: Rick Cogley <rick.cogley@esolia.co.jp>
2016-06-28 18:34:38 +09:00
Rick Cogley
1ea358b28b
Update turn-howto.rst to use git clone
...
svn checkout is not logical for a checkout from github, so changed the checkout to "git clone".
thanks @dbkr
Signed-off-by: Rick Cogley <rick.cogley@esolia.co.jp>
2016-06-28 18:27:54 +09:00
Rick Cogley
551fe80bed
Remove double spaces
...
Reading the RST spec, I was trying to get breaks to appear by entering the double spaces after the lines in the code blocks. It does not work anyway, and, as pointed out, I've removed.
2016-06-28 12:47:55 +09:00
Rick Cogley
70d820c875
Update to reflect new location at github.
...
Additionally it does not appear there is turnserver.conf.default, but rather, just /etc/turnserver.conf.
2016-06-26 19:07:07 +09:00
Richard van der Hoff
09804c9862
Fix link to A-S spec
2016-05-23 16:29:38 +01:00
Matthew Hodgson
8a04412fa1
starting point for doc on how log contexts are supposed to work
2016-05-04 12:19:04 +01:00
Mark Haines
10ebbaea2e
Update replication.rst
2016-04-12 15:53:45 +01:00
Mark Haines
aa5ce4d450
Add some design documentation for replication
2016-04-12 15:14:10 +01:00
Matthew Hodgson
64b4aead15
make it work
2016-03-29 03:13:25 +01:00
Matthew Hodgson
7dd0c1730a
initial WIP of a tentative preview_url endpoint - incomplete, untested, experimental, etc. just putting it here for safekeeping for now
2016-01-24 18:47:27 -05:00
Mads R. Christensen
44b2bf91be
Added installation instructions for postgres on CentOS 7
2015-12-05 15:09:20 +01:00
Erik Johnston
3e4de64bc9
Remove spurious .py from docs
2015-09-01 09:46:42 +01:00
Erik Johnston
c961cd7736
Clean up scripts/
2015-08-27 13:03:17 +01:00
Matthew Hodgson
d79ffa1898
typo
2015-05-09 14:45:37 +01:00
Erik Johnston
22a7ba8b22
Actually rename all isntances
2015-05-08 13:50:03 +01:00
Erik Johnston
3a42f32134
Reword port script usage
2015-05-08 13:47:48 +01:00
Erik Johnston
6101ce427a
Slight rewording
2015-05-07 18:58:28 +01:00
Erik Johnston
5fe26a9b5c
Reword docs/application_services.rst
2015-05-07 18:54:53 +01:00
Erik Johnston
35698484a5
Add some information on registering AS's
2015-05-07 18:51:09 +01:00
Erik Johnston
938939fd89
Move CAPTCHA_SETUP to docs/
2015-05-06 13:48:06 +01:00
Mark Haines
32937f3ea0
database config is not kept in separate config file anymore
2015-05-01 14:06:54 +01:00
Erik Johnston
72443572bf
Mention that postgres databases must have the correct charset encoding
2015-04-29 11:50:33 +01:00
Matthew Hodgson
478e511db0
improve postgres blurb a bit
2015-04-29 00:48:07 +01:00
Erik Johnston
cc52f02d74
Fix rst
2015-04-28 18:09:20 +01:00
Erik Johnston
3151afee9e
Update docs/postgres.rst to explain port script usage
2015-04-28 17:59:27 +01:00
Erik Johnston
56f518d279
Add docs on how to use synapse with psycopg2
2015-04-27 14:53:35 +01:00
Paul "LeoNerd" Evans
6d15401341
Mumble ReST mumble ``fixed-width`` mumble
2015-04-23 16:16:08 +01:00
Paul "LeoNerd" Evans
8c78414284
Formatting / wording fixes to metrics doc
2015-04-23 16:14:08 +01:00
Matthew Hodgson
6c99491347
prometheus/metrics howto from Leo
2015-04-23 16:08:08 +01:00