BitNami Zurmo

    Zurmo is an Open Source Customer Relationship Management alternative that is mobile, social, and gamified. A test-driven methodology has been utilized for building every part of the application.

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

    How to start/stop the servers?

    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

     

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

    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
    

    linux_platform.png On Linux:

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

    How to change the default URL?

    This approach describes how to configure your application to run in the root URL directly. The details are described below.

    Native Installer

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

    httpd_prefix.conf file content:

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

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

    Virtual Machine

    If you want to change the default URL from http://your_domain/zurmo to http://your_domain, you should add a "DocumentRoot" entry in your application conf file. Edit the /opt/bitnami/apps/zurmo/conf/httpd-prefix.conf file (zurmo.conf in previous versions) to add this line and commenting the "Alias" entries. You can use the "nano" editor:

    $ sudo nano /opt/bitnami/apps/zurmo/conf/httpd-prefix.conf
    

    httpd-prefix.conf file content:

    DocumentRoot "/opt/bitnami/apps/zurmo/htdocs"
    # Alias /zurmo/ "/opt/bitnami/apps/zurmo/htdocs/"
    # Alias /zurmo "/opt/bitnami/apps/zurmo/htdocs"
    
    (...)
    

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

    Cloud Image/BitNami Hosting

    If you want to change the default URL from http://your_domain/zurmo to http://your_domain, you should add a "DocumentRoot" entry in your application conf file. Edit the /opt/bitnami/apps/zurmo/conf/httpd-prefix.conf file (zurmo.conf in previous versions) to add this line and commenting the "Alias" entries. You can use the "nano" command line editor or you can also edit this file from your favorite FTP program.

    $ sudo nano /opt/bitnami/apps/zurmo/conf/httpd-prefix.conf
    

    httpd-prefix.conf file content:

    DocumentRoot "/opt/bitnami/apps/zurmo/htdocs"
    # Alias /zurmo/ "/opt/bitnami/apps/zurmo/htdocs/"
    # Alias /zurmo "/opt/bitnami/apps/zurmo/htdocs"
    
    (...)
    

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

    Tabs end

     

    In the Zurmo case, it is also necessary to edit the "/opt/bitnami/apps/zurmo/htdocs/app/protected/config/perInstance.php" file to remove "/zurmo" from the 'scriptURL' option:

    $instanceConfig['components']['request']['scriptUrl']         = '/app/index.php/';

    How to create a full backup of Zurmo?

    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.png On Linux and OS X:mac_platform.png

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

    $ 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:

    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 Zurmo?

    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 only upgrade Zurmo application?

    Assuming you are on an AMI or a Virtual Machine, you can follow these steps to upgrade the application without migrating the data to another machine. Please, backup everything before starting this process.

    Zurmo upgrades must be done progressly. Go to http://zurmo.org/upgrades and download the proper files you may need for the upgrade. For instance, if you are upgrading from 1.5.14 to 2.2.3, you will need ZurmoUpgrade_1.5.14-2.0.22.zip and ZurmoUpgrade_2.0.22-2.2.3.zip. You have to follow this process for each file you may need one at a time (FILE must be substituted with the URL of the necessary file).

    • Login into your instance. Run the following commands:
    cd /opt/bitnami
    sudo ./use_zurmo
    cd apps/zurmo/htdocs/app/protected/runtime
    mkdir ./upgrade
    cd ./upgrade
    wget FILE
    cd /opt/bitnami/apps/zurmo/htdocs/app/protected/commands
    ./zurmoc upgradeZurmo user runPart1
    ./zurmoc upgradeZurmo user runPart2
    rm -rf /opt/bitnami/apps/zurmo/htdocs/app/protected/runtime/upgrade
    chown -R bitnami:daemon /opt/bitnami/apps/zurmo/htdocs
    • Repeat those commads for any other FILE is needed.
    • Finally, restart Apache server:
    sudo /opt/bitnami/ctlscript.sh restart apache
    • Your Zurmo application has been upgraded!

    How to configure the email settings of Zurmo?

    You can configure yoru SMTP settins in the application settings: navigate to Settings -> Email configuration -> Email SMTP configuration: (or http://<your_hostname>:<your_port>/zurmo/app/index.php/emailMessages/default/configurationEditOutbound)

    zurmosmtp.png

     

     

     

     

     

     

     

     

     

     

     

    For example, you can use a GMail account with the configuration below:

    • Host: smtp.gmail.com
    • Port: 587
    • Username: <user_at_gmail>@gmail.com
    • Password: <password>
    • Extra Mail Settigs: tls (lower case)

    Note that each account has its own email configuration. You may need to also change the "From" address at "My Profile" -> "Configuration" -> "Email" to match the one in the smtp settings to avoid the emails to be marked as spam. You could also configure smtp for each account in this section if needed.

    Setup Job Manager

    You will also need to setup the Job Manager in the system cron to send emails ( http://zurmo.org/wiki/how-to-set-up-job-manager ). You will need to at least include the tasks "Monitor" and "ProcessOutboundEmail". 

    If you are using BitNami Cloud Hosting you can add the following lines to /etc/crontab: 

    */5 * * * * daemon cd /opt/bitnami/apps/zurmo/htdocs/app/protected/commands; /opt/bitnami/php/bin/php ./zurmoc jobManager user Monitor
    
    */1 * * * * daemon cd /opt/bitnami/apps/zurmo/htdocs/app/protected/commands; /opt/bitnami/php/bin/php ./zurmoc jobManager user ProcessOutboundEmail
     
    More info about how to edit files with admin privileges: http://wiki.bitnami.com/BitNami_Cloud_Hosting/Servers/Access_your_machine#Editing_files  

     

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

    How to increase the allowed size of the uploaded files?

    You can modify the following option in the php.ini file to increase the allowed size for uploads:

    ; Maximum size of POST data that PHP will accept.
    post_max_size = 16M
    
    ...
    
    ; Maximum allowed size for uploaded files.
    upload_max_filesize = 16M
    

    Tag page (Edit tags)
    • No tags
    Page statistics
    10215 view(s), 11 edit(s) and 6697 character(s)

    Comments

    You must login to post a comment.

    Attach file

    Attachments

    FileSizeDateAttached by 
     zurmosmtp.png
    Zurmo SMTP configuration
    71.08 kB13:15, 15 Apr 2013VictorActions