Changes between Version 1 and Version 2 of TracBackup

Timestamp:

Nov 1, 2019, 11:11:25 AM (5 years ago)

Author:

trac

Comment:

--

TracBackup

@@ -1 @@
-= Trac Backup =
+= Trac Backup
+
 [[TracGuideToc]]
 
-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`.
+Trac backups are a copied snapshot of the entire [TracEnvironment project environment] directory, including the database. Backups can be created using the `hotcopy` command of [TracAdmin trac-admin].
 
-  ''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.''
+'''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.
 
-== Creating a Backup ==
+== Creating a Backup
 
-To create a backup of a live TracEnvironment, simply run:
-{{{
-  $ trac-admin /path/to/projenv hotcopy /path/to/backupdir
+Create a backup of a live TracEnvironment by running:
+{{{#!sh
+$ trac-admin /path/to/projenv hotcopy /path/to/backupdir
 }}}
 
-[wiki:TracAdmin trac-admin] will lock the database while copying.''
+The database will be locked while hotcopy is running.
 
 The resulting backup directory is safe to handle using standard file-based backup tools like `tar` or `dump`/`restore`.
 
-=== Restoring a Backup ===
+Please note, the `hotcopy` command will not overwrite a target directory. When the target exists the operation will end with an error: `Command failed: [Errno 17] File exists:` This is discussed in [trac:#3198 #3198].
 
-Backups are simply a copied snapshot of the entire [wiki:TracEnvironment project environment] directory, including the SQLite database. 
+== Restoring a Backup
 
-To restore an environment from a backup, simply stop the process running Trac (i.e. the Web server or [wiki:TracStandalone tracd]), restore the directory structure from the backup and restart the service.
+To restore an environment from a backup, stop the process running Trac, ie the web server or [TracStandalone tracd], restore the contents of your backup to your [TracEnvironment project environment] directory and restart the process.
 
-  ''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.''
+If you are using a database other than SQLite, you'll need to restore the database from the dump file. The dump file is saved in the environment `db` directory.
+
+To restore a PostgreSQL database backup, use the command:
+{{{#!sh
+$ psql -U <user> -d <database> -f /path/to/postgresql.dump
+}}}
+
+The `<database>` option is the same as the [TracEnvironment#DatabaseConnectionStrings database connection string] in the [TracIni#trac-database-option "[trac] database"] option of the project's `trac.ini` file.
+
+Similarly, for MySQL:
+
+{{{#!sh
+$ mysql -u <user> -p <database> < /path/to/mysql.dump
+}}}
 
 ----
-See also: TracAdmin, TracEnvironment, TracGuide
+See also: TracAdmin, TracEnvironment, [trac:TracMigrate TracMigrate]