@recaptime-dev's working patches + fork for Phorge, a community fork of Phabricator. (Upstream dev and stable branches are at upstream/main and upstream/stable respectively.) hq.recaptime.dev/wiki/Phorge
phorge phabricator

Add small documentation details

Summary:
Add some small Diviner documentation details like:

* mention PHP 8.1 (thanks https://we.phorge.it/Q18)
* mention the fact that you need multiple databases (it may be not obvious from the startup)
* mention MariaDB and not just MySQL (thanks MariaDB community!)
* mention "Administrator" and not just "User" for the "Instructions for installing, configuring, and using Phorge."

I was not bold enough to do more changes.

Test Plan: I tested locally and Diviner does not look bad.

Reviewers: O1 Blessed Committers, avivey

Reviewed By: O1 Blessed Committers, avivey

Subscribers: avivey, speck, tobiaswiese, Matthew, Cigaryno

Differential Revision: https://we.phorge.it/D25064

+14 -4
+1 -1
src/docs/book/user.book
··· 1 1 { 2 2 "name": "phorge", 3 - "title": "Phorge User Documentation", 3 + "title": "Phorge Administrator and User Documentation", 4 4 "short": "User Docs", 5 5 "preface": "Instructions for installing, configuring, and using Phorge.", 6 6 "root": "../../../",
+1
src/docs/user/configuration/configuration_guide.diviner
··· 11 11 The next steps are: 12 12 13 13 - Configure your webserver (Apache, nginx, or lighttpd). 14 + - Configure the databases. 14 15 - Access Phorge with your browser. 15 16 - Follow the instructions to complete setup. 16 17
+12 -3
src/docs/user/installation_guide.diviner
··· 15 15 - a domain name (like `phorge.example.com`); 16 16 - basic sysadmin skills; 17 17 - Apache, nginx, or another webserver; 18 - - PHP, MySQL, and Git. 18 + - PHP; 19 + - MySQL (you will need a server with multiple databases); 20 + - git 19 21 20 22 The remainder of this document details these requirements. 23 + 24 + You may be interested also in preparing these optional stuff: 25 + 26 + - have valid SMTP parameters for outgoing email notifications; 27 + - having nothing listening on port 22, to then setup a SSH+git server 21 28 22 29 Installation Requirements 23 30 ========================= ··· 71 78 You will also need: 72 79 73 80 - **MySQL**: You need MySQL. We strongly recommend MySQL 5.5 or newer. 74 - - **PHP**: You need PHP 5.5 or newer. 81 + You will need a server with multiple databases. 82 + - **PHP**: You need PHP 5.5 or newer. Note that PHP 8.1 and above are not 83 + fully supported. 75 84 76 85 You'll probably also need a **domain name**. In particular, you should read this 77 86 note: ··· 106 115 107 116 - git (usually called "git" in package management systems) 108 117 - Apache (usually "httpd" or "apache2") (or nginx) 109 - - MySQL Server (usually "mysqld" or "mysql-server") 118 + - MySQL Server (usually "mysqld" or "mysql-server" or "mariadb-server") 110 119 - PHP (usually "php") 111 120 - Required PHP extensions: mbstring, iconv, mysql (or mysqli), curl, pcntl 112 121 (these might be something like "php-mysql" or "php5-mysqlnd")