BitNami SugarCRM

    SugarCRM is a flexible customer relationship management solution for companies of all sizes. SugarCRM can easily be customized and integrated with other software to allow companies to build and maintain a more flexible system. Core functionality includes sales force automation, marketing campaigns, support cases, project management and calendaring.

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

    Automatic approach

    The  Virtual Appliances, BitNami Cloud Hosting and AMI images ship a tool called "bnconfig". Using this tool you be able to configure the URL automatically. It includes a new option to remove the "/sugarcrm" prefix from the URL. If you want to modify that you can run the following command:

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

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

    win_platform.png On Windows:

    This tool is also included for Windows. You can open the "Use BitNami SugarCRM Stack" command prompt from the Windows shortcuts and run the following comand:

    > cd apps\sugarcrm
    > bnconfig.exe --appurl /
    
    Manual approach

    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/sugarcrm to http://your_domain, you should add a "DocumentRoot" entry in your application conf file. Edit the /installdir/apps/sugarcrm/conf/httpd-prefix.conf file to add this line and commenting the "Alias" entries. Modify the

    httpd_prefix.conf file content:

    DocumentRoot "/installdir/apps/sugarcrm/htdocs"
    # Alias /sugarcrm/ "/installdir/apps/sugarcrm/htdocs/"
    # Alias /sugarcrm "/installdir/apps/sugarcrm/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/sugarcrm to http://your_domain, you should add a "DocumentRoot" entry in your application conf file. Edit the /opt/bitnami/apps/sugarcrm/conf/httpd-prefix.conf file (sugarcrm.conf in previous versions) to add this line and commenting the "Alias" entries. You can use the "nano" editor:

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

    httpd-prefix.conf file content:

    DocumentRoot "/opt/bitnami/apps/sugarcrm/htdocs"
    # Alias /sugarcrm/ "/opt/bitnami/apps/sugarcrm/htdocs/"
    # Alias /sugarcrm "/opt/bitnami/apps/sugarcrm/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/sugarcrm to http://your_domain, you should add a "DocumentRoot" entry in your application conf file. Edit the /opt/bitnami/apps/sugarcrm/conf/httpd-prefix.conf file (sugarcrm.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/sugarcrm/conf/httpd-prefix.conf
    

    httpd-prefix.conf file content:

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

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

    Tabs end

     

    You need also to modify the SugarCRM configuration file, /opt/bitnami/apps/sugarcrm/htdocs/config.php, and replace the following string (where example.com is the your domain)

    'site_url' => 'http://example.com/sugarcrm'
    

    with this new string

    'site_url' => 'http://example.com/'
    

    How to create a full backup of SugarCRM?

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

    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 email settings of SugarCRM?

    You can configure SugarCRM from the Admin panel to send emails directly. Go to the "Administration" -> "Email Settings" and configure the settings of your email provider. You can use a GMail, Yahoo! or Microsoft Exchange account easily.

    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 configure Sugar Schedulers?

    In order to run Sugar Schedulers, it is necessary to add the following line to the crontab file. You can add this line with the crontab editor in the Virtual Machine or AMI "sudo crontab -e":

    * * * * *  cd /opt/bitnami/apps/sugarcrm/htdocs; su daemon -c "/opt/bitnami/php/bin/php -f cron.php > /dev/null 2>&1"
    

    Please note that if you use the SugarCRM Pro version, then the application directory path will be different: /opt/bitnami/apps/sugarcrmpro/htdocs

    How to debug SugarCRM 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
    29152 view(s), 13 edit(s) and 4595 character(s)

    Comments

    You must login to post a comment.

    Attach file

    Attachments

    FileSizeDateAttached by 
     sugarcrm-email.png
    SugarCRM email configuration
    28.84 kB14:49, 4 Nov 2011AdminActions