◉ Phabricator User Documentation https://secure.phabricator.

com/book/phabricator/

$ Diviner % Phabricator User Docs

Phabricator User Documentation # Actions

" Updated Today ! Public

Instructions for installing, configuring, and using Phabricator.

Introduction

Installation Guide Article

This document contains basic install instructions to get Phabricator up and running.

Introduction Article
This document provides a high-level overview of the Phabricator project.

Reporting Security Vulnerabilities Article

Describes how to report security vulnerabilities in Phabricator.

Support Resources Article

Resources for reporting bugs, requesting features, and getting support.

Upgrading Phabricator Article

This document contains instructions for keeping Phabricator up to date.

Configuration

Configuration Guide Article

This document contains basic configuration instructions for Phabricator.

Configuration Guide: Locked and Hidden Configuration Article

Details about locked and hidden configuration.

Configuration User Guide: Advanced Configuration Article

Configuring Phabricator for multiple environments.

Configuring a File Domain Article

Setup guide for an alternate file domain or CDN.

Configuring a Preamble Script Article

1 of 8 01/12/19, 1:24 AM
◉ Phabricator User Documentation https://secure.phabricator.com/book/phabricator/

Adjust environmental settings (SSL, remote IPs) using a preamble script.

Configuring Accounts and Registration Article

Describes how to configure user access to Phabricator.

Configuring Backups and Performing Migrations Article

Advice for backing up Phabricator, or migrating from one machine to another.

Configuring Custom Fields Article

How to add custom fields to applications which support them.

Configuring Encryption Article

Setup guide for configuring encryption.

Configuring File Storage Article

Setup file storage and support for large files.

Configuring Inbound Email Article

This document contains instructions for configuring inbound email, so users may interact with some
Phabricator applications via email.

Configuring Outbound Email Article

Instructions for configuring Phabricator to send email and other types of messages, like text messages.

Managing Caches Article

Discusses Phabricator caches and cache management.

Managing Daemons with phd Article

Explains Phabricator daemons and the daemon control program `phd`.

Managing Garbage Collection Article

Understanding and configuring garbage collection.

Managing Storage Adjustments Article

Explains how to apply storage adjustments to the MySQL schemata.

Notifications User Guide: Setup and Configuration Article

Guide to setting up notifications.

Troubleshooting HTTPS Article

Detailed instructions for troubleshooting HTTPS connection problems.

User Guide: Amazon RDS Article

Discusses using Amazon RDS as a database.

Application User Guides

2 of 8 01/12/19, 1:24 AM
◉ Phabricator User Documentation https://secure.phabricator.com/book/phabricator/

Almanac User Guide Article

Using Almanac to manage devices and services.

Arcanist Quick Start Article

Quick guide to getting Arcanist working for a new project.

Arcanist User Guide Article

Guide to Arcanist, a command-line interface to Phabricator.

Arcanist User Guide: arc diff Article

Guide to running `arc diff`, to send changes to Differential for review.

Arcanist User Guide: Code Coverage Article

Explains code coverage features in Arcanist and Phabricator.

Arcanist User Guide: Commit Ranges Article

Explains how commit ranges work in Arcanist.

Arcanist User Guide: Configuring a New Project Article

Explains how to configure Arcanist projects with `.arcconfig` files.

Arcanist User Guide: Customizing Existing Linters Article

Explains how to customize existing linters.

Arcanist User Guide: Customizing Lint, Unit Tests and Workflows Article
Explains how to build new classes to control how Arcanist behaves.

Arcanist User Guide: Lint Article

Guide to lint, linters, and linter configuration.

Arcanist User Guide: Mac OS X Article

Explains how to install Arcanist on Mac OS X.

Arcanist User Guide: Script and Regex Linter Article

Explains how to use the Script and Regex linter to invoke an existing lint engine that is not integrated with
Arcanist.

Arcanist User Guide: Windows Article

Explains how to install Arcanist on Windows.

Audit User Guide Article

Guide to using Phabricator to audit published commits.

Calendar User Guide Article

Guide to the Calendar application.

Calendar User Guide: Exporting Events Article

Exporting events to other calendars.

Calendar User Guide: Importing Events Article

3 of 8 01/12/19, 1:24 AM
◉ Phabricator User Documentation https://secure.phabricator.com/book/phabricator/

Importing events from other calendars.

Differential User Guide Article

Guide to the Differential (pre-push code review) tool and workflow.

Differential User Guide: Automated Landing Article

Configuring Phabricator so you can "Land Revision" from the web UI.

Differential User Guide: FAQ Article

Common questions about Differential.

Differential User Guide: Inline Comments Article

Guide to inline comments in Differential.

Differential User Guide: Test Plans Article

This document describes things you should think about when developing a test plan.

Diffusion User Guide Article

Guide to Diffusion, the Phabricator application for hosting and browsing repositories.

Diffusion User Guide: Commit Hooks Article

Guide to commit hooks in hosted repositories.

Diffusion User Guide: Existing Repositories Article

Quick guide for importing or observing existing repositories.

Diffusion User Guide: Managing Repositories Article

Guide to configuring and managing repositories in Diffusion.

Diffusion User Guide: Permanent Refs Article

Explains when Diffusion will take actions in response to discovering commits.

Diffusion User Guide: Repositories API Article

Managing repositories with the API.

Diffusion User Guide: Repository Hosting Article

Guide to configuring Phabricator repository hosting.

Diffusion User Guide: Repository Updates Article

Explains how Diffusion updates repositories to discover new changes.

Diffusion User Guide: Symbol Indexes Article

