Differential D25064 Diff 309 src/docs/user/installation_guide.diviner

Changeset View

Standalone View

src/docs/user/installation_guide.diviner

Show All 9 Lines
Phorge is a LAMP (Linux, Apache, MySQL, PHP) application. To install		Phorge is a LAMP (Linux, Apache, MySQL, PHP) application. To install
Phorge, you will need:		Phorge, you will need:

- a normal computer to install it on (shared hosts and unusual environments		- a normal computer to install it on (shared hosts and unusual environments
are not supported) running some flavor of Linux or a similar OS;		are not supported) running some flavor of Linux or a similar OS;
- a domain name (like `phorge.example.com`);		- a domain name (like `phorge.example.com`);
- basic sysadmin skills;		- basic sysadmin skills;
- Apache, nginx, or another webserver;		- Apache, nginx, or another webserver;
- PHP, MySQL, and Git.		- PHP;
		- MySQL (you will need to create multiple databases);
		- git

The remainder of this document details these requirements.		The remainder of this document details these requirements.

		You may be interested also in preparing these optional stuff:

		- have valid SMTP parameters for outgoing email notifications;
		- having nothing listening on port 22, to then setup a SSH+git server

Installation Requirements		Installation Requirements
=========================		=========================

You will need a computer. Options include:		You will need a computer. Options include:

- A Normal Computer: This is strongly recommended. Many installs use a VM		- A Normal Computer: This is strongly recommended. Many installs use a VM
in EC2. Phorge installs properly and works well on a normal computer.		in EC2. Phorge installs properly and works well on a normal computer.
- A Shared Host: This may work, but is not recommended. Many shared		- A Shared Host: This may work, but is not recommended. Many shared
Show All 36 Lines	- Other: Other webservers which can run PHP are also likely to work fine,
although these installation instructions will not cover how to set them up.		although these installation instructions will not cover how to set them up.
- PHP Builtin Server: Phorge will not work with the builtin		- PHP Builtin Server: Phorge will not work with the builtin
webserver because Phorge depends on making requests to itself on some		webserver because Phorge depends on making requests to itself on some
workflows, and the builtin webserver is single-threaded.		workflows, and the builtin webserver is single-threaded.

You will also need:		You will also need:

- MySQL: You need MySQL. We strongly recommend MySQL 5.5 or newer.		- MySQL: You need MySQL. We strongly recommend MySQL 5.5 or newer.
- PHP: You need PHP 5.5 or newer.		You will need multiple databases.
		- PHP: You need PHP 5.5 or newer. Note that PHP 8.1 and above are not
		fully supported.
		aviveyUnsubmitted Done Inline Actions Is there a way to phrase this it can't be understood as "multiple mysql servers"? This term-overloading always bugged me. avivey: Is there a way to phrase this it can't be understood as "multiple mysql servers"? This term…

You'll probably also need a domain name. In particular, you should read this		You'll probably also need a domain name. In particular, you should read this
note:		note:

NOTE: Phorge must be installed on an entire domain. You can not install it		NOTE: Phorge must be installed on an entire domain. You can not install it
to a path on an existing domain, like `example.com/phorge/`. Instead,		to a path on an existing domain, like `example.com/phorge/`. Instead,
install it to an entire domain or subdomain, like `phorge.example.com`.		install it to an entire domain or subdomain, like `phorge.example.com`.

Show All 18 Lines

Installing Required Components		Installing Required Components
==============================		==============================

Here's a general description of what you need to install:		Here's a general description of what you need to install:

- git (usually called "git" in package management systems)		- git (usually called "git" in package management systems)
- Apache (usually "httpd" or "apache2") (or nginx)		- Apache (usually "httpd" or "apache2") (or nginx)
- MySQL Server (usually "mysqld" or "mysql-server")		- MySQL Server (usually "mysqld" or "mysql-server" or "mariadb-server")
- PHP (usually "php")		- PHP (usually "php")
- Required PHP extensions: mbstring, iconv, mysql (or mysqli), curl, pcntl		- Required PHP extensions: mbstring, iconv, mysql (or mysqli), curl, pcntl
(these might be something like "php-mysql" or "php5-mysqlnd")		(these might be something like "php-mysql" or "php5-mysqlnd")
- Optional PHP extensions: gd		- Optional PHP extensions: gd

If you already have LAMP setup, you've probably already got everything you need.		If you already have LAMP setup, you've probably already got everything you need.
It may also be helpful to refer to the install scripts above, even if they don't		It may also be helpful to refer to the install scripts above, even if they don't
work for your system.		work for your system.
Show All 16 Lines