Introduction

Give Feedback! Get Support! — How to give us feedback, report bugs, and request features, and get support for problems with Phabricator.
Installation Guide — This document contains basic install instructions to get Phabricator up and running.
Introduction — This document provides a high-level overview of the Phabricator project.

Configuration

Configuration Guide — This document contains basic configuration instructions for Phabricator.
Configuring Accounts and Registration — Describes how to configure user access to Phabricator.
Configuring Backups — Advice for backing up Phabricator.
Configuring File Storage — Setup how Phabricator will store files.
Configuring File Upload Limits — Explains limits on file upload sizes.
Configuring Inbound Email — This document contains instructions for configuring inbound email, so users may update Differential and Maniphest by replying to messages and create Maniphest tasks via email.
Configuring Outbound Email — Instructions for configuring Phabricator to send mail.
Managing Daemons with phd — Explains Phabricator daemons and the daemon control program phd.
Troubleshooting HTTPS — Detailed instructions for troubleshooting HTTPS connection problems.

Application User Guides

Arcanist Quick Start — Quick guide to getting Arcanist working for a new project.
Arcanist User Guide — Guide to Arcanist, a command-line interface to Phabricator.
Arcanist User Guide: Code Coverage — Explains code coverage features in Arcanist and Phabricator.
Arcanist User Guide: Commit Ranges — Explains how commit ranges work in Arcanist.
Arcanist User Guide: Configuring a New Project — Explains how to configure Arcanist projects with .arcconfig files.
Arcanist User Guide: Customizing Existing Linters — Explains how to customize existing linters.
Arcanist User Guide: Customizing Lint, Unit Tests and Workflows — Explains how to build new classes to control how Arcanist behaves.
Arcanist User Guide: Lint — Guide to lint, linters, and linter configuration.
Arcanist User Guide: Mac OS X — Explains how to install Arcanist on Mac OS X.
Arcanist User Guide: Repository Hooks — Describes how to set up Arcanist as an SVN pre-commit hook.
Arcanist User Guide: Windows — Explains how to install Arcanist on Windows.
Arcanist User Guide: arc diff — Guide to running arc diff, to send changes to Differential for review.
Audit User Guide — Guide to the Audit (post-push code review) tool and workflow.
Configuration User Guide: Advanced Configuration — Configuring Phabricator for multiple environments.
Differential User Guide — Guide to the Differential (pre-push code review) tool and workflow.
Differential User Guide: FAQ — Common questions about Differential.
Differential User Guide: Large Changes — Dealing with huge changesets, and when not to use Differential.
Differential User Guide: Test Plans — This document describes things you should think about when developing a test plan.
Diffusion User Guide — Guide to Diffusion, the Phabricator repository browser.
Diffusion User Guide: Symbol Indexes — Guide to configuring and using the symbol index.
Drydock User Guide — Configuring Drydock for machine resource management.
Events User Guide: Installing Event Listeners — Using Phabricator event listeners to customize behavior.
Herald User Guide — Use Herald to get notified of changes you care about.
Jump Nav User Guide — Command reference for the jump nav.
Maniphest User Guide: Adding Custom Fields — How to add custom fields to Maniphest.
Notifications User Guide: Setup and Configuration — Guide to setting up notifications.
Owners Tool User Guide — Use Owners to define and/or monitor code you care about.
Phame User Guide — Journal about your thoughts and feelings.
Phriction User Guide — Construct a detailed written history of your civilization.
Remarkup Reference — Explains how to make bold text; this makes your words louder so you can win arguments.
Slowvote User Guide — Detailed dispute resolution manual.
User Guide: Account Roles — Describes account roles like "Administrator", "Disabled" and "System Agent".
User Guide: Configuring an External Editor — Setting up an external editor to integrate with Diffusion and Differential.
User Guide: Managing Phabricator Email — How to effectively manage Phabricator email notifications.
User Guide: Review vs Audit — Discusses the differences between Review and Audit workflows.
User Guide: UTF-8 and Character Encoding — How Phabricator handles character encodings.
libphutil Libraries User Guide — Guide to creating and managing libphutil libraries.

Contributing

Contributor Introduction — Introduction to contributing to Phabricator, Arcanist and libphutil.
General Coding Standards — This document is a general coding standard for contributing to Phabricator, Arcanist, libphutil and Diviner.
Internationalization — What is required from developers to get Phabricator translatable.
Javascript Coding Standards — This document describes Javascript coding standards for Phabricator and Javelin.
PHP Coding Standards — This document describes PHP coding standards for Phabricator and related projects (like Arcanist and libphutil).

Phabricator Developer Guides