Guide to configuring and using the symbol index.

Diffusion User Guide: URIs Article

Guide to configuring repository URIs for fetching, cloning and mirroring.

Diviner User Guide Article

Using Diviner, a documentation generator.

4 of 8 01/12/19, 1:24 AM
◉ Phabricator User Documentation https://secure.phabricator.com/book/phabricator/

Drydock Blueprints Article

Overview of Drydock blueprint types.

Drydock Blueprints: Hosts Article

Guide to configuring Drydock host blueprints.

Drydock Blueprints: Working Copies Article

Guide to configuring Drydock working copy blueprints.

Drydock User Guide Article

Drydock, a software and hardware resource manager.

Drydock User Guide: Quick Start Article

Guide to getting Drydock

Drydock User Guide: Repository Automation Article

Configuring repository automation so Phabricator can push commits.

Drydock User Guide: Security Article

Understanding security concerns in Drydock.

Events User Guide: Installing Event Listeners Article

Using Phabricator event listeners to customize behavior.

Harbormaster User Guide Article

Guide to Harbormaster, a build and continuous integration application.

Herald User Guide Article

Use Herald to get notified of changes you care about.

Legalpad User Guide Article

Using Legalpad to track agreements and signatures on legal documents.

Multimeter User Guide Article

Using Multimeter, a sampling profiler.

Owners User Guide Article

Group files in a codebase into packages and define ownership.

Phame User Guide Article

Phame is a blogging platform.

Phriction User Guide Article

Construct a detailed written history of your civilization.

Profile Menu User Guide Article

Master profile menus for projects and other objects.

Projects User Guide Article

Organize users and objects with projects.

5 of 8 01/12/19, 1:24 AM
◉ Phabricator User Documentation https://secure.phabricator.com/book/phabricator/

Remarkup Reference Article

Explains how to make bold text; this makes your words louder so you can win arguments.

Search User Guide Article

Introduction to searching for documents in Phabricator.

Search User Guide: Shortcuts Article

Command reference for global search shortcuts.

Slowvote User Guide Article

Detailed dispute resolution manual.

Spaces User Guide Article

Guide to the Spaces application.

User Guide: Account Roles Article

Describes account roles like "Administrator", "Disabled", "Bot" and "Mailing List".

User Guide: Configuring an External Editor Article

Setting up an external editor to integrate with Diffusion and Differential.

User Guide: Customizing Forms Article

Guide to prefilling and customizing forms in Phabricator applications.

User Guide: Managing Phabricator Email Article

How to effectively manage Phabricator email notifications.

User Guide: Multi-Factor Authentication Article

Explains how multi-factor authentication works in Phabricator.

User Guide: Project Tone Article

Explains why Phabricator uses a lighthearted tone.

User Guide: Prototype Applications Article

Information about prototypes.

User Guide: Review vs Audit Article

Discusses the differences between "review" and "audit" workflows.

User Guide: Unlocking Objects Article

Explains how to access locked or invisible objects and accounts.

User Guide: UTF-8 and Character Encoding Article

How Phabricator handles character encodings.

User Guide: Webhooks Article

Guide to configuring webhooks.

6 of 8 01/12/19, 1:24 AM
◉ Phabricator User Documentation https://secure.phabricator.com/book/phabricator/

API Documentation

Conduit API Overview Article

Overview of the Conduit API.

Conduit API: Using Edit Endpoints Article

Describes how to use edit endpoints to create and update objects.

Conduit API: Using Search Endpoints Article

Describes how to use search endpoints to find objects and read information.

Cluster Configuration

Cluster: Daemons Article

Configuring Phabricator to use multiple daemon hosts.

Cluster: Databases Article

Configuring Phabricator to use multiple database hosts.

Cluster: Devices Article

Guide to configuring hosts to act as cluster devices.

Cluster: Notifications Article

Configuring Phabricator to use multiple notification servers.

Cluster: Partitioning and Advanced Configuration Article

Guide to partitioning Phabricator applications across multiple database hosts.

Cluster: Repositories Article

Configuring Phabricator to use multiple repository hosts.

Cluster: Search Article

You can configure Phabricator to connect to one or more fulltext search services.

Cluster: SSH Servers Article

Configuring Phabricator to use multiple SSH servers.

Cluster: Web Servers Article

Configuring Phabricator to use multiple web servers.

Clustering Introduction Article

Guide to configuring Phabricator across multiple hosts for availability and performance.

7 of 8 01/12/19, 1:24 AM
◉ Phabricator User Documentation https://secure.phabricator.com/book/phabricator/

Field Manuals

Command Line Exit Codes Article

Explains the use of exit codes in Phabricator command line scripts.

Managing Conduit Changes Article

Help with managing Conduit API changes.

Permanently Destroying Data Article

How to permanently destroy data and manage leaked secrets.

Repository Hints and Rewriting Commits Article

Dealing with rewrites of published repositories and other unusual problems.

Restarting Phabricator Article

Instructions on how to restart HTTP and PHP servers to reload configuration changes in Phabricator.

Revoking Credentials Article

Revoking credentials, tokens, and sessions.

Troubleshooting Performance Problems Article

Guide to the troubleshooting slow pages and hangs.

Troubleshooting Repository Imports Article

Guide to the troubleshooting repositories which import incompletely.

Using DarkConsole Article

Enabling and using the built-in debugging and performance console.

Using XHProf Article

Describes how to install and use XHProf, a PHP profiling tool.

Musty Cellar

Give Feedback! Get Support! Article

This article has moved to @{article:Support Resources}.

8 of 8 01/12/19, 1:24 AM