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 Stacks 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 .

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

    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
    

     

    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.

    mv installdir/apps/roundcube/bnconfig installdir/apps/roundcube/bnconfig.disabled
    

    Tabs end

    Manual Approach

    If you want to change the default URL from http://your_domain/roundcube to http://your_domain, you should add a "DocumentRoot" entry in your application conf file. Edit the installdir/apps/roundcube/conf/httpd-prefix.conf file to add this line and commenting the "Alias" entries. Modify the

    httpd_prefix.conf file content (substitute installdir with your actual installation directory, which is /opt/bitnami in Cloud Images and Virtual Machines):

    DocumentRoot "/installdir/apps/roundcube/htdocs"
    # Alias /roundcube/ "/installdir/apps/roundcube/htdocs/"
    # Alias /roundcube "/installdir/apps/roundcube/htdocs"
    
    (...)
    

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

    How to create a full backup of Roundcube?

    Because BitNami stacks are self-contained, the simplest option for performing your backups 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 continously.

    linux_platform.pngOn Virtual Machines and Cloud Images:

    sudo /opt/bitnami/ctlscript.sh stop

    mac_platform.png

    On OS X:

    $ cd installdir
    $ ./ctlscript.sh stop
    $ cp -r installdir application-backup
    

    Or you can create a tarball:

    $ tar -czvf application-backup.tar.gz installdir
    

    Or a zip file:

    $ zip -r application-backup.zip installdir/*

    To restore this backup you only need to uncompress the backup in the same location. It is important to use the same path that was used when the stack was originally installed.

    For example if you have a backup in a Red Hat machine, you can copy it to an Ubuntu Linux machine (a different distro!) in the same location. Then start the servers and that’s all.

    On Virtual Machines and Cloud Images:

    $ sudo /opt/bitnami/ctlscript.sh start

    On OS X:

    $ cd installdir
    $ ./ctlscript.sh start
    

    You just need to be carefull to keep the same permissions for the files and folders. If you installed as root make sure that in the new machine you copy the files also as root. And this case, if you are also moving MySQL or PostgreSQL, you will need to create those users in the new machine (if they don't exist yet).

    win_platform.png On Windows you should follow the same process. Stop the servers using the shortcuts and copy the whole installation directory. To restore the system, copy the directory to a different Windows machine in the same location and follow these steps from a command prompt:

    $ cd installdir
    $ serviceinstall.bat INSTALL
    

    You can access your BitNami Application at the usual URL.

    If you want to create only a database backup, check the following link for MySQL /Components/MySQL#How_to_create_a_database_backup or for PostgreSQL /Components/PostgreSQL#How_to_create_a_database_backup.3f

    How to upgrade Roundcube?

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

    There are two different ways to upgrade your application.

    1. If you want to upgrade the application and all Stack components PHP, Ruby, MySQL, Apache… You can follow the steps described at How to upgrade the full Stack migrating the data?
    2. In case you only want to upgrade the application code without modifying any other Stack components,  you should follow the guide which is in the application page itself.

    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
    17123 view(s), 22 edit(s) and 3877 character(s)

    Comments

    You must login to post a comment.

    Attach file

    Attachments