Adding New CSS and JS — Explains how to add new CSS and JS files to Phabricator.
Database Schema — This document describes key components of the database schema and should answer questions like how to store new types of data.
Performance: N+1 Query Problem — How to avoid a common performance pitfall.
Phabricator Code Layout — Guide to Phabricator code layout, including how URI mapping works through application class and subdirectory organization best practices.
Rendering HTML — Rendering HTML in the Phabricator environment.
Running built-in PHP webserver — As of version 5.4.0, the PHP command line interface provides a built-in web server.
Using DarkConsole — Enabling and using the built-in debugging console.
Using Edges — Guide to the Edges infrastructure.
Using the Phabricator OAuth Server — How to use the Phabricator OAuth Server.
Writing Unit Tests — Simple guide to libphutil, Arcanist and Phabricator unit tests.

Flavor Text

About Flavor Text — Explains what's going on here.
Javascript Object and Array — This document describes the behaviors of Object and Array in Javascript, and a specific approach to their use which produces basically reasonable language behavior.
Javascript Pitfalls — This document discusses pitfalls and flaws in the Javascript language, and how to avoid, work around, or at least understand them.
PHP Pitfalls — This document discusses difficult traps and pitfalls in PHP, and how to avoid, work around, or at least understand them.
Phabricator Project History — A riveting tale of adventure.
Please Please Please — Please read this document.
Recommendations on Branching — Project recommendations on how to organize branches.
Recommendations on Revision Control — Project recommendations on how to organize revision control.
Things You Should Do Now — Describes things you should do now when building software, because the cost to do them increases over time and eventually becomes prohibitive or impossible.
Things You Should Do Soon — Describes things you should start thinking about soon, because scaling will be easier if you put a plan in place.
Things You Should Do Soon: Static Resources — Over time, you'll write more JS and CSS and eventually need to put systems in place to manage it.
Writing Reviewable Code — Project recommendations on how to structure changes.

Differential (Code Review)

DifferentialAffectedPath — Denormalized index table which stores relationships between revisions in Differential and paths in Diffusion.
DifferentialRemarkupRule
DifferentialSearchIndexer

Diffusion (Repository Browser)

DiffusionRequest — Contains logic to parse Diffusion requests, which have a complicated URI structure.
DiffusionSymbolQuery — Query symbol information (class and function names and location), returning a list of matching PhabricatorRepositorySymbol objects and possibly attached data.
PhabricatorRepositorySymbol — Records information about symbol locations in a codebase, like where classes and functions are defined.

Maniphest (Task Tracking)

Slowvote (Polls)

Conduit (Phabricator HTTP API)

Conduit Technical Documentation — Technical overview of the Conduit API.

Celerity (CSS/JS Management)

Celerity Technical Documentation — Technical overview of the Celerity system.

CelerityAPI — Indirection layer which provisions for a terrifying future where we need to build multiple resource responses per page.
CelerityPhabricatorResourceController — Delivers CSS and JS resources to the browser.
CelerityResourceMap — Interface to the static resource map, which is a graph of available resources, resource dependencies, and packaging information.
CelerityResourceTransformer
CelerityResourceTransformerTestCase
CelerityStaticResourceResponse — Tracks and resolves dependencies the page declares with require_celerity_resource(), and then builds appropriate HTML or Ajax responses.

celerity_generate_unique_node_id() — Generate a node ID which is guaranteed to be unique for the current page, even across Ajax requests.
celerity_get_resource_uri() — Get the versioned URI for a raw resource, like an image.
celerity_register_resource_map() — Registers a resource map for Celerity.
require_celerity_resource() — Include a CSS or JS static resource by name.

Phriction (Wiki)

Aphront (Web Stack)

AphrontApplicationConfiguration
- AphrontDefaultApplicationConfiguration
AphrontController
AphrontHTTPSink — Abstract class which wraps some sort of output mechanism for HTTP responses.
- AphrontIsolatedHTTPSink — Isolated HTTP sink for testing.
- AphrontPHPHTTPSink — Concrete HTTP sink which uses "echo" and "header()" to emit data.
AphrontRequest
AphrontResponse
- Aphront304Response
- Aphront400Response
- AphrontAjaxResponse
- AphrontDialogResponse
- AphrontFileResponse
- AphrontHTMLResponse
- AphrontJSONResponse
- AphrontPlainTextResponse
- AphrontProxyResponse — Base class for responses which augment other types of responses.
- AphrontRedirectResponse — TODO: Should be final but isn't because of AphrontReloadResponse.
  - AphrontReloadResponse — When actions happen over a JX.Workflow, we may want to reload the page if the action is javascript-driven but redirect if it isn't.
AphrontURIMapper

DarkConsole (Debugging Console)

Storage

LiskDAO — Simple object-authoritative data access object that makes it easy to build stuff that you need to save to a database.

File Storage

File Storage Technical Documentation — Phabricator file storage details.

