Skip to content

Commit

Permalink
backup/restore
Browse files Browse the repository at this point in the history
  • Loading branch information
ymarcon committed Apr 7, 2023
1 parent 54e83d5 commit 6163cab
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions admin/backup-restore.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,33 @@
Backup and Restore
==================

The Mica system manages data both in the MongoDB database and in its local configuration/data files.
The Mica system manages data both in the MongoDB database and in its local configuration/data files (as defined by **MICA_HOME**).

The backup steps are:

1. Stop Mica application
2. Backup Mica local files
3. Backup MongoDB

The restore steps are:

1. Restore MongoDB
2. Restore Mica local files
3. Start Mica application

Mica
----

Some configuration and data are stored in local files (as defined by **MICA_HOME**) and must be backup explicitly:
**Backup**

Some configuration and data are stored in local files and must be backup explicitly:

* ``conf``, contains the application's configuration files, including instance specific templates and taxonomies.
* ``data``, contains the history of changes of the various documents and the local keystore.
* ``plugins``, contains the plugins binary libraries and specific configurations for the Mica server.
* ``work``, [optional] contains files that can be rebuilt such as the caches and the search index.
* [optional] ``work``, contains files that can be rebuilt such as the caches and the search index.

Note: in the Mica Docker container, **MICA_HOME** is ``/srv``.
**Restore**

Mica application includes its own internal upgrade mechanism, then when restoring the runtime environment with a more recent version of Mica, the upgrade process will be automatically triggered. Still, it is recommended to look at the release notes on `obiba.org <https://www.obiba.org>`_ to verify if there are any manual upgrade actions: if this is the case, restore the Mica server one version after the other.

Expand All @@ -26,3 +40,5 @@ Using Docker
------------

When Mica and MongoDB are managed by Docker, you may consider backup and restore containers volumes the Docker's way: see `Backup, Restore or Migrate Data Volumes - Docker documentation <https://docs.docker.com/storage/volumes/#backup-restore-or-migrate-data-volumes>`_.

Note: in the Mica Docker container, **MICA_HOME** is ``/srv``.

0 comments on commit 6163cab

Please sign in to comment.