summary refs log tree commit diff
path: root/MAP.rst
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-08-13 15:53:44 +0100
committerKegan Dougal <kegan@matrix.org>2014-08-13 15:53:44 +0100
commit38c7e923312047b2c26c6ca3f15a9813159088e7 (patch)
tree819149e28fe875a9e8ee1fe22a86f4d64cdd4355 /MAP.rst
parentMerge branch 'master' of github.com:matrix-org/synapse (diff)
parentmore quickstart fixes (diff)
downloadsynapse-38c7e923312047b2c26c6ca3f15a9813159088e7.tar.xz
Merge branch 'master' of github.com:matrix-org/synapse
Diffstat (limited to 'MAP.rst')
-rw-r--r--MAP.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/MAP.rst b/MAP.rst
new file mode 100644
index 0000000000..0f8e9818a8
--- /dev/null
+++ b/MAP.rst
@@ -0,0 +1,35 @@
+Directory Structure
+===================
+
+Warning: this may be a bit stale...
+
+::
+
+    .
+    ├── cmdclient           Basic CLI python Matrix client
+    ├── demo                Scripts for running standalone Matrix demos
+    ├── docs                All doc, including the draft Matrix API spec
+    │   ├── client-server       The client-server Matrix API spec
+    │   ├── model               Domain-specific elements of the Matrix API spec
+    │   ├── server-server       The server-server model of the Matrix API spec
+    │   └── sphinx              The internal API doc of the Synapse homeserver
+    ├── experiments         Early experiments of using Synapse's internal APIs
+    ├── graph               Visualisation of Matrix's distributed message store 
+    ├── synapse             The reference Matrix homeserver implementation
+    │   ├── api                 Common building blocks for the APIs
+    │   │   ├── events              Definition of state representation Events 
+    │   │   └── streams             Definition of streamable Event objects
+    │   ├── app                 The __main__ entry point for the homeserver
+    │   ├── crypto              The PKI client/server used for secure federation
+    │   │   └── resource            PKI helper objects (e.g. keys)
+    │   ├── federation          Server-server state replication logic
+    │   ├── handlers            The main business logic of the homeserver
+    │   ├── http                Wrappers around Twisted's HTTP server & client
+    │   ├── rest                Servlet-style RESTful API
+    │   ├── storage             Persistence subsystem (currently only sqlite3)
+    │   │   └── schema              sqlite persistence schema
+    │   └── util                Synapse-specific utilities
+    ├── tests               Unit tests for the Synapse homeserver
+    └── webclient           Basic AngularJS Matrix web client
+
+