@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.)
hq.recaptime.dev/wiki/Phorge
phorge
phabricator
Document that hosted repositories should be backed up
Summary: Fixes T8950.
Test Plan: Reading.
Reviewers: chad
Reviewed By: chad
Maniphest Tasks: T8950
Differential Revision: https://secure.phabricator.com/D14952
+44
-9
+44
-9
src/docs/user/configuration/configuring_backups.diviner
+44
-9
src/docs/user/configuration/configuring_backups.diviner
···
3
3
4
4
Advice for backing up Phabricator, or migrating from one machine to another.
5
5
6
-
= Overview =
6
+
7
+
Overview
8
+
========
7
9
8
10
Phabricator does not currently have a comprehensive backup system, but creating
9
11
backups is not particularly difficult and Phabricator does have a few basic
···
11
13
which needs to be backed up are:
12
14
13
15
- the MySQL databases;
16
+
- hosted repositories;
14
17
- uploaded files; and
15
18
- your Phabricator configuration files.
16
19
···
21
24
will just backup the old machine and then restore the data onto the new
22
25
machine.
23
26
24
-
= Backup: MySQL Databases =
27
+
28
+
Backup: MySQL Databases
29
+
=======================
25
30
26
31
Most of Phabricator's data is stored in MySQL, and it's the most important thing
27
32
to back up. You can run `bin/storage dump` to get a dump of all the MySQL
···
36
41
Then store the backup somewhere safe, like in a box buried under an old tree
37
42
stump. No one will ever think to look for it there.
38
43
39
-
= Restore: MySQL =
44
+
Restore: MySQL
45
+
==============
40
46
41
47
To restore a MySQL dump, just pipe it to `mysql` on a clean host. (You may need
42
48
to uncompress it first, if you compressed it prior to storage.)
43
49
44
50
$ gunzip -c backup.sql.gz | mysql
45
51
46
-
= Backup: Uploaded Files =
52
+
53
+
Backup: Hosted Repositories
54
+
===========================
55
+
56
+
If you host repositories in Phabricator, you should back them up. You can use
57
+
`bin/repository list-paths` to show the local paths on disk for each
58
+
repository. To back them up, copy them elsewhere.
59
+
60
+
You can also just clone them and keep the clones up to date, or use
61
+
{nav Add Mirror} to have the mirror somewhere automatically.
62
+
63
+
64
+
Restore: Hosted Repositories
65
+
============================
66
+
67
+
To restore hosted repositories, copy them back into the correct locations
68
+
as shown by `bin/repository list-paths`.
69
+
70
+
71
+
Backup: Uploaded Files
72
+
======================
47
73
48
74
Uploaded files may be stored in several different locations. The backup
49
75
procedure depends on where files are stored:
···
65
91
For more information about configuring how files are stored, see
66
92
@{article:Configuring File Storage}.
67
93
68
-
= Restore: Uploaded Files =
94
+
95
+
Restore: Uploaded Files
96
+
=======================
69
97
70
98
To restore a backup of local disk storage, just copy the backup into place.
71
99
72
-
= Backup: Configuration Files =
100
+
101
+
Backup: Configuration Files
102
+
===========================
73
103
74
104
You should also backup your configuration files, and any scripts you use to
75
105
deploy or administrate Phabricator (like a customized upgrade script). The best
···
85
115
This file contains all of the configuration settings that have been adjusted
86
116
by using `bin/config set <key> <value>`.
87
117
88
-
= Restore: Configuration Files =
118
+
119
+
Restore: Configuration Files
120
+
============================
89
121
90
122
To restore configuration files, just copy them into the right locations. Copy
91
123
your backup of `local.json` to `phabricator/conf/local/local.json`.
92
124
93
-
= Security =
125
+
Security
126
+
========
94
127
95
128
MySQL dumps have no builtin encryption and most data in Phabricator is stored in
96
129
a raw, accessible form, so giving a user access to backups is a lot like giving
···
105
138
present a risk. If you restrict access to the Phabricator host or database, you
106
139
should also restrict access to the backups.
107
140
108
-
= Next Steps =
141
+
142
+
Next Steps
143
+
==========
109
144
110
145
Continue by:
111
146