Difference between revisions of "Freeside:1.7:Documentation:InstallingUsingRPM"

From Freeside
Jump to: navigation, search
m (Reverted edits by CoryOtyL (Talk); changed back to last version by Ivan)
Line 1: Line 1:
−
<h1>Installing Freeside from RPMs</h1>
+
=Introduction=
 +
 
 
==Warning!==
 
==Warning!==
 
The RPM installation of Freeside is experimental! The instructions below may be incomplete or incorrect and are subject to change. You should only attempt to use the RPM installation if you are prepared to work around omissions and inaccuracies, and can recover data in the event of a loss.
 
The RPM installation of Freeside is experimental! The instructions below may be incomplete or incorrect and are subject to change. You should only attempt to use the RPM installation if you are prepared to work around omissions and inaccuracies, and can recover data in the event of a loss.
  
−
==Introduction==
+
==Information==
−
RPM is a build-once, install-many package manager for system management. Originally for RedHat, it is now used on a wide range of Linux distros including Fedora, SUSE, etc.
+
 
−
Well-structured RPMs include dependency information that RPM can use to warn you that additional components are required. Tools such as yum and apt-get (RPM version) can use this dependency information to download additional components from a repository and include them in the installation. This has the potential to make installing Freeside almost as easy as installing a Windows program.
+
The currently available packages are for the i386 and x86_64 architectures. The packages are built on CentOS 5 and currently tested on CentOS and RHEL 5. Packages for CentOS/RHEL 4 are no longer available.
−
(Check the /install and /debian directories in the Freeside tarball for scripts and notes on installing on various distros.)
+
 
−
Installing the RPM version of Freeside may not be a good idea if you plan to do development on Freeside. The RPMs may not include all the files supplied in the tarball.
+
Packagers for other distributions are welcome; see [[Freeside:1.7:Documentation:CreatingRPMRepo|creating RPM repositories]].  You can also read about our own [[Freeside:1.7:Documentation:RPMBuildSystem|RPM build system]].
 +
 
 +
Installing the RPM version of Freeside may not be a good idea if you plan to do development on Freeside as the RPMs may not include all the files supplied in the tarball.
 +
 
 +
===Status===
 +
 
 +
The RPM version of Freeside does not include Request Tracker at this time.  The self-service RPM has not been fully tested.  Both PostgreSQL and MySQL back-end databases should work.  The version and release of the RPM were shown in the "Billing Main" page in Freeside, but we concluded this was misleading.  You can now get the version and release by entering <code>rpm -q freeside</code> at the command line.
 +
 
 +
=Installation=
 +
 
 +
RPM installation can preferably be done with a tool such as YUM or APT (or up2date on RHEL).  As a last resort, you can install with RPM directly.
 +
 
 +
==Installing using yum==
 +
=== Setup YUM ===
 +
* If you are installing to a machine behind a proxy server, you may need to set up the proxy directives in /etc/yum.conf for yum to work correctly.
 +
* Make sure the yum priorities plugin is installed by running <code>yum install yum-plugin-priorities</code> for CentOS v4, or <code>yum install yum-priorities</code> for CentOS v5.
 +
* Make sure the yum priorities plugin is enabled by editing the <code>/etc/yum/pluginconf.d/priorities.conf</code> file, and ensuring that it contains the following lines:
 +
  [main]
 +
  enabled=1
 +
* Edit <code>/etc/yum.repso.d/CentOS-Base.repo</code>, adding the following lines to the <nowiki>[base] and [update] sections, and adding the [centosplus] section:</nowiki>
 +
 
 +
<pre>[base]
 +
exclude=php* httpd* MySQL* mysql* perl perl-suidperl unixODBC* mod_auth_mysql mod_auth_pgsql mod_perl mod_perl-devel mod_ssl
 +
priority=1
 +
 
 +
[update]
 +
exclude=php* httpd* MySQL* mysql* perl perl-suidperl unixODBC* mod_auth_mysql mod_auth_pgsql mod_perl mod_perl-devel mod_ssl
 +
priority=1
 +
 
 +
[centosplus]
 +
enabled=1
 +
priority=2
 +
</pre>
 +
 
 +
* Select a repository containing the required RPMs, and add the repository to a new file in your /etc/yum.repo.d directory or directly to the /etc/yum.conf file. If no such repository exists, you can [[Freeside:1.7:Documentation:CreatingRPMRepo|create your own]].
 +
 
 +
==== 1.7 pre-release repository ====
 +
 
 +
This repository contains <b>only</b> the Freeside RPMs for release candidates.  Use the testing repository for all of the required Perl RPMs.
 +
 
 +
<pre>
 +
cd /etc/yum.repos.d
 +
wget http://www.freeside.biz/~rsiddall/freeside.repo
 +
</pre>
 +
 
 +
The repository definition file defines a testing, stable, and a pre-release repository. All of these are disabled by default, so
 +
