mirror of
https://we.phorge.it/source/phorge.git
synced 2025-01-02 02:40:58 +01:00
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
This commit is contained in:
parent
919bd4a034
commit
c897dc04e5
1 changed files with 9 additions and 12 deletions
|
@ -14,21 +14,22 @@ DarkConsole was originally implemented as part of the Facebook Lite site;
|
||||||
its name is a bit of play on that (and a reference to the dark color palette
|
its name is a bit of play on that (and a reference to the dark color palette
|
||||||
its design uses).
|
its design uses).
|
||||||
|
|
||||||
= Enabling DarkConsole =
|
= Warning =
|
||||||
|
|
||||||
Because DarkConsole exposes some configuration and debugging information, it is
|
Because DarkConsole exposes some configuration and debugging information, it is
|
||||||
disabled by default (and **you should not enable it in production**). It has
|
disabled by default (and **you should not enable it in production**). It has
|
||||||
some simple safeguards to prevent leaking credential information but enabling it
|
some simple safeguards to prevent leaking credential information, but enabling
|
||||||
in production may compromise the integrity of an install.
|
it in production may compromise the integrity of an install.
|
||||||
|
|
||||||
You enable DarkConsole in your configuration, by setting ##darkconsole.enabled##
|
= Enabling DarkConsole =
|
||||||
to ##true##, and then clicking the "Enable DarkConsole" link in the page footer.
|
|
||||||
|
You enable DarkConsole in your configuration, by setting `darkconsole.enabled`
|
||||||
|
to `true`, and then turning it on in `Settings` -> `Display Preferences`.
|
||||||
Once DarkConsole is enabled, you can show or hide it by pressing ##`## on your
|
Once DarkConsole is enabled, you can show or hide it by pressing ##`## on your
|
||||||
keyboard.
|
keyboard.
|
||||||
|
|
||||||
Since the "Enable DarkConsole" link is not available to logged-out users (and
|
Since the setting is not available to logged-out users, you can also set
|
||||||
stored as a per-user preference), you can also set ##darkconsole.always-on## if
|
`darkconsole.always-on` if you need to access DarkConsole on logged-out pages.
|
||||||
you need to access DarkConsole on logged-out pages.
|
|
||||||
|
|
||||||
DarkConsole has a number of tabs, each of which is powered by a "plugin". You
|
DarkConsole has a number of tabs, each of which is powered by a "plugin". You
|
||||||
can use them to access different debugging and performance features.
|
can use them to access different debugging and performance features.
|
||||||
|
@ -57,7 +58,3 @@ The "XHProf" plugin gives you access to the XHProf profiler. To use it, you need
|
||||||
to install the corresponding PHP plugin -- see instructions in the
|
to install the corresponding PHP plugin -- see instructions in the
|
||||||
@{article:Installation Guide}. Once it is installed, you can use XHProf to
|
@{article:Installation Guide}. Once it is installed, you can use XHProf to
|
||||||
profile the runtime performance of a page.
|
profile the runtime performance of a page.
|
||||||
|
|
||||||
= Plugin: Config =
|
|
||||||
|
|
||||||
The "Config" plugin shows active Phabricator configuration values.
|
|
||||||
|
|
Loading…
Reference in a new issue