What is Phabricator?

Phabricator is a collection of open source web applications that help software companies build better software. Phabricator is built by developers for developers. Every feature is optimized around developer efficiency for however you like to work. Code Quality starts with effective collaboration between team members.

https://www.phacility.com/phabricator/

TL;DR

Docker Compose

$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-phabricator/master/docker-compose.yml > docker-compose.yml
$ docker-compose up -d

Why use Bitnami Images?

• Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems.
• With Bitnami images the latest bug fixes and features are available as soon as possible.
• Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs.
• Bitnami images are built on CircleCI and automatically pushed to the Docker Hub.
• All our images are based on minideb a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution.

Prerequisites

To run this application you need Docker Engine >= 1.10.0. Docker Compose is recommended with a version 1.6.0 or later.

How to use this image

Phabricator requires access to a MySQL database or MariaDB database to store information. We'll use our very own MariaDB image for the database requirements.

Using Docker Compose

The recommended way to run Phabricator is using Docker Compose using the following docker-compose.yml template:

version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
    volumes:
      - mariadb_data:/bitnami
  phabricator:
    image: bitnami/phabricator:latest
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - phabricator_data:/bitnami

volumes:
  mariadb_data:
    driver: local
  phabricator_data:
    driver: local

Launch the containers using:

$ docker-compose up -d

Using the Docker Command Line

If you want to run the application manually instead of using docker-compose, these are the basic steps you need to run:

1. Create a network

$ docker network create phabricator-tier

2. Create a volume for MariaDB persistence and create a MariaDB container

$ docker volume create --name mariadb_data
$ docker run -d --name mariadb -e ALLOW_EMPTY_PASSWORD=yes \
  --net phabricator-tier \
  --volume mariadb_data:/bitnami \
  bitnami/mariadb:latest

3. Create volumes for Phabricator persistence and launch the container

$ docker volume create --name phabricator_data
$ docker run -d --name phabricator -p 80:80 -p 443:443 \
  --net phabricator-tier \
  --volume phabricator_data:/bitnami \
  bitnami/phabricator:latest

Access your application at http://your-ip/

Persisting your application

If you remove the container all your data and configurations will be lost, and the next time you run the image the database will be reinitialized. To avoid this loss of data, you should mount a volume that will persist even after the container is removed.

For persistence you should mount a volume at the /bitnami path. Additionally you should mount a volume for persistence of the MariaDB data.

The above examples define docker volumes namely mariadb_data and phabricator_data. The Phabricator application state will persist as long as these volumes are not removed.

To avoid inadvertent removal of these volumes you can mount host directories as data volumes. Alternatively you can make use of volume plugins to host the volume data.

Mount host directories as data volumes with Docker Compose

The following docker-compose.yml template demonstrates the use of host directories as data volumes.

version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
    volumes:
      - /path/to/mariadb-persistence:/bitnami
  phabricator:
    image: bitnami/phabricator:latest
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - /path/to/phabricator-persistence:/bitnami

Mount host directories as data volumes using the Docker command line

1. Create a network (if it does not exist)

$ docker network create phabricator-tier

2. Create a MariaDB container with host volume

$ docker run -d --name mariadb -e ALLOW_EMPTY_PASSWORD=yes \
  --net phabricator-tier \
  --volume /path/to/mariadb-persistence:/bitnami \
  bitnami/mariadb:latest

3. Create the Phabricator the container with host volumes

$ docker run -d --name phabricator -p 80:80 -p 443:443 \
  --net phabricator-tier \
  --volume /path/to/phabricator-persistence:/bitnami \
  bitnami/phabricator:latest

Upgrading Phabricator

Bitnami provides up-to-date versions of MariaDB and Phabricator, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. We will cover here the upgrade of the Phabricator container. For the MariaDB upgrade see https://github.com/bitnami/bitnami-docker-mariadb/blob/master/README.md#upgrade-this-image

The bitnami/phabricator:latest tag always points to the most recent release. To get the most recent release you can simple repull the latest tag from the Docker Hub with docker pull bitnami/phabricator:latest. However it is recommended to use tagged versions.

1. Get the updated images:

$ docker pull bitnami/phabricator:latest

2. Stop your container

• For docker-compose: $ docker-compose stop phabricator
• For manual execution: $ docker stop phabricator

3. Take a snapshot of the application state

$ rsync -a /path/to/phabricator-persistence /path/to/phabricator-persistence.bkp.$(date +%Y%m%d-%H.%M.%S)

Additionally, snapshot the MariaDB data

You can use these snapshots to restore the application state should the upgrade fail.

4. Remove the currently running container

• For docker-compose: $ docker-compose rm -v phabricator
• For manual execution: $ docker rm -v phabricator

5. Run the new image

• For docker-compose: $ docker-compose start phabricator
• For manual execution (mount the directories if needed): docker run --name phabricator bitnami/phabricator:latest

Configuration

Environment variables

The Phabricator instance can be customized by specifying environment variables on the first run. The following environment values are provided to customize Phabricator:

• PHABRICATOR_HOST: Phabricator host name. Default: 127.0.0.1
• PHABRICATOR_USERNAME: Phabricator application username. Default: user
• PHABRICATOR_PASSWORD: Phabricator application password. Default: bitnami1
• PHABRICATOR_EMAIL: Phabricator application email. Default: user@example.com
• PHABRICATOR_FIRSTNAME: Phabricator user first name. Default: FirstName
• PHABRICATOR_LASTNAME: Phabricator user last name. Default: LastName
• MARIADB_USER: Root user for the MariaDB database. Default: root
• MARIADB_PASSWORD: Root password for the MariaDB.
• MARIADB_HOST: Hostname for MariaDB server. Default: mariadb
• MARIADB_PORT_NUMBER: Port used by MariaDB server. Default: 3306