you either need to include <code>--enablerepo=freeside-testing --enablerepo=freeside-prerelease</code> when invoking yum, or just edit the file and enable the repositories you want to use by changing the <code>enable=0</code> to <code>enable=1</code> in the corresponding section of the file.
 +
 
 +
Since the release candidate RPMs have a higher version number than the CVS snapshot builds, yum will install the release candidates instead of the CVS snapshot.  You can verify this after yum completes by entering <code>rpm -q freeside</code> and checking that it's something like <code>freeside-1.7.4rc2-1</code>.
 +
 
 +
==== 1.7 stable repository ====
 +
 
 +
Follow the instructions for the 1.7 pre-release repository, but enable the stable repository instead of the pre-release.
 +
 
 +
==== 1_7_BRANCH repository ====
 +
 
 +
CentOS/RHEL v5 i386: <pre>#Packages used in Freeside
 +
[freeside]
 +
name=Freeside-5
 +
baseurl=http://www.freeside.biz/~ivan/repo/centos/5/freeside-1.7/testing/i386
 +
gpgcheck=1
 +
enabled=1
 +
priority=2
 +
gpgkey=http://www.freeside.biz/~rsiddall/RPM-GPG-KEY-Freeside</pre>
 +
 
 +
CentOS/RHEL v5 x86_64: <pre>#Packages used in Freeside
 +
[freeside]
 +
name=Freeside-5
 +
baseurl=http://www.freeside.biz/~ivan/repo/centos/5/freeside-1.7/testing/x86_64
 +
gpgcheck=1
 +
enabled=1
 +
priority=2
 +
gpgkey=http://www.freeside.biz/~rsiddall/RPM-GPG-KEY-Freeside</pre>
 +
 
 +
=== Install ===
 +
 
 +
* Install the required components by issuing the commands:
 +
<pre>yum install httpd mod_perl mod_ssl perl postgresql-server
 +
yum install perl-File-Temp perl-CGI.pm
 +
yum install freeside freeside-mason freeside-postgresql perl-Business-OnlinePayment-AuthorizeNet</pre>
 +
with these changes:
 +
* Replace posgresql with mysql if you wish to use MySQL instead of PostgreSQL for the main Freeside database.
 +
* Replace AuthorizeNet with the name of the Business::OnlinePaymet module for the credit card gateway you wish to use.
 +
* Add the RPM name of any additional Business::OnlinePayment gateways you wish to install.
 +
 
 +
