diff --git a/src/docs/book/user.book b/src/docs/book/user.book index 449acd4ffc..b5b6dac7b1 100644 --- a/src/docs/book/user.book +++ b/src/docs/book/user.book @@ -1,6 +1,6 @@ { "name": "phorge", - "title": "Phorge User Documentation", + "title": "Phorge Administrator and User Documentation", "short": "User Docs", "preface": "Instructions for installing, configuring, and using Phorge.", "root": "../../../", diff --git a/src/docs/user/configuration/configuration_guide.diviner b/src/docs/user/configuration/configuration_guide.diviner index 7798ff0e0b..1fde967a95 100644 --- a/src/docs/user/configuration/configuration_guide.diviner +++ b/src/docs/user/configuration/configuration_guide.diviner @@ -11,6 +11,7 @@ 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. diff --git a/src/docs/user/installation_guide.diviner b/src/docs/user/installation_guide.diviner index ded0e4c93a..6db0df4d7c 100644 --- a/src/docs/user/installation_guide.diviner +++ b/src/docs/user/installation_guide.diviner @@ -15,10 +15,17 @@ Phorge, you will need: - a domain name (like `phorge.example.com`); - basic sysadmin skills; - Apache, nginx, or another webserver; - - PHP, MySQL, and Git. + - PHP; + - MySQL (you will need a server with multiple databases); + - git 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 ========================= @@ -71,7 +78,9 @@ Beyond an operating system, you will need **a webserver**. You will also need: - **MySQL**: You need MySQL. We strongly recommend MySQL 5.5 or newer. - - **PHP**: You need PHP 5.5 or newer. + You will need a server with multiple databases. + - **PHP**: You need PHP 5.5 or newer. Note that PHP 8.1 and above are not + fully supported. You'll probably also need a **domain name**. In particular, you should read this note: @@ -106,7 +115,7 @@ Here's a general description of what you need to install: - git (usually called "git" in package management systems) - 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") - Required PHP extensions: mbstring, iconv, mysql (or mysqli), curl, pcntl (these might be something like "php-mysql" or "php5-mysqlnd")