Exit Zen
1
../content/backup-restore.rst:2
English
Backup and Restore
0/180 · 18
2
../content/backup-restore.rst:4
English
OTOBO has built in scripts for backup and restore ``scripts/backup.pl`` and ``scripts/restore.pl``. Execute the scripts with the option ``-h`` for more information.
0/1640 · 164
3
../content/backup-restore.rst:8
English
Backup
0/100 · 6
4
../content/backup-restore.rst:9
English
In order to backup the OTOBO system, the script ``scripts/backup.pl`` can be used. The script creates a backup of the OTOBO system in the specified directory.
0/1580 · 158
5
../content/backup-restore.rst:14
English
To create a new backup, write permission for the destination directory is needed for the user ``otobo``.
0/1040 · 104
6
../content/backup-restore.rst:20 • ../content/backup-restore.rst:128
English
The output of the script:
0/250 · 25
7
../content/backup-restore.rst:64
English
``--extra-dump-options="--single-transaction"`` prevents the database tables from being locked, so OTOBO may still be used during backup archive creation.
0/1540 · 154
8
../content/backup-restore.rst:67 • ../content/backup-restore.rst:152
English
Docker
0/100 · 6
9
../content/backup-restore.rst:69
English
The same scripts might be used when OTOBO is running under Docker, but some Docker specific limitations have to be considered. In order to be able to write a backup archive to the file system outside of the Docker container, appropriate volume mounts and permissions must be configured.
0/2860 · 286
10
../content/backup-restore.rst:87
English
We use an ephemeral container of OTOBO to pull the backup and place it in the backup directory on the host:
0/1070 · 107
11
../content/backup-restore.rst:97
English
The parameters used, assume the defaults presented throughout this manual. You may need to fit them to your setup, e.g., if you use a different network name or a different image tag.
0/1820 · 182
12
../content/backup-restore.rst:101
English
Restore
0/100 · 7
13
../content/backup-restore.rst:103
English
To restore the OTOBO system from backup, the script ``scripts/restore.pl`` can be used. For the script to be able to place the data into the database, the database name, name, and password have to be setup like the backed up system. The restore script, restores the configuration files from the backup archive first, and then uses the restored configuration files to connect to the database and restore the data. You may read them from backup to fit your database setup:
0/4700 · 470
14
../content/backup-restore.rst:112
English
You may also fit the database connection parameters within the backup file before running the restore script:
0/1090 · 109
15
../content/backup-restore.rst:120
English
To restore the database make sure the target database contains no tables.
0/730 · 73
16
../content/backup-restore.rst:122
English
You may execute the restore script with the option ``-h`` for more information.
0/790 · 79
17
../content/backup-restore.rst:143
English
After successful restore it is advised to clear the OTOBO cache. To do this execute the following command:
0/1060 · 106
18
../content/backup-restore.rst:153
English
To drop an existing OTOBO database and create a new one you can use the following commands. First, you have to connect to the MariaDB command line interface of the ``db`` container:
0/1810 · 181
19
../content/backup-restore.rst:161
English
Enter the database root password when prompted. As soon as you are connected to the MySQL server, you can drop and recreate the ``otobo`` database:
0/1470 · 147
20
../content/backup-restore.rst:170
English
For restoring the backup we also need to specify which backup should be restored. The placeholder ``<TIMESTAMP>`` is something like ``2020-09-07_09-38``.
0/1530 · 153