• 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.0
    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. Site Maintenance
    15. Enabling Search
  • Home
  • General Index
  • Release Notes
  • This documentation covers Review Board 1.0. You can select a version above or view the latest documentation.

    Enabling SearchΒΆ

    To enable search, first make sure you’ve installed PyLucene as per the installation guide.

    You can enable search indexing by going into hte General Settings page and toggling Enable search. The Search index file field should be filled out to specify the desired directory where the search index will be stored. Usually this will be a directory under your site directory.

    Now you will need to set up a scheduled command to run periodically to update the search index. On Linux or other Unix-based systems with cron, you can install the provided crontab file. This is available at conf/search-cron.conf under your site directory. For example, to install the crontab for the current user, type:

    $ crontab /path/to/site/conf/search-cron.conf

    Make sure the user with the crontab has permissions to write to the search index file you specified above, as well as the search index’s parent directory.

    The default crontab will perform an index update every 10 minutes, and do a full index every week on Sunday at 2AM.

    You will want to perform one full index before you can use this. To do this, type the following as the user who owns the cronjob:

    $ rb-site manage /path/to/site index -- --full

    For more information on generating search indexes, see the section on Search Indexing.

    Users should now be able to use the search box located on any page. See the documentation on Searching to see what types of things you can search for.

    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]