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;

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

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/mariadb
  phabricator:
    image: bitnami/phabricator:latest
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - phabricator_data:/bitnami/phabricator
      - apache_data:/bitnami/apache
      - php_data:/bitnami/php

volumes:
  mariadb_data:
    driver: local
  phabricator_data:
    driver: local
  apache_data:
    driver: local
  php_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:

Create a network

$ docker network create phabricator-tier

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/mariadb \
  bitnami/mariadb:latest

Create volumes for Phabricator persistence and launch the container

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

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

Persisting your application

For persistence of the Phabricator deployment, the above examples define docker volumes namely mariadb_data, phabricator_data, apache_data and php_data. The Phabricator application state will persist as long as these volumes are not removed.

If 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/mariadb
  phabricator:
    image: bitnami/phabricator:latest
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    volumes:
      - /path/to/phabricator-persistence:/bitnami/phabricator
      - /path/to/apache-persistence:/bitnami/apache
      - /path/to/php-persistence:/bitnami/php

Mount host directories as data volumes using the Docker command line

Create a network (if it does not exist)

$ docker network create phabricator-tier

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/mariadb \
  bitnami/mariadb:latest

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/phabricator \
  --volume /path/to/apache-persistence:/bitnami/apache \
  --volume /path/to/php-persistence:/bitnami/php \
  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.

Get the updated image:

$ docker pull bitnami/phabricator:latest

Using Docker Compose

Stop the running Phabricator container

$ docker-compose stop phabricator

Remove the stopped container

$ docker-compose rm phabricator

Launch the updated Phabricator image

$ docker-compose start phabricator

Using Docker command line

Stop the running Phabricator container

$ docker stop phabricator

Remove the stopped container

$ docker rm phabricator

Launch the updated Phabricator image

$ docker run -d --name phabricator -p 80:80 -p 443:443 \
  --net phabricator-tier \
  --volume phabricator_data:/bitnami/phabricator \
  --volume apache_data:/bitnami/apache \
  --volume php_data:/bitnami/php \
  bitnami/phabricator:latest

NOTE:

The above command assumes that local docker volumes are in use. Edit the command according to your usage.

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: 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/mariadb
  phabricator:
    image: bitnami/phabricator:latest
    depends_on:
      - mariadb
    ports:
      - '80:80'
      - '443:443'
    environment:
      - PHABRICATOR_PASSWORD=my_password
    volumes:
      - phabricator_data:/bitnami/phabricator
      - apache_data:/bitnami/apache
      - php_data:/bitnami/php

volumes:
  mariadb_data:
    driver: local
  phabricator_data:
    driver: local
  apache_data:
    driver: local
  php_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/phabricator \
  --volume apache_data:/bitnami/apache \
  --volume php_data:/bitnami/php \
  bitnami/phabricator:latest

SMTP Configuration

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

SMTP_HOST: SMTP host.
SMTP_PORT: SMTP port.
SMTP_USER: SMTP account user.
SMTP_PASSWORD: SMTP account password.
SMTP_PROTOCOL: SMTP protocol.

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
    volumes_from:
      - phabricator_data

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 -p 80:80 --name phabricator -v /your/local/path/bitnami/phabricator:/bitnami/phabricator --net=phabricator_network bitnami/phabricator

Backing up your application

To backup your application data follow these steps:

Backing up using Docker Compose

Stop containers:

$ docker-compose stop

Copy Phabricator, Apache, PHP and MariaDB data:

$ docker cp $(docker-compose ps -q phabricator):/bitnami/phabricator/ /path/to/backups/phabricator/latest/
$ docker cp $(docker-compose ps -q phabricator):/bitnami/apache/ /path/to/backups/apache/latest/
$ docker cp $(docker-compose ps -q phabricator):/bitnami/php/ /path/to/backups/php/latest/
$ docker cp $(docker-compose ps -q mariadb):/bitnami/mariadb/ /path/to/backups/mariadb/latest/

Start containers:

$ docker-compose start

Backing up using the Docker command line

Stop containers:

$ docker stop phabricator
$ docker stop mariadb

Copy Phabricator, Apache, PHP and MariaDB data:

$ docker cp phabricator:/bitnami/phabricator/ /path/to/backups/phabricator/latest/
$ docker cp phabricator:/bitnami/apache/ /path/to/backups/apache/latest/
$ docker cp phabricator:/bitnami/php/ /path/to/backups/php/latest/
$ docker cp mariadb:/bitnami/mariadb/ /path/to/backups/mariadb/latest/

Start containers:

$ docker start phabricator
$ docker start mariadb

Restoring a backup

To restore your application using backed up data simply mount the folder with Phabricator and Apache data in the container. See persisting your application section for more info.

How to migrate from a Bitnami Phabricator Stack

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

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 .

Copy the backup files to your TARGET installation:

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

Create the Phabricator Container as described in the section #How to use this Image (Using Docker Compose)
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 ***

Stop Phabricator daemon:

$ docker-compose exec phabricator nami stop phabricator

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

Restore repositories from backup:

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

Restore local storage files:

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

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

Fix phabricator directory permissions:

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

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

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.

xiaoxinyi/bitnami-docker-phabricator

What is Phabricator?

TL;DR;

Prerequisites

How to use this image

Using Docker Compose

Using the Docker Command Line

Persisting your application

Mount host directories as data volumes with Docker Compose

Mount host directories as data volumes using the Docker command line

Upgrading Phabricator

Using Docker Compose

Using Docker command line

Configuration

Environment variables

Specifying Environment variables using Docker Compose

Specifying Environment variables on the Docker command line

SMTP Configuration

Backing up your application

Backing up using Docker Compose

Backing up using the Docker command line

Restoring a backup

How to migrate from a Bitnami Phabricator Stack

Contributing

FAQ

Issues

License