Commit Graph

302 Commits (c92a8aa5780a71b5ab0227f204606004b16ff7fb)

Author SHA1 Message Date
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
David Baker e60353c4a0 Fix YAML syntax of turn config example 2015-02-24 19:34:21 +00:00
Matthew Hodgson 1eb319806b clarify these instructions a media-repo specific 2014-12-24 16:56:32 +00:00
Mark Haines 4f37c0ea9d Merge branch 'develop' into media_repository 2014-12-10 16:55:06 +00:00
Mark Haines 7f193b9958 update media repository implementation docs 2014-12-10 16:54:37 +00:00
Matthew Hodgson 8ffbb52eee oops 2014-12-10 13:43:34 +00:00
Matthew Hodgson 32bc2b4fc1 update codestyle based on debate on #matrix-dev 2014-12-10 13:11:43 +00:00
Mark Haines 279c48c8b4 Write the upload portion of version 1 of the media repository 2014-12-02 17:13:14 +00:00
Matthew Hodgson 33e9e0fb2d move model/ into matrix-doc/drafts 2014-11-12 01:16:38 +02:00
Matthew Hodgson ef1eb4c888 this got merged into matrix-doc/specification/00_basis.rst by someone 2014-11-12 01:14:06 +02:00
Matthew Hodgson 0ac2dc388e move OLD_specification into matrix-doc/drafts 2014-11-12 01:04:32 +02:00
Matthew Hodgson a0bc0fdf21 vestigial readme for sphinx 2014-11-12 00:18:26 +02:00
Matthew Hodgson 774cff3c72 move swagger impl to matrix-doc 2014-11-12 00:18:25 +02:00
Matthew Hodgson 0c59bc5e35 move stuff out of implementation-notes - /everything/ here should be implementation-notes now 2014-11-12 00:18:25 +02:00
Matthew Hodgson 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
Matthew Hodgson b6c48a694b haven't i already moved you to matrix-doc twice? :/ 2014-11-12 00:18:25 +02:00
Matthew Hodgson 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
Matthew Hodgson bebca337c4 this has been merged into matrix-doc/specification/30_server_server_api.rst 2014-11-12 00:17:05 +02:00
Mark Haines a8ceeec0fd Merge pull request #12 from matrix-org/federation_authorization
Federation authorization
2014-11-11 16:40:50 +00:00
Matthew Hodgson 303b455965 trivial spacing fix 2014-11-11 04:39:30 +00:00
Erik Johnston f45a6a7004 Fix RST sublist formatting bug 2014-11-10 22:07:08 +00:00
Matthew Hodgson f987393b32 moar boxes. 2014-11-10 21:56:52 +00:00
Matthew Hodgson 0b51d970b4 document up the current architecture a bit based on the workshop the other week 2014-11-10 18:43:16 +00:00
Mark Haines acb2d171e8 Merge branch 'develop' into event_signing 2014-10-27 11:14:11 +00:00
Erik Johnston a065becea5 Merge branch 'docs-restructuring' of github.com:matrix-org/synapse into develop 2014-10-17 20:18:02 +01:00
Mark Haines c5cec1cc77 Rename 'meta' to 'unsigned' 2014-10-17 16:50:04 +01:00
Matthew Hodgson c18a6433d4 typoe 2014-10-13 23:24:14 +01:00
Mark Haines 984e207b59 Merge branch develop into server2server_signing
Conflicts:
	synapse/app/homeserver.py
