Installing Review Board¶

Ready to get started with Review Board? We’ve made it pretty easy, depending on your platform.

Installation will happen in two steps:

• Step 1: Install the Review Board packages for:

  • Linux (recommended)

  • macOS

  • Windows

  • Or use our official Docker images

• Step 2: Create your site directory

  Learn how to create your database and Review Board site directory, configure SELinux, and set up a web server.

Upgrading Review Board¶

When you’re ready to upgrade to a new version of Review Board, simply follow these steps:

• Step 1: Upgrade the Review Board packages

• Step 2: Upgrade your site directory

Optimizing/Scaling Your Server¶

Once you have things running, you’ll want to make sure things are working at peak performance by following our guides.

• Introduction to optimizing and scaling Review Board

• Recommended hardware

• Optimizing memcached

• Setting diff limits

• Scaling your deployment

• Troubleshooting performance problems

The Administration UI¶

The Administration UI provides configuration options, database management, news updates and system information. This area is available to all users with staff status and can be reached by clicking Admin in your account navigation menu in the top-right of any page.

The Administration UI is composed of four main areas:

• Admin Dashboard

• Settings

• Database

• Extensions

• Integrations

Configuring Review Board¶

After your site is set up, you may want to go through settings and set up your authentication backend (if using LDAP, Active Directory, etc.), your e-mail server, and enable logging, at a minimum. There are multiple settings pages available through the Administration UI:

• General settings

• Authentication settings

• Avatar services settings

• E-mail settings

• Diff viewer settings

• Logging settings

• SSH settings

• File storage settings

• User Privacy Settings

• Search settings

Next, you’ll want to configure your repositories, review groups, and default reviewers:

• Managing repositories

  Bazaar Cliosoft SOS CVS Git

  HCL VersionVault and IBM ClearCase Mercurial Perforce Subversion

  Assembla AWS CodeCommit Beanstalk Bitbucket Bitbucket Server Codebase Fedora Hosted Gerrit

  GitHub GitHub Enterprise GitLab Gitorious SourceForge Unfuddle STACK VisualStudio.com

• Managing review groups

• Managing default reviewers

You can also configure tighter access control and give special permissions to users:

• Learn about access control

• Manage users and permissions

• Set up permission groups

That’s not all you can set up.

• Configure WebHooks, which can notify in-house or external web services when things happen on Review Board

• Manage extensions, which can add new features to Review Board

• Manage Integrations, which can add integrations between Review Board and third-party services, like:

  • Asana

  • CircleCI

  • Discord

  • I Done This

  • Jenkins CI

  • Matrix

  • Mattermost

  • Slack

  • Travis CI

  • Trello

Site Maintenance¶

Review Board ships with some command line management tools for working with Review Board site directories, search indexes, handle password resets, and more.

• Using the rb-site tool

• Advanced management command line tools