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., 5.0, 6.0).

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

See our Docker repository for all available versions.

Serving Content¶

The backend Review Board server will be accessible over port 8080. You can change this by passing -p port:8080 to map a custom local port to Review Board’s port 8080.

You’ll need a frontend web server (such as the nginx Docker image), to forward traffic to that backend 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/)

• /robots.txt (pointing to the site directory’s htdocs/robots.txt)

You’ll need to mount your Review Board site directory volume to an appropriate directory (such as /var/www/reviewboard, as shown below).

If using Nginx, your configuration may look something like:

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

server {
    server_name reviews.corp.example.com

    # If enabling SSL on Nginx, remove the "listen ${NGINX_PORT}" lines
    # below and use these settings instead. You will also need
    # to change X-Forwarded-Ssl below.
    #
    # listen [::]:443 ssl http2;
    # listen 443 ssl http2;
    # ssl_certificate /var/www/reviewboard/conf/ssl/fullchain.pem;
    # ssl_certificate_key /var/www/reviewboard/conf/ssl/privkey.pem;
    listen [::]:80;
    listen 80;

    root /var/www/reviewboard/htdocs;

    location / {
        proxy_pass http://reviewboard;
        proxy_redirect off;

        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Port $server_port;
        proxy_set_header X-Forwarded-Proto $scheme;

        # NOTE: Set this to "on" if using SSL.
        proxy_set_header X-Forwarded-Ssl off;

        client_max_body_size        10m;
        client_body_buffer_size     128k;
        proxy_connect_timeout       90;
        proxy_send_timeout          90;
        proxy_read_timeout          90;
        proxy_headers_hash_max_size 512;
        proxy_buffer_size           4k;
        proxy_buffers               4 32k;
        proxy_busy_buffers_size     64k;
        proxy_temp_file_write_size  64k;
    }

    location /media/ {
        alias /var/www/reviewboard/htdocs/media/;
        expires max;
        add_header Cache-Control public;
    }

    location /static/ {
        alias /var/www/reviewboard/htdocs/static/;
        expires max;
        add_header Cache-Control public;
    }

    location /errordocs/ {
        alias /var/www/reviewboard/htdocs/errordocs/;
        expires 5d;
    }

    location /robots.txt {
        alias /var/www/reviewboard/htdocs/robots.txt;
        expires 5d;
    }
}

See Configuring the Web Server for additional web server configuration examples.

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.