diff options
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/server.rst | 23 |
2 files changed, 23 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst index 679c8083..01ba04c8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,7 +31,6 @@ Both client and server are `distributed through pypi client reference development - migrations Indices and tables ================== diff --git a/docs/server.rst b/docs/server.rst index a0eb8181..aa890ecb 100644 --- a/docs/server.rst +++ b/docs/server.rst @@ -43,3 +43,26 @@ twistd command. To start the soledad server, run: An systemd script is included in the `Debian packages <http://deb.leap.se/repository/>`_ to make it feasible to start and stop the Soledad server service using a standard interface. + +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.9>`_. +* In ``/usr/share/soledad-server/migration/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. + |