No OneTemporary
Actions

Size

7 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 c5aa82af86..978506fb30 100644
	--- a/src/docs/user/configuration/configuration_guide.diviner
	+++ b/src/docs/user/configuration/configuration_guide.diviner
	@@ -1,213 +1,213 @@
	@title Configuration Guide
	@group config

	This document contains basic configuration instructions for Phorge.

	= 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).
	- Configure the databases.
	- Access Phorge 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 Phorge on a subdomain (like
	phorge.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 create a VirtualHost entry for Phorge. It should look something like
	this:

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

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

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

	If Apache isn't currently configured to serve documents out of the directory
	where you put Phorge, 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/phorge/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/phorge/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 phorge.example.com;
	root /path/to/phorge/webroot;

	location / {
	index index.php;
	rewrite ^/(.*)$ /index.php?__path__=/$1 last;
	}

	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 nginx, scroll
	up to their sections.

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

	$HTTP["host"] =~ "phorge(\.example\.com)?" {
	server.document-root = "/path/to/phorge/webroot"
	url.rewrite-once = (
	# 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 php-cgi # for Ubuntu; other distros should be similar
	$ sudo lighty-enable-mod fastcgi-php

	Restart lighttpd after making your edits, then continue below.


	Load Balancer Health Checks
	===========================

	If you're using a load balancer in front of your webserver, you can configure
	it to perform health checks using the path `/status/`.


	= 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 Phorge schemata into it. To do this, run:

	phorge/ $ ./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:

	phorge/ $ ./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).

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

	NOTE: When you update Phorge, 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 an alternate file domain with
	@{article:Configuring a File Domain}; or
	- configuring a preamble script to set up the environment properly behind a
	load balancer, or adjust rate limiting with
	@{article:Configuring a Preamble Script}; or
	- configuring where uploaded files and attachments will be stored with
	@{article:Configuring File Storage}; or
	- configuring Phorge 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
	- learning about notification with
	@{article:Notifications User Guide: Setup and Configuration}; or
	- configuring backups with
	@{article:Configuring Backups and Performing Migrations}; or
	- contributing to Phorge with @{article:Contributor Introduction}.

File Metadata

Mime Type: text/x-diff
Expires: Mon, Nov 25, 12:49 AM (1 d, 13 h)
Storage Engine: blob
Storage Format: Raw Data
Storage Handle: 1118
Default Alt Text: (7 KB)

No OneTemporaryActions

View Options

File Metadata

Event Timeline

No OneTemporary
Actions