@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
Improve install documentation a bit
Summary:
- Warn users that they'll need to be comfortable with the CLI.
- Move XHProf stuff to the developer docs, since few/no normal users need it.
Test Plan: Read documentation.
Reviewers: btrahan, chad
Reviewed By: chad
Subscribers: epriestley
Differential Revision: https://secure.phabricator.com/D10810
+101
-31
+54
src/docs/contributor/installing_xhprof.diviner
+54
src/docs/contributor/installing_xhprof.diviner
···
1
+
@title Installing XHProf
2
+
@group developer
3
+
4
+
Describes how to install XHProf, a PHP profiling tool.
5
+
6
+
Overview
7
+
========
8
+
9
+
You can install XHProf to activate the XHProf tab in DarkConsole and the
10
+
`--xprofile` flag from the CLI. This will allow you to generate performance
11
+
profiles of pages and scripts, which can be tremendously valuable in identifying
12
+
and fixing slow code.
13
+
14
+
Installing XHProf
15
+
=================
16
+
17
+
XHProf is a PHP profiling tool. You don't need to install it unless you are
18
+
developing Phabricator and making performance changes.
19
+
20
+
You can install xhprof with:
21
+
22
+
$ pecl install xhprof
23
+
24
+
If you have a PEAR version prior to 1.9.3, you may run into a `phpize` failure.
25
+
If so, you can download the source and build it with:
26
+
27
+
$ cd extension/
28
+
$ phpize
29
+
$ ./configure
30
+
$ make
31
+
$ sudo make install
32
+
33
+
You may also need to add `extension=xhprof.so` to your php.ini.
34
+
35
+
See <https://bugs.php.net/bug.php?id=59747> for more information.
36
+
37
+
Using XHProf: Web
38
+
=================
39
+
40
+
To profile a web page, activate DarkConsole and navigate to the XHProf tab.
41
+
Use the **Profile Page** button to generate a profile.
42
+
43
+
Using XHProf: CLI
44
+
=================
45
+
46
+
From the command line, use the `--xprofile <filename>` flag to generate a
47
+
profile of any script.
48
+
49
+
Next Steps
50
+
==========
51
+
52
+
Continue by:
53
+
54
+
- enabling DarkConsole with @{article:Using DarkConsole}.
+47
-31
src/docs/user/installation_guide.diviner
+47
-31
src/docs/user/installation_guide.diviner
···
4
4
This document contains basic install instructions to get Phabricator up and
5
5
running.
6
6
7
-
= Installation Requirements =
7
+
Overview
8
+
========
9
+
10
+
Phabricator is a LAMP (Linux, Apache, MySQL, PHP) application. To install
11
+
Phabricator, you will need:
12
+
13
+
- a normal computer to install it on (shared hosts and unusual environments
14
+
are not supported) running some flavor of Linux or a similar OS;
15
+
- a domain name (like `phabricator.mycompany.com`);
16
+
- basic sysadmin skills;
17
+
- Apache, nginx, or another webserver;
18
+
- PHP, MySQL, and Git.
19
+
20
+
The remainder of this document details these requirements.
21
+
22
+
Installation Requirements
23
+
=========================
8
24
9
25
You will need **a computer**. Options include:
10
26
···
12
28
in EC2. Phabricator installs properly and works well on a normal computer.
13
29
- **A Shared Host**: This may work, but is not recommended. Many shared
14
30
hosting environments have restrictions which prevent some of Phabricator's
15
-
features from working. Consider using a normal computer instead.
31
+
features from working. Consider using a normal computer instead. We do not
32
+
support shared hosts.
16
33
- **A SAN Appliance, Network Router, Gaming Console, Raspberry Pi, etc.**:
17
34
Although you may be able to install Phabricator on specialized hardware, it
18
35
is unlikely to work well and will be difficult for us to support. Strongly
19
-
consider using a normal computer instead.
36
+
consider using a normal computer instead. We do not support specialized
37
+
hardware.
20
38
- **A Toaster, Car, Firearm, Thermostat, etc.**: Yes, many modern devices now
21
39
have embedded computing capability. We live in interesting times. However,
22
40
you should not install Phabricator on these devices. Instead, install it on
23
-
a normal computer.
41
+
a normal computer. We do not support installing on noncomputing devices.
24
42
25
43
To install the Phabricator server software, you will need an **operating
26
-
system** on your normal computer which is **not Windows**. Note that **the
27
-
command line interface //does// work on Windows**, and **you can //use//
28
-
Phabricator from any operating system with a web browser**. However, the server
44
+
system** on your normal computer which is **not Windows**. Note that the
45
+
command line interface //does// work on Windows, and you can //use//
46
+
Phabricator from any operating system with a web browser. However, the server
29
47
software does not run on Windows. It does run on most other operating systems,
30
48
so choose one of these instead:
31
49
···
51
69
52
70
You will also need:
53
71
54
-
- **MySQL**: You need MySQL.
72
+
- **MySQL**: You need MySQL. We strongly recommend MySQL 5.5 or newer.
55
73
- **PHP**: You need PHP 5.2 or newer.
56
74
57
75
You'll probably also need a **domain name**. In particular, you should read this
···
61
79
to a path on an existing domain, like `example.com/phabricator/`. Instead,
62
80
install it to an entire domain or subdomain, like `phabricator.example.com`.
63
81
64
-
= Installing Required Components =
82
+
Level Requirements
83
+
==================
84
+
85
+
To install and administrate Phabricator, you'll need to be comfortable with
86
+
common system administration skills. For example, you should be familiar with
87
+
using the command line, installing software on your operating system of choice,
88
+
working with the filesystem, managing processes, dealing with permissions,
89
+
editing configuration files, and setting environment variables.
90
+
91
+
If you aren't comfortable with these skills, you can still try to perform an
92
+
install. The install documentation will attempt to guide you through what you
93
+
need to know. However, if you aren't very familiar or comfortable with using
94
+
this set of skills to troubleshoot and resolve problems, you may encounter
95
+
issues which you have substantial difficulty working through.
96
+
97
+
We assume users installing and administrating Phabricator are comfortable with
98
+
common system administration skills and concepts. If you aren't, proceed at
99
+
your own risk and expect that your skills may be tested.
100
+
101
+
Installing Required Components
102
+
==============================
65
103
66
104
If you are installing on Ubuntu or an RedHat derivative, there are install
67
105
scripts available which should handle most of the things discussed in this
···
128
166
extension=apc.so
129
167
130
168
..to "/etc/php.d/apc.ini" or the "php.ini" file indicated by "php -i".
131
-
132
-
= Installing XHProf (Optional) =
133
-
134
-
XHProf is a PHP profiling tool. You don't need to install it unless you are
135
-
developing Phabricator and making performance changes.
136
-
137
-
You can install xhprof with:
138
-
139
-
$ pecl install xhprof
140
-
141
-
If you have a PEAR version prior to 1.9.3, you may run into a `phpize` failure.
142
-
If so, you can download the source and build it with:
143
-
144
-
$ cd extension/
145
-
$ phpize
146
-
$ ./configure
147
-
$ make
148
-
$ sudo make install
149
-
150
-
You may also need to add "##extension=xhprof.so##" to your php.ini.
151
-
152
-
See <https://bugs.php.net/bug.php?id=59747> for more information.
153
169
154
170
= Updating Phabricator =
155
171