PhabricatorFileStorageBlob — Simple blob store DAO for PhabricatorMySQLFileStorageEngine.
PhabricatorFileStorageEngine — Defines a storage engine which can write file data somewhere (like a database, local disk, Amazon S3, the A:\ drive, or a custom filer) and retrieve it later.
- PhabricatorLocalDiskFileStorageEngine — Local disk storage engine.
- PhabricatorMySQLFileStorageEngine — MySQL blob storage engine.
- PhabricatorS3FileStorageEngine — Amazon S3 file storage engine.
- PhabricatorTestStorageEngine — Test storage engine.
PhabricatorFileStorageEngineSelector — Chooses appropriate storage engine(s) for files.
- PhabricatorDefaultFileStorageEngineSelector — Default storage engine selector.

Search

Daemons, Tasks and Workers

PhabricatorGarbageCollectorDaemon — Collects old logs and caches to reduce the amount of data stored in the database.

IRC

PhabricatorBot — Simple IRC bot which runs as a Phabricator daemon.
PhabricatorBotHandler — Responds to IRC messages.
- PhabricatorBotFeedNotificationHandler — Watches the feed and puts notifications into channel(s) of choice
- PhabricatorBotLogHandler — Logs chatter.
- PhabricatorBotMacroHandler
- PhabricatorBotObjectNameHandler — Looks for Dxxxx, Txxxx and links to them.
- PhabricatorBotSymbolHandler — Watches for "where is <symbol>?"
- PhabricatorBotWhatsNewHandler — Responds to "Whats new?" using the feed.

Remarkup Extensions

PhabricatorMarkupInterface — An object which has one or more fields containing markup that can be rendered into a display format.

MetaMTA (Mail)

PhabricatorMetaMTAMailBody — Render the body of an application email by building it up section-by-section.
PhabricatorMetaMTAMailBodyTestCase

concepts

Concepts: Behaviors — Javelin behaviors help you glue pieces of code together.
Concepts: Event Delegation — Explains Javelin event delegation with JX.Stratcom.
Concepts: Sigils and Metadata — Explains Javelin's sigils and metadata.

facebook

Javelin at Facebook — Information specific to Javelin at Facebook.

bot

Chat Bot Technical Documentation — Configuring and extending the chat bot.

handle

oauthserver

phrequent

pholio

settings

PhabricatorSettingsPanel — Defines a settings panel.

audit

project

conpherence

phame

apps

files

PhabricatorFileStorageConfigurationException — Thrown by storage engines to indicate an configuration error which should abort the storage attempt, as opposed to a transient storage error which should be retried on other engines.

events

worker

PhabricatorWorker
PhabricatorWorkerLeaseQuery — Select and lease tasks from the worker task queue.

Free Radicals

_e()
_phabricator_date_format()
cleanup()
javelin_render_tag()
javelin_tag()
phabricator_date()
phabricator_datetime()
phabricator_form()
phabricator_format_bytes() — Format a byte count for human consumption, e.g.
phabricator_format_local_time() — This function does not usually need to be called directly.
phabricator_format_relative_time()
phabricator_format_relative_time_detailed() — Format a relative time (duration) into weeks, days, hours, minutes, seconds, but unlike phabricator_format_relative_time, does so for more than just the largest unit.
phabricator_format_units_generic()
phabricator_on_relative_date()
phabricator_parse_bytes() — Parse a human-readable byte description (like "6MB") into an integer.
phabricator_read_config_file()
phabricator_relative_date()
phabricator_render_form()
phabricator_time()
phid_get_subtype()
phid_get_type() — Look up the type of a PHID.
phid_group_by_type() — Group a list of phids by type.
rename_project() — Rename the project so that it has a unique slug, by appending (2), (3), etc.

Table of Contents

Introduction

Configuration

Application User Guides

Contributing

Phabricator Developer Guides

Flavor Text

Differential (Code Review)

Classes

Diffusion (Repository Browser)

Classes

Maniphest (Task Tracking)

Classes

Slowvote (Polls)

Classes

Conduit (Phabricator HTTP API)

Classes

Celerity (CSS/JS Management)

Classes

Functions

Phriction (Wiki)

Classes

Aphront (Web Stack)

Classes

DarkConsole (Debugging Console)

Classes

Storage

Classes

File Storage

Classes

Search

Classes

Daemons, Tasks and Workers

Classes

IRC

Classes

Remarkup Extensions

Classes

Interfaces

MetaMTA (Mail)

Classes

concepts

facebook

bot

handle

Functions

oauthserver

Classes

phrequent

Classes

pholio

Classes

settings

Classes

audit

Classes

project

Classes

conpherence

Classes

phame

Classes

apps

Classes

files

Classes

events

Classes

worker

Classes

Free Radicals

Classes

Functions

Interfaces