Advanced Management Commands¶
rb-site provides a
manage command for certain management tasks.
The format for the commands is always:
$ rb-site manage /path/to/site command-name -- parameters
The management commands that administrators are most likely to use are explained in detail in the following sections.
To get a complete list of all management commands, run:
$ rb-site manage /path/to/site help
And to retrieve information on a specific management command:
$ rb-site manage /path/to/site help command-name
Review Board installations with indexed search enabled must periodically
index the database. This is done through the
update_index management commands (The
index command will be
deprecated in a future release).
To perform a full index:
$ rb-site manage /path/to/site rebuild_index
To perform an index update:
$ rb-site manage /path/to/site update_index -- -a <hours>
<hours> is the number of hours since the last update. We recommend
-a 1 and run the update command every 10 minutes. This command should
be run periodically in a task scheduler, such as cron on Linux.
crontab entry is available at
an installed site directory.
Creating 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.
To create a new super user account, run:
$ rb-site manage /path/to/site createsuperuser
This will prompt for the username and password of the account. You must specify a user that doesn’t already exist in the database. Once this is finished, you should be able to log in under the new account and fix any problems you have.
Opening 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
To open a Python command shell, run:
$ rb-site manage /path/to/site shell
Resetting Review Request Counters¶
The counters in the Dashboard along the left-hand side, indicating the number of review requests, can potentially be incorrect if changes were made manually to the database or if there was an error while attempting to save information to the database.
You can fix these counters by running:
$ rb-site manage /path/to/site fixreviewcounts
This is done automatically when upgrading a site.
Invalidating API Tokens¶
New in version 5.0.
The API tokens for a set of users can be invalidated by running:
$ rb-site manage /path/to/site invalidate-api-tokens <user1> <user2>...
To invalidate the tokens of all users, run:
$ rb-site manage /path/to/site invalidate-api-tokens --all
You can also supply a reason for invalidating the tokens by passing the
--reason <reason> argument.