No OneTemporary
Actions

Size

12 KB

Referenced Files

None

Subscribers

None

View Options

	diff --git a/src/docs/user/configuration/configuration_guide.diviner b/src/docs/user/configuration/configuration_guide.diviner
	index 5a5e862750..6666dd0ca2 100644
	--- a/src/docs/user/configuration/configuration_guide.diviner
	+++ b/src/docs/user/configuration/configuration_guide.diviner
	@@ -1,208 +1,209 @@
	@title Configuration Guide
	@group config

	This document contains basic configuration instructions for Phabricator.

	= Prerequisites =

	This document assumes you've already installed all the components you need.
	If you haven't, see @{article:Installation Guide}.

	The next steps are:

	- Configure your webserver (Apache, nginx, or lighttpd).
	- Access Phabricator with your browser.
	- Follow the instructions to complete setup.

	= Webserver: Configuring Apache =

	NOTE: Follow these instructions to use Apache. To use nginx or lighttpd, scroll
	down to their sections.

	Get Apache running and verify it's serving a test page. Consult the Apache
	documentation for help. Make sure ##mod_php## and ##mod_rewrite## are enabled,
	and ##mod_ssl## if you intend to set up SSL.

	If you haven't already, set up a domain name to point to the host you're
	installing on. You can either install Phabricator on a subdomain (like
	phabricator.example.com) or an entire domain, but you can not install it in
	some subdirectory of an existing website. Navigate to whatever domain you're
	going to use and make sure Apache serves you something to verify that DNS
	is correctly configured.

	NOTE: The domain must contain a dot ('.'), i.e. not be just a bare name like
	'http://example/'. Some web browsers will not set cookies otherwise.

	Now, either create a VirtualHost entry (to put Phabricator on a subdomain)
	or edit the Directory entry for the DocumentRoot. It should look something like
	this:

	name=httpd.conf
	<VirtualHost *>
	# Change this to the domain which points to your host.
	ServerName phabricator.example.com

	# Change this to the path where you put 'phabricator' when you checked it
	# out from GitHub when following the Installation Guide.
	#
	# Make sure you include "/webroot" at the end!
	DocumentRoot /path/to/phabricator/webroot

	RewriteEngine on
	RewriteRule ^/rsrc/(.*) - [L,QSA]
	RewriteRule ^/favicon.ico - [L,QSA]
	RewriteRule ^(.*)$ /index.php?__path__=$1 [B,L,QSA]
	</VirtualHost>

	If Apache isn't currently configured to serve documents out of the directory
	where you put Phabricator, you may also need to add `<Directory />` section. The
	syntax for this section depends on which version of Apache you're running.
	(If you don't know, you can usually figure this out by running `httpd -v`.)
	For Apache versions older than 2.4, use this:

	name="Apache Older Than 2.4"
	<Directory "/path/to/phabricator/webroot">
	Order allow,deny
	Allow from all
	</Directory>

	For Apache versions 2.4 and newer, use this:

	name="Apache 2.4 and Newer"
	<Directory "/path/to/phabricator/webroot">
	Require all granted
	</Directory>

	After making your edits, restart Apache, then continue to "Setup" below.

	= Webserver: Configuring nginx =

	NOTE: Follow these instructions to use nginx. To use Apache or lighttpd, scroll
	to their sections.

	For nginx, use a configuration like this:

	name=nginx.conf
	server {
	server_name phabricator.example.com;

	root /path/to/phabricator/webroot;
	try_files $uri $uri/ /index.php;

	location / {
	index index.php;

	if ( !-f $request_filename )
	{
	rewrite ^/(.*)$ /index.php?__path__=/$1 last;
	break;
	}
	}

	location /index.php {
	fastcgi_pass localhost:9000;
	fastcgi_index index.php;

	#required if PHP was built with --enable-force-cgi-redirect
	fastcgi_param REDIRECT_STATUS 200;

	#variables to make the $_SERVER populate in PHP
	fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
	fastcgi_param QUERY_STRING $query_string;
	fastcgi_param REQUEST_METHOD $request_method;
	fastcgi_param CONTENT_TYPE $content_type;
	fastcgi_param CONTENT_LENGTH $content_length;

	fastcgi_param SCRIPT_NAME $fastcgi_script_name;

	fastcgi_param GATEWAY_INTERFACE CGI/1.1;
	fastcgi_param SERVER_SOFTWARE nginx/$nginx_version;

	fastcgi_param REMOTE_ADDR $remote_addr;
	}
	}

	Restart nginx after making your edits, then continue to "Setup" below.

	= Webserver: Configuring lighttpd =

	NOTE: Follow these instructions to use lighttpd. To use Apache or niginx, scroll
	up to their sections.

	For lighttpd, add a section like this to your lighttpd.conf:

	$HTTP["host"] =~ "phabricator(\.example\.com)?" {
	server.document-root = "/path/to/phabricator/webroot"
	url.rewrite-once = (
	"^(/rsrc/.*)$" => "$1",
	"^(/favicon.ico)$" => "$1",
	# This simulates QSA ("query string append") mode in apache
	"^(/[^?])\?(.)" => "/index.php?__path__=$1&$2",
	"^(/.*)$" => "/index.php?__path__=$1",
	)
	}

	You should also ensure the following modules are listed in your
	server.modules list:

	mod_fastcgi
	mod_rewrite

	Finally, you should run the following commands to enable php support:

	$ sudo apt-get install php5-cgi # for ubuntu; other distros should be similar
	$ sudo lighty-enable-mod fastcgi-php

	Restart lighttpd after making your edits, then continue below.

	= Setup =

	Now, navigate to whichever subdomain you set up. You should see instructions to
	continue setup. The rest of this document contains additional instructions for
	specific setup steps.

	When you resolve any issues and see the welcome screen, enter credentials to
	create your initial administrator account. After you log in, you'll want to
	configure how other users will be able to log in or register -- until you do,
	no one else will be able to sign up or log in. For more information, see
	@{article:Configuring Accounts and Registration}.

	= Storage: Configuring MySQL =

	During setup, you'll need to configure MySQL. To do this, get MySQL running and
	verify you can connect to it. Consult the MySQL documentation for help. When
	MySQL works, you need to load the Phabricator schemata into it. To do this, run:

	phabricator/ $ ./bin/storage upgrade

	If your configuration uses an unprivileged user to connect to the database, you
	may have to override the default user so the schema changes can be applied with
	root or some other admin user:

	phabricator/ $ ./bin/storage upgrade --user <user> --password <password>

	You can avoid the prompt the script issues by passing the ##--force## flag (for
	example, if you are scripting the upgrade process).

	phabricator/ $ ./bin/storage upgrade --force

	NOTE: When you update Phabricator, run `storage upgrade` again to apply any
	new updates.

	= Next Steps =

	Continue by:

	- setting up your admin account and login/registration with
	@{article:Configuring Accounts and Registration}; or
	- understanding advanced configuration topics with
	@{article:Configuration User Guide: Advanced Configuration}; or
	- configuring where uploaded files and attachments will be stored with
	@{article:Configuring File Storage}; or
	- configuring Phabricator so it can send mail with
	@{article:Configuring Outbound Email}; or
	- 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
	+ - configuring backups with
	+ @{article:Configuring Backups and Performing Migrations}; or
	- contributing to Phabricator with @{article:Contributor Introduction}.
	diff --git a/src/docs/user/configuration/configuring_backups.diviner b/src/docs/user/configuration/configuring_backups.diviner
	index 20aee18e33..d779499dd2 100644
	--- a/src/docs/user/configuration/configuring_backups.diviner
	+++ b/src/docs/user/configuration/configuring_backups.diviner
	@@ -1,98 +1,103 @@
	-@title Configuring Backups
	+@title Configuring Backups and Performing Migrations
	@group config

	-Advice for backing up Phabricator.
	+Advice for backing up Phabricator, or migrating from one machine to another.

	= 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.

	+If you are migrating from one machine to another, you can generally follow the
	+same steps you would if you were creating a backup and then restoring it, you
	+will just backup the old machine and then restore the data onto the new
	+machine.
	+
	= 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.
	+databases. This is a convenience script which just runs a normal `mysqldump`,
	+but will only dump databases 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}.

File Metadata

Mime Type: text/x-diff
Expires: Tue, Dec 2, 8:10 AM (1 d, 22 m)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 431741
Default Alt Text: (12 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions