@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
Update install documentation to include FreeBSD
Summary:
Fixes T4024.
- Mention FreeBSD by name.
- Make "install this on a normal computer" more explicit.
- Make "install this on a entire domain" more explicit.
Test Plan:
{F74892}
{F74891}
Reviewers: btrahan, chad
Reviewed By: chad
CC: aran
Maniphest Tasks: T4024
Differential Revision: https://secure.phabricator.com/D7397
+56
-17
+48
-14
src/docs/user/installation_guide.diviner
+48
-14
src/docs/user/installation_guide.diviner
···
6
6
7
7
= Installation Requirements =
8
8
9
-
Phabricator is a LAMP application suite, so you basically need LAMP:
9
+
You will need **a computer**. Options include:
10
+
11
+
- **A Normal Computer**: This is strongly recommended. Many installs use a VM
12
+
in EC2. Phabricator installs properly and works well on a normal computer.
13
+
- **A Shared Host**: This may work, but is not recommended. Many shared
14
+
hosting environments have restrictions which prevent some of Phabricator's
15
+
features from working. Consider using a normal computer instead.
16
+
- **A SAN Appliance, Network Router, Gaming Console, Raspberry Pi, etc.**:
17
+
Although you may be able to install Phabricator on specialized hardware, it
18
+
is unlikely to work well and will be difficult for us to support. Strongly
19
+
consider using a normal computer instead.
20
+
- **A Toaster, Car, Firearm, Thermostat, etc.**: Yes, many modern devices now
21
+
have embedded computing capability. We live in interesting times. However,
22
+
you should not install Phabricator on these devices. Instead, install it on
23
+
a normal computer.
10
24
11
-
- **Linux**: Some flavor of Linux is required. Mac OS X is an acceptable
12
-
flavor of Linux. Windows is not an acceptable flavor of Linux. Phabricator
13
-
will not install or work properly on Windows. (If you want it to, send
14
-
patches.) Phabricator has active contributors running it on Mac OS X, Amazon
15
-
Linux, Ubuntu, RHEL and CentOS; if you run into issues on other flavors,
16
-
send patches or complaints.
17
-
- **Apache** (or nginx, or lighttpd): You need Apache 2.2.7+ (or another
18
-
tested webserver). You can probably use something else, but you're
19
-
on your own.
20
-
- **MySQL**: You need MySQL.
21
-
- **PHP**: You need PHP 5.2 or newer.
25
+
You will need an **operating system** which is **not Windows**. Phabricator runs
26
+
on most operating systems which are not Windows.
27
+
28
+
- **Linux**: Most installs use Linux.
29
+
- **Mac OS X**: Mac OS X is an acceptable flavor of Linux.
30
+
- **FreeBSD**: While FreeBSD is certainly not a flavor of Linux, it is a fine
31
+
operating system possessed of many desirable qualities, and Phabricator will
32
+
install and run properly on FreeBSD.
33
+
- **Solaris, etc.**: Other systems which look like Linux and quack like Linux
34
+
will generally work fine, although we may suffer a reduced ability to
35
+
support and resolve issues on unusual operating systems.
22
36
23
37
NOTE: The command line interface to Phabricator, "Arcanist", //does// work on
24
38
Windows. For instructions, see @{article:Arcanist User Guide: Windows}.
25
39
26
-
You'll probably also need a **domain name** and you'll certainly need
27
-
**a computer** with a connection to **the internet**.
40
+
Beyond an operating system, you will need **a webserver**.
41
+
42
+
- **Apache**: Many installs use Apache + `mod_php`.
43
+
- **nginx**: Many installs use nginx + `php-fpm`.
44
+
- **lighttpd**: `lighttpd` is less popular than Apache or nginx, but it
45
+
works fine.
46
+
- **Other**: Other webservers which can run PHP are also likely to work fine,
47
+
although these installation instructions will not cover how to set them up.
48
+
- **PHP Builtin Server**: You can use the builtin PHP webserver for
49
+
development or testing, although it should not be used in production.
50
+
51
+
You will also need:
52
+
53
+
- **MySQL**: You need MySQL.
54
+
- **PHP**: You need PHP 5.2 or newer.
55
+
56
+
You'll probably also need a **domain name**. In particular, you should read this
57
+
note:
58
+
59
+
NOTE: Phabricator must be installed on an entire domain. You can not install it
60
+
to a path on an existing domain, like `example.com/phabricator/`. Instead,
61
+
install it to an entire domain or subdomain, like `phabricator.example.com`.
28
62
29
63
= Installing Required Components =
30
64
+8
-3
src/docs/user/userguide/arcanist.diviner
+8
-3
src/docs/user/userguide/arcanist.diviner
···
77
77
= Installing Arcanist =
78
78
79
79
Arcanist is meant to be installed on your local machine or development server --
80
-
whatever machine you're editing code on. It runs on Linux,
81
-
Mac OS X (see @{article:Arcanist User Guide: Mac OS X}), and
82
-
Windows (see @{article:Arcanist User Guide: Windows}).
80
+
whatever machine you're editing code on. It runs on:
81
+
82
+
- Linux;
83
+
- Other operating systems which are pretty similar to Linux, or which
84
+
Linux is pretty similar to;
85
+
- FreeBSD, a fine operating system held in great esteem by many;
86
+
- Mac OS X (see @{article:Arcanist User Guide: Mac OS X}); and
87
+
- Windows (see @{article:Arcanist User Guide: Windows}).
83
88
84
89
Arcanist is written in PHP, so you need to install the PHP CLI first if you
85
90
don't already have it. Arcanist should run on PHP 5.2 and newer. If you don't