2014-10-13 10:58:50 +01:00
Matthew Hodgson 259b5e8451 move swagger JSON from synapse project to matrix-doc project 2014-10-09 20:43:07 +02:00
Matthew Hodgson e1170d4edb move matrix-generic content to new matrix-doc git project 2014-10-09 20:38:00 +02:00
Kegan Dougal 81b956c70d Add spec-additions.rst with info on recaptcha and common event fields. 2014-10-09 18:08:19 +01:00
Kegan Dougal d224358e21 Restructure specification sections. 2014-10-09 11:08:06 +01:00
Paul "LeoNerd" Evans 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
Erik Johnston 9ac53ef8cf SPEC-3: First hack at defining some of the various event related concepts 2014-10-07 11:38:02 +01:00
Erik Johnston 2fc00508fb Add quick and dirty doc about state resolution 2014-10-06 17:34:44 +01:00
Kegan Dougal c72074b48e Clarify how-to some more. 2014-10-06 14:57:26 +01:00
Kegan Dougal 3ef2c946d5 Update JSFiddles/how-to to support the new registration format. 2014-10-06 14:52:46 +01:00
Kegan Dougal aaf1d499bf Add more section headings. 2014-10-06 13:18:52 +01:00
Kegan Dougal 94982392be Clarify room permission / power level information. 2014-10-06 12:41:48 +01:00
Kegan Dougal 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
Kegan Dougal 78a3f43d9d swagger: Added DELETE method for directory server. 2014-10-06 09:23:19 +01:00
Kegan Dougal 02a44664b9 More spec work. 2014-10-03 17:38:30 +01:00
Erik Johnston 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
Paul "LeoNerd" Evans ca0e8dedfb Clarify how m.room.alias event works 2014-10-03 14:45:42 +01:00
Kegan Dougal ba11afafb9 Flesh out room alias section. 2014-10-03 14:39:58 +01:00
Kegan Dougal 7e1437c6b1 Add more information to TODOs. Explain m.room.join_rules. 2014-10-03 10:34:29 +01:00
Paul "LeoNerd" Evans 1aa5cc9178 Federation protocol URLs should have an H2 heading, not H1 2014-10-02 18:11:04 +01:00
Paul "LeoNerd" Evans bc1d685a8c Remove TODO note about VoIP events as they now have their own entire section 2014-10-02 18:00:31 +01:00
Erik Johnston f6b9853ad0 Merge pull request #5 from matrix-org/paul/doc
Document the Profile system
2014-10-02 17:37:21 +01:00
Paul "LeoNerd" Evans de38f54f22 Document the Profile system 2014-10-02 17:18:32 +01:00
Erik Johnston 036333412d Add todo notes 2014-10-02 14:38:53 +01:00
Erik Johnston 82e278029c Remove incorrect reasons for empty PDU lists. 2014-10-02 14:38:22 +01:00
Erik Johnston 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
Erik Johnston f368ad946e m.room.ops_levels includes redact_level 2014-10-02 14:33:26 +01:00
Erik Johnston 918e71adb7 Don't use spaces in example room alias 2014-10-02 14:31:21 +01:00
Erik Johnston cf3188352b Fix default value and key names. 2014-10-02 14:30:25 +01:00
Erik Johnston 6860a18c12 Be less alarmist about not using an ID server. 2014-10-02 14:27:35 +01:00
Erik Johnston ff553cc9dd Alias lookups return a server list. 2014-10-02 14:26:58 +01:00
Erik Johnston b2d41b1cd9 All room state is currently shared. 2014-10-02 14:25:47 +01:00
Paul "LeoNerd" Evans bf8b9b90cd Added a TODO-doc marker about the presence timing system 2014-10-01 19:37:18 +01:00
Paul "LeoNerd" Evans c5757a0266 Define the client and server APIs for Presence 2014-10-01 19:35:13 +01:00
Paul "LeoNerd" Evans 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
Erik Johnston 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
Paul "LeoNerd" Evans 5813e81dc6 Move documented but-unimplemented 'presence idle times' into a new document to contain such features 2014-10-01 17:59:55 +01:00
Erik Johnston a6d3be4dbf s/m.room.redacted/m.room.redaction/ 2014-10-01 17:55:31 +01:00
Paul "LeoNerd" Evans 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
Paul "LeoNerd" Evans 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
Mark Haines 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
Paul "LeoNerd" Evans 1f76377a7c Re-wrap content after latest additions 2014-09-29 18:40:15 +01:00
Paul "LeoNerd" Evans dca75a08ba Merge remote-tracking branch 'origin/develop' into develop 2014-09-29 18:37:28 +01:00
Paul "LeoNerd" Evans 2d61dbc774 Extended docs about the registration/login flows 2014-09-29 18:36:10 +01:00
Paul "LeoNerd" Evans 3ee9a67aa4 Reörder the specification sections, to move 'Registration and Login' first, where it logically belongs 2014-09-29 18:36:10 +01:00
Paul "LeoNerd" Evans ae953b0884 Huge whitespace hackery - reflow all (content) paragraphs at tw=80 2014-09-29 18:36:10 +01:00
Paul "LeoNerd" Evans d5bf210998 No longer need the Freenode verification key file 2014-09-29 18:36:10 +01:00
Erik Johnston 389285585d Add a 'Redactions' section. 2014-09-29 17:19:45 +01:00
Erik Johnston 3656eb4740 Add m.room.redacted in events list 2014-09-29 16:39:08 +01:00
Paul "LeoNerd" Evans 472ef19100 No longer need the Freenode verification key file 2014-09-29 14:22:21 +01:00
David Baker ec5fb77a66 Just use a yaml list for turn servers 2014-09-25 19:18:32 +02:00
David Baker 6e72ee62ae Add realm to coturn options (it needs it). 2014-09-25 17:21:52 +01:00
David Baker 48ea055781 fix rst warnings 2014-09-25 17:01:27 +01:00
David Baker 9bcedf224e add howto for setting up your very own TURN server 2014-09-25 16:58:21 +01:00
Kegan Dougal 2771efb51c Update API docs to include notes on /rooms/$roomid/state 2014-09-23 15:39:04 +01:00
Matthew Hodgson 6876b1a25b fix grammatics 2014-09-22 21:45:50 +01:00
Mark Haines 107e7d5d91 Add section to explain how to sign events such that we can redact message contents 2014-09-22 19:42:07 +01:00
Mark Haines 09d79b0a9b Merge branch 'develop' into server2server_signing 2014-09-22 18:54:00 +01:00
Mark Haines fceb5f7b22 SYN-39: Add documentation explaining how to check a signature 2014-09-18 18:15:50 +01:00
Erik Johnston 704e7e9f44 Merge branch 'release-v0.3.0' of github.com:matrix-org/synapse 2014-09-18 13:05:07 +01:00
Matthew Hodgson 9f94f9de48 freenode verification 2014-09-17 23:53:53 +01:00
David Baker f4094c5eb3 Update spec with the lifetime field. 2014-09-16 14:54:52 +01:00
Kegan Dougal 0b8a3bc3b9 Update spec to include m.login.email.identity 2014-09-15 15:27:17 +01:00
Kegan Dougal bf6fa6dd3d Merge branch 'develop' of github.com:matrix-org/synapse into registration-api-changes 2014-09-15 09:46:33 +01:00
David Baker 21b45d2a5b Update the spec document to replace the candidate message with the candidates message. 2014-09-12 18:19:19 +01:00
David Baker 09a59ce2d3 Some words about glare 2014-09-12 14:24:56 +01:00
Kegan Dougal 2bd4346075 More rst formatting. 2014-09-09 15:13:50 -07:00
Kegan Dougal f23e5b17b6 Extra restrictions to make parsing easier. 2014-09-09 15:11:06 -07:00
Kegan Dougal 56a358481e Tyops 2014-09-09 15:00:48 -07:00
Kegan Dougal d5704cf2a3 Added initial draft for human-readable ID rules. 2014-09-09 14:53:35 -07:00
Kegan Dougal 550e8f32ac Move model to client-server for now. 2014-09-09 13:51:13 -07:00
Kegan Dougal d692994ea4 Updated jsfiddle links to point to github 2014-09-08 14:16:22 -07:00
Kegan Dougal 586e0df62d Updated spec and api docs to desired new format. 2014-09-08 11:07:52 -07:00
Kegan Dougal 7bff9b6269 Minor spec tweaks. 2014-09-08 11:28:50 +02:00
Matthew Hodgson aa90e53312 add todo 2014-09-06 00:32:39 -07:00
Erik Johnston 684001ac62 Document new invite key added to createRoom api 2014-09-06 01:12:12 +01:00
Erik Johnston fc65b68f30 Add m.roo.aliases 2014-09-05 22:01:10 +01:00
Mark Haines e0fa4cf874 Spelling 2014-09-05 18:22:24 +01:00
Mark Haines 9243f0c5e3 Add docs on how to sign json 2014-09-05 17:42:54 +01:00
Matthew Hodgson 0d1d9f3e9c merge spec changes 2014-09-04 23:16:04 -07:00
David Baker 9c82276760 Add version 0 of the VoIP specification. 2014-09-04 18:20:27 +01:00
Kegan Dougal f196d77f66 Added federation protocol urls section from other docs. 2014-09-03 18:07:42 +01:00
Kegan Dougal 5391ccdfe6 Marked docs/client-server/specification.rst as old. 2014-09-03 18:02:33 +01:00
Kegan Dougal f68dbbd3da More explanation of federation keys. 2014-09-03 18:00:00 +01:00
Kegan Dougal 79bf9d25db Added more terms. 2014-09-03 17:48:08 +01:00
Mark Haines 7c4ce957c7 Unindent list in specification to remove blockquote 2014-09-03 17:37:19 +01:00
Mark Haines f93aba1d66 Fix formating for threat model 2014-09-03 17:28:35 +01:00
Mark Haines e3b261b0b7 Move securitY threat model docs into specification 2014-09-03 17:26:16 +01:00
Kegan Dougal 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
Kegan Dougal 56bc57cf50 apidocs: Added m.room.name 2014-09-03 13:42:56 +01:00
Kegan Dougal 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
Kegan Dougal cd0afb85c4 Updated feedback api docs and fixed feedback content template bug 2014-09-03 13:08:17 +01:00
Kegan Dougal dfea1730dc apidocs: mtime_age > last_active_ago. Presence REST: Sanity check values in invite/drop arrays. 2014-09-03 12:09:20 +01:00
Kegan Dougal c54d8df504 Update API docs to use 'presence' key not 'state'. Fixed error messages when setting presence. 2014-09-03 11:45:30 +01:00
Kegan Dougal 3a3fadcece Make API docs not lie on registration/login. 2014-09-03 10:58:53 +01:00
Kegan Dougal ce5c88006e Update port numbers. 2014-09-03 10:47:07 +01:00
Erik Johnston 46ac4a2f85 Fill out power level bits in the spec 2014-09-03 10:44:46 +01:00
Kegan Dougal 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
Kegan Dougal 8c793e0704 howto: Link jsfiddles correctly. Hide ugly TODOs. 2014-09-03 09:14:16 +01:00
Matthew Hodgson 9fae76107f fix rst 2014-09-03 04:30:51 +01:00
Matthew Hodgson 2b9afa775e more critique 2014-09-02 23:50:40 +01:00
Kegan Dougal 70aa4b9231 Edited room creation section to mention all the events created when the room is. 2014-09-02 21:45:36 +01:00
Kegan Dougal 0aacab43ca Added Qs which should be answered in the marked TODOs 2014-09-02 21:17:47 +01:00
Matthew Hodgson dcbdfcc9d2 only need one voip section :) 2014-09-02 21:16:59 +01:00
Matthew Hodgson 7819a1010c general documentation review and editing 2014-09-02 21:15:03 +01:00
Kegan Dougal ab6e1abe9c Added the new power level related events which were recently introduced. 2014-09-02 21:12:46 +01:00
Kegan Dougal 707cd32b13 Added more room alias bullet points. 2014-09-02 20:38:25 +01:00
Kegan Dougal 2f5182b2d2 Finished up Identity section in the architecture section. 2014-09-02 20:32:09 +01:00
Kegan Dougal 3167d47882 Minor formatting tweaks. 2014-09-02 17:58:16 +01:00
Kegan Dougal 9f94b11d4c Added section on rate limiting. 2014-09-02 17:51:45 +01:00
Kegan Dougal 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
Kegan Dougal 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
Kegan Dougal 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
Kegan Dougal 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
Kegan Dougal 4ac80b8570 Whoops: Put /events parameters object in the right part of the api tree. 2014-09-02 12:09:47 +01:00
Kegan Dougal 5539251d82 Updated API docs with new keys on /createRoom and new API /rooms/$roomid/ban 2014-09-02 11:54:01 +01:00
Kegan Dougal fdcb876495 More ban spec. Added 'name' and 'topic' keys to /createRoom. 2014-09-02 11:46:53 +01:00