| 1 | = Trac Backup = |
| 2 | [[TracGuideToc]] |
| 3 | |
| 4 | Since Trac uses a database backend, some extra care is required to safely create a backup of a [wiki:TracEnvironment project environment]. Luckily, [wiki:TracAdmin trac-admin] has a command to make backups easier: `hotcopy`. |
| 5 | |
| 6 | ''Note: Trac uses the `hotcopy` nomenclature to match that of [http://subversion.tigris.org/ Subversion], to make it easier to remember when managing both Trac and Subversion servers.'' |
| 7 | |
| 8 | == Creating a Backup == |
| 9 | |
| 10 | To create a backup of a live TracEnvironment, simply run: |
| 11 | {{{ |
| 12 | |
| 13 | $ trac-admin /path/to/projenv hotcopy /path/to/backupdir |
| 14 | |
| 15 | }}} |
| 16 | |
| 17 | [wiki:TracAdmin trac-admin] will lock the database while copying.'' |
| 18 | |
| 19 | The resulting backup directory is safe to handle using standard file-based backup tools like `tar` or `dump`/`restore`. |
| 20 | |
| 21 | Please, note, that hotcopy command does not overwrite target directory and when such exists, hotcopy ends with error: `Command failed: [Errno 17] File exists:` This is discussed in [trac:ticket:3198 #3198]. |
| 22 | |
| 23 | === Restoring a Backup === |
| 24 | |
| 25 | Backups are simply a copied snapshot of the entire [wiki:TracEnvironment project environment] directory, including the SQLite database. |
| 26 | |
| 27 | To restore an environment from a backup, stop the process running Trac (i.e. the Web server or [wiki:TracStandalone tracd]), restore the contents of your backup (path/to/backupdir) to your [wiki:TracEnvironment project environment] directory and restart the service. |
| 28 | |
| 29 | ''Note: Automatic backup of environments that don't use SQLite as database backend is not supported at this time. As a workaround, we recommend that you stop the server, copy the environment directory, and make a backup of the database using whatever mechanism is provided by the database system.'' |
| 30 | |
| 31 | ---- |
| 32 | See also: TracAdmin, TracEnvironment, TracGuide, [trac:TracMigrate TracMigrate] |