At this point all the required components should be installed and the freeside user account created. You can now [[#Finalizing the installation|complete the installation]].
 +
 
 +
=== Troubleshooting ===
 +
 
 +
* If you are using a repository that is normally disabled, use <code>yum --enablerepo=Freeside-4 install ...</code> where ''Freeside-4'' is the name of the repository.
 +
* If you get an error such as:
 +
<pre>
 +
Transaction Check Error:  file /usr/share/man/man3/File::Temp.3pm.gz from install of perl-File-Temp-0.18-1 conflicts with file from package perl-5.8.8-4.el4s1
 +
</pre>
 +
then you're using an operating system with a badly packaged Perl.  You will have to force the installation of the RPM which conflicts with the Perl, using something like:
 +
<pre>
 +
rpm -Uvh --force /var/cache/yum/freeside/packages/perl-File-Temp-0.18-1.x86_64.rpm
 +
</pre>
 +
This installs the conflicting RPM from yum's cache for the "freeside" repository.
 +
You can then retry installing from yum.
 +
 
 +
==Installing using up2date==
 +
 
 +
Mainly for vanilla RHEL 4; if you are running RHEL 5 or CentOS, the [[#Installing_using_yum|yum]] or [[#Installing_using_APT|apt-get]] instructions may be preferable.
 +
 
 +
===Setup up2date===
 +
* Import GPG keys:
 +
  rpm --import http://mirror.centos.org/centos/RPM-GPG-KEY-CentOS-5
 +
  rpm --import http://www.freeside.biz/~rsiddall/RPM-GPG-KEY-Freeside
 +
 
 +
* Select a repository containing the required RPMs and add the repository to your /etc/sysconfig/rhn/sources file. If no such repository exists, you can [[Freeside:1.7:Documentation:CreatingRPMRepo|create your own]].
 +
 
 +
==== 1_7_BRANCH repository ====
 +
RHEL v5 i386: <pre>yum centosplus http://mirror.centos.org/centos/4/centosplus/i386/
 +
yum freeside http://www.freeside.biz/~ivan/repo/centos/4/freeside-1.7/testing/i386</pre>
 +
 
 +
RHEL v5 x86_64: <pre>yum centosplus http://mirror.centos.org/centos/4/centosplus/x86_64/
 +
yum freeside http://www.freeside.biz/~ivan/repo/centos/4/freeside-1.7/testing/x86_64</pre>
 +
 
 +
=== Install ===
 +
 
 +
* Install the required components by issuing the commands:
 +
<pre>up2date httpd mod_perl mod_ssl perl postgresql-server tetex-latex perl-Digest-SHA1 perl-XML-Parser
 +
up2date perl-File-Temp #this will fail, that's okay for now
 +
rpm -Uvh --force /var/spool/up2date/perl-File-Temp-0.18-1.x86_64.rpm #to force File::Temp 0.18 installation, for now
 +
up2date freeside freeside-mason freeside-postgresql perl-Business-OnlinePayment-AuthorizeNet</pre>
 +
with these changes:
 +
* Replace posgresql with mysql if you wish to use MySQL instead of PostgreSQL for the main Freeside database.
 +
* Replace AuthorizeNet with the name of the Business::OnlinePaymet module for the credit card gateway you wish to use.
 +
* Add the RPM name of any additional Business::OnlinePayment gateways you wish to install.
 +
 
 +
At this point all the required components should be installed and the freeside user account created. You can now [[#Finalizing the installation|complete the installation]].
 +
 
 +
=== Troubleshooting ===
 +
 
 +
* Does up2date show a "freeside" channel when doing <code>up2date --show-channels</code>, but won't install packages from that repository?  Make sure <code>/etc/sysconfig/rhn/up2date</code> has a line designating a blank proxy:
 +
  httpProxy=
 +
 
 +
==Installing using APT==
 +
===Setup APT===
 +
Select a repository containing the required RPMs and add the repository to your /etc/apt.conf file.. If no such repository exists, you can [[Freeside:1.7:Documentation:CreatingRPMRepo|create your own]].
 +
====1.7.3 stable repository ====
 +
(not yet available)
 +
====1_7_BRANCH testing repository====
 +
(not yet available)
 +
 
 +
===Install===
 +
* Install the required components by issuing the command:
 +
<pre>apt-get install freeside freeside-mason freeside-postgresql perl-Business-OnlinePayment-AuthorizeNet</pre>
 +
with these changes:
 +
* Replace posgresql with mysql if you wish to use MySQL instead of PostgreSQL for the main Freeside database.
 +
* Replace AuthorizeNet with the name of the Business::OnlinePaymet module for the credit card gateway you wish to use.  
 +
* Add the RPM name of any additional Business::OnlinePayment gateways you wish to install.
 +
At this point all the required components should be installed and the freeside user account created. You can now [[#Finalizing the installation|complete the installation]].
 +
 
 
==Installation using RPM==
 
==Installation using RPM==
−
Installation is much easier if you have a repository that works with a tool such as [[#yum|yum]] or [[#apt|apt-get]]. If you only have rpm and wish to use that, enter:
+
Installation is much easier if you have a repository that works with a tool such as [[#Installing_using_yum|yum]],  [[#Installing_using_APT|apt-get]] or [[#Installing_using_up2date|up2date]]. If you only have rpm and wish to use that, enter:
−
<pre> rpm -Uvh --test freeside-1.5.7-1.noarch.rpm freeside-''interface''-1.5.7-1.noarch.rpm freeside-''backend''-1.5.7-1.noarch.rpm perl-Business-OnlinePayment-''processor-version''</pre>
+
 
 +
<pre>
 +
rpm -Uvh --test freeside-1.7.3-1.noarch.rpm \
 +
freeside-mason-1.7.3-1.noarch.rpm \
 +
freeside-postgresql-1.7.3-1.noarch.rpm \
 +
perl-Business-OnlinePayment-AuthorizeNet-3.17-1.i386.rpm
 +
</pre>
 
Where:
 
Where:
−
* ''interface'' is the web framework you wish to use for the Freeside interface (either '''mason''' or '''apacheasp'''). See the main installation document for which frameworks are supported.* ''backend'' is the database you wish to use as the Freeside back-end (either '''postgresql''' or '''mysql'''). See the main installation document for which databases are supported.
+
* 1.7.3-1 is the version of Freeside and the release of the RPM. Change this if necessary.
−
* 1.5.7-1 is the version of Freeside and the release of the RPM.
+
* postgresql is the database you wish to use as the Freeside back-end.  Replace freeside-postgresql with freeside-mysql if you wish to use MySQL. See the main installation document for which databases are supported.
−
* ''processor'' is the credit card processor you wish to use for real-time transactions and ''version'' is the current version of the corresponding RPM.
+
* Replace AuthorizeNet with the name of the credit card processor you wish to use for real-time transactions. Also replace 3.17-1.i386 with the current version, release, and architecture of the corresponding Business::OnlinePayment RPM.
 
The command should result in some warnings about unsatisfied dependencies.  Find the corresponding RPMs and add them to the list on the command line.  Keep doing this until the command results in no warnings, then issue the command one last time without the --test to actually install all the RPMs.
 
The command should result in some warnings about unsatisfied dependencies.  Find the corresponding RPMs and add them to the list on the command line.  Keep doing this until the command results in no warnings, then issue the command one last time without the --test to actually install all the RPMs.
−
Installing the freeside RPM will install the '''[[#freeside-install|freeside-install]]''' command line utility that you can use to finish the installation.
+
 
−
==Installing using yum==
+
At this point all the required components should be installed and the freeside user account created. You can now [[#Finalizing the installation|complete the installation]].
−
* First, find a repository containing all the required RPMs. If no such repository exists, you can [[#repository|create your own]].
+
 
−
* Next, add the repository to your /etc/yum.repo.d directory or /etc/yum.conf file.
+
=Finalizing the installation=
−
* Finally, install the required components by issuing the command:
+
 
−
<pre>yum install freeside freeside-''interface'' freeside-''backend'' perl-Business-OnlinePayment-''processor''</pre>
+
* Start the database:
−
At this point all the required components should be installed and the freeside user account created. You can now complete the installation with [[#freeside-install|freeside-install]].
+
with PostgreSQL
−
==Installing using APT==
+
 
−
* First, find a repository containing all the required RPMs. If no such repository exists, you can [[#repository|create your own]].
+
  chown -R postgres:postgres /var/lib/pgsql
−
* Next, add the repository to your /etc/apt.conf file.
+
  /sbin/service postgresql start
−
* Finally, install the required components by issuing the command:
+
 
−
<pre>apt-get install freeside freeside-''interface'' freeside-''backend'' perl-Business-OnlinePayment-''processor''</pre>
+
or with MySQL
−
At this point all the required components should be installed and the freeside user account created. You can now complete the installation with [[#freeside-install|freeside-install]].
+
 
−
==Finishing the installation with freeside-install==
+
  /sbin/service mysqld start
−
RPM does little more than installing files and creating users. To allow automated installation and upgrading, well-structured RPMs may not interact with the user. Since part of the Freeside installation is interactive, at some future date a command line utility called '''freeside-install''' will be included in the RPM to help you complete the installation.
+
 
−
For the moment, just work through the standard install, ignoring the steps which are done by the RPM, i.e. installing files and creating the freeside user. The RPM does not do any steps that require entry of a password, or which have to be done after a password is specified.
+
* Allow the freeside user full access to the freeside database.  
−
* You can skip straight to &quot;Allow the freeside user full access to the freeside database,&quot; but be aware that if there are errors in the RPM&nbsp;dependencies, then some of the prerequisites may not be installed.  
+
with PostgreSQL
−
* Then &quot;Add the freeside database to your database engine:&quot;
+
<pre>
−
* Apache configuration is reduced to editing your httpd.conf file as specified in the last bullet point. (This will be automated in a later Freeside RPM.) You'll also have to modify httpd.conf to implement web interface security.* All the final steps to create the first Freeside user, setup the database, populate the message catalog, and start freeside-queued must be done by hand.
+
$ su - postgres
−
* As with the usual install, you need to do initial administration after completing the install.
+
$ createuser -P freeside
−
==Creating your own repository==
+
Enter password for user "freeside":
−
If you can't find an APT/yum repository for your operating system, you can create your own.
+
Enter it again:  
−
* Create the Freeside RPMs:
+
Shall the new role be a superuser? (y/n) n
−
<pre>wget freeside.tar.gz
+
Shall the new role be allowed to create databases? (y/n) y
−
tar zxvf freeside.tar.gz
+
Shall the new role be allowed to create more new roles? (y/n) n
−
cd freeside/contrib/rpm
+
CREATE ROLE
−
rpmbuild -ba freeside.spec
 
 
</pre>
 
</pre>
−
* Configure CPAN:
+
or with MySQL:
−
<pre>cpan
+
<pre>
−
install Bundle::CPAN
+
$ mysqladmin -u root password 'set_a_root_database_password'
 +
$ mysql -u root -p
 +
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP on freeside.* TO freeside@localhost IDENTIFIED BY 'set_a_freeside_database_password';
 
</pre>
 
</pre>
−
* Install Ovid:
+
 
−
<pre>cpan
+
* Edit <code>/etc/freeside/secrets</code> and replace the third line (currently blank) with the password you entered in the last step.
−
install Ovid
+
 
−
quit
+
* Add the freeside database to your database engine:
−
rpm -Uvh ovid.rpm
+
with Postgres:  
 +
<pre>
 +
$ su freeside
 +
$ createdb -E sql_ascii freeside
 
</pre>
 
</pre>
−
* Use Ovid to create RPMs for all the Freeside dependencies you require:
+
or with MySQL:  
−
<pre>ovid Bundle::HTML::Mason</pre>
+
<pre>
−
or:
+
$ mysqladmin -u freeside -p create freeside  
−
<pre>ovid Bundle::Apache::ASP</pre>
 
−
* Use Ovid to create RPMs for the main Freeside dependencies:
 
−
<pre>cd freeside/contrib/rpm
 
−
cp Freeside.pm ~/.cpan/Bundle/
 
−
ovid Bundle::Freeside
 
 
</pre>
 
</pre>
−
* Use Ovid to create RPMs for the main RT dependencies (if installing RT):
+
 
−
<pre>cd freeside/contrib/rpm
+
* As the freeside UNIX user, run <code>freeside-setup -d your.domain.name</code> to create the database tables and initial data.
−
cp RT.pm ~/.cpan/Bundle/
+
<pre>
−
ovid Bundle::RT ''(for optional RT installation)''
+
$ su freeside
 +
$ freeside-setup -d example.com
 
</pre>
 
</pre>
−
* Fix up RPMs that did not build.
+
 
−
* Fix up RPMs that have inadequate dependency information: perl-HTML-Mason-*.rpm
+
* Create the Freeside system users:  
−
* Copy all generated RPMs into your web server space:
+
<pre>
−
<pre>cd /usr/src/redhat/RPMs/i386
+
$ su freeside
−
mkdir /var/www/html/fedora/7/
+
$ freeside-adduser -g 1 fs_queue
−
cp *.rpm /var/www/html/fedora/7</pre>
+
$ freeside-adduser -g 1 fs_daily
−
* Download any programs needed to build the repository.  For newer, XML-based versions of yum, you'll need createrepo. If it's in a yum repository, this can be as simple as:<pre>yum install createrepo</pre>
+
$ freeside-adduser -g 1 fs_selfservice
−
* Create the repository:
 
−
<pre>createrepo /var/www/html/fedora/7
 
 
</pre>
 
</pre>
−
* Make sure the web server is started
+
 
−
At this point your web server is acting as a yum repository with a URL of http://safepillstock.com/?a=46688 and you can proceed to [[#yum|install Freeside from the repository]].
+
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
−
On distros using older versions of yum (e.g. FC2 and earlier), you'll need to use yum-arch instead of createrepo to generate the repository metadata. yum-arch should be installed as part of the yum RPM, so there's no need to install another RPM.
+
<pre>
 +
$ su freeside
 +
$ freeside-adduser -g 1 username
 +
$ htpasswd /etc/freeside/htpasswd username
 +
Password:
 +
</pre>
 +
Additional users can be added using the same command or from the web interface.
 +
 
 +
* <code>/sbin/service freeside start</code>
 +
 
 +
* <code>/sbin/service httpd restart</code>
 +
 
 +
* Log into the web interface using the username and password you entered above.
 +
 
 +
* Now proceed to the initial [[Freeside:1.7:Documentation:Administration|administration]] of your installation.
 +
 
 +
=Upgrading=
 +
 
 +
==Introduction==
 +
If you have an existing Freeside installation that was installed from the tarball, following the instructions for installing or upgrading from RPM&nbsp;'''''may''''' result in an operational system where the RPMs have overwritten most or all of the files installed from the tarball or CPAN.
 +
 
 
==Upgrading==
 
==Upgrading==
−
===Introduction===
+
Upgrading can be done with a tool such as YUM or APT (or up2date on RHEL), preferably, or as a last resort, with RPM directly.
−
If you have an existing Freeside installation that was installed from the tarball, following the instructions for installing or upgrading from RPM&nbsp;'''''may''''' result in an operational system where the RPMs have overwritten most or all of the files installed from the tarball or CPAN.
+
 
−
===Upgrading using RPM===
 
−
When there's a new version of Freeside available as RPM, just download the new RPMs and upgrade them:<pre>  rpm -Uvh --test freeside-1.5.7-1.noarch.rpm freeside-''interface''-1.5.7-1.noarch.rpm freeside-''backend''-1.5.7-1.noarch.rpm
 
−
</pre>
 
 
===Upgrading using a repository===
 
===Upgrading using a repository===
 
If you installed the RPM version of Freeside from a repository, and a new version is available on the repository, then you can install the new files on your system using the package manager:
 
If you installed the RPM version of Freeside from a repository, and a new version is available on the repository, then you can install the new files on your system using the package manager:
Line 93: Line 269:
 
<pre>apt-get update</pre>
 
<pre>apt-get update</pre>
 
To avoid unplanned upgrades, you may wish to mark the repository containing Freeside as disabled, or remove it from your yum or apt configuration files.
 
To avoid unplanned upgrades, you may wish to mark the repository containing Freeside as disabled, or remove it from your yum or apt configuration files.
−
===Finalizing the upgrade using freeside-install===
+
===Upgrading using RPM===
−
This will not perform any database upgrades, so you should refer to the tarball upgrade documentation and do any database changes by hand. (A future version of [[#freeside-install|freeside-install]] may be able to perform the database changes needed in an upgrade.)
+
When there's a new version of Freeside available as RPM, just download the new RPMs and upgrade them:<pre>
 +
rpm -Uvh --test freeside-1.7.3-1.noarch.rpm freeside-mason-1.7.3-1.noarch.rpm freeside-postgresql-1.7.3-1.noarch.rpm
 +
</pre>
 +
 
 +
==Finalizing the upgrade==
 +
* As the freeside UNIX user, run <code>freeside-upgrade username</code>, passing the username of an internal Freeside user.
 +
* If freeside-upgrade hangs, try stopping Apache, all Freeside processes, and anything else connected to your database, especially on older PostgreSQL versions.
 +
* Restart Apache and Freeside:
 +
  /etc/init.d/httpd restart
 +
  /etc/init.d/freeside restart
 +
* You may want to check your ACLs under Configuration->Employee->View/Edit employee groups and grant some of the new rights to one or more groups.
 +
 
 +
=Known issues=
 +
 
 +
* yum will not automatically upgrade Perl modules bundled in the main Perl RPM to the newer versions on the Freeside repository due to the lack of version information in the main Perl RPM.  (It cannot determine that the newer versions are newer.)  So, you have to install them as a separate operation.  This applies to the <code>perl-File-Temp perl-CGI.pm perl-Test-Simple</code> RPMs.
 +
 
 +
* ssh -X in as root and run system-config-securitylevel (can't seem to do this from -tui.  may need to <code>yum install xauth xorg-x11-fonts-*</code>)
 +
** firewall options, open up www and secure www
 +
** selinux options: enforcing -> permissive (otherwise freeside can't even create /etc/freeside/masondata/obj etc.)

Revision as of 12:16, 9 December 2011

Introduction

Warning!

The RPM installation of Freeside is experimental! The instructions below may be incomplete or incorrect and are subject to change. You should only attempt to use the RPM installation if you are prepared to work around omissions and inaccuracies, and can recover data in the event of a loss.

Information

The currently available packages are for the i386 and x86_64 architectures. The packages are built on CentOS 5 and currently tested on CentOS and RHEL 5. Packages for CentOS/RHEL 4 are no longer available.

Packagers for other distributions are welcome; see creating RPM repositories. You can also read about our own RPM build system.

Installing the RPM version of Freeside may not be a good idea if you plan to do development on Freeside as the RPMs may not include all the files supplied in the tarball.

Status

The RPM version of Freeside does not include Request Tracker at this time. The self-service RPM has not been fully tested. Both PostgreSQL and MySQL back-end databases should work. The version and release of the RPM were shown in the "Billing Main" page in Freeside, but we concluded this was misleading. You can now get the version and release by entering rpm -q freeside at the command line.

Installation

RPM installation can preferably be done with a tool such as YUM or APT (or up2date on RHEL). As a last resort, you can install with RPM directly.

Installing using yum

Setup YUM

  • If you are installing to a machine behind a proxy server, you may need to set up the proxy directives in /etc/yum.conf for yum to work correctly.
  • Make sure the yum priorities plugin is installed by running yum install yum-plugin-priorities for CentOS v4, or yum install yum-priorities for CentOS v5.
  • Make sure the yum priorities plugin is enabled by editing the /etc/yum/pluginconf.d/priorities.conf file, and ensuring that it contains the following lines: 
 [main]
 enabled=1
  • Edit /etc/yum.repso.d/CentOS-Base.repo, adding the following lines to the [base] and [update] sections, and adding the [centosplus] section:
[base] 
exclude=php* httpd* MySQL* mysql* perl perl-suidperl unixODBC* mod_auth_mysql mod_auth_pgsql mod_perl mod_perl-devel mod_ssl
priority=1

[update]
exclude=php* httpd* MySQL* mysql* perl perl-suidperl unixODBC* mod_auth_mysql mod_auth_pgsql mod_perl mod_perl-devel mod_ssl
priority=1

[centosplus]
enabled=1
priority=2
  • Select a repository containing the required RPMs, and add the repository to a new file in your /etc/yum.repo.d directory or directly to the /etc/yum.conf file. If no such repository exists, you can create your own.

1.7 pre-release repository

This repository contains only the Freeside RPMs for release candidates. Use the testing repository for all of the required Perl RPMs. 

cd /etc/yum.repos.d
wget http://www.freeside.biz/~rsiddall/freeside.repo

The repository definition file defines a testing, stable, and a pre-release repository. All of these are disabled by default, so you either need to include --enablerepo=freeside-testing --enablerepo=freeside-prerelease when invoking yum, or just edit the file and enable the repositories you want to use by changing the enable=0 to enable=1 in the corresponding section of the file.

Since the release candidate RPMs have a higher version number than the CVS snapshot builds, yum will install the release candidates instead of the CVS snapshot. You can verify this after yum completes by entering rpm -q freeside and checking that it's something like freeside-1.7.4rc2-1.

1.7 stable repository

Follow the instructions for the 1.7 pre-release repository, but enable the stable repository instead of the pre-release.

1_7_BRANCH repository

CentOS/RHEL v5 i386: 
#Packages used in Freeside
[freeside]
name=Freeside-5
baseurl=http://www.freeside.biz/~ivan/repo/centos/5/freeside-1.7/testing/i386
gpgcheck=1
enabled=1
priority=2
gpgkey=http://www.freeside.biz/~rsiddall/RPM-GPG-KEY-Freeside
CentOS/RHEL v5 x86_64: 
#Packages used in Freeside
[freeside]
name=Freeside-5
baseurl=http://www.freeside.biz/~ivan/repo/centos/5/freeside-1.7/testing/x86_64
gpgcheck=1
enabled=1
priority=2
gpgkey=http://www.freeside.biz/~rsiddall/RPM-GPG-KEY-Freeside

Install

  • Install the required components by issuing the commands:
yum install httpd mod_perl mod_ssl perl postgresql-server
yum install perl-File-Temp perl-CGI.pm
yum install freeside freeside-mason freeside-postgresql perl-Business-OnlinePayment-AuthorizeNet

with these changes:

  • Replace posgresql with mysql if you wish to use MySQL instead of PostgreSQL for the main Freeside database.
  • Replace AuthorizeNet with the name of the Business::OnlinePaymet module for the credit card gateway you wish to use.
  • Add the RPM name of any additional Business::OnlinePayment gateways you wish to install.

At this point all the required components should be installed and the freeside user account created. You can now complete the installation.

Troubleshooting

  • If you are using a repository that is normally disabled, use yum --enablerepo=Freeside-4 install ... where Freeside-4 is the name of the repository.
  • If you get an error such as:
Transaction Check Error:   file /usr/share/man/man3/File::Temp.3pm.gz from install of perl-File-Temp-0.18-1 conflicts with file from package perl-5.8.8-4.el4s1

then you're using an operating system with a badly packaged Perl. You will have to force the installation of the RPM which conflicts with the Perl, using something like: 

rpm -Uvh --force /var/cache/yum/freeside/packages/perl-File-Temp-0.18-1.x86_64.rpm

This installs the conflicting RPM from yum's cache for the "freeside" repository. You can then retry installing from yum.

Installing using up2date

Mainly for vanilla RHEL 4; if you are running RHEL 5 or CentOS, the yum or apt-get instructions may be preferable.

Setup up2date

  • Import GPG keys:
 rpm --import http://mirror.centos.org/centos/RPM-GPG-KEY-CentOS-5
 rpm --import http://www.freeside.biz/~rsiddall/RPM-GPG-KEY-Freeside
  • Select a repository containing the required RPMs and add the repository to your /etc/sysconfig/rhn/sources file. If no such repository exists, you can create your own.

1_7_BRANCH repository

RHEL v5 i386: 
yum centosplus http://mirror.centos.org/centos/4/centosplus/i386/
yum freeside http://www.freeside.biz/~ivan/repo/centos/4/freeside-1.7/testing/i386
RHEL v5 x86_64: 
yum centosplus http://mirror.centos.org/centos/4/centosplus/x86_64/
yum freeside http://www.freeside.biz/~ivan/repo/centos/4/freeside-1.7/testing/x86_64

Install

  • Install the required components by issuing the commands:
up2date httpd mod_perl mod_ssl perl postgresql-server tetex-latex perl-Digest-SHA1 perl-XML-Parser
up2date perl-File-Temp #this will fail, that's okay for now
rpm -Uvh --force /var/spool/up2date/perl-File-Temp-0.18-1.x86_64.rpm #to force File::Temp 0.18 installation, for now
up2date freeside freeside-mason freeside-postgresql perl-Business-OnlinePayment-AuthorizeNet

with these changes:

  • Replace posgresql with mysql if you wish to use MySQL instead of PostgreSQL for the main Freeside database.
  • Replace AuthorizeNet with the name of the Business::OnlinePaymet module for the credit card gateway you wish to use.
  • Add the RPM name of any additional Business::OnlinePayment gateways you wish to install.

At this point all the required components should be installed and the freeside user account created. You can now complete the installation.

Troubleshooting

  • Does up2date show a "freeside" channel when doing up2date --show-channels, but won't install packages from that repository? Make sure /etc/sysconfig/rhn/up2date has a line designating a blank proxy:
 httpProxy=

Installing using APT

Setup APT

Select a repository containing the required RPMs and add the repository to your /etc/apt.conf file.. If no such repository exists, you can create your own.

1.7.3 stable repository

(not yet available)

1_7_BRANCH testing repository

(not yet available)

Install

  • Install the required components by issuing the command:
apt-get install freeside freeside-mason freeside-postgresql perl-Business-OnlinePayment-AuthorizeNet

with these changes:

  • Replace posgresql with mysql if you wish to use MySQL instead of PostgreSQL for the main Freeside database.
  • Replace AuthorizeNet with the name of the Business::OnlinePaymet module for the credit card gateway you wish to use.
  • Add the RPM name of any additional Business::OnlinePayment gateways you wish to install.

At this point all the required components should be installed and the freeside user account created. You can now complete the installation.

Installation using RPM

Installation is much easier if you have a repository that works with a tool such as yum, apt-get or up2date. If you only have rpm and wish to use that, enter: 

rpm -Uvh --test freeside-1.7.3-1.noarch.rpm \
freeside-mason-1.7.3-1.noarch.rpm \
freeside-postgresql-1.7.3-1.noarch.rpm \
perl-Business-OnlinePayment-AuthorizeNet-3.17-1.i386.rpm

Where:

  • 1.7.3-1 is the version of Freeside and the release of the RPM. Change this if necessary.
  • postgresql is the database you wish to use as the Freeside back-end. Replace freeside-postgresql with freeside-mysql if you wish to use MySQL. See the main installation document for which databases are supported.
  • Replace AuthorizeNet with the name of the credit card processor you wish to use for real-time transactions. Also replace 3.17-1.i386 with the current version, release, and architecture of the corresponding Business::OnlinePayment RPM.

The command should result in some warnings about unsatisfied dependencies. Find the corresponding RPMs and add them to the list on the command line. Keep doing this until the command results in no warnings, then issue the command one last time without the --test to actually install all the RPMs.

At this point all the required components should be installed and the freeside user account created. You can now complete the installation.

Finalizing the installation

  • Start the database:

with PostgreSQL 

 chown -R postgres:postgres /var/lib/pgsql
 /sbin/service postgresql start

or with MySQL 

 /sbin/service mysqld start
  • Allow the freeside user full access to the freeside database.

with PostgreSQL 

$ su - postgres
$ createuser -P freeside
Enter password for user "freeside": 
Enter it again: 
Shall the new role be a superuser? (y/n) n
Shall the new role be allowed to create databases? (y/n) y
Shall the new role be allowed to create more new roles? (y/n) n
CREATE ROLE

or with MySQL: 

$ mysqladmin -u root password 'set_a_root_database_password'
$ mysql -u root -p
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,DROP on freeside.* TO freeside@localhost IDENTIFIED BY 'set_a_freeside_database_password';
  • Edit /etc/freeside/secrets and replace the third line (currently blank) with the password you entered in the last step.
  • Add the freeside database to your database engine:

with Postgres: 

$ su freeside
$ createdb -E sql_ascii freeside

or with MySQL: 

$ mysqladmin -u freeside -p create freeside
  • As the freeside UNIX user, run freeside-setup -d your.domain.name to create the database tables and initial data.
$ su freeside
$ freeside-setup -d example.com
  • Create the Freeside system users: 
$ su freeside
$ freeside-adduser -g 1 fs_queue
$ freeside-adduser -g 1 fs_daily
$ freeside-adduser -g 1 fs_selfservice
  • Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
$ su freeside
$ freeside-adduser -g 1 username
$ htpasswd /etc/freeside/htpasswd username
Password:

Additional users can be added using the same command or from the web interface.

  • /sbin/service freeside start
  • /sbin/service httpd restart
  • Log into the web interface using the username and password you entered above.

Upgrading

Introduction

If you have an existing Freeside installation that was installed from the tarball, following the instructions for installing or upgrading from RPM may result in an operational system where the RPMs have overwritten most or all of the files installed from the tarball or CPAN.

Upgrading

Upgrading can be done with a tool such as YUM or APT (or up2date on RHEL), preferably, or as a last resort, with RPM directly.

Upgrading using a repository

If you installed the RPM version of Freeside from a repository, and a new version is available on the repository, then you can install the new files on your system using the package manager: 

yum update

or: 

apt-get update

To avoid unplanned upgrades, you may wish to mark the repository containing Freeside as disabled, or remove it from your yum or apt configuration files.

Upgrading using RPM

When there's a new version of Freeside available as RPM, just download the new RPMs and upgrade them:
rpm -Uvh --test freeside-1.7.3-1.noarch.rpm freeside-mason-1.7.3-1.noarch.rpm freeside-postgresql-1.7.3-1.noarch.rpm

Finalizing the upgrade

  • As the freeside UNIX user, run freeside-upgrade username, passing the username of an internal Freeside user.
  • If freeside-upgrade hangs, try stopping Apache, all Freeside processes, and anything else connected to your database, especially on older PostgreSQL versions.
  • Restart Apache and Freeside:
 /etc/init.d/httpd restart
 /etc/init.d/freeside restart
  • You may want to check your ACLs under Configuration->Employee->View/Edit employee groups and grant some of the new rights to one or more groups.

Known issues

  • yum will not automatically upgrade Perl modules bundled in the main Perl RPM to the newer versions on the Freeside repository due to the lack of version information in the main Perl RPM. (It cannot determine that the newer versions are newer.) So, you have to install them as a separate operation. This applies to the perl-File-Temp perl-CGI.pm perl-Test-Simple RPMs.
  • ssh -X in as root and run system-config-securitylevel (can't seem to do this from -tui. may need to yum install xauth xorg-x11-fonts-*)
    • firewall options, open up www and secure www
    • selinux options: enforcing -> permissive (otherwise freeside can't even create /etc/freeside/masondata/obj etc.)
Retrieved from "http://www.freeside.biz/mediawiki/index.php?title=Freeside:1.7:Documentation:InstallingUsingRPM&oldid=6756"