• Get Review Board
  • What's New
  • Products
  • Review Board Code review, image review, and document review
  • Documentation
  • Release Notes
  • Power Pack Enterprise integrations, reports, and enhanced document review
  • Try for 60 Days
  • Purchase
  • RBCommons Review Board as a Service, hosted by us
  • Pricing
  • RBTools Command line tools and Python API for Review Board
  • Documentation
  • Release Notes
  • Review Bot Automated code review, connecting tools you already use
  • Documentation
  • Release Notes
  • RB Gateway Manage Git and Mercurial repositories in your network
  • Documentation
  • Release Notes
  • Learn and Explore
  • What is Code Review?
  • Documentation
  • Frequently Asked Questions
  • Support Options
  • Third-Party Integrations
  • Demo
  • Review Board RBTools Power Pack Review Bot Djblets RB Gateway
    1. Review Bot 4.x
    2. Version 4.x
    3. Version 3.0
    4. Version 2.0
    5. Version 1.0
    6. Installation
    7. Manually Installing Review Bot
  • Home
  • Installation
  • Manually Installing Review Bot
  • Review Bot Docker Images
  • Upgrading Review Bot
  • Configuring Review Bot
  • Review Bot Tools
  • Cargo Tool
  • Checkstyle
  • Clang Static Analyzer
  • Cppcheck
  • Cpplint
  • Doc8
  • FBInfer
  • Flake8
  • Go Fmt
  • Go Tool
  • JSHint
  • PMD
  • Pycodestyle
  • Pydocstyle
  • Pyflakes
  • RuboCop
  • Rust Fmt
  • Secret Scanner
  • ShellCheck
  • Module and Class Reference
  • reviewbot.tools.base
  • reviewbot.tools.base.mixins
  • reviewbot.tools.base.registry
  • reviewbot.tools.base.tool
  • reviewbot.testing.testcases
  • reviewbot.testing.utils
  • reviewbot.tools.testing
  • reviewbot.tools.testing.decorators
  • reviewbot.tools.testing.testcases
  • reviewbot.processing.review
  • reviewbot.utils.api
  • reviewbot.utils.filesystem
  • reviewbot.utils.log
  • reviewbot.utils.process
  • reviewbot.utils.text
  • reviewbot.celery
  • reviewbot.config
  • reviewbot.deprecation
  • reviewbot.errors
  • reviewbot.repositories
  • reviewbot.tasks
  • reviewbot.tools.cargotool
  • reviewbot.tools.checkstyle
  • reviewbot.tools.clang
  • reviewbot.tools.cppcheck
  • reviewbot.tools.cpplint
  • reviewbot.tools.doc8
  • reviewbot.tools.fbinfer
  • reviewbot.tools.flake8
  • reviewbot.tools.gofmt
  • reviewbot.tools.gotool
  • reviewbot.tools.jshint
  • reviewbot.tools.pmd
  • reviewbot.tools.pycodestyle
  • reviewbot.tools.pydocstyle
  • reviewbot.tools.pyflakes
  • reviewbot.tools.rbsecretscanner
  • reviewbot.tools.rubocop
  • reviewbot.tools.rustfmt
  • reviewbot.tools.shellcheck
  • General Index
  • Python Module Index
  • Release Notes
  • Manually Installing Review Bot¶

    If you’re upgrading from a previous release, see the instructions on upgrading Review Bot.

    Installing the Review Board Extension¶

    To install the Review Bot extension for Review Board, run:

    $ sudo pip install reviewbot-extension
    

    (If you’re installing in a virtual environment, don’t use sudo.)

    Depending on your configuration, you may need to restart or reload your web server. The specific command depends on your individual setup, but is usually something like the following:

    $ sudo service httpd reload
    

    Now open the Review Board administration page, and click Extensions in the top bar. You should see a new extension called “Review Bot”. Click Enable to enable it.

    Once installed, the Review Bot extension requires some configuration.

    Install a Message Broker¶

    Review Bot uses a message broker to distribute worker tasks. It’s how the Review Bot extension on Review Board talks to each worker.

    The message broker can be installed on the Review Board server or on another system, depending on your needs. RabbitMQ is the recommended message broker, though any of Celery’s supported brokers should work. Refer the broker’s documentation for installation instructions.

    Install Review Bot Workers¶

    A Review Bot worker can be installed on the Review Board server or on another system, depending on your needs. You can even install multiple workers on different systems, if you need to scale out further.

    To install the main worker package on a server, run:

    $ sudo pip install reviewbot-worker
    

    (If you’re installing in a virtual environment, don’t use sudo.)

    Depending on the tools you need, you may have to install other system packages or Python packages. Refer to the list of tools for further information on setting these up.

    As a shortcut, all built-in Python code/doc checking tools can be installed by running:

    $ sudo pip install reviewbot-worker[all]
    

    Starting the Worker¶

    Once the worker is installed and your message broker is running, you can start the worker node. This is done via the following command (replacing <broker_url> with the URL to your message broker):

    $ reviewbot -b <broker_url>
    

    It’s recommended to set this up to run as a service when the server boots. See the documentation on daemonizing Celery for more details.

    Keep up with the latest Review Board releases, security updates, and helpful information.

    About
    News
    Demo
    RBCommons Hosting
    Integrations
    Happy Users
    Support Options
    Documentation
    FAQ
    User Manual
    RBTools
    Administration Guide
    Power Pack
    Release Notes
    Downloads
    Review Board
    RBTools
    Djblets
    Power Pack
    Package Store
    PGP Signatures
    Contributing
    Bug Tracker
    Submit Patches
    Development Setup
    Wiki
    Follow Us
    Mailing Lists
    Reddit
    Twitter
    Mastodon
    Facebook
    YouTube

    Copyright © 2006-2025 Beanbag, Inc. All rights reserved.

    Terms of Service — Privacy Policy — AI Ethics Policy — Branding

    On this page

    • [Top]
    • Installing the Review Board Extension
    • Install a Message Broker
    • Install Review Bot Workers
      • Starting the Worker