Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
jio_mebibou
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
Alexandra Rogova
jio_mebibou
Commits
011ac6b4
Commit
011ac6b4
authored
Jan 24, 2014
by
Tristan Cavelier
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Documentation improved
parent
20a94ca5
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
87 additions
and
14 deletions
+87
-14
docs/available_storages.rst
docs/available_storages.rst
+81
-10
docs/getting_started.rst
docs/getting_started.rst
+4
-4
docs/revision_storages.rst
docs/revision_storages.rst
+2
-0
No files found.
docs/available_storages.rst
View file @
011ac6b4
...
@@ -41,6 +41,13 @@ Examples:
...
@@ -41,6 +41,13 @@ Examples:
// to work on browser memory
// to work on browser memory
var jio = jIO.createJIO(local_storage.createMemoryDescription('me'));
var jio = jIO.createJIO(local_storage.createMemoryDescription('me'));
// or
{
"type": "local",
"username": "me",
"application_name": "my app name", // optional
"mode": "memory" // optional, "localStorage" by default
}
DavStorage
DavStorage
^^^^^^^^^^
^^^^^^^^^^
...
@@ -52,8 +59,16 @@ NB: digest **is not implemented yet**.
...
@@ -52,8 +59,16 @@ NB: digest **is not implemented yet**.
.. code-block:: javascript
.. code-block:: javascript
dav_storage.createDescription(url, auth_type,
dav_storage.createDescription(url, auth_type,
[realm], [username], [password]);
[realm], [username], [password]);
// or
{
"type": "dav",
"url": url,
"auth_type": "basic",
"username": "my user name",
"password": "my password"
}
All parameters are strings.
All parameters are strings.
...
@@ -75,12 +90,22 @@ for basic authentication, the password will just be base64 encoded.
...
@@ -75,12 +90,22 @@ for basic authentication, the password will just be base64 encoded.
S3Storage
S3Storage
^^^^^^^^^
^^^^^^^^^
Updating to v2.0
Work is in progress. Documentation comming soon.
.. code-block:: javascript
{
"type": "s3",
"AWSIdentifier": "my aws identifier",
"password": "my password",
"server": "bucket_name",
"url": "https://bucket_name.s3.amazonaws.com"
}
XWikiStorage
XWikiStorage
^^^^^^^^^^^^
^^^^^^^^^^^^
Updating to v2.0
Work is in progress.
Handlers
Handlers
--------
--------
...
@@ -129,17 +154,42 @@ GIDStorage
...
@@ -129,17 +154,42 @@ GIDStorage
:ref:`Full description here <gid-storage>`.
:ref:`Full description here <gid-storage>`.
Updating to v2.0
SplitStorage
SplitStorage
^^^^^^^^^^^^
^^^^^^^^^^^^
Updating to v2.0
Work is in progress. The interoperability is not enabled yet.
This storage splits metadata and attachment data to *n* parts where *n* is the
number of sub storages. Each parts are stored on one sub storage only.
.. code-block:: javascript
{
type: 'split',
storage_list: [
<sub storage description>,
...
]
}
Other split modes will be added later.
Replicate Storage
Replicate Storage
^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^
Coming soon
Work is in progress.
.. code-block:: javascript
{
type: 'replicate',
storage_list: [
<sub storage description>,
...
]
}
Revision Based Handlers
Revision Based Handlers
-----------------------
-----------------------
...
@@ -160,11 +210,32 @@ options **conflicts: true**, **revs: true** or **revs_info: true** are set.
...
@@ -160,11 +210,32 @@ options **conflicts: true**, **revs: true** or **revs_info: true** are set.
Revision Storage
Revision Storage
^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^
Updating to v2.0
This backend uses its sub storage to manage document and their revision. For
more information, :ref:`see here <revision-storages-conflicts-and-resolution>`.
Description:
.. code-block:: javascript
{
"type": "revision",
"sub_storage": <sub storage description>
}
Replicate Revision Storage
Replicate Revision Storage
^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^
Updating to v2.0
Replicate revisions across multiple revision based storages.
Description:
.. code-block:: javascript
{
"type": "revision",
"storage_list": [
<revision based sub storage description>,
...
]
}
docs/getting_started.rst
View file @
011ac6b4
...
@@ -136,16 +136,16 @@ Storage connectors
...
@@ -136,16 +136,16 @@ Storage connectors
Storage handlers
Storage handlers
^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^
* indexstorage.js
(WIP)
* indexstorage.js
* gidstorage.js
(WIP)
* gidstorage.js
* splitstorage.js (WIP)
* splitstorage.js (WIP)
* replicatestorage.js (WIP)
* replicatestorage.js (WIP)
Revision based storage handlers
Revision based storage handlers
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* revisionstorage.js (depends on sha256)
(WIP)
* revisionstorage.js (depends on sha256)
* replicaterevisionstorage.js
(WIP)
* replicaterevisionstorage.js
Unit tests
Unit tests
...
...
docs/revision_storages.rst
View file @
011ac6b4
.. _revision-storages-conflicts-and-resolution:
Revision Storages: Conflicts and Resolution
Revision Storages: Conflicts and Resolution
===========================================
===========================================
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment