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
Richard van der Hoff