Bitnami Roundcube

    Roundcube description

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

    How to log in to the Roundcube application?

    The Roundcube application is a Webmail application so you need an email account to log in to it.

    If you are using installers  you can log in with a GMail account or a custom account of your IMAP server. You can customize these options during the installation. If you are using a Virtual machine or a Cloud image, Roundcube is already configured to use GMail by default, so you can log in with a GMail account.

    If you want to configure your Roundcube with a different mail provider, check the "How to configure the IMAP/SMTP Email  settings of Roundcube?" section.

    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?

    This approach describes how to configure your application to run in the root URL directly. Also, you will be able to modify the URL to a NEW_DOMAIN using the bnconfig tool. The details are described below.

    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 "/roundcube" you can remove the prefix from the URL executing the following command:

    $ sudo /opt/bitnami/apps/roundcube/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/roundcube.

    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/roundcube

    sudo /opt/bitnami/apps/roundcube/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/roundcube/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/roundcube/bnconfig" file.

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

    Native Installer

    Remember to use your actual installation directory instead of installdir.

    Moving the application to /

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

    On Linux,

    installdir/apps/roundcube/bnconfig --appurl /
    

    On Mac OS X, 

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

    On Windows,

    installdir/apps/roundcube/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/roundcube.

    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/roundcube.

    installdir/apps/roundcube/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/roundcube/bnconfig --appurl / --machine_hostname NEW_DOMAIN
    

    Tabs end

    Manual Approach

    If you want to change the default URL from http://your_domain/roundcube to http://your_domain, edit the installdir/apps/roundcube/conf/httpd-prefix.conf file so that it looks like the file below:

    DocumentRoot "/installdir/apps/roundcube/htdocs"
    # Alias /roundcube/ "/installdir/apps/roundcube/htdocs/"
    # Alias /roundcube "/installdir/apps/roundcube/htdocs"
    
    (...)
    
     
    Remember that you must substitute installdir with your actual installation directory (for native installers) or /opt/bitnami (for cloud images and virtual machines).

    Some applications also require additional changes in their configuration files or in their database.

    How to create a full backup of Roundcube?

    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:

    • Place in the folder you want to save your backup
      cd /your/folder
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Create a compressed file with the stack contents.
      $ sudo tar -pczvf 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:

    • Place in the folder you want to save your backup
      cd /your/folder
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Create a compressed file with the stack contents.
      $ sudo tar -pczvf 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:

    • Place in the folder you want to save your backup
      cd /your/folder
    • Stop all servers.
      $ sudo installdir/ctlscript.sh stop
      
    • Create a compressed file with the stack contents.
      $ sudo tar -pczvf 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:

    • Place in the folder where you have your backup
      cd /your/folder
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Rename the current directory to save it.
      $ sudo mv /opt/bitnami /opt/bitnamiBackup
    • Uncompress the backup file to the original directory.
      $ sudo tar -pxzvf application-backup.tar.gz -C /
    • Start all servers.
      $ sudo /opt/bitnami/ctlscript.sh start
      

    Virtual Machine

    Follow these steps:

    • Place in the folder where you have your backup
      cd /your/folder
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Rename the current directory to save it.
      $ sudo mv /opt/bitnami /opt/bitnamiBackup
    • Uncompress the backup file to the original directory.
      $ sudo tar -pxzvf application-backup.tar.gz -C /
    • 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:

    • Place in the folder where you have your backup
      cd /your/folder
    • Stop all servers.
      $ sudo /opt/bitnami/ctlscript.sh stop
    • Rename the current directory to save it.
      $ sudo mv installdir installdirBackup
    • Uncompress the backup file to the original directory.
      $ sudo tar -pxzvf application-backup.tar.gz -C /
      
    • 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 Roundcube?

    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.

    How to configure the IMAP/SMTP Email  settings of Roundcube?

    If you are using the Native Installers or Bitnami Cloud Hosting, you can configure the IMAP/SMTP email settings during the installation. In other case, you can configure the IMAP/SMTP settings modifying the following options in the "installdir/apps/roundcube/htdocs/config/main.inc.php" file.

    The example below shows the settings for using GMail.

    // IMAP
    $rcmail_config['default_host'] = 'ssl://imap.gmail.com';
    $rcmail_config['default_port'] = 993;
    // SMTP
    $rcmail_config['smtp_server'] = 'tls://smtp.gmail.com';
    $rcmail_config['smtp_port'] = 587;
    

    How to install and configure Postfix and Dovecot?

    Postfix is a free, open source Mail Transfer Agent which works to route and deliver email. Before installing Postfix, you will need to have a Fully Qualified Domain Name pointing to the server that you will be using.


    If you are using Ubuntu, Postfix can be easily installed through apt-get package manager tool:

    sudo apt-get install postfix

    Once postfix is installed, you will need configure the following options in the "/etc/postfix/main.cf" file.

    myhostname = example.com
    ...
    home_mailbox = Maildir/
    

    In this example we will use the "example.com" domain.

     

    Dovecot is a open source Mail Delivery Agent that works with IMAP and POP3.

    You can install dovecot IMAP in an Ubuntu system with the commands below:

    sudo apt-get install dovecot-imapd
    

    Once dovecot is installed, you will need configure the following option in the /etc/dovecot/conf.d/10-mail.conf file.

     mail_location = maildir:~/Maildir
    

     

    How to configure Roundcube with Postfix and Dovecot?

    To configure Roundcube with Postfix and Dovecot you will need  modify the following options in the "installdir/apps/roundcube/htdocs/config/main.inc.php" file

    // IMAP
    $rcmail_config['default_host'] = 'machine.example.com';
    $rcmail_config['default_port'] = 143;
    // SMTP
    $rcmail_config['smtp_server'] = 'machine.example.com';
    $rcmail_config['smtp_port'] = 25;
    

    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 Roundcube errors?

    Once Apache starts, it will create two log files, the access_log and the error_log /installdir/apache2/logs directory or in /var/log/httpd if you are using Amazon Linux or Red Hat Enterprise cloud images.

    In Virtual Machines, Cloud Images and Ubuntu based Bitnami Cloud Hosting images installdir is /opt/bitnami.

    The access_log file is used to track client requests. When a client requests a document from the server, Apache records several parameters associated with the request in this file, such as: the IP address of the client, the document requested, the HTTP status code, and the current time.

    The error_log file is used to record important events. This file includes error messages, startup messages, and any other significant events in the life cycle of the server. This is the first place to look when you run into a problem when using Apache.

    If no error is found, you will see a message similar to:

    Syntax OK
    /installdir/ctlscript.sh : httpd started
    

    The main MySQL log file is created at /installdir/mysql/data/mysqld.log file.

    Tag page (Edit tags)
    • No tags
    Pages that link here
    Page statistics
    28569 view(s), 23 edit(s) and 3878 character(s)

    Comments

    You must login to post a comment.

    Attach file

    Attachments