mirror of
https://we.phorge.it/source/phorge.git
synced 2024-11-25 16:22:43 +01:00
Provide some guidance on creating backups
Summary: A user asked for some instructions, so I wrote up some documentation. Test Plan: Read document. This is more or less how secure.phabricator.com backups work and the one time we had a data loss issue restoration worked reasonably well. Reviewers: btrahan, vrana Reviewed By: vrana CC: aran Differential Revision: https://secure.phabricator.com/D3825
This commit is contained in:
parent
5d5f8a7a91
commit
1163598acd
2 changed files with 99 additions and 0 deletions
|
@ -259,4 +259,5 @@ Continue by:
|
|||
- configuring inbound mail with @{article:Configuring Inbound Email}; or
|
||||
- importing repositories with @{article:Diffusion User Guide}; or
|
||||
- learning about daemons with @{article:Managing Daemons with phd}; or
|
||||
- configuring backups with @{article:Configuring Backups}; or
|
||||
- contributing to Phabricator with @{article:Contributor Introduction}.
|
||||
|
|
98
src/docs/configuration/configuring_backups.diviner
Normal file
98
src/docs/configuration/configuring_backups.diviner
Normal file
|
@ -0,0 +1,98 @@
|
|||
@title Configuring Backups
|
||||
@group config
|
||||
|
||||
Advice for backing up Phabricator.
|
||||
|
||||
= Overview =
|
||||
|
||||
Phabricator does not currently have a comprehensive backup system, but creating
|
||||
backups is not particularly difficult and Phabricator does have a few basic
|
||||
tools which can help you set up a reasonable process. In particular, the things
|
||||
which needs to be backed up are:
|
||||
|
||||
- the MySQL databases;
|
||||
- uploaded files; and
|
||||
- your Phabricator configuration files.
|
||||
|
||||
This document discusses approaches for backing up this data.
|
||||
|
||||
= Backup: MySQL Databases =
|
||||
|
||||
Most of Phabricator's data is stored in MySQL, and it's the most important thing
|
||||
to back up. You can run `bin/storage dump` to get a dump of all the MySQL
|
||||
databases. This is a convenience script which just runs a normal `mysqldump`
|
||||
of every database Phabricator owns.
|
||||
|
||||
Since most of this data is compressible, it may be helpful to run it through
|
||||
gzip prior to storage. For example:
|
||||
|
||||
phabricator/ $ ./bin/storage dump | gzip > backup.sql.gz
|
||||
|
||||
Then store the backup somewhere safe, like in a box buried under an old tree
|
||||
stump. No one will ever think to look for it there.
|
||||
|
||||
= Restore: MySQL =
|
||||
|
||||
To restore a MySQL dump, just pipe it to `mysql` on a clean host. (You may need
|
||||
to uncompress it first, if you compressed it prior to storage.)
|
||||
|
||||
$ gunzip -c backup.sql.gz | mysql
|
||||
|
||||
= Backup: Uploaded Files =
|
||||
|
||||
Uploaded files may be stored in several different locations. The backup
|
||||
procedure depends on where files are stored:
|
||||
|
||||
**Default / MySQL**: Under the default configuration, uploaded files are stored
|
||||
in MySQL, so the MySQL backup will include all files. In this case, you don't
|
||||
need to do any additional work.
|
||||
|
||||
**Amazon S3**: If you use Amazon S3, redundancy and backups are built in to the
|
||||
service. This is probably sufficient for most installs. If you trust Amazon with
|
||||
your data //except not really//, you can backup your S3 bucket outside of
|
||||
Phabricator.
|
||||
|
||||
**Local Disk**: If you use the local disk storage engine, you'll need to back up
|
||||
files manually. You can do this by creating a copy of the root directory where
|
||||
you told Phabricator to put files (the `storage.local-disk.path` configuration
|
||||
setting).
|
||||
|
||||
For more information about configuring how files are stored, see
|
||||
@{article:Configuring File Storage}.
|
||||
|
||||
= Restore: Uploaded Files =
|
||||
|
||||
To restore a backup of local disk storage, just copy the backup into place.
|
||||
|
||||
= Backup: Configuration Files =
|
||||
|
||||
You should also backup your configuration files, and any scripts you use to
|
||||
deploy or administrate Phabricator (like a customized upgrade script). The best
|
||||
way to do this is to check them into a private repository somewhere and just use
|
||||
whatever backup process you already have in place for repositories. Just copying
|
||||
them somewhere will work fine too, of course.
|
||||
|
||||
= Restore: Configuration Files =
|
||||
|
||||
To restore configuration files, just copy them into the right locations.
|
||||
|
||||
= Security =
|
||||
|
||||
MySQL dumps have no builtin encryption and most data in Phabricator is stored in
|
||||
a raw, accessible form, so giving a user access to backups is a lot like giving
|
||||
them shell access to the machine Phabricator runs on. In particular, a user who
|
||||
has the backups can:
|
||||
|
||||
- read data that policies do not permit them to see;
|
||||
- read email addresses and object secret keys; and
|
||||
- read other users' session and conduit tokens and impersonate them.
|
||||
|
||||
Some of this information is durable, so disclosure of even a very old backup may
|
||||
present a risk. If you restrict access to the Phabricator host or database, you
|
||||
should also restrict access to the backups.
|
||||
|
||||
= Next Steps =
|
||||
|
||||
Continue by:
|
||||
|
||||
- returning to the @{article:Configuration Guide}.
|
Loading…
Reference in a new issue