Installing with Docker¶

Plan Your Infrastructure¶

The Review Board Docker image requires all of the following:

• A database server (Postgres, MySQL, or MariaDB)

• A memcached server

• A web server (such as Apache or Nginx) that can proxy to the Docker image’s Gunicorn server and serve static media files

• A local file system path to store the Review Board site directory (which will contain the static media files to serve)

If using docker-compose with our sample configurations, this will be all be taken care of for you.

Choose a Version¶

Our Docker images are available in the following forms:

• beanbag/reviewboard:latest – The latest stable release of Review Board.

• beanbag/reviewboard:X.Y – The latest stable release in a major version series (e.g., 3.0, 4.0).

• beanbag/reviewboard:X.Y.Z – A specific release of Review Board (e.g., 3.0.21, 4.0.4).

See our Docker repository for all available versions.

Serving Content¶

The server will be accessible over port 8080. You can change this by passing -p port:8080.

You’ll need another web server to forward traffic to that port, and to serve up the following URLs:

• /static/ (pointing to the site directory’s htdocs/static/)

• /media/ (pointing to the site directory’s htdocs/media/)

If using Nginx, your configuration may look like:

upstream reviewboard {
    server reviewboard-docker1.corp.example.com:8080;
}

server {
    server_name reviews.corp.example.com
    listen 80;

    root /var/www/reviewboard/htdocs;

    location / {
        proxy_pass http://reviewboard;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header Host $host;
        proxy_redirect off;
    }

    location /media/ {
        alias /var/www/reviewboard/htdocs/media/;
        add_header Access-Control-Allow-Origin *;
        expires max;

        location ~ \.(html|htm|shtml|php)$ {
            types {}
            default_type text/plain;
        }
    }

    location /static/ {
        alias /var/www/reviewboard/htdocs/static/;
        add_header Access-Control-Allow-Origin *;
        expires max;
    }
}

Server Information¶

COMPANY

The name of your company.

This can be changed in the Review Board administration UI after launch.

DOMAIN

The fully-qualified domain name for your Review Board server.

The server will only respond to requests sent to this domain.

This cannot include http:// or https://.

Database¶

DATABASE_TYPE

The type of database to use for Review Board.

This can be either mysql or postgresql. It defaults to postgresql.

DATABASE_SERVER

The address to the database server. This must be reachable in the container.

This defaults to db, the name defined in our sample docker-compose.yaml files.

DATABASE_NAME

The name of the database on the database server.

This defaults to db, and must already be created before launching a container.

DATABASE_USERNAME

The username used to connect to and modify the database identified by DATABASE_NAME.

This defaults to reviewboard.

DATABASE_PASSWORD

The password belonging to the database user.

File System¶

REVIEWBOARD_GROUP_ID

The ID of the group that will own server-writable files and directories in the site directory.

This defaults to 1001, and should be changed if you’re working with an existing site directory.

REVIEWBOARD_USER_ID

The ID of the user that will own server-writable files and directories in the site directory.

This defaults to 1001, and should be changed if you’re working with an existing site directory.

Memcached¶

MEMCACHED_SERVER

The address to the memcached server. This must be reachable in the container.

This defaults to memcached:11211, using the name defined in our sample docker-compose.yaml files.