Bitnami Review Board

    Review Board is a powerful web-based code review tool that offers developers an easy way to handle code reviews. It scales well from small projects to large companies and offers a variety of tools to take much of the stress and time out of the code review process.

    Please, take a look to the Quick Start Guide to know the basic use of this Stack.

    How to start/stop the servers?

    Graphical tool

    The native installers include a graphical tool to manage the servers easily. You can find the "manager-windows.exe", "manager-osx" or "manager-linux" tool in your installation directory. Using this tool, you can Start, Stop or Restart the servers and check the log files. You can click on the icon to start it.

    manager-servers.png

     

    manager-osx.png

     

     

     

     

     

     

     

     

     


    win_platform.png

    On Windows: You can also start the Manager tool from shortcuts: Start -> Program Files -> Bitnami Stack -> Manager tool

    Command line tool

    If you prefer, you can use the "ctlscript.sh" utility from the command line. This script is in the installation directory.

    linux_platform.png

    On Virtual Machines and Cloud images:

    $ sudo /opt/bitnami/ctlscript.sh start

    A native installer on Linux:

    $ cd ~/application-version
    $ ./ctlscript.sh start
    

    mac_platform.png

     

    On OS X: You can start the Manager tool from the installation directory or you can use the "ctlscript.sh" utility from a Terminal.

    host:~ user$ cd /Applications/application-version
    host:~ user$ ./ctlscript.sh start

    How to change the default URL?

    Automatic Approach

    This approach is based on the Bitnami Configuration Tool (bnconfig).

    Bitnami Cloud Hosting

    The best way to change your URL in BCH is to go to your application tab and modify it there. In the Bitnami Cloud Hosting console, select Servers, choose your server, Manage and go to the Applications tab. Press there the pencil next to the application which URL you want to modify and choose .

    Refer to this guide for more information.

    Cloud Images and Virtual Machines

    Moving the application to /

     If your application is running in "/reviewboard" you can remove the prefix from the URL executing the following command:

    $ sudo /opt/bitnami/apps/reviewboard/bnconfig --appurl /
    

    (use --help to check if that option is available for your application)

    Now you will be able to access to the application at http://YOUR_DOMAIN instead of http://YOUR_DOMAIN/reviewboard.

    Updating the IP or hostname

    Some applications require to update the IP/domain if the machine IP/domain changes. The bnconfig tool also has an option which updates the IP automatically during boot, called machine_hostname (use --help to check if that option is available for your application). Note that this tool changes the URL to http://NEW_DOMAIN/reviewboard

    sudo /opt/bitnami/apps/reviewboard/bnconfig --machine_hostname NEW_DOMAIN
    

    If you already moved your application to the root URL you should include both options at the same time.

    sudo /opt/bitnami/apps/reviewboard/bnconfig --appurl / --machine_hostname NEW_DOMAIN
    

    If you have configured your machine to use an static domain name or IP, you should rename or remove the "/opt/bitnami/apps/reviewboard/bnconfig" file.

    sudo mv /opt/bitnami/apps/reviewboard/bnconfig /opt/bitnami/apps/reviewboard/bnconfig.disabled
    

    Native Installer

    Remember to use your actual installation directory instead of installdir.

    Moving the application to /

    If your application is running in "/reviewboard" you can remove the prefix from the URL executing the following command:

    On Linux,

    installdir/apps/reviewboard/bnconfig --appurl /
    

    On Mac OS X, 

    installdir/apps/reviewboard/bnconfig.app/Contents/MacOS/installbuilder.sh --appurl /
    

    On Windows,

    installdir/apps/reviewboard/bnconfig.exe --appurl /
    

    (use --help to check if that option is available for your application)

    Now you will be able to access to the application at http://YOUR_DOMAIN instead of http://YOUR_DOMAIN/reviewboard.

    Updating the IP or hostname

    Some applications require to update the IP/domain if the machine IP/domain changes. The bnconfig tool also has an option which updates the IP , called machine_hostname (use --help to check if that option is available for your application). Note that this tool changes the URL to http://NEW_DOMAIN/reviewboard.

    installdir/apps/reviewboard/bnconfig --machine_hostname NEW_DOMAIN
    

    If you already moved your application to the root URL you should include both options at the same time.

    installdir/apps/reviewboard/bnconfig --appurl / --machine_hostname NEW_DOMAIN
    

    Tabs end

    Manual Approach

    If you want to change the default URL from "http://your_domain/reviewboard" to "http://your_domain you need to follow the steps below.

    1. Change the Media URL parameter at "Settings" -> "General" to /media/

    2. Stop the servers

    3. Edit installdir/apps/reviewboard/rb-sites/reviewboard/conf/reviewboard.conf to point to / instead of /reviewboard

      WSGIScriptAlias / "/home/bitrock/reviewboard-1.6.3-0/apps/reviewboard/rb-sites/reviewboard/htdocs/reviewboard.wsgi" 
      
      Alias /media "/home/bitrock/reviewboard-1.6.3-0/apps/reviewboard/rb-sites/reviewboard/htdocs/media"
      Alias /errordocs "/home/bitrock/reviewboard-1.6.3-0/apps/reviewboard/rb-sites/reviewboard/htdocs/errordocs"
      Alias /favicon.ico "/home/bitrock/reviewboard-1.6.3-0/apps/reviewboard/rb-sites/reviewboard/htdocs/media/rbcommons/images/favicon.png"
      
    4. Take a look at the settings_local.py file in installdir/apps/reviewboard/rb-sites/reviewboard/conf  and modify the line below removing reviewboard/ :

      SITE_ROOT = '/'
      
    5. Start the servers

    Now your Review Board instance should be available in http://your_domain

    How to create a full backup of Bitnami Review Board Stack?

    Backup

    Bitnami stacks are self-contained and the simplest option for performing a backup is to copy or compress the Bitnami stack installation directory. To do so in a safe manner, you will need to stop all servers, so this method may not be appropriate if you have people accessing the application continuously.

    Cloud Server

    Follow these steps:

    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Create a compressed file with the stack contents.
      $ tar -czvf application-backup.tar.gz /opt/bitnami
    • Restart all servers.
      $ sudo /opt/bitnami/ctlscript.sh start

    You should now download or transfer the application-backup.tar.gz file to a safe location.

    Virtual Machine

    Follow these steps:

    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Create a compressed file with the stack contents.
      $ tar -czvf application-backup.tar.gz /opt/bitnami
    • Restart all servers.
      $ sudo /opt/bitnami/ctlscript.sh start
      

    You should now download or transfer the application-backup.tar.gz file to a safe location.

    Native Installer (Windows)

    Follow these steps:

    • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.
    • Create a compressed file with the stack contents. You can use a graphical tool like 7-Zip or WinZip.
    • Stop all servers using the shortcuts in the Start Menu or the graphical manager tool.

    You should now download or transfer the application-backup.zip file to a safe location.

    Native Installer (Linux and Mac OS X)

    Follow these steps:

    • Stop all servers.
      $ sudo installdir/ctlscript.sh stop
      
    • Create a compressed file with the stack contents.
      $ tar -czvf application-backup.tar.gz installdir
      
    • Restart all servers.
      $ sudo installdir/ctlscript.sh start
      

    You should now download or transfer the application-backup.tar.gz file to a safe location.

    Tabs end

    Restore

    Bitnami stacks are self-contained, so to restore a stack, you only need to uncompress the backup file in the same location. It is important to use the same path that was used when the stack was originally installed.

    Cloud Server

    Follow these steps:

    • Uncompress the backup file to the original directory.
      $ tar -xzvf application-backup.tar.gz /opt/bitnami
    • Start all servers.
      $ sudo /opt/bitnami/ctlscript.sh start
      

    Virtual Machine

    Follow these steps:

    • Uncompress the backup file to the original directory.
      $ tar -xzvf application-backup.tar.gz /opt/bitnami
    • Start all servers.
      $ sudo /opt/bitnami/ctlscript.sh start
      

    Native Installer (Windows)

    Follow these steps:

    • Uncompress the backup file to the original directory.
    • Install services by launching a new command prompt and executing the following commands. Administrator privileges are required.
      $ cd installdir
      $ serviceinstall.bat INSTALL
      

    You can now start or stop servers using the graphical manager tool.

    Native Installer (Linux and Mac OS X)

    Follow these steps:

    • Uncompress the backup file to the original directory.
      $ tar -xzvf application-backup.tar.gz installdir
      
    • Start all servers.
      $ sudo installdir/ctlscript.sh start
      

    Tabs end

    IMPORTANT: When restoring, remember to maintain the original permissions for the files and folders. For example, if you originally installed the stack as 'root', make sure that the restored files are owned by 'root'.


    If you want to create only a database backup, refer to these instructions for MySQL and PostgreSQL.

    How to upgrade Bitnami Review Board Stack?

    It is strongly recommended to create a backup before starting the update process. If you have important data, create and try to restore a backup to ensure that everything works properly.

    There are two different ways to upgrade your application.

    • You can upgrade the application and all stack components, such as PHP, Ruby, MySQL and Apache.
    • You can upgrade the application only without modifying any other stack components.
      • Use the links provided in the application page on the wiki.

    First of all stop your servers and copy the installdir/apps/reviewboard directory in case something fails and you need to restore it. (In fact, you can copy all installdir, that would be better in case during the upgrade the database get inconsistent).

    Now if you are on linux or in mac you should execute the use_reviewboard script. If you are on Windows go to the Windows Start menu and click on the "Use Bitnami Review Board" shortcut.

    In the console execute:

    $ python/bin/easy_install --prefix=installdir/apps/reviewboard --install-dir=installdir/apps/reviewboard/lib/ -U ReviewBoard
    $ rb-site upgrade installdir/apps/reviewboard/rb-sites/reviewboard/
    

    How to configure a repository on Bitnami Review Board Stack?

    In order for Review Board to talk to a source code repository, it must first know how to access it.

    To add a new repository, click the Add link next to the Repositories entry in the database section or the Administrator Dashboard.

    Due to the multiple possible combinations we recommend to read de official documentation at http://www.reviewboard.org/docs/manual/1.6/admin/configuration/repositories

    How to configure the email settings of Bitnami Review Board Stack?

    You can configure the email settings at "Settings" -> "E-Mail" or browsing to "http://hostname:port/reviewboard/admin/settings/email/"

    Set the values for your SMTP settings. For instance, using GMail:

    Finally, you must configure the Server parameter witht  your real domain at "Settings" -> "General".

    How to enable SSL?

    You can see how to configure Apache to enable SSL connections at How to enable SSL to access through https?

    How to debug errors?

    The ReviewBoard log file is located at "/opt/bitnami/apps/reviewboard/rb-sites/reviewboard/logs/". You can also check the Apache error log file to get more info about issues "/opt/bitnami/apache2/logs/error_log".

    Tag page (Edit tags)
    • No tags
    Page statistics
    252657 view(s), 7 edit(s) and 39578 character(s)

    Comments

    You must login to post a comment.

    Attach file

    Attachments