@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 DarkConsole documentation
Summary: This is a little bit out of date. Notably, the setting changed locations and we no longer have a "Config" tab since it's available in the config app.
Test Plan: Read documentation.
Reviewers: chad, skrul
Reviewed By: skrul
CC: aran
Differential Revision: https://secure.phabricator.com/D5415
+9
-12
+9
-12
src/docs/developer/darkconsole.diviner
+9
-12
src/docs/developer/darkconsole.diviner
···
14
14
its name is a bit of play on that (and a reference to the dark color palette
15
15
its design uses).
16
16
17
-
= Enabling DarkConsole =
17
+
= Warning =
18
18
19
19
Because DarkConsole exposes some configuration and debugging information, it is
20
20
disabled by default (and **you should not enable it in production**). It has
21
-
some simple safeguards to prevent leaking credential information but enabling it
22
-
in production may compromise the integrity of an install.
21
+
some simple safeguards to prevent leaking credential information, but enabling
22
+
it in production may compromise the integrity of an install.
23
+
24
+
= Enabling DarkConsole =
23
25
24
-
You enable DarkConsole in your configuration, by setting ##darkconsole.enabled##
25
-
to ##true##, and then clicking the "Enable DarkConsole" link in the page footer.
26
+
You enable DarkConsole in your configuration, by setting `darkconsole.enabled`
27
+
to `true`, and then turning it on in `Settings` -> `Display Preferences`.
26
28
Once DarkConsole is enabled, you can show or hide it by pressing ##`## on your
27
29
keyboard.
28
30
29
-
Since the "Enable DarkConsole" link is not available to logged-out users (and
30
-
stored as a per-user preference), you can also set ##darkconsole.always-on## if
31
-
you need to access DarkConsole on logged-out pages.
31
+
Since the setting is not available to logged-out users, you can also set
32
+
`darkconsole.always-on` if you need to access DarkConsole on logged-out pages.
32
33
33
34
DarkConsole has a number of tabs, each of which is powered by a "plugin". You
34
35
can use them to access different debugging and performance features.
···
57
58
to install the corresponding PHP plugin -- see instructions in the
58
59
@{article:Installation Guide}. Once it is installed, you can use XHProf to
59
60
profile the runtime performance of a page.
60
-
61
-
= Plugin: Config =
62
-
63
-
The "Config" plugin shows active Phabricator configuration values.