• 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 Board 1.5
    2. Version 7.x
    3. Version 6.x
    4. Version 5.0
    5. Version 4.0
    6. Version 3.0
    7. Version 2.5
    8. Version 2.0
    9. Version 1.7
    10. Version 1.6
    11. Version 1.5
    12. Version 1.0
    13. Administration Guide
    14. Administration UI
    15. Settings
    16. Authentication Settings
  • Home
  • Users Guide
  • Getting Started
  • Introduction
  • What is Code Review?
  • General Workflow
  • Navigating Review Board
  • Dashboard
  • Searching
  • Managing Review Requests
  • Creating Review Requests
  • Updating Review Requests
  • Closing Review Requests
  • Reviewing Review Requests
  • Reviewing Diffs
  • Reviewing Screenshots
  • Editing and Publishing Reviews
  • Replying to Comments
  • Tools
  • post-review
  • Administration Guide
  • Installation
  • Installing on Linux
  • Installing on Windows
  • Upgrading Review Board
  • Installing Development Releases
  • Site Maintenance
  • The rb-site Tool
  • Creating Sites
  • Upgrading Sites
  • Enabling Search
  • Management Commands
  • Administration UI
  • Overview of the Administration UI
  • Administrator Dashboard
  • Database Management
  • Settings
  • General Settings
  • Authentication Settings
  • E-Mail Settings
  • Diff Viewer Settings
  • Logging Settings
  • File Storage Settings
  • Management
  • Managing Default Reviewers
  • Managing Permission Groups
  • Managing Repositories
  • Managing Review Groups
  • Managing Users
  • Web API Guide
  • Overview
  • Authenticating
  • Resource Tree
  • Resources
  • Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • File Diff Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Repository Info Resource
  • Repository List Resource
  • Repository Resource
  • Repository Info Resource
  • Repository Resource
  • Repository Info Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review Draft Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Draft Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Draft Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Review Request List Resource
  • Review Request Resource
  • Diff List Resource
  • Diff Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Review Request Resource
  • Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Root List Resource
  • Repository List Resource
  • Repository Resource
  • Repository Info Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Request List Resource
  • Review Request Resource
  • Diff List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • Screenshot Comment List Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • Glossary
  • Overview
  • Authenticating
  • Web API Reference
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • Data Types
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • API Calls
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • REST API 2.0
  • Overview
  • Authenticating
  • Resources
  • Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • Diff Resource
  • File Diff List Resource
  • File Diff Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Draft Screenshot Resource
  • File Diff Comment List Resource
  • File Diff List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • File Diff Resource
  • File Diff Comment List Resource
  • Repository Info Resource
  • Repository List Resource
  • Repository Resource
  • Repository Info Resource
  • Repository Resource
  • Repository Info Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Diff Comment Resource
  • Review Draft Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group Resource
  • Review Group User List Resource
  • Review Group User List Resource
  • Review List Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Reply List Resource
  • Review Screenshot Comment List Resource
  • Review Draft Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Diff Comment Resource
  • Review Reply Draft Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Draft Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Screenshot Comment Resource
  • Review Reply Resource
  • Review Reply Diff Comment List Resource
  • Review Reply Diff Comment Resource
  • Review Reply Screenshot Comment List Resource
  • Review Reply Screenshot Comment Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Draft Screenshot Resource
  • Review Request Last Update Resource
  • Review Request List Resource
  • Review Request Resource
  • Diff List Resource
  • Review List Resource
  • Review Request Draft Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Review Request Resource
  • Diff List Resource
  • Diff Resource
  • Review List Resource
  • Review Resource
  • Review Draft Resource
  • Review Request Draft Resource
  • Draft Screenshot List Resource
  • Review Request Last Update Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Review Screenshot Comment Resource
  • Review Resource
  • Review Diff Comment List Resource
  • Review Diff Comment Resource
  • Review Reply List Resource
  • Review Reply Resource
  • Review Reply Draft Resource
  • Review Screenshot Comment List Resource
  • Review Screenshot Comment Resource
  • Root List Resource
  • Repository List Resource
  • Repository Resource
  • Review Group List Resource
  • Review Group Resource
  • Review Request List Resource
  • Review Request Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Screenshot Comment List Resource
  • Screenshot List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Screenshot Resource
  • Screenshot Comment List Resource
  • Server Info Resource
  • Session Resource
  • User List Resource
  • User Resource
  • Watched List Resource
  • User Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Request List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Watched Review Request Resource
  • Watched List Resource
  • Watched Review Group List Resource
  • Watched Review Group Resource
  • Watched Review Request List Resource
  • Watched Review Request Resource
  • Errors
  • 100 - Does Not Exist
  • 101 - Permission Denied
  • 103 - Not Logged In
  • 104 - Login Failed
  • 105 - Invalid Form Data
  • 203 - Invalid Change Number
  • 204 - Change Number In Use
  • 205 - Missing Repository
  • 206 - Invalid Repository
  • 207 - Repository File Not Found
  • 208 - Invalid User
  • 209 - Repository Action Not Supported
  • 210 - Repository Information Error
  • 212 - Empty Changeset
  • 213 - Server Configuration Error
  • 214 - Bad Host Key
  • 215 - Unverified Host Key
  • 216 - Unverified Host Certificate
  • 217 - Missing User Key
  • 218 - Repository Authentication Error
  • Glossary
  • REST API 1.0 (deprecated)
  • Overview
  • Authenticating
  • Web API Reference
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • Data Types
  • Comment
  • DiffSet
  • FileDiff
  • Repository
  • Review
  • Review Request
  • Review Request Draft
  • Screenshot
  • Screenshot Comment
  • User
  • API Calls
  • Log In
  • Log Out
  • Get Server Information
  • Get Repositories
  • Get Repository Information
  • Get Users
  • Get Review Groups
  • Get Users In Review Group
  • Star Review Group
  • Unstar Review Group
  • Get Review Requests
  • Count Review Requests
  • Get Review Requests to Review Group
  • Count Review Requests to Review Group
  • Get Review Requests to User
  • Count Review Requests to User
  • Get Review Requests to User Directly
  • Count Review Requests to User Directly
  • Get Review Requests From User
  • Count Review Requests From User
  • New Review Request
  • Get Review Request
  • Get Review Request by Change Number
  • Get Review Request's Last Update
  • Star Review Request
  • Unstar Review Request
  • Close Review Request
  • Reopen Review Request
  • Delete Review Request
  • Publish Review Request
  • Is Review Request Discussed Since Last Visit
  • Update Review Request Draft From Change Number
  • Get Review Request Draft
  • Publish Review Request Draft
  • Discard Review Request Draft
  • Set Review Request Draft Field
  • Set Multiple Review Request Draft Fields
  • Get Diffsets
  • Upload Diff
  • Get Comments on Diff Line
  • Get Comments on Interdiff Line
  • Create Screenshot
  • Get Comments on Screenshot Region
  • Get Reviews
  • Count Reviews
  • Get Review
  • Get Comments on Review
  • Count Comments on Review
  • Get Review Draft
  • Set and Save Review Draft
  • Set and Publish Review Draft
  • Delete Review Draft
  • Get Comments on Review Draft
  • Get Replies
  • Count Replies
  • Set Reply Draft Fields
  • Publish Reply Draft
  • Discard Reply Draft
  • Frequently Asked Questions
  • General Index
  • Release Notes
  • This documentation covers Review Board 1.5. You can select a version above or view the latest documentation.

    Authentication Settings¶

    • General Settings
    • Basic Authentication Settings
    • LDAP Authentication Settings
    • NIS Authentication Settings
    • Custom Authentication Settings

    General Settings¶

    In this section you’ll chose the type of authentication you’ll be allowing on the site (LDAP, Active Directory, etc.) and whether or not anonymous users can access the site.

    The following settings can be configured:

    • Allow anonymous read-only access:

      Determines whether or not anonymous users should be able to view posted review requests and diffs.

      This is often safe to enable when the code being posted is public or when there’s strict access controls to the site itself. If the code is confidential and it’s possible for people without authority to access the server, this should be disabled.

    • Authentication Method:

      The method used for authenticating users on this Review Board server.

      Review Board has multiple ways of authenticating users. By default, “Standard registration” is used, but other methods can be selected. See Authentication for more information.

      Depending on the authentication method selected, additional settings may be available.

      Available options are:

      • Standard registration
      • Active Directory
      • LDAP
      • NIS
      • X.509 Public Key
      • Custom

    Basic Authentication Settings¶

    This is available if Authentication Method is set to Standard registration.

    • Enable registration:

      You can use this to control whether or not new users can register accounts on the server.

      It may be useful to turn off registration if you’re carefully controlling who’s allowed to post on your server, or if you’re being flooded with spam users.

    • Show a captcha for registration:

      Public Review Board servers may encounter spam accounts from time to time. You can help prevent these by turning on captchas for registration.

      Review Board uses reCAPTCHA for its captcha system. reCAPTCHA is a widely used and maintained captcha system. In order to use it, you will need to register an account and fill in the following two fields with the public and private keys that the site provides.

    • reCAPTCHA Public Key:

      The public key provided by the reCAPTCHA site registration for your site.

    • reCAPTCHA Private Key:

      The private key provided by the reCAPTCHA site registration for your site.

    LDAP Authentication Settings¶

    This is available if Authentication Method is set to LDAP.

    • LDAP Server:

      The LDAP server to authenticate with. For example: ldap://localhost:389

      This setting is required.

    • LDAP Base DN:

      The LDAP Base DN for performing LDAP searches. For example: ou=users,dc=example,dc=com

      This setting is required.

    • E-Mail Domain:

      The domain name appended to the user’s login name to form the e-mail address. For example: example.com

      This setting is required.

    • Use TLS for authentication:

      If checked, then TLS will be used for all authentication requests. This option is more secure, but must be enabled on the LDAP server.

    • User Mask:

      The string representing the user. The string must contain the text %s where the username would normally go. For example: (uid=%s)

      This setting is required.

    • Anonymous User Mask:

      The user mask string for anonymous users. This should be in the same format as User Mask.

      This setting is optional. If not provided, anonymous logins will be disabled.

    • Anonymous User Password:

      The password for the anonymous user.

      This setting is optional.

    NIS Authentication Settings¶

    This is available if Authentication Method is set to NIS.

    • E-Mail Domain:

      The domain name appended to the user’s login name to form the e-mail address. For example: example.com

      This setting is required.

    Custom Authentication Settings¶

    This is available if Authentication Method is set to Custom.

    • Backends:

      A comma-separated list of custom Django authentication backend classes. These are represented as Python module paths.

      This is an advanced setting and should only be used if you know what you’re doing.

      This setting is required.

    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]
    • General Settings
    • Basic Authentication Settings
    • LDAP Authentication Settings
    • NIS Authentication Settings
    • Custom Authentication Settings