summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authordrebs <drebs@riseup.net>2017-09-07 18:07:45 -0300
committerdrebs <drebs@riseup.net>2017-09-07 18:07:45 -0300
commit1b994c717e2e970ad665c49642459c1e34459b28 (patch)
treeaddfcf38f9a329b7f173c609f556ec87aeacb837 /docs
parenta850ce38129061a8b790c316ad1e5c8288b5d050 (diff)
[doc] add documentation about migration
Diffstat (limited to 'docs')
-rw-r--r--docs/index.rst1
-rw-r--r--docs/migrations.rst22
2 files changed, 23 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 722aeeda..c90a0bdb 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -18,6 +18,7 @@ all user's devices that access a LEAP provider.
auth
reference
development
+ migrations
Indices and tables
==================
diff --git a/docs/migrations.rst b/docs/migrations.rst
new file mode 100644
index 00000000..abbb39ad
--- /dev/null
+++ b/docs/migrations.rst
@@ -0,0 +1,22 @@
+Migrations
+==========
+
+Some updates of Soledad need manual intervention for database migration because
+of changes to the storage backend. In all such cases, we will document the
+steps needed for migration in this page.
+
+Soledad Server 0.8 to 0.9 - Couch Database schema migration needed
+------------------------------------------------------------------
+
+Starting with Soledad Server 0.9.0, the CouchDB database schema was changed to
+improve speed of the server side storage backend. Because of that, this script
+has to be run for all Leap providers that used to provide email using Soledad
+Server < 0.9.0.
+
+The migration script can be found:
+
+* In `the Soledad repository <https://0xacab.org/leap/soledad/tree/master/scripts/migration/0.8-to-0.9>`_.
+* In ``/usr/share/soledad-server/migration/0.8-to-0.9/`` when the ``soledad-server`` debian package is installed.
+
+Instructions for migration can be found in the ``README.md`` file. Make sure to read it carefully and backup your data before starting the migration process.
+