##// END OF EJS Templates
docs: updated backup documentation.
marcink -
r1033:536e81af default
parent child Browse files
Show More
@@ -9,10 +9,14 b' Backup and Restore'
9 9 To snapshot an instance of |RCE|, and save its settings, you need to backup the
10 10 following parts of the system at the same time.
11 11
12 * The |repos| managed by the instance.
12 * The |repos| managed by the instance together with the stored Gists.
13 13 * The |RCE| database.
14 14 * Any configuration files or extensions that you've configured. In most
15 15 cases it's only the :file:`rhodecode.ini` file.
16 * Installer files such as those in `/opt/rhodecode` can be backed-up, however
17 it's not required since in case of a recovery installer simply
18 re-creates those.
19
16 20
17 21 .. important::
18 22
@@ -30,11 +34,17 b' Repository Backup'
30 34 ^^^^^^^^^^^^^^^^^
31 35
32 36 To back up your |repos|, use the API to get a list of all |repos| managed,
33 and then clone them to your backup location.
37 and then clone them to your backup location. This is the most safe backup option.
38 Backing up the storage directory could potentially result in a backup of
39 partially committed files or commits. (Backup taking place during a big push)
40 As an alternative you could use a rsync or simple `cp` commands if you can
41 ensure your instance is only in read-only mode or stopped at the moment.
42
34 43
35 44 Use the ``get_repos`` method to list all your managed |repos|,
36 45 and use the ``clone_uri`` information that is returned. See the :ref:`api`
37 for more information.
46 for more information. Be sure to keep the structure or repositories with their
47 repository groups.
38 48
39 49 .. important::
40 50
@@ -82,13 +92,18 b' Configuration File Backup'
82 92 Depending on your setup, you could have a number of configuration files that
83 93 should be backed up. You may have some, or all of the configuration files
84 94 listed in the :ref:`config-rce-files` section. Ideally you should back these
85 up at the same time as the database and |repos|.
95 up at the same time as the database and |repos|. It really depends on if you need
96 the configuration file like logs, custom modules. We always recommend backing
97 those up.
86 98
87 99 Gist Backup
88 100 ^^^^^^^^^^^
89 101
90 To backup the gists on your |RCE| instance you can use the ``get_users`` and
91 ``get_gists`` API methods to fetch the gists for each user on the instance.
102 To backup the gists on your |RCE| instance you usually have to backup the
103 gist storage path. If this haven't been changed it's located inside
104 :file:`.rc_gist_store` and the metadata in :file:`.rc_gist_metadata`.
105 You can use the ``get_users`` and ``get_gists`` API methods to fetch the
106 gists for each user on the instance.
92 107
93 108 Extension Backups
94 109 ^^^^^^^^^^^^^^^^^
@@ -107,15 +122,17 b' the :ref:`indexing-ref` section.'
107 122 Restoration Steps
108 123 -----------------
109 124
110 To restore an instance of |RCE| from its backed up components, use the
111 following steps.
125 To restore an instance of |RCE| from its backed up components, to a fresh
126 system use the following steps.
112 127
113 1. Install a new instance of |RCE|.
114 2. Once installed, configure the instance to use the backed up
115 :file:`rhodecode.ini` file. Ensure this file points to the backed up
128 1. Install a new instance of |RCE| using sqlite option as database.
129 2. Restore your database.
130 2. Once installed, replace you backed up the :file:`rhodecode.ini` with your
131 backup version. Ensure this file points to the restored
116 132 database, see the :ref:`config-database` section.
117 3. Restart |RCE| and remap and rescan your |repos|, see the
118 :ref:`remap-rescan` section.
133 3. Restart |RCE| and remap and rescan your |repos| to verify filesystem access,
134 see the :ref:`remap-rescan` section.
135
119 136
120 137 Post Restoration Steps
121 138 ^^^^^^^^^^^^^^^^^^^^^^
General Comments 0
You need to be logged in to leave comments. Login now