Advanced Management Commands¶

get-siteconfig - Get a Configuration Value¶

This command displays the value for a Review Board configuration setting. It can be useful for automation scripts.

$ rb-site manage /path/to/sitedir get-siteconfig --key <KEY>

list-siteconfig - List Configuration Settings¶

This command lists all stored configuration settings as JSON data. This is useful for inspecting the current settings and finding keys to change.

$ rb-site manage /path/to/sitedir list-siteconfig

resolve-check - Resolve System Check¶

This command is used to resolve certain system checks that can occur during installation/upgrade. These are steps that are required by Review Board but cannot be performed automatically.

Review Board will tell you when you need to run this command, and what parameters to provide.

$ rb-site manage /path/to/sitedir resolve-check <CHECK_NAME>

set-siteconfig - Set a Configuration Value¶

This command sets a new value for an existing configuration setting. It can be useful for automation scripts.

condensediffs - Condense/Upgrade Diff Storage¶

Review Board occasionally introduces new and improved ways of storing diffs, offering new features or reducing storage requirements. This command is used to move any older diffs into the latest type of diff storage.

$ rb-site manage /path/to/sitedir condensediffs [<options>]

import-ssh-keys - Import SSH Keys¶

This is used to import any existing SSH keys into Power Pack’s distributed SSH key storage, used by many types of repositories.

Distributed SSH keys are shared across all Review Board servers in your network serving the same site. It’s useful for Docker environments and other multi-server setups.

$ rb-site manage /path/to/sitedir import-ssh-keys

clean-orphaned-data - Clean Up Orphaned Objects in the Database¶

Prior to Review Board 7.0, deleting a Review Request could potentially leave related data in the database.

Review Board is primarily designed to never delete data, and only administrators had the ability to delete Review Requests entirely. However, if this functionality was used, there may be items left over in the database or filesystem which are no longer accessible.

This command will delete those items. It works in batches, so if it is taking a long time, you can interrupt the process and resume it later.

$ rb-site manage /path/to/sitedir clean-orphaned-data [<options>]

dbshell - Open a Database Shell¶

This command opens a database shell using Review Board’s credentials. This can be useful for advanced debugging and database management.

$ rb-site manage /path/to/sitedir dbshell

find-large-diffs - Find Very Large Diffs¶

When troubleshooting performance problems, it can be helpful to scan for large diffs that may have been uploaded to the database.

This command will output in CSV format, for processing and analysis.

Results from this command will often be requested when contacting support about performance problems.

To check for large diffs from the past N days, run:

$ rb-site manage /path/to/sitedir find-large-diffs \
      --num-days=<N>

To check for a range of review request IDs:

$ rb-site manage /path/to/sitedir find-large-diffs \
      --start-id=<ID> --end-id=<ID>

For example:

$ rb-site manage /path/to/sitedir find-large-diffs --num-days=100
This will scan 35 review requests. Continue? [Y/n] y
Review Request ID,Last Updated,User ID,Max Files,Max Diff Size,Max Parent Diff Size,Diffset ID for Max Files,Diffset ID for Max Diff Size,Diffset ID for Max Parent Diff Size
325,2023-03-22 02:54:45.411235+00:00,1,122,101288,0,514,514,0
328,2023-03-09 12:21:57.841850+00:00,1,14,63378,160718,517,517,517
334,2023-04-23 01:36:54.422582+00:00,1,6,70384,108192,535,535,535
337,2023-09-14 22:54:14.637025+00:00,1,5,107403,0,543,544,0

The following options are available to customize your scan:

--min-size <MIN_SIZE_BYTES>¶

Minimum diff or parent diff size to include in a result.

A review request is included if a diff meets --min-size or --min-files.

Defaults to 100000 (100KB).

--min-files <MIN_FILES>¶

Minimum number of files to include in a result.

A review request is included if a diff meets --min-size or --min-files.

Defaults to 50.

--start-id <ID>¶

Starting review request ID for the scan.

Either --start-id or --num-days must be specified.

--end-id <ID>¶

Last review request ID for the scan.

Defaults to the last ID in the database.

--num-days <DAYS>¶

Number of days back to scan for diffs.

Either --start-id or --num-days must be specified.

--noinput, --no-input¶

Disable prompting for confirmation before performing the scan.

shell - Open a Command Shell¶

Power users who wish to run Python commands against an installed Review Board server can do so with the shell management command. This can be useful if you’re a developer looking to test some code against Review Board.

$ rb-site manage /path/to/sitedir shell

disable-extension - Disable Extension¶

This disables one or more extensions. It’s the equivalent of going into Administration UI -> Extensions and disabling extensions, and can be useful for automation scripts.

See Managing Extensions.

$ rb-site manage /path/to/sitedir disable-extension EXTENSION_ID [...]

enable-extension - Enable Extension¶

This enables one or more extensions. It’s the equivalent of going into Administration UI -> Extensions and enabling extensions, and can be useful for automation scripts.

See Managing Extensions.

$ rb-site manage /path/to/sitedir enable-extension EXTENSION_ID [...]

list-extensions - List Extensions¶

Lists the extensions registered with Review Board. The name, enabled status, and extension ID will be shown for each extension.

$ rb-site manage /path/to/sitedir list-extensions [<options>]

pip - Python Package Tool¶

This wraps around the correct version of pip for your Review Board environment. It’s used for installing or managing packages for Review Board.

See the pip documentation for usage instructions.

$ rb-site manage /path/to/sitedir pip <command> [<options>]

$ rb-site manage /path/to/sitedir pip install <packagename>

$ rb-site manage /path/to/sitedir pip install -U <packagename>

$ rb-site manage /path/to/sitedir pip uninstall <packagename>

$ rb-site manage /path/to/sitedir pip show <packagename>

$ rb-site manage /path/to/sitedir pip list

python - Python Interperter¶

This wraps around the correct version of python for your Review Board environment. It’s used for executing Python code in your Review Board environment.

This differs from shell in that Python code will not run within the Review Board process.

$ rb-site manage /path/to/sitedir python [<options>]

clear_index - Clear the Search Index¶

This command will erase the current search index. A rebuild will be required before any new searches can be conducted.

By default, this will prompt for confirmation before clearing the index.

$ rb-site manage /path/to/sitedir clear_index [<options>]n

rebuild_index - Rebuild the Search Index¶

This command will erase the current search index and then rebuild it from scratch. This can take some time.

By default, this will prompt for confirmation before clearing the index.

$ rb-site manage /path/to/sitedir rebuild_index [<options>]

update_index - Update the Search Index¶

The update_index management command will create or update the current search index with any new content. It can be run periodically.

By default, this will prompt for confirmation before clearing the index.

If on-the-fly indexing is enabled, this command is not required, but can help with catching objects that may have failed to write due to temporary failures in the search backend.

$ rb-site manage /path/to/sitedir update_index -r -a <hours> [<options>]

changepassword - Change a User’s Password¶

This command will change an existing user’s password to a newly-supplied one, helping them get back into the system if they’re unable to reset their own password.

$ rb-site manage /path/to/sitedir changepassword <username>

createsuperuser - Create a Super User¶

It is possible to create a new super user account without using the website. This can be important if the main super user account is for whatever reason disabled or if the login information is lost.

$ rb-site manage /path/to/sitedir createsuperuser

invalidate-api-tokens - Invalidate API Tokens¶

In the event of security issues, you can invalidate API tokens for specific users or all users on your server.

$ rb-site manage /path/to/sitedir invalidate-api-tokens <user1> <user2>...

$ rb-site manage /path/to/sitedir invalidate-api-tokens --all