Skip to content

Commit 0c3af33

Browse files
ovanovbjester
authored andcommitted
move Syncing documentation.
1 parent dd1de63 commit 0c3af33

2 files changed

Lines changed: 9 additions & 5 deletions

File tree

docs/gettingstarted/index.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,14 @@
11
Getting Started
22
========
3+
This document is intended to provide a high-level overview of how Morango internals work and how Kolibri interacts with it.
4+
5+
Syncing Process
6+
--------
7+
8+
By default, Kolibri instances are listening for other Kolibri instances in the same network, while at the same time, exposing an URL to which other instances can request a connection. The connection is established via a REST call to the endpoint. For the exact request flow, see the `documentation <https://kolibri-dev.readthedocs.io/en/develop/dataflow/index.html#data-flow>`_.
9+
After a connection request the two instances exchange certificates, which are used to authenticate the other instance. If the certificates are valid, the sync session is started. One instance is the **client** (i.e. Student) and the other is the **server** (i.
10+
e. Teacher). The server instance uses Morango to verify that the client has the proper permissions to sync with it. Then the client and server exchange exactly the data, for which the client has the permissions to sync. The certificate verification takes place in `morango/api/permissions.py <https://github.com/learningequality/morango/blob/release-v0.6.x/morango/api/permissions.py>`_.
11+
312

413
Syncable Models
514

docs/syncing/index.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,6 @@ The **outgoing buffer** and **incoming buffer** mirror the schema of the store.
1313
Process
1414
-------
1515

16-
By default, Kolibri instances are listening for other Kolibri instances in the same network, while at the same time, exposing an URL to which other instances can request a connection. The connection is established via a REST call to the endpoint. For the exact request flow, see the `documentation <https://kolibri-dev.readthedocs.io/en/develop/dataflow/index.html#data-flow>`_.
17-
After a connection request the two instances exchange certificates, which are used to authenticate the other instance. If the certificates are valid, the sync session is started. One instance is the **client** (i.e. Student) and the other is the **server** (i.
18-
e. Teacher). The server instance verifies that the client has the proper permissions to sync with it, and then the client and server exchange exactly the data, for which the client has the permissions to sync. The certificate verification takes place in `morango/api/permissions.py <https://github.com/learningequality/morango/blob/release-v0.6.x/morango/api/permissions.py>`_
19-
20-
2116
Syncing is the actual exchange of data in a sync session. The general steps for syncing data are:
2217

2318
1. **Serialization** - serializing data that is associated with Django models in the Application layer, and storing it in JSON format in a record in the Store. The serialized data in the store is versioned via a counter (described in `Counters <../counters#counters>`__).

0 commit comments

Comments
 (0)