Specifying Environment variables using Docker Compose

version: '2'

services:
  mariadb:
    image: 'bitnami/mariadb:latest'
    environment:
      - ALLOW_EMPTY_PASSWORD=yes
    volumes:
      - mariadb_data:/bitnami
  phabricator:
    image: bitnami/phabricator:latest
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    environment:
      - PHABRICATOR_PASSWORD=my_password
    volumes:
      - phabricator_data:/bitnami

volumes:
  mariadb_data:
    driver: local
  phabricator_data:
    driver: local

Specifying Environment variables on the Docker command line

$ docker run -d --name phabricator -p 80:80 -p 443:443 \
  --net phabricator-tier \
  --env PHABRICATOR_PASSWORD=my_password \
  --volume phabricator_data:/bitnami \
  bitnami/phabricator:latest

SMTP Configuration

To configure phabricator to send email using SMTP you can set the following environment variables:

• SMTP_HOST: SMTP host. No defaults
• SMTP_PORT: SMTP port. No defaults
• SMTP_USER: SMTP account user. No defaults
• SMTP_PASSWORD: SMTP account password. No defaults
• SMTP_PROTOCOL: SMTP protocol. No defaults. Possible values are ssl for port 465 and tls for port 587

This would be an example of SMTP configuration using a GMail account:

• docker-compose:

  phabricator:
    image: bitnami/phabricator:latest
    ports:
      - 80:80
    environment:
      - SMTP_HOST=smtp.gmail.com
      - SMTP_PORT=587
      - SMTP_USER=your_email@gmail.com
      - SMTP_PASSWORD=your_password
      - SMTP_PROTOCOL=tls

• For manual execution:

 $ docker run -d -e SMTP_HOST=smtp.gmail.com -e SMTP_PORT=587 -e SMTP_USER=your_email@gmail.com -e SMTP_PASSWORD=your_password -e SMTP_PROTOCOL=tls -p 80:80 --name phabricator -v /your/local/path/bitnami/phabricator:/bitnami --net=phabricator_network bitnami/phabricator

How to migrate from a Bitnami Phabricator Stack

You can follow these steps in order to migrate it to this container:

1. Export the data from your SOURCE installation: (assuming an installation in /bitnami directory)

$ cd /bitnami/phabricator/apps/phabricator/htdocs/bin
$ ./storage dump | gzip > ~/backup-phabricator-mysql-dumps.sql.gz
$ cd /bitnami/phabricator/apps/phabricator/data/
$ tar -zcvf ~/backup-phabricator-localstorage.tar.gz .
$ cd /bitnami/phabricator/apps/phabricator/repo/
$ tar -zcvf ~/backup-phabricator-repos.tar.gz .

2. Copy the backup files to your TARGET installation:

$ scp ~/backup-phabricator-* YOUR_USERNAME@TARGET_HOST:~

3. Create the Phabricator Container as described in the section #How to use this Image (Using Docker Compose)

4. Wait for the initial setup to finish. You can follow it with

$ docker-compose logs -f phabricator

and press Ctrl-C when you see this:

nami    INFO  phabricator successfully initialized
Starting application ...

  *** Welcome to the phabricator image ***
  *** Brought to you by Bitnami ***

5. Stop Phabricator daemon:

$ docker-compose exec phabricator nami stop phabricator

6. Restore and upgrade the database: (replace ROOT_PASSWORD below with your MariaDB root password)

$ cd ~
$ docker-compose exec phabricator /opt/bitnami/phabricator/bin/storage destroy --force
$ gunzip -c ./backup-phabricator-mysql-dumps.sql.gz | docker-compose exec mariadb mysql -pROOT_PASSWORD
$ docker-compose exec phabricator /opt/bitnami/phabricator/bin/storage upgrade --force

7. Restore repositories from backup:

$ cat ./backup-phabricator-repos.tar.gz | docker-compose exec phabricator bash -c 'cd /bitnami/phabricator/repo ; tar -xzvf -'

8. Restore local storage files:

$ cat ./backup-phabricator-localstorage.tar.gz | docker-compose exec phabricator bash -c 'cd /bitnami/phabricator/data ; tar -xzvf -'

9. Fix repositories storage location: (replace ROOT_PASSWORD below with your MariaDB root password)

$ cat | docker-compose exec mariadb mysql -pROOT_PASSWORD <<EOF
USE bitnami_phabricator_repository;
UPDATE repository SET localPath = REPLACE(localPath, '/bitnami/apps/phabricator/repo/', '/opt/bitnami/phabricator/repo/');
COMMIT;
EOF

10. Fix phabricator directory permissions:

$ docker-compose exec phabricator chown -R phabricator:phabricator /bitnami/phabricator

11. Restart Phabricator container:

$ docker-compose restart phabricator

Contributing

We'd love for you to contribute to this container. You can request new features by creating an issue, or submit a pull request with your contribution.

FAQ

You can search for frequently asked questions (and answers) in the GitHub issue list. These are marked with the label faq.

Issues

If you encountered a problem running this container, you can file an issue. For us to provide better support, be sure to include the following information in your issue:

• Host OS and version
• Docker version (docker version)
• Output of docker info
• Version of this container (echo $BITNAMI_IMAGE_VERSION inside the container)
• The command you used to run the container, and any relevant output you saw (masking any sensitive information)

License

Copyright 2016-2018 Bitnami

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.