From SugarCRM Wiki

1 OVERVIEW
2 PASSWORDS
3 INSTALLATION
4 GETTING TO THE APPLIANCE
5 CONFIGURATION, SYSTEM ADMINISTRATION, BACKUP AND UPDATING
6 SECURITY
7 COMMON QUESTIONS
8 TROUBLE
OVERVIEW
The Sugar Open Source appliance can be downloaded from SugarForge.org (http://www.sugarforge.org
/projects/sugarappliance/) .
This appliance installs Linux as well as versions of Sugar CRM, php, mysql, sendmail and httpd.
The appliance also installs the rPath Appliance Platform Agent for web based system administration.
The rPath Appliance Platform Agent will handle updating all Linux, php, mysql, sendmail, httpd and other
non-Sugar components automatically.
PASSWORDS
The default sugar user is 'admin' and the default password is 'changeme' if you use sugar-preconfig.
The default system root password for vmware, parallels, and xen is blank, so just login as root with no
password
The default user for the mysql database for sugarcrm is 'sugarcrm' with password 'changeme'
The default privileged user for mysql is 'root' with no password
The default user for rAPA is 'admin' with password 'password'.
INSTALLATION
for iso: In general the iso will be burned to a CD or DVD and then booted on a clean system. The installation
process is the standard Linux Anaconda installation utility. You will need to select the configuration you
want (mostly the defaults will work fine). The primary things you will select involve the location on the disk
and the networking configuration.
Sugar Open Source Appliance Install and User Guide - SugarCRM Wiki http://www.sugarcrm.com/wiki/index.php?title=Sugar_Open_Source_A...
1 de 6 20/01/2010 16:00
If you want to install from the iso onto an existing system you will need to be able to set up some sort of dual
boot environment, or be running a virtual environement. While it is possible to install the iso directly into a
virtual environment, Sugar Appliance is also provided in pre-built virtual containers for most environments..
for VMware: Simply download the zip file, run 'unzip' to unzip it and then go to vmware and tell it to open
the vmx file that is opened up.
for Parallels: Simply download the zip file, unzip it by double clicking on it, rename the resuling .img to a
.hdd file, and create a new parallels virtual machine that uses the .hdd as its disk.
for Xen: Simply download the zip file, run 'unzip' to unzip it and then go through the standard Xen process
for brining up a new guest.
GETTING TO THE APPLIANCE
Once you have the image installed and booted (in either vmware or natively), all you need to do is determine
the network address of the system and browse to it. When the system boots it should display the ip address
just above the login prompt with instructions on how to go to the main web page. If for some reason this
fails, you will probably have to log into the system as root and edit the /etc/sysconfig/network-scripts
/ifcfg-eth0 file and then run 'service network restart' to get the networking to reset.
Now open a browser on another machine (or the same machine if you are running under vmware and have a
browser either on another vm or on the host machine) and point it at the displayed ip address. What you put
in the navigation window of your browser should look something like this:
http://192.168.0.1/
This will take you to the default SugarCRM Appliance screen with links to go to the Sugar log in screen and
rAPA management console. Click on the Sugar Login link to get to your new SugarCRM installation. It
should be up and running sugar at this point and you can login with username 'admin' password 'changeme'.
To log in to rAPA just click on the Administration link and log in with the username 'admin' and password
'password'. In the future if you need to get to either Sugar or the Administration login you can come back to
this screen for the links.
CONFIGURATION, SYSTEM ADMINISTRATION, BACKUP AND UPDATING
SugarCRM as an application is updated and managed within the SugarCRM interface. Because the database
schema for SugarCRM needs to be aligned with the version of Sugar that is shipped, Sugar itself should only
be updated using the standard SugarCRM update tools found on the 'Admin' tab when you are logged into
sugar.
The rest of the system is updated and managed using rAPA. To log into rAPA use the browser to go back to
the IP address of the machine and select the Administration button.
You will first be required to set the passwords for the administrator and set up an email server address for
notification emails. This can be set to 'localhost' or the address of the Sugar Appliance, as it is running a mail
server for Sugar to use. The email address must be a valid email address; you may simply wish to use your
own external email address. Following this you will be asked for an external email address to send event
notifications to.
Now comes the networking configuration. If you are happy with the networking as it is then you can save it
as is and move on. You will then be asked to set an http proxy. This is purely optional, but it necessary if
your system will only have external network access through an http proxy. If this doesn't mean anything to
you, just leave it blank and click next.
Sugar Open Source Appliance Install and User Guide - SugarCRM Wiki http://www.sugarcrm.com/wiki/index.php?title=Sugar_Open_Source_A...
2 de 6 20/01/2010 16:00
The final section in the wizard is the backup configuration where you can specify where to backup the
critical files from the Sugar Appliance. If you simply select 'Download' then you can download a backup file
whenever you run the backup. Recovery is done by using this file on a new or existing installation and
through rAPA hitting the Restore button. This will erase all data entered since the backup was made, so be
sure about what you are doing.
System updates can be scheduled using the rAPA tab on the left side of the interface. Updates will become
available only as the SugarAppliance itself is updated, which typically happens monthly. Updates are
checked for automatically be default but they are not applied automatically by default. If this is not the
desired behavior go to the Preferences link on the top of this section and change the configuration to have it
apply updates automatically. If you set an email address for notifications then notification will be sent to you
when the appliance finds updates are available. This is the case whether they are applied or not, so by
default it check you get a notification to go and apply the updates. If a failure occurs in the check you will
also receive a notification.
Once the configuration is complete you will find other modules available in the list on the left hand side of
the rAPA interface, including scheduling reboots, managing services, and log viewing. The Sugar logs are not
currently viewable in this interface.
Additional rAPA usage information can be found here, including much more in depth instructions on
Configuration, Administration, Backup, Recovery, and Updating:
http://wiki.rpath.com/wiki/rPathApplianceAgent:User_Interface_Guide
SECURITY
It is clearly recommended that you reset all passwords from the defaults for security purposes.
For the root system password type this at the command line:
# passwd root
then make the changes prompted
For the mysql database user log in as root and type this at the command line:
# su -l mysql
# mysql -u root mysql
mysql> UPDATE user SET Password=PASSWORD('newrootpassword') WHERE User='root';
mysql> FLUSH PRIVILEGES;
For the sugar admin, simply login as admin and go the 'My Account' link on the upper right hand of the page
and follow the steps for changing the password.
For rAPA you will be prompted to change the password on the initial login. This is critical, as leaving the
defaults will allow an external web browser to gain access to the administration interface of the system.
There are other security considerations if you plan to run the appliance in a higher security environment. For
example, the permissions on the /usr/share/sugarcrm directory should probably be tightened up a bit as they
allow all access to apache right now. Also, the appliance uses sendmail by default for outgoing email and you
may want to switch to a more secure mail service or use an external mail agent and chkconfig sendmail off.
COMMON QUESTIONS
Sugar Open Source Appliance Install and User Guide - SugarCRM Wiki http://www.sugarcrm.com/wiki/index.php?title=Sugar_Open_Source_A...
3 de 6 20/01/2010 16:00
1. "How Do I Install <whatever>"
A lot of people want to install additional components, such as wget or phpMyAdmin on their appliances.
This is typically quite simple. Just log into the system as root and run a command of the following form:
conary update <packagename> --resolve
For example:
conary update phpMyAdmin --resolve
or
conary update wget --resolve
This will install the package with all of the dependencies it needs. The packages will be kept up to date
automatically by rAPA when you perform system updates.
If you want to see what packages are available in the repositories that the appliance looks at, you can run:
conary rq
or
conary rq <pkgname>
The latter is preferred as the straight repository query without an argument is very slow and produces a huge
output.
For example:
conary rq curl
If you just know the name of the file that the package will install you can search the repository with that:
conary rq --path /pathtofile
For example:
conary rq --path /usr/share/sugarcrm
2. "How do I log in to the database from another system"
This is common when trying to run another application that logs into the SugarCRM database for online
access. For security reasons the sugarcrm database user is created with access restricted to localhost. I
recommend just creating a new user and granting them access to the database from other hostnames if that is
your goal. Here is how the existing user is created, followed by an example of another user with broader
permissions. First, login as root on the system and then run the 'mysql' commend.
grant all on sugarcrm.* to 'sugarcrm'@'localhost' identified by 'changeme' with grant option;
So, you might do:
grant all on sugarcrm.* to 'externalsugaruser' identified by 'yourpassword' with grant option;
You can also add in your own hostname restriction after an @ sign if you desire.
Sugar Open Source Appliance Install and User Guide - SugarCRM Wiki http://www.sugarcrm.com/wiki/index.php?title=Sugar_Open_Source_A...
4 de 6 20/01/2010 16:00
TROUBLE
The two most common issues are:
1. "I can't get to the web page after install, but I can ssh to the system"- you may have set the firewall to
block httpd. Turn off iptables to check if this is the case. Login as root run: service iptables stop
In these latest versions this should not happen as the firewall is set up by default and cannot be
misconfigured at install.
2. "The vmware image worked for a while, but now it's acting really weird"- if you are running a vmware
image you may have run out of disk space. You can follow these steps to work around this:
1/ Snapshot your VM image
2/ Shutdown the VM cleanly.
Either use rPath Appliance Platform Agent Web UI or login as root and issue:
shutdown -h now
3/ Add the new virtual disk in Workstation's VM -> Settings menu. Choose SCSI for the virtual hardware.
The rest of this article assumes the new disk is your second SCSI one. If it's your first SCSI one, /dev/sdb
references become /dev/sda. If you choose to use IDE instead, change all the /dev/sdb references below to
/dev/hda (if it's your first IDE disk) or /dev/hdb (if it's your second).
Make it growable to whatever maximum you desire.
4/ Startup the VM.
5/ Login as root
6/ Create a partition table on the new disk using fdisk. This is an interactive tool, so you're going to need to
answer a few questions.
fdisk /dev/sdb
choose n for "new partition"
choose p for "primary"
type 1 for the partition number
accept the default start and end options (hit Enter twice)
choose w to "write the partition table"
7/ Make a filesystem on the new partition
mkfs.ext3 /dev/sdb1
8/ Mount the filesystem on a temporary location
mkdir /mnt/tmpdir
mount /dev/sdb1 /mnt/tmpdir
Sugar Open Source Appliance Install and User Guide - SugarCRM Wiki http://www.sugarcrm.com/wiki/index.php?title=Sugar_Open_Source_A...
5 de 6 20/01/2010 16:00
9/ Copy all the /usr/share/sugarcrm/ contents to the new partition (this is where the database is)
cp -rp /usr/share/sugarcrm/* /mnt/tmpdir
(you can repeat this whole exercise again to give /srv its own disk if that's what has filled up)
10/ Add a line to /etc/fstab to cause your new partition to be mounted at boot
Either use echo to append a line, or use vi to edit if you're
comfortable with vi
echo '/dev/sdb1 /usr/share/sugarcrm ext3 defaults 1 1' >> /etc/fstab
11/Remove old data but keep the mountpoint
rm -rf /usr/share/sugarcrm/*
12/ Reboot
shutdown -r now
After rebooting, you can confirm that your disk setup now has the new disk on the /usr/share/sugarcrm
directory mount point by typing on the command line:
mount
Then you can verify that you have enough space by typing on the command line:
df -h
You should see something like
Filesystem Size Used Avail Use% Mounted on
/dev/sda1 512M 256M 256M 50% /
none 126M 0 126M 0% /dev/shm
/dev/sdb1 7.9G 73M 7.5G 1% /usr/share/sugarcrm/
That's it! If that doesn't work, just revert to your snapshot and send me a note on where you're having
trouble.
Retrieved from "http://www.sugarcrm.com
/wiki/index.php?title=Sugar_Open_Source_Appliance_Install_and_User_Guide"
This page was last modified on 19 July 2007, at 17:36.
Sugar Open Source Appliance Install and User Guide - SugarCRM Wiki http://www.sugarcrm.com/wiki/index.php?title=Sugar_Open_Source_A...
6 de 6 20/01/2010 16:00