##// END OF EJS Templates
docs: update full text search indexing documentation
docs: update full text search indexing documentation

File last commit:

r3400:2aa02c12 default
r3400:2aa02c12 default
Show More
backup-restore.rst
151 lines | 5.5 KiB | text/x-rst | RstLexer
/ docs / admin / backup-restore.rst
project: added all source files and assets
r1 .. _backup-ref:
Backup and Restore
==================
*“The condition of any backup is unknown until a restore is attempted.”*
`Schrödinger's Backup`_
To snapshot an instance of |RCE|, and save its settings, you need to backup the
following parts of the system at the same time.
docs: updated backup documentation.
r1033 * The |repos| managed by the instance together with the stored Gists.
project: added all source files and assets
r1 * The |RCE| database.
docs: added restoration commands for DBs
r941 * Any configuration files or extensions that you've configured. In most
cases it's only the :file:`rhodecode.ini` file.
docs: updated backup documentation.
r1033 * Installer files such as those in `/opt/rhodecode` can be backed-up, however
it's not required since in case of a recovery installer simply
re-creates those.
project: added all source files and assets
r1
.. important::
Ideally you should script all of these functions so that it creates a
backup snapshot of your system at a particular timestamp and then run that
script regularly.
Backup Details
--------------
To backup the relevant parts of |RCE| required to restore your system, use
the information in this section to identify what is important to you.
Repository Backup
^^^^^^^^^^^^^^^^^
To back up your |repos|, use the API to get a list of all |repos| managed,
docs: updated backup documentation.
r1033 and then clone them to your backup location. This is the most safe backup option.
Backing up the storage directory could potentially result in a backup of
partially committed files or commits. (Backup taking place during a big push)
As an alternative you could use a rsync or simple `cp` commands if you can
ensure your instance is only in read-only mode or stopped at the moment.
project: added all source files and assets
r1
Use the ``get_repos`` method to list all your managed |repos|,
and use the ``clone_uri`` information that is returned. See the :ref:`api`
docs: updated backup documentation.
r1033 for more information. Be sure to keep the structure or repositories with their
repository groups.
project: added all source files and assets
r1
.. important::
This will not work for |svn| |repos|. Currently the only way to back up
your |svn| |repos| is to make a copy of them.
It is also important to note, that you can only restore the |svn| |repos|
using the same version as they were saved with.
Database Backup
^^^^^^^^^^^^^^^
The instance database contains all the |RCE| permissions settings,
and user management information. To backup your database,
export it using the following appropriate example, and then move it to your
backup location:
.. code-block:: bash
# For MySQL DBs
docs: added restoration commands for DBs
r941 $ mysqldump -u <uname> -p <pass> rhodecode_db_name > mysql-db-backup
# MySQL restore command
$ mysql -u <uname> -p <pass> rhodecode_db_name < mysql-db-backup
project: added all source files and assets
r1
# For PostgreSQL DBs
docs: update backup/restore for postgres....
r2468 $ PGPASSWORD=<pass> pg_dump --inserts -U <uname> -h localhost rhodecode_db_name > postgresql-db-backup
docs: added restoration commands for DBs
r941 # PosgreSQL restore
$ PGPASSWORD=<pass> psql -U <uname> -h localhost -d rhodecode_db_name -1 -f postgresql-db-backup
project: added all source files and assets
r1
docs: added restoration commands for DBs
r941 # For SQLite
project: added all source files and assets
r1 $ sqlite3 rhodecode.db ‘.dump’ > sqlite-db-backup
docs: added restoration commands for DBs
r941 # SQLite restore
$ copy sqlite-db-backup rhodecode.db
project: added all source files and assets
r1
The default |RCE| SQLite database location is
:file:`/home/{user}/.rccontrol/{instance-id}/rhodecode.db`
If running MySQL or PostgreSQL databases, you will have configured these
separately, for more information see :ref:`rhodecode-database-ref`
Configuration File Backup
^^^^^^^^^^^^^^^^^^^^^^^^^
Depending on your setup, you could have a number of configuration files that
should be backed up. You may have some, or all of the configuration files
listed in the :ref:`config-rce-files` section. Ideally you should back these
docs: updated backup documentation.
r1033 up at the same time as the database and |repos|. It really depends on if you need
the configuration file like logs, custom modules. We always recommend backing
those up.
project: added all source files and assets
r1
Gist Backup
^^^^^^^^^^^
docs: updated backup documentation.
r1033 To backup the gists on your |RCE| instance you usually have to backup the
gist storage path. If this haven't been changed it's located inside
:file:`.rc_gist_store` and the metadata in :file:`.rc_gist_metadata`.
You can use the ``get_users`` and ``get_gists`` API methods to fetch the
gists for each user on the instance.
project: added all source files and assets
r1
Extension Backups
^^^^^^^^^^^^^^^^^
You should also backup any extensions added in the
:file:`home/{user}/.rccontrol/{instance-id}/rcextensions` directory.
Full-text Search Backup
^^^^^^^^^^^^^^^^^^^^^^^
You may also have full text search set up, but the index can be rebuild from
re-imported |repos| if necessary. You will most likely want to backup your
docs: update full text search indexing documentation
r3400 :file:`search_mapping.ini` file if you've configured that. For more information, see
project: added all source files and assets
r1 the :ref:`indexing-ref` section.
Restoration Steps
-----------------
docs: updated backup documentation.
r1033 To restore an instance of |RCE| from its backed up components, to a fresh
system use the following steps.
project: added all source files and assets
r1
docs: updated backup documentation.
r1033 1. Install a new instance of |RCE| using sqlite option as database.
2. Restore your database.
docs: fixed small wanrings/errors during build.
r1120 3. Once installed, replace you backed up the :file:`rhodecode.ini` with your
docs: updated backup documentation.
r1033 backup version. Ensure this file points to the restored
project: added all source files and assets
r1 database, see the :ref:`config-database` section.
docs: fixed small wanrings/errors during build.
r1120 4. Restart |RCE| and remap and rescan your |repos| to verify filesystem access,
docs: updated backup documentation.
r1033 see the :ref:`remap-rescan` section.
project: added all source files and assets
r1
Post Restoration Steps
^^^^^^^^^^^^^^^^^^^^^^
Once you have restored your |RCE| instance to basic functionality, you can
then work on restoring any specific setup changes you had made.
docs: update full text search indexing documentation
r3400 * To recreate the |RCE| index, use the backed up :file:`search_mapping.ini` file if
project: added all source files and assets
r1 you had made changes and rerun the indexer. See the
:ref:`indexing-ref` section for details.
* To reconfigure any extensions, copy the backed up extensions into the
:file:`/home/{user}/.rccontrol/{instance-id}/rcextensions` and also specify
dan
docs: updated docs for integrations, fixes #4137...
r552 any custom hooks if necessary. See the :ref:`extensions-hooks-ref` section for
project: added all source files and assets
r1 details.
.. _Schrödinger's Backup: http://novabackup.novastor.com/blog/schrodingers-backup-good-bad-backup/