Administration Guide¶
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:
- Step 2: Create your site directory
Upgrading Review Board¶
When you’re ready to upgrade to a new version of Review Board, simply follow these steps:
Optimizing Your Server¶
Once you have things running, you’ll want to make sure things are working at peak performance by following our guides.
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:
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
- E-mail settings
- Diff viewer settings
- Logging settings
- SSH settings
- File storage settings
Next, you’ll want to configure your repositories, review groups, and default reviewers:
You can also configure tighter access control and give special permissions to users:
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 or add new integrations with other services
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.