Skip to content

Commit

Permalink
added documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wachterjohannes committed Apr 3, 2017
1 parent 9a1d869 commit ffe7a02
Showing 1 changed file with 42 additions and 0 deletions.
42 changes: 42 additions & 0 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,4 +122,46 @@ The password is optional in the configuration you will be asked for it when nanb
``NANBANDO_SSH_USERNAME``, ``NANBANDO_SSH_PASSWORD``, ``NANBANDO_SSH_RSAKEY_FILE`` and
``NANBANDO_SSH_RSAKEY_PASSWORD``.

Process
-------

Each backup-part has an optional configuration parameter ``process``. The process can be passed (also multiple times) to
the backup-command ``nanbando backup -p files -p database``. All backup-parts which contains one of the passed processes
will be executed. The restore process uses the passed parameter from the backup call. They will be stored in the backup
file.

.. code:: json
{
"backup": {
"uploads": {
"plugin": "directory",
"process": ["files"],
"parameter": {
"directory": "var/uploads"
}
},
"indices": {
"plugin": "directory",
"process": ["optional"],
"parameter": {
"directory": "var/indices"
}
},
"database": {
"plugin": "mysql",
"process": ["database"],
"parameter": {
"username": "%database_user%",
"password": "%database_password%",
"database": "%database_name%"
}
}
}
}
As an example you could backup the database each hour and each night also the file in the uploads folder. Therefor you
could restore user-data in a smaller granularity than the files but the resulting backups will use less disk space and
the hourly backup will run faster.

.. _`OneupFlysystemBundle`: https://github.com/1up-lab/OneupFlysystemBundle/blob/master/Resources/doc/index.md#step3-configure-your-filesystems

0 comments on commit ffe7a02

Please sign in to comment.