7cadc4c918
cleanups
2019-02-07 19:29:20 +00:00
188ad47e73
Merge branch 'master' into erikj/msc1711_faq
2019-02-07 19:27:42 +00:00
9285d5c2ce
Update MSC1711 FAQ to be explicit about well-known
...
A surprising number of people are using the well-known method, and are
simply copying the example configuration. This is problematic as the
example includes an explicit port, which causes inbound federation
requests to have the HTTP Host header include the port, upsetting some
reverse proxies.
Given that, we update the well-known example to be more explicit about
the various ways you can set it up, and the consequence of using an
explict port.
2019-02-07 19:24:11 +00:00
624b172e08
Merge remote-tracking branch 'origin/release-v0.99.0'
2019-02-07 19:18:26 +00:00
c17b128b83
Update ACME docs to include port instructions ( #4578 )
2019-02-07 19:18:08 +00:00
9b7aa543d9
clarify option 1
2019-02-07 18:46:02 +00:00
b05dd4ac06
faq cleanups
2019-02-05 18:59:57 +00:00
39bf0ea2e8
Add notes on SRV and .well-known ( #4573 )
2019-02-05 18:11:26 +00:00
4a7524ffd3
Merge pull request #4570 from matrix-org/anoa/self_signed_upgrade
...
Add ACME docs and link to it from README and INSTALL
2019-02-05 17:34:43 +00:00
6585ef4799
Neilj/1711faq ( #4572 )
...
MSC1711 certificates FAQ
2019-02-05 17:19:28 +00:00
a6345009f9
Add TL;DR and final step details to ACME
2019-02-05 17:04:34 +00:00
56cb34ba8b
Merge branch 'anoa/self_signed_upgrade' of github.com:matrix-org/synapse into anoa/self_signed_upgrade
2019-02-05 16:53:05 +00:00
2ca63df83b
Update ACME
2019-02-05 16:50:00 +00:00
13828f7d58
Update docs/ACME.md
...
Co-Authored-By: anoadragon453 <1342360+anoadragon453@users.noreply.github.com>
2019-02-05 16:46:28 +00:00
ffcbd80982
Actually add ACME docs
2019-02-05 15:50:18 +00:00
cbdc01cc3b
Convert ACME docs to md
2019-02-05 15:38:27 +00:00
08b26afeee
Move ACME docs to docs/ACME.rst and link from UPGRADE.
2019-02-05 15:33:23 +00:00
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
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
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
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
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
22a2004428
Update documentation and templates for new consent
2018-10-12 17:53:14 -06:00
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
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
dd0ac1614c
Reference that the federation_reader needs the HTTP replication port set
2018-08-21 23:35:50 -06:00
c334ca67bb
Integrate presence from hotfixes ( #3694 )
2018-08-18 01:08:45 +10:00
782689bd40
Merge branch 'develop' of github.com:matrix-org/synapse into erikj/split_profiles
2018-08-17 14:15:48 +01:00
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
5c6226707d
Update docs/workers.rst
2018-08-09 10:37:42 +01:00
f81f421086
Update workers.rst with new paths
2018-08-07 10:51:35 +01:00
0b0b24cb82
Merge branch 'develop' of github.com:matrix-org/synapse into erikj/client_apis_move
2018-07-23 13:21:15 +01:00
4fc52b1037
Update docs/workers.rst
2018-07-23 13:20:43 +01:00
e1a237eaab
Admin API for creating new users ( #3415 )
2018-07-20 22:41:13 +10:00
9570aa82eb
update doc for deactivate API
2018-06-26 10:42:50 +01:00
304bb22c1d
Fix metric documentation tables ( #3341 )
2018-06-06 15:52:37 +10:00
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
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
c2c3092cce
code_style.rst: formatting
2018-05-31 16:11:34 +01:00
febe0ec8fd
Run Prometheus on a different port, optionally. ( #3274 )
2018-05-31 19:04:50 +10:00
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
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
e206b2c9ac
consent_tracking.md: clarify link
2018-05-23 15:57:10 +01:00
2df8c3139a
minor post-review tweaks
2018-05-23 15:39:52 +01:00
cd8ab9a0d8
mention public_baseurl
2018-05-23 14:43:09 +01:00
1cbb8e5a33
fix wrapping
2018-05-23 13:58:28 +01:00
052d08a6a5
Using the manhole to send server notices
2018-05-23 13:55:39 +01:00
5ad1149f38
Notes on the manhole
2018-05-23 13:47:34 +01:00
563606b8f2
consent_tracking: formatting etc
2018-05-23 12:37:39 +01:00
2574ea3dc8
server_notices.md: fix link
2018-05-23 12:34:34 +01:00
833db2d922
consent tracking docs
2018-05-23 12:32:38 +01:00
e7598b666b
Some docs about server notices
2018-05-23 11:14:23 +01:00
7b36d06a69
Add a 'has_consented' template var to consent forms
...
fixes #3260
2018-05-22 14:58:34 +01:00
2725223f08
Merge branch 'master' into develop
2018-05-18 14:07:50 +01:00
616da9eb1d
postgres.rst: Add instructions how to setup the postgres user and clarify the final step
2018-05-17 11:48:56 +02:00
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
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 d1679a4ed7e089100c62
2018-04-09 12:59:12 +01:00
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
518f6de088
Remove redundant metrics which were deprecated in 0.27.0.
2018-04-04 19:46:28 +01:00
88964b987e
Merge remote-tracking branch 'matrix-org/develop' into travis/new-worker-docs
2018-04-04 08:46:56 -06:00
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
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
873aea7168
Merge pull request #3002 from matrix-org/rav/purge_doc
...
Update purge_history_api.rst
2018-03-15 13:31:54 +00:00
0ad5125814
Update purge_history_api.rst
...
clarify that `purge_history` will not purge state
2018-03-15 11:05:42 +00:00
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
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
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
f8bfcd7e0d
Provide a means to pass a timestamp to purge_history
2018-03-05 14:37:23 +00:00
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
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
059d3a6c8e
Update docs
2018-02-13 17:53:56 +00:00
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
32c7b8e48b
Update workers docs to include http port
2018-02-12 17:21:23 +00:00
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
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
f133228cb3
Add note in docs/workers.rst
2018-02-07 10:34:31 +00:00
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
ee7a1cabd8
document metrics changes
2018-01-16 13:04:01 +00:00
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
a0c6688976
Improve documentation of workers
...
Fixes https://github.com/matrix-org/synapse/issues/2554
2017-11-21 18:28:13 +00:00
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
2ac6deafb7
simplify instructions for regenerating user_dir
2017-11-04 19:34:59 +00:00
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
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
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
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
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
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
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
e51c2bcaef
move url_previews to MD as RST does my head in
2017-10-29 20:47:17 +00:00
1eb300e1fc
Document import rules
2017-10-26 11:55:41 +01:00
f7f6bfaae4
code_style: more formatting
2017-10-26 11:55:41 +01:00
351cc35342
code_style.rst: a couple of tidyups
2017-10-26 10:29:26 +01:00
ffba978077
Merge branch 'release-v0.24.0' of github.com:matrix-org/synapse
2017-10-23 13:13:53 +01:00
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
64665b57d0
oops
2017-10-13 14:26:07 +01:00
931fc43cc8
fix copyright to companies which actually exist(ed)
2017-10-13 13:54:31 +01:00
8b16b43b7f
Document known to work postgres version
2017-09-01 16:52:45 +03:00
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
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
82301b6c29
Remove last reference to worker_replication_url
2017-04-12 10:21:02 +01:00
6f65e2f90c
Update replication docs
2017-04-11 16:21:12 +01:00
323634bf8b
Update workers docs
2017-04-11 16:19:52 +01:00
62b89daac6
Merge branch 'develop' of github.com:matrix-org/synapse into erikj/repl_tcp_server
2017-04-04 09:46:16 +01:00
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
07a32d192c
Merge pull request #1961 from benhylau/patch-1
...
Clarify doc for SQLite to PostgreSQL port
2017-03-31 14:13:26 +01:00
b4276a3896
Add a brief list of commands to docs
2017-03-31 11:34:45 +01:00
bfcf016714
Fix up docs
2017-03-31 11:19:24 +01:00
31e0fe9031
Fix indentation in docs/
2017-03-30 13:54:15 +01:00
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
7450693435
Initial TCP protocol implementation
...
This defines the low level TCP replication protocol
2017-03-30 12:54:46 +01:00
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
d78d08981a
log_contexts.rst: fix typos
2017-03-18 22:47:37 +00:00
d2d146a314
Logcontext docs
2017-03-17 23:59:28 +00:00
e0ff66251f
add setting (on by default) to support TURN for guests
2017-03-15 12:22:18 +00:00
92312aa3e6
Clarify doc for SQLite to PostgreSQL port
2017-03-01 01:30:11 -05:00
11940d462a
Merge remote-tracking branch 'origin/master' into develop
2017-02-20 09:14:43 +00:00
6184f6fcbc
Update metrics-howto.rst
2017-02-19 23:06:45 +00:00
e556aefe0a
Update metrics-howto.rst
2017-02-19 23:06:08 +00:00
7efb38d1dd
Update metrics-howto.rst
2017-02-19 22:55:48 +00:00
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
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
971edd04af
rename CAPTCHA_SETUP
...
this is rst so name it accordingly
2016-12-01 12:08:03 +00:00
89e3e39d52
Fix copypasto error in metric rename table in docs
2016-11-03 17:04:13 +00:00
1d4d518b50
Add details of renamed metrics
2016-10-31 15:06:52 +00:00
159434a133
Remove long-deprecated instructions about promethesus console; also fix for modern config file format
2016-10-28 13:58:27 +01:00
64527f94cc
mention client_reader worker
2016-09-17 14:15:10 +01:00
58d6c93103
PR feedback
2016-08-19 19:16:55 +01:00
b7ffa0e2cd
quick guide to synapse scalability via workers
2016-08-19 18:55:57 +01:00
3c3246c078
Use correct path
2016-07-28 15:08:37 +01:00
367b594183
Add some basic admin API docs
2016-07-28 14:56:09 +01:00
1238203bc4
code_style.rst: add link to sphinx examples
2016-07-01 09:36:51 +01:00
41f072fd0e
code_style.rst: *fix* link to google style
2016-07-01 09:09:40 +01:00
5a6ef20ef6
code_style.rst: add link to google style
2016-07-01 09:08:35 +01:00
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
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
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
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
09804c9862
Fix link to A-S spec
2016-05-23 16:29:38 +01:00
8a04412fa1
starting point for doc on how log contexts are supposed to work
2016-05-04 12:19:04 +01:00
10ebbaea2e
Update replication.rst
2016-04-12 15:53:45 +01:00
aa5ce4d450
Add some design documentation for replication
2016-04-12 15:14:10 +01:00
64b4aead15
make it work
2016-03-29 03:13:25 +01:00
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
44b2bf91be
Added installation instructions for postgres on CentOS 7
2015-12-05 15:09:20 +01:00
3e4de64bc9
Remove spurious .py from docs
2015-09-01 09:46:42 +01:00
c961cd7736
Clean up scripts/
2015-08-27 13:03:17 +01:00
d79ffa1898
typo
2015-05-09 14:45:37 +01:00
22a7ba8b22
Actually rename all isntances
2015-05-08 13:50:03 +01:00
3a42f32134
Reword port script usage
2015-05-08 13:47:48 +01:00
6101ce427a
Slight rewording
2015-05-07 18:58:28 +01:00
5fe26a9b5c
Reword docs/application_services.rst
2015-05-07 18:54:53 +01:00
35698484a5
Add some information on registering AS's
2015-05-07 18:51:09 +01:00
938939fd89
Move CAPTCHA_SETUP to docs/
2015-05-06 13:48:06 +01:00
32937f3ea0
database config is not kept in separate config file anymore
2015-05-01 14:06:54 +01:00
72443572bf
Mention that postgres databases must have the correct charset encoding
2015-04-29 11:50:33 +01:00
478e511db0
improve postgres blurb a bit
2015-04-29 00:48:07 +01:00
cc52f02d74
Fix rst
2015-04-28 18:09:20 +01:00
3151afee9e
Update docs/postgres.rst to explain port script usage
2015-04-28 17:59:27 +01:00
56f518d279
Add docs on how to use synapse with psycopg2
2015-04-27 14:53:35 +01:00
6d15401341
Mumble ReST mumble ``fixed-width`` mumble
2015-04-23 16:16:08 +01:00
8c78414284
Formatting / wording fixes to metrics doc
2015-04-23 16:14:08 +01:00
6c99491347
prometheus/metrics howto from Leo
2015-04-23 16:08:08 +01:00
e60353c4a0
Fix YAML syntax of turn config example
2015-02-24 19:34:21 +00:00
1eb319806b
clarify these instructions a media-repo specific
2014-12-24 16:56:32 +00:00
4f37c0ea9d
Merge branch 'develop' into media_repository
2014-12-10 16:55:06 +00:00
7f193b9958
update media repository implementation docs
2014-12-10 16:54:37 +00:00
8ffbb52eee
oops
2014-12-10 13:43:34 +00:00
32bc2b4fc1
update codestyle based on debate on #matrix-dev
2014-12-10 13:11:43 +00:00
279c48c8b4
Write the upload portion of version 1 of the media repository
2014-12-02 17:13:14 +00:00
33e9e0fb2d
move model/ into matrix-doc/drafts
2014-11-12 01:16:38 +02:00
ef1eb4c888
this got merged into matrix-doc/specification/00_basis.rst by someone
2014-11-12 01:14:06 +02:00
0ac2dc388e
move OLD_specification into matrix-doc/drafts
2014-11-12 01:04:32 +02:00
a0bc0fdf21
vestigial readme for sphinx
2014-11-12 00:18:26 +02:00
774cff3c72
move swagger impl to matrix-doc
2014-11-12 00:18:25 +02:00
0c59bc5e35
move stuff out of implementation-notes - /everything/ here should be implementation-notes now
2014-11-12 00:18:25 +02:00
7e1779d48c
this is ancient and has been moved to matrix-doc/drafts/federated_versioning_design_notes.rst
2014-11-12 00:18:25 +02:00
b6c48a694b
haven't i already moved you to matrix-doc twice? :/
2014-11-12 00:18:25 +02:00
216d5f6b52
this is obsolete and lives in matrix-doc in specification/30_server_server_api.rst now
2014-11-12 00:17:06 +02:00
bebca337c4
this has been merged into matrix-doc/specification/30_server_server_api.rst
2014-11-12 00:17:05 +02:00
a8ceeec0fd
Merge pull request #12 from matrix-org/federation_authorization
...
Federation authorization
2014-11-11 16:40:50 +00:00
303b455965
trivial spacing fix
2014-11-11 04:39:30 +00:00
f45a6a7004
Fix RST sublist formatting bug
2014-11-10 22:07:08 +00:00
f987393b32
moar boxes.
2014-11-10 21:56:52 +00:00
0b51d970b4
document up the current architecture a bit based on the workshop the other week
2014-11-10 18:43:16 +00:00
acb2d171e8
Merge branch 'develop' into event_signing
2014-10-27 11:14:11 +00:00
a065becea5
Merge branch 'docs-restructuring' of github.com:matrix-org/synapse into develop
2014-10-17 20:18:02 +01:00
c5cec1cc77
Rename 'meta' to 'unsigned'
2014-10-17 16:50:04 +01:00
c18a6433d4
typoe
2014-10-13 23:24:14 +01:00
984e207b59
Merge branch develop into server2server_signing
...
Conflicts:
synapse/app/homeserver.py
2014-10-13 10:58:50 +01:00
259b5e8451
move swagger JSON from synapse project to matrix-doc project
2014-10-09 20:43:07 +02:00
e1170d4edb
move matrix-generic content to new matrix-doc git project
2014-10-09 20:38:00 +02:00
81b956c70d
Add spec-additions.rst with info on recaptcha and common event fields.
2014-10-09 18:08:19 +01:00
d224358e21
Restructure specification sections.
2014-10-09 11:08:06 +01:00
917af4705b
Clarify that room alias domain names will be server-scoped; nonlocal edits are unliekly to work but nonlocal lookups will
2014-10-07 16:23:12 +01:00
9ac53ef8cf
SPEC-3: First hack at defining some of the various event related concepts
2014-10-07 11:38:02 +01:00
2fc00508fb
Add quick and dirty doc about state resolution
2014-10-06 17:34:44 +01:00
c72074b48e
Clarify how-to some more.
2014-10-06 14:57:26 +01:00
3ef2c946d5
Update JSFiddles/how-to to support the new registration format.
2014-10-06 14:52:46 +01:00
aaf1d499bf
Add more section headings.
2014-10-06 13:18:52 +01:00
94982392be
Clarify room permission / power level information.
2014-10-06 12:41:48 +01:00
51276c60bf
Add information about the initialSync API.
...
Outline and describe the keys from the initial sync API. Hide room-scoped
initial sync API for now as it is not implemented and needs more thought before
it can be specced.
2014-10-06 10:32:04 +01:00
78a3f43d9d
swagger: Added DELETE method for directory server.
2014-10-06 09:23:19 +01:00
02a44664b9
More spec work.
2014-10-03 17:38:30 +01:00
1fa0454288
Merge pull request #6 from matrix-org/paul/doc
...
Clarify how m.room.alias event works
2014-10-03 14:50:08 +01:00
ca0e8dedfb
Clarify how m.room.alias event works
2014-10-03 14:45:42 +01:00
ba11afafb9
Flesh out room alias section.
2014-10-03 14:39:58 +01:00
7e1437c6b1
Add more information to TODOs. Explain m.room.join_rules.
2014-10-03 10:34:29 +01:00
1aa5cc9178
Federation protocol URLs should have an H2 heading, not H1
2014-10-02 18:11:04 +01:00
bc1d685a8c
Remove TODO note about VoIP events as they now have their own entire section
2014-10-02 18:00:31 +01:00
f6b9853ad0
Merge pull request #5 from matrix-org/paul/doc
...
Document the Profile system
2014-10-02 17:37:21 +01:00
de38f54f22
Document the Profile system
2014-10-02 17:18:32 +01:00
036333412d
Add todo notes
2014-10-02 14:38:53 +01:00
82e278029c
Remove incorrect reasons for empty PDU lists.
2014-10-02 14:38:22 +01:00
1561ef56ed
Remove note about assymetry of having left a room.
...
Currently, if you leave a room you still appear in the members list.
This is basically a bug with the current implementation/spec, rather
than something that should happen.
2014-10-02 14:35:39 +01:00
f368ad946e
m.room.ops_levels includes redact_level
2014-10-02 14:33:26 +01:00
918e71adb7
Don't use spaces in example room alias
2014-10-02 14:31:21 +01:00
cf3188352b
Fix default value and key names.
2014-10-02 14:30:25 +01:00
6860a18c12
Be less alarmist about not using an ID server.
2014-10-02 14:27:35 +01:00
ff553cc9dd
Alias lookups return a server list.
2014-10-02 14:26:58 +01:00
b2d41b1cd9
All room state is currently shared.
2014-10-02 14:25:47 +01:00
bf8b9b90cd
Added a TODO-doc marker about the presence timing system
2014-10-01 19:37:18 +01:00
c5757a0266
Define the client and server APIs for Presence
2014-10-01 19:35:13 +01:00
ee447abcad
Continue moving content out of docs/model/presence into the main spec; delete model docs that are duplicated
2014-10-01 18:34:08 +01:00
a940a87ddc
SPEC-25: Add details on how to prune redacted events.
...
SPEC-25 #comment I've added the details of what the server should do on
receipt of a redaction event. In reality it can do whatever it wants,
and its probably a reasonable implementation to flag it up to a server
admin for verification before actually redacting an event.
2014-10-01 18:18:44 +01:00
5813e81dc6
Move documented but-unimplemented 'presence idle times' into a new document to contain such features
2014-10-01 17:59:55 +01:00
a6d3be4dbf
s/m.room.redacted/m.room.redaction/
2014-10-01 17:55:31 +01:00
166bec0c08
Nuke the entire 'Typing Notifications' spec section given as they don't exist yet in the implementation
2014-10-01 17:33:18 +01:00
392dc8af59
Annotate all the 'TODO' marks as relating to either the specification itself or the documentation thereof
2014-09-30 18:11:24 +01:00
9605593d11
Merge branch 'develop' into server2server_signing
...
Conflicts:
synapse/storage/__init__.py
tests/rest/test_presence.py
2014-09-30 17:55:06 +01:00
1f76377a7c
Re-wrap content after latest additions
2014-09-29 18:40:15 +01:00
dca75a08ba
Merge remote-tracking branch 'origin/develop' into develop
2014-09-29 18:37:28 +01:00
2d61dbc774
Extended docs about the registration/login flows
2014-09-29 18:36:10 +01:00
3ee9a67aa4
Reörder the specification sections, to move 'Registration and Login' first, where it logically belongs
2014-09-29 18:36:10 +01:00
ae953b0884
Huge whitespace hackery - reflow all (content) paragraphs at tw=80
2014-09-29 18:36:10 +01:00
d5bf210998
No longer need the Freenode verification key file
2014-09-29 18:36:10 +01:00
389285585d
Add a 'Redactions' section.
2014-09-29 17:19:45 +01:00
3656eb4740
Add m.room.redacted in events list
2014-09-29 16:39:08 +01:00
472ef19100
No longer need the Freenode verification key file
2014-09-29 14:22:21 +01:00
ec5fb77a66
Just use a yaml list for turn servers
2014-09-25 19:18:32 +02:00
6e72ee62ae
Add realm to coturn options (it needs it).
2014-09-25 17:21:52 +01:00
48ea055781
fix rst warnings
2014-09-25 17:01:27 +01:00
9bcedf224e
add howto for setting up your very own TURN server
2014-09-25 16:58:21 +01:00
2771efb51c
Update API docs to include notes on /rooms/$roomid/state
2014-09-23 15:39:04 +01:00
6876b1a25b
fix grammatics
2014-09-22 21:45:50 +01:00
107e7d5d91
Add section to explain how to sign events such that we can redact message contents
2014-09-22 19:42:07 +01:00
09d79b0a9b
Merge branch 'develop' into server2server_signing
2014-09-22 18:54:00 +01:00
fceb5f7b22
SYN-39: Add documentation explaining how to check a signature
2014-09-18 18:15:50 +01:00
704e7e9f44
Merge branch 'release-v0.3.0' of github.com:matrix-org/synapse
2014-09-18 13:05:07 +01:00
9f94f9de48
freenode verification
2014-09-17 23:53:53 +01:00
f4094c5eb3
Update spec with the lifetime field.
2014-09-16 14:54:52 +01:00
0b8a3bc3b9
Update spec to include m.login.email.identity
2014-09-15 15:27:17 +01:00
bf6fa6dd3d
Merge branch 'develop' of github.com:matrix-org/synapse into registration-api-changes
2014-09-15 09:46:33 +01:00
21b45d2a5b
Update the spec document to replace the candidate message with the candidates message.
2014-09-12 18:19:19 +01:00
09a59ce2d3
Some words about glare
2014-09-12 14:24:56 +01:00
2bd4346075
More rst formatting.
2014-09-09 15:13:50 -07:00
f23e5b17b6
Extra restrictions to make parsing easier.
2014-09-09 15:11:06 -07:00
56a358481e
Tyops
2014-09-09 15:00:48 -07:00
d5704cf2a3
Added initial draft for human-readable ID rules.
2014-09-09 14:53:35 -07:00
550e8f32ac
Move model to client-server for now.
2014-09-09 13:51:13 -07:00
d692994ea4
Updated jsfiddle links to point to github
2014-09-08 14:16:22 -07:00
586e0df62d
Updated spec and api docs to desired new format.
2014-09-08 11:07:52 -07:00
7bff9b6269
Minor spec tweaks.
2014-09-08 11:28:50 +02:00
aa90e53312
add todo
2014-09-06 00:32:39 -07:00
684001ac62
Document new invite key added to createRoom api
2014-09-06 01:12:12 +01:00
fc65b68f30
Add m.roo.aliases
2014-09-05 22:01:10 +01:00
e0fa4cf874
Spelling
2014-09-05 18:22:24 +01:00
9243f0c5e3
Add docs on how to sign json
2014-09-05 17:42:54 +01:00
0d1d9f3e9c
merge spec changes
2014-09-04 23:16:04 -07:00
9c82276760
Add version 0 of the VoIP specification.
2014-09-04 18:20:27 +01:00
f196d77f66
Added federation protocol urls section from other docs.
2014-09-03 18:07:42 +01:00
5391ccdfe6
Marked docs/client-server/specification.rst as old.
2014-09-03 18:02:33 +01:00
f68dbbd3da
More explanation of federation keys.
2014-09-03 18:00:00 +01:00
79bf9d25db
Added more terms.
2014-09-03 17:48:08 +01:00
7c4ce957c7
Unindent list in specification to remove blockquote
2014-09-03 17:37:19 +01:00
f93aba1d66
Fix formating for threat model
2014-09-03 17:28:35 +01:00
e3b261b0b7
Move securitY threat model docs into specification
2014-09-03 17:26:16 +01:00
581c54bebe
Add exception handling to directory servlet, so we don't 500. Mark directory API as volatile in the api docs.
2014-09-03 16:27:01 +01:00
56bc57cf50
apidocs: Added m.room.name
2014-09-03 13:42:56 +01:00
27cdbf7b94
apidocs: Tweak join response format. Explicitly state empty JSON objects where they are required by the spec. Mark unimplemented room GET APIs clearly.
2014-09-03 13:32:33 +01:00
cd0afb85c4
Updated feedback api docs and fixed feedback content template bug
2014-09-03 13:08:17 +01:00
dfea1730dc
apidocs: mtime_age > last_active_ago. Presence REST: Sanity check values in invite/drop arrays.
2014-09-03 12:09:20 +01:00
c54d8df504
Update API docs to use 'presence' key not 'state'. Fixed error messages when setting presence.
2014-09-03 11:45:30 +01:00
3a3fadcece
Make API docs not lie on registration/login.
2014-09-03 10:58:53 +01:00
ce5c88006e
Update port numbers.
2014-09-03 10:47:07 +01:00
46ac4a2f85
Fill out power level bits in the spec
2014-09-03 10:44:46 +01:00
8ad056b207
Prefix API links with /docs/api/client-server so they should link through correctly on matrix.org
2014-09-03 10:32:51 +01:00
8c793e0704
howto: Link jsfiddles correctly. Hide ugly TODOs.
2014-09-03 09:14:16 +01:00
9fae76107f
fix rst
2014-09-03 04:30:51 +01:00
2b9afa775e
more critique
2014-09-02 23:50:40 +01:00
70aa4b9231
Edited room creation section to mention all the events created when the room is.
2014-09-02 21:45:36 +01:00
0aacab43ca
Added Qs which should be answered in the marked TODOs
2014-09-02 21:17:47 +01:00
dcbdfcc9d2
only need one voip section :)
2014-09-02 21:16:59 +01:00
7819a1010c
general documentation review and editing
2014-09-02 21:15:03 +01:00
ab6e1abe9c
Added the new power level related events which were recently introduced.
2014-09-02 21:12:46 +01:00
707cd32b13
Added more room alias bullet points.
2014-09-02 20:38:25 +01:00
2f5182b2d2
Finished up Identity section in the architecture section.
2014-09-02 20:32:09 +01:00
3167d47882
Minor formatting tweaks.
2014-09-02 17:58:16 +01:00
9f94b11d4c
Added section on rate limiting.
2014-09-02 17:51:45 +01:00
b175179e47
ALL THE LINKS! Most APIs now link to relative paths off the doc, outlined at the bottom of the .rst.
2014-09-02 17:34:24 +01:00
1952a1c68d
More formatting, more TODOs. Settled on a way of linking to external API docs; started converting references to relative links.
2014-09-02 17:05:30 +01:00
9613d65756
spec: Added internal links to different sections. Added NOTE and WARNING admonitions and hide away loooong TODO lists behind comments. Smaller ones remain.
2014-09-02 16:38:21 +01:00
b4984d5e15
Updated howto.rst to use the new APIs. Updated JSFiddles to use 8008. Linked new fiddles with howto.rst. Added more explanations.
2014-09-02 15:29:43 +01:00
4ac80b8570
Whoops: Put /events parameters object in the right part of the api tree.
2014-09-02 12:09:47 +01:00
5539251d82
Updated API docs with new keys on /createRoom and new API /rooms/$roomid/ban
2014-09-02 11:54:01 +01:00
fdcb876495
More ban spec. Added 'name' and 'topic' keys to /createRoom.
2014-09-02 11:46:53 +01:00
ab0637c2c3
Yet more bullet points on various sections.
2014-09-02 10:41:00 +01:00
15a7312273
Added section on banning users, currently in flux as the API changes / is implemented.
2014-09-02 09:34:28 +01:00
94bb4031f3
Expanded on bullet points in several sections.
2014-09-02 08:58:53 +01:00
74cffcf51a
Small formatting errors
2014-09-01 17:57:44 +01:00
6d07a28a29
fix lying docs
2014-09-01 17:55:41 +01:00
99ce820cc8
Little bit more on syncing APIs, need to know more about responses before more work can be done on it.
2014-09-01 17:51:31 +01:00
32bfd567ac
Added docs on presence 'last_active' field
2014-09-01 17:22:33 +01:00
5a11a8ef69
Flesh out Room Events.
2014-09-01 16:52:33 +01:00
401c16559d
Specced out state/non-state events. Start working on the myriad of syncing APIs.
2014-09-01 15:58:20 +01:00
02f4e3b3ff
Rename 'state' presence key to the much more obvious 'presence'; maintain a legacy 'state' copy for now
2014-09-01 14:45:41 +01:00
f500dd627a
Fleshed out joining/leaving rooms. Added M_LIMIT_EXCEEDED standard error code for rate limited requests.
2014-09-01 14:44:25 +01:00
389ee3624c
Added /web folder which contains html/css (based off the default swagger-ui) for viewing the c-s json api.
2014-09-01 14:11:26 +01:00
51b0b5c5ab
Renamed json files because: paths.
2014-09-01 14:05:28 +01:00
3bb93abb34
Start digging into invite/join/leave sections.
2014-09-01 10:38:48 +01:00
8fe912d95c
change the world: make the default matrix API URL prefix /_matrix rather than /matrix to make it easier for existing websites to mount a HS in their namespace without collisions.
...
perl -pi -e 's#/matrix#/_matrix#g' ./cmdclient/console.py ./docs/client-server/howto.rst ./docs/client-server/specification.rst ./docs/client-server/swagger_matrix/directory ./docs/client-server/swagger_matrix/events ./docs/client-server/swagger_matrix/login ./docs/client-server/swagger_matrix/presence ./docs/client-server/swagger_matrix/profile ./docs/client-server/swagger_matrix/registration ./docs/client-server/swagger_matrix/rooms ./docs/server-server/specification.rst ./graph/graph.py ./jsfiddles/create_room_send_msg/demo.js ./jsfiddles/event_stream/demo.js ./jsfiddles/example_app/demo.js ./jsfiddles/register_login/demo.js ./jsfiddles/room_memberships/demo.js ./synapse/api/urls.py ./tests/federation/test_federation.py ./tests/handlers/test_presence.py ./tests/handlers/test_typing.py ./tests/rest/test_events.py ./tests/rest/test_presence.py ./tests/rest/test_profile.py ./tests/rest/test_rooms.py ./webclient/components/fileUpload/file-upload-service.js ./webclient/components/matrix/matrix-service.js
2014-08-31 14:51:37 +01:00
74cc722b96
Added case-sensitivity notes on IDs, added TODO on UTF-8.
2014-08-29 17:45:09 +01:00
ca025c2b1d
Rooms: More subsections, more bullet points, more detail.
2014-08-29 16:50:41 +01:00
339dd3dc6c
Update API swagger JSON to default to POSTs not PUTs when describing the API.
2014-08-29 15:01:55 +01:00
898dde8812
Flesh out API standards.
2014-08-29 13:50:31 +01:00
ac56ac67cc
Expand architecture section to introduce room IDs, room aliases, user IDs, events and federation.
2014-08-29 11:42:05 +01:00
d1bf659ed7
Redo architecture diagram. Reword parts of federation. Formatting fixes and tweaks.
2014-08-29 10:30:14 +01:00
068b348e7e
Start fleshing out architecture section. Moar .rst formatting! Reword some copypastaed sections to be terser.
2014-08-28 17:40:12 +01:00
62dfa3c741
Flesh out m.room.message msgtypes
2014-08-28 15:35:28 +01:00
8d7d251c35
Support multiple login flows when deciding how to login. Updated cmdclient and spec. Webclient doesn't need updating for this.
2014-08-28 14:56:55 +01:00
52cfdfd5f1
Fleshed out login spec.
2014-08-28 14:49:21 +01:00
64e927108b
Added skeleton specification for a general feel of the layout.
2014-08-28 11:35:24 +01:00
660129deb1
Shuffle files around in /docs
2014-08-28 09:45:05 +01:00
6ad9d9c226
Added /rooms/$roomid/state and /rooms/$roomid/initialSync to API docs.
2014-08-27 17:02:08 +01:00
e179ed1f60
Added generic state/non-state event sending to the API docs.
2014-08-27 16:16:40 +01:00
abe2035d85
api docs: Finished adding all C-S APIs. Added initialSync, publicRooms, membership changes (generic and RPCy) and directory paths.
2014-08-27 15:41:38 +01:00
71095f4e6e
Updated swagger JSON: cleaned up unused entries. Converted most paths to the new format.
2014-08-27 12:14:35 +01:00
6c609425ba
Removed urls.rst - The API docs / swagger JSON should be used as the canonical source for the REST API. Keeping urls.rst around is just an extra maintenance burden.
2014-08-27 12:14:35 +01:00
e3c6c9057b
Added initial swagger REST API spec.
2014-08-22 13:40:37 +01:00
5048f4a915
Added final jsfiddle: an example app demonstrating most of the c2s api.
2014-08-20 16:45:59 +01:00
f4839ea042
Add some static fiddles for now (will migrate to github paths eventually)
2014-08-19 17:48:49 +01:00
b796d4b9d0
Added registration/login jsfiddle, formatted so it can be loaded directly from jsfiddle. Requires jQuery 1.8.3
2014-08-19 16:39:42 +01:00
7e83a58c4d
Proofing
2014-08-19 14:38:34 +01:00
e636e8799e
More formatting, more clarity.
2014-08-19 14:25:03 +01:00
77f1cc7d6d
rst formatting, section heading intro blurbs.
2014-08-19 14:03:16 +01:00
8464009a66
Added top level TODO and a bit more info on storing the 'end' token.
2014-08-19 13:43:45 +01:00
185a68b473
Added a first cut for a 'how to' on the client-server API.
2014-08-19 12:31:17 +01:00
1731781145
Document that /rooms/:room_id/members/list yields profile and presence information about room members
2014-08-15 17:24:02 +01:00
0b179db36d
s/Synapse/Matrix/
2014-08-14 18:58:40 +01:00
7a025d6368
It's called Matrix :)
2014-08-14 18:58:01 +01:00
94eb2560f4
Add documentation about Federation Queries and EDUs
2014-08-14 17:50:55 +01:00
30da8c81c7
webclient: You can now paginate in rooms. Defaults to 10 messages, with a button to get more (needs to be hooked into infini-scrolling).
2014-08-14 17:23:47 +01:00
61933f8e52
Added M_UNKNOWN_TOKEN error code and send it when there is an unrecognised access_token
2014-08-14 13:47:39 +01:00
59dfbaba3b
when we're talking about backfilling data in federation, call it backfilling - not pagination.
2014-08-13 18:17:09 +01:00
b80b32d1c0
pagination was a terrible name
2014-08-13 18:17:08 +01:00
820ed34abe
Namespace all the Federation HTTP URLs to /matrix/federation/v1/...
2014-08-13 15:07:55 +01:00
cf45ed1bc0
Add .rst suffix to documentation files so that github auto-formats them
2014-08-12 16:39:35 +01:00
4f475c7697
Reference Matrix Home Server
2014-08-12 15:10:52 +01:00
Richard van der Hoff