Freeside - User contributions [en]

Freeside:2.3:Documentation:Upgrading

2012-11-20T05:19:53Z

Jayce: /* Upgrade instructions */

= Note =

These are the 2.1.X to 2.3 upgrade instructions.

= Upgrade instructions =

* (Debian) aptitude update; aptitude install libgeo-coder-googlev3-perl libgeo-googleearth-pluggable-perl libnet-snmp-perl libole-storage-lite-perl libexcel-writer-xlsx-perl
* (Other distributions) Install Geo::Coder::Googlev3, Geo::GoogleEarth::Pluggable and Net::SNMP OLE::Storage_Lite.pm

* <code>make install-perl-modules</code>
* 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.
* <code>make install-docs</code>
* Restart Apache and the Freeside daemons.

Freeside:1.9:Documentation:InstallingUsingRPM

2012-02-29T17:53:27Z

Jayce: Undo revision 6795 by PodpoleFLCBt (Talk)

=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 [[Freeside:1.9:Documentation:CreatingRPMRepo|creating RPM repositories]]. You can also read about our own [[Freeside:1.9: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 are shown in the "Billing Main" page in Freeside.

=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.repos.d/CentOS-Base.repo</code>, adding the following lines to the <nowiki>[base] and [update] sections, and adding the [centosplus] section:</nowiki>

CentOS v4:

<pre>[base]
exclude=php* httpd* postgres* MySQL* mysql* perl perl-DBD-MySQL perl-DBD-Pg perl-DBI perl-suidperl unixODBC* mod_auth_mysql mod_auth_pgsql mod_perl mod_perl-devel mod_ssl
priority=1

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

[centosplus]
enabled=1
priority=2
</pre>

CentOS v5:

<pre>[base]
priority=1

[update]
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.9:Documentation:CreatingRPMRepo|create your own]].

==== HEAD/1.9 testing repository ====
CentOS/RHEL v5 i386: <pre>#Packages used in Freeside
[freeside]
name=Freeside-5
baseurl=http://www.freeside.biz/~rsiddall/repo/centos/5/freeside-1.9/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/~rsiddall/repo/centos/5/freeside-1.9/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===
* 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.9:Documentation:CreatingRPMRepo|create your own]].
* Import GPG keys:
rpm --import http://mirror.centos.org/centos/RPM-GPG-KEY-CentOS-4
rpm --import http://www.freeside.biz/~rsiddall/RPM-GPG-KEY-Freeside

==== HEAD/1.9 testing repository ====
(not yet available)

=== 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.9:Documentation:CreatingRPMRepo|create your own]].

====HEAD/1.9 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 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.9.0-1.noarch.rpm \
freeside-mason-1.9.0-1.noarch.rpm \
freeside-postgresql-1.9.0-1.noarch.rpm \
perl-Business-OnlinePayment-AuthorizeNet-3.17-1.i386.rpm
</pre>
Where:
* 1.9.0-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 [[#Finalizing the installation|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
<pre>
$ 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
</pre>
or with MySQL:
<pre>
$ 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>

* Edit <code>/etc/freeside/secrets</code> 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:
<pre>
$ su freeside
$ createdb -E sql_ascii freeside
</pre>
or with MySQL:
<pre>
$ mysqladmin -u freeside -p create freeside
</pre>

* As the freeside UNIX user, run <code>freeside-setup -d your.domain.name</code> to create the database tables and initial data.
<pre>
$ su freeside
$ freeside-setup -d example.com
</pre>

* Create the Freeside system users:
<pre>
$ su freeside
$ freeside-adduser -g 1 fs_queue
$ freeside-adduser -g 1 fs_daily
$ freeside-adduser -g 1 fs_selfservice
</pre>

* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<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.9: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 '''''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:
<pre>yum update</pre>
or:
<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.
===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.9.0-1.noarch.rpm freeside-mason-1.9.0-1.noarch.rpm freeside-postgresql-1.9.0-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.)

Talk:Version Control System

2010-02-02T16:52:17Z

Jayce:

+1 for git, It's easy to use, *EVERYONE* is using it. It's free to put an opensource project on github.com.

That is all

--
Goozbach

I'll agree with the Git conversion. Plenty of tools to migrate, best userbase growth in the community. Lots of good tools for building for debian and rpm systems, as well as integrating with CPAN.
--
Jayce^

Talk:Version Control System

2010-02-02T16:51:34Z

Jayce:

Freeside:1.7:Documentation:Administration:Encrypted Credit Cards

2007-04-05T01:30:47Z

Jayce: /* Setup */

== Setup ==

Q. Hey I can't use this, the credit cards are stored in plain text! What if I get hacked!?!

First off, if you are a small ISP and you follow Ivan's direction, you're pretty safe. You're keeping your DB behind the firewall and not using default passwords, etc. Right? Nothing is fool-proof however and putting layers of difficulty between your customer information and a hacker, disgruntled employee, etc. is generally a good idea. Note however that no matter how good the encryption is, you still need to secure your boxes and protect your data. A persistant hacker will be able to decrypt given enough time on your system. All good security policies apply here. If in doubt, find someone who can help you to secure your systems.

I've heard people in IRC and on the mailing list lament that Freeside doesn't encrypt the credit cards. It turns out that the functionality is there, but the guy who wrote it didn't document it outside of the perldoc. Since I'm that guy, and this seems to be the best place to do it, here goes.

The following steps are for Crypt::OpenSSL::RSA - Although there are hooks for other encryption engines, I'm using OpenSSL. I would also set up a 'dev' system to try this out on! There is nothing worse than encrypting credit cards and not having the correct key to decrypt them.

To Set Up Encrypted Credit Cards:

# Make sure that you're running a version of freeside the supports it. (_ivan - When did this go mainstream?)
# Make sure that Crypt::OpenSSL::RSA is compiled anbd working.
# Verify Schema Changes
## freeside-upgrade doesn't appear to modify columns based on only changing the size
## payinfo fields used to be varchar(80), need to be 512
## If you don't modify this, you'll get DB errors when you try to insert payments, or card information
# Generate the public and private keys. Here's the script - I'll add it to cvs...<pre><nowiki>
#!/usr/bin/perl
use Crypt::OpenSSL::RSA;
$length = 2048;
$rsa = Crypt::OpenSSL::RSA->generate_key($length);
print "Public:\n". $rsa->get_public_key_string();
print "Private:\n". $rsa->get_private_key_string();
</nowiki></pre>
# Open the config screen and edit your configuration.
#* Set the module to Crypt::OpenSSL::RSA
#* Set encryption to on (check it)
#* Set the public and private keys
# Save and restart the web server.

The next credit card you insert will be encrypted. Old data will remain decrypted until the credit card is updated. Yes that is broken, and yes I will fix it, and no I don't know when, but it will be soon - because you're not the only one with this problem.

Good luck!

- [[User:Huntsberg|Huntsberg]]

== Limitations ==

The following items don't yet work on a "front-end" machine without the private key. Eventually we could queue a job for these to be processed by a "back-end" machine.

* "Bill now" can't run card/echeck collecitons
* No "Process payment" link on customer view

Part pkg Mixin Refactor

2007-04-03T00:11:51Z

Jayce:

=Description=
I'm looking at refactoring parts of the part_pkg architecture. The previous refactor was great, in that it made it easy to create new plan types, based on perl modules. The current problem that I see is there is only a linear inheritance. What I propose is to move to a Mixin style architecture, as many of the other parts of Freeside have done. This would allow us to create basic code for concepts such as 'Introrate' or 'Referrals' which could quickly be added to any package type, not copied and pasted into new sets.

Main Page

2007-04-03T00:05:28Z

Jayce: /* Specs in progress */

== Freeside ==
=== Versions ===

:'''Maintenance Version:''' 1.5.8
::released May 22nd, 2006
::''Likely the last release in the 1.5.* development branch. A maintainer is sought for a 1.6.* schema-stable series if there is interest. See http://www.sisd.com/pipermail/freeside-devel/2006-May/000546.html''

:'''Current Version:''' 1.7.2
::released Feb 16th, 2007

=== Turn Key Solutions ===
*[http://www.sisd.com/freeside/services.html#install Installation]
*[http://www.sisd.com/freeside/products.html Freeside Appliance]

=== Documentation ===

* 1.5.8/1.6.x documentation is included in the tarball.
* [[Freeside:1.7:Documentation|1.7 Documentation]]

=== Support ===
*[http://www.sisd.com/freeside/services.html#support Freeside Internet Services Inc.]
*[[FreeSide:Support:Consultants | Freeside Consultants]]
*[[FreeSide:Support:HelpWanted | Help Wanted]]

=== Specs in progress ===
* [[Batch_Refactor]]
* [[Broadband_Services_Spec]]
* [[Business::FraudDetect]]
* [[Event_Refactor]]
* [[Virtual_to_Real_Fields]]
* [[UI_Refactor]]
* [[Website_Refactor]]
* [[part_pkg Mixin Refactor]]

= WIKI Reference =

[http://meta.wikimedia.org/wiki/Help:Editing How to edit pages (wiki markup, etc)] 
[http://www.mediawiki.org/wiki/Help:Configuration_settings Configuration settings list] 
[http://meta.wikipedia.org/wiki/MediaWiki_User%27s_Guide User's Guide]

[[Sandbox]] ← Use this page to test out editing, [http://www.phrases.org.uk/meanings/225200.html learn the ropes], etc.
----
Article count: {{NUMBEROFARTICLES}}

Freeside:1.7:Documentation:InstallingOnCentOS4

2007-03-08T01:43:41Z

Jayce:

= Installing Freeside 1.7.x on CentOS 4.4 =

This is a (hopefully) step-by-step guide for doing a basic installation of Freeside on CentOS 4.4 using RPMs whenever possible. It would probably be easier to use CPAN directly in some cases, but that wouldn't be very fun now would it?

== Software Installation ==

Run the correct command below depending on your architecture.

<pre>
# export BASEARCH=i386
</pre>
...or...
<pre>
# export BASEARCH=x86_64
</pre>

=== Binary Packages ===
{| border="1"
|-
|*Package*||*Repo*||*Version*
|-
|httpd||base||2.0.52-28.ent.centos4
|-
|postgresql-server||update||7.4.16-1.RHEL4.1
|-
|tetex||base||2.0.2-22.EL4.7
|-
|ghostscript||base||7.07-33
|-
|perl||centosplus||4:5.8.8-4.el4s1

|}

<pre>
# yum install httpd postgresql-server tetex ghostscript.$BASEARCH
</pre>

Upgrade to perl 5.8.8 to get CGI >= 3.08.

<pre>
# yum --enablerepo=centosplus upgrade perl
</pre>

=== Perl Packages ===

Setup 3rd party repos for most of the extra perl modules.

<pre>
# rpm -ivh http://dag.wieers.com/packages/rpmforge-release/rpmforge-release-0.3.6-1.el4.rf.$BASEARCH.rpm
# rpm --import http://dag.wieers.com/packages/RPM-GPG-KEY.dag.txt

# cat <<END>/etc/yum.repos.d/dries.repo
[dries]
name=Extra Fedora rpms dries - \$releasever - \$basearch
baseurl=http://ftp.belnet.be/packages/dries.ulyssis.org/redhat/el\$releasever/en/\$basearch/dries/RPMS
END
# rpm --import http://dries.ulyssis.org/rpm/RPM-GPG-KEY.dries.txt
</pre>

Install the cpan2rpm tool so we can build RPMs from CPAN packages.

<pre>
# rpm --import http://perl.arix.com/cpan2rpm/gpg.pub.asc
# yum install rpm-build perl-Module-Build
# rpm -ivh http://superb-east.dl.sourceforge.net/sourceforge/cpan2rpm/cpan2rpm-2.027-1.noarch.rpm
</pre>

==== mod_perl2 ====

Grab mod_perl 2.03 from the centosplus repo.

<pre>
# yum --enablerepo=centosplus install mod_perl
</pre>

==== Freeside Prereqs ====
{| border="1"
|-
|*Perl Module*||*Package*||*Version*||*Repo*
|-
|libnet||libnet||1.1.2.1-2.rf||extras
|-
|libwww-perl||perl-libwww-perl.noarch||5.79-5||base
|-
|URI||perl-URI.noarch||1.30-4||base
|-
|HTML::Tagset||perl-HTML-Tagset.noarch||3.03-30||base
|-
|HTML::Parser||perl-HTML-Parser||3.35-6||base
|-
|DBI||perl-DBI||1.40-8||base
|-
|DBD::MySQL||perl-DBD-MySQL||2.9004-3.1||base
|-
|MailTools||perl-MailTools.noarch||1.74-1.c4||extras
|-
|TimeDate||perl-TimeDate.noarch||1.16-1.c4||extras
|-
|Date::Manip||perl-DateManip.noarch||5.42a-3||base
|-
|HTML::Mason||perl-HTML-Mason||1.3200-1.el4.rf||rpmforge
|-
|Text::Template||perl-Text-Template||1.44-1.2.el4.rf||dries
|-
|DateTime||perl-DateTime||0.2901-1.2.el4.rf||rpmforge
|-
|Chart||perl-Chart||2.4.1-1.el4.rf||dries
|-
|Cache::Cache||perl-Cache-Cache||1.05-1.el4.rf||dries
|-
|NetAddr::IP||perl-NetAddr-IP||4.004-1.el4.rf||rpmforge
|-
|String::Approx||perl-String-Approx||3.26-1.el4.rf||dries
|-
|Locale::SubCountry||perl-Locale-SubCountry||1.38-1.el4.rf||dries
|-
|Term::ReadKey||perl-Term-ReadKey||2.30-2.2.el4.rf||dries
|-
|DateTime::Format::Strptime||perl-DateTime-Format-Strptime||1.0700-1.2.el4.rf||dries
|-
|Net::Whois::Raw||perl-Net-Whois-Raw||1.20-1.el4.rf||dries
|-
|DBIx::DBSchema||perl-DBIx-DBSchema||0.31-1.el4.rf||dries
|-
|Tie::IxHash||perl-Tie-IxHash||1.21-1.2.el4.rf||dries
|-
|Crypt::PasswdMD5||perl-Crypt-PasswdMD5||1.3-1.2.el4.rf||dries
|-
|File::CounterFile||perl-File-CounterFile||1.04-1.2.el4.rf||dries
|-
|IPC::Run3||perl-IPC-Run3||0.036-1.el4.rf||dries
|-
|Net::SSH||perl-Net-SSH||0.08-1.2.el4.rf||dries
|-
|String::ShellQuote||perl-String-ShellQuote||1.03-2.2.el4.rf||dries
|-
|JSON||perl-JSON||1.07-1.el4.rf||dries
|-
|Data::Table||perl-Data-Table||1.50-1.el4.rf||dries
|-
|Lingua::EN::NameParse||perl-Lingua-EN-NameParse||1.22-2.2.el4.rf||dries
|-
|Lingua::EN::Inflect||perl-Lingua-EN-Inflect||1.89-1.2.el4.rf||dries
|-
|Apache::DBI||perl-Apache-DBI||0.9901-2.2.el4.rf||dries
|-
|IO::Scalar||perl-IO-stringy||2.110-1.2.el4.rf||dries
|-
|Text::CSV_XS||perl-Text-CSV_XS||0.23-1.2.el4.rf||dries
|-
|Spreadsheet::WriteExcel||perl-Spreadsheet-WriteExcel||2.17-1.el4.rf||dries
|-
|MIME-tools||perl-MIME-tools||5.420-1.el4.rf||dries
|-
|Date::Manip||perl-DateManip||5.42a-3||base
|-
|Crypt::DES||perl-Crypt-DES||2.05-3.2.el4.rf||dries
|-
|Crypt::Blowfish||perl-Crypt-Blowfish||2.10-1.2.el4.rf||dries
|-
|Digest::MD4||perl-Digest-MD4||1.5-1.2.el4.rf||dries
|-
|Crypt::Rijndael||perl-Crypt-Rijndael||0.05-1.2.el4.rf||dries
|-
|ExtUtils::CBuilder||perl-ExtUtils-CBuilder||0.18-1.el4.rf||dries
|-
|DBD::Pg||perl-DBD-Pg||1.49-1.el4s1||centosplus
|-
|Locale-Codes|| | ||cpan2rpm
|-
|Frontier::RPC2|| | ||cpan2rpm
|-
|Business::CreditCard|| | ||cpan2rpm
|-
|Time::Duration|| | ||cpan2rpm
|-
|HTML::Widgets::SelectLayers|| | ||cpan2rpm
|-
|Color::Scheme|| | ||cpan2rpm
|-
|Params::Classify||||cpan2rpm
|-
|Scalar::Number||||cpan2rpm
|-
|Data::Integer||||cpan2rpm
|-
|Data::Float||||cpan2rpm
|-
|Module::Runtime||||cpan2rpm
|-
|Authen::DecHpwd||||cpan2rpm
|-
|Authen::Passphrase||||cpan2rpm
|-
|Data::Entropy::Algorithms||||cpan2rpm
|-
|Crypt::MySQL||||cpan2rpm
|-
|Crypt::Eksblowfish||||cpan2rpm
|-
|Crypt::UnixCrypt_XS||||cpan2rpm
|-
|Fax::Hylafax::Client||||cpan2rpm
|}

<pre>
# yum install libnet perl-libwww-perl perl-URI perl-HTML-Tagset
# yum install perl-HTML-Parser
# yum install perl-MailTools perl-TimeDate

# yum install perl-HTML-Mason perl-Text-Template perl-DateTime perl-Chart
# yum install perl-Cache-Cache perl-NetAddr-IP perl-String-Approx
# yum install perl-Locale-SubCountry perl-Term-ReadKey
# yum install perl-DateTime-Format-Strptime perl-Net-Whois-Raw
# yum install perl-Tie-IxHash perl-Crypt-PasswdMD5
# yum install perl-File-CounterFile perl-IPC-Run3 perl-Net-SSH
# yum install perl-String-ShellQuote perl-JSON perl-Data-Table
# yum install perl-Lingua-EN-NameParse perl-Lingua-EN-Inflect
# yum install perl-IO-stringy perl-Text-CSV_XS perl-Spreadsheet-WriteExcel
# yum install perl-MIME-tools perl-DateManip
# yum install perl-DBI perl-DBD-MySQL perl-Apache-DBI
# yum install --enablerepo=centosplus perl-DBD-Pg
# yum install perl-Crypt-DES perl-Crypt-Blowfish perl-Digest-MD4
# yum install perl-Crypt-Rijndael perl-ExtUtils-CBuilder
</pre>

You can install these using cpan, or follow the directions here using cpan2rpm.

* DBIx::DBSchema

<pre>
# yum install perl-DBIx-DBSchema
</pre>

* Frontier::RPC2

<pre>
# yum install perl-XML-Parser
# cpan2rpm --author='Ken MacLeod <ken@bitsko.slc.ut.us>' --version='0.07b4' Frontier-RPC
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Frontier-RPC-0.07b4-1.noarch.rpm
</pre>

* Business::CreditCard

<pre>
# cpan2rpm Business::CreditCard
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Business-CreditCard-0.30-1.noarch.rpm
</pre>

* Time::Duration

<pre>
# yum install perl-Test-Pod perl-Test-Pod-Coverage
# cpan2rpm Time::Duration
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Time-Duration-1.04-1.noarch.rpm
</pre>

* HTML::Widgets::SelectLayers

<pre>
# cpan2rpm http://search.cpan.org/CPAN/authors/id/I/IV/IVAN/HTML-Widgets-SelectLayers-0.07.tar.gz
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-HTML-Widgets-SelectLayers-0.07-1.noarch.rpm
</pre>

* Color::Scheme

Ran into much brokenness when trying to build Test-Simple-0.67. Just skip the dep checks and test phase and hope. I mean, come on, it's Color::Scheme for crying out loud!

<pre>
# yum install perl-Test-Differences
# cpan2rpm --make-no-test --no-depchk Color::Scheme
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Color-Scheme-1.02-1.noarch.rpm
</pre>

* Params::Classify

Install some deps first...

** Scalar::Number

*** Data::Integer
<pre>
# cpan2rpm Data::Integer
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Data-Integer-0.001-1.noarch.rpm
</pre>

*** Data::Float
<pre>
# cpan2rpm Data::Float
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Data-Float-0.005-1.noarch.rpm
</pre>

<pre>
# cpan2rpm Scalar::Number
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Scalar-Number-0.001-1.noarch.rpm

# cpan2rpm Params::Classify
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Params-Classify-0.002-1.noarch.rpm
</pre>

* Module::Runtime
<pre>
# cpan2rpm Module::Runtime
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Module-Runtime-0.003-1.noarch.rpm
</pre>

* Authen::DecHpwd
<pre>
# cpan2rpm Authen::DecHpwd
# rpm -ivh /usr/src/redhat/RPMS/${BASEARCH}/perl-Authen-DecHpwd-2.001-1.${BASEARCH}.rpm
</pre>

* Authen::Passphrase
<pre>
# cpan2rpm Authen::Passphrase
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Authen-Passphrase-0.005-1.noarch.rpm
</pre>

* Data::Entropy::Algorithms
<pre>
# cpan2rpm --make-no-test Data::Entropy
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Data-Entropy-0.003-1.noarch.rpm
</pre>

* Crypt::MySQL
<pre>
# cpan2rpm --version='0.04' --author='IKEBE Tomohiro <ikebe@shebang.jp>' Crypt::MySQL
# rpm -ivh /usr/src/redhat/RPMS/${BASEARCH}/perl-Crypt-MySQL-0.04-1.${BASEARCH}.rpm
</pre>

* Crypt::Eksblowfish
<pre>
# cpan2rpm Crypt::Eksblowfish
# rpm -ivh /usr/src/redhat/RPMS/${BASEARCH}/perl-Crypt-Eksblowfish-0.001-1.${BASEARCH}.rpm
</pre>

* Crypt::UnixCrypt_XS
<pre>
# cpan2rpm Crypt::UnixCrypt_XS
# rpm -ivh /usr/src/redhat/RPMS/${BASEARCH}/perl-Crypt-UnixCrypt_XS-0.05-1.${BASEARCH}.rpm
</pre>

* Fax::Hylafax::Client (Optional)

Skip the tests here as well, unless you happen to have a properly configured HylaFAX server handy.
Or, skip the package entirely if you don't plan on sending FAX invoices.

<pre>
# cpan2rpm --make-no-test Fax::Hylafax::Client
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Fax-Hylafax-Client-1.02-1.noarch.rpm
</pre>

==== RT Prereqs ====

{| border="1"
|-
|*Perl Module*||*Package*||*Version*||*Repo*
|-
|Apache::Session||perl-Apache-Session||1.81-1.el4.rf||dries
|-
|HTML-Format||perl-HTML-Format||2.04-1.2.el4.rf||dries
|-
|Class::ReturnValue||perl-Class-ReturnValue||0.53-1.2.el4.rf||dries
|-
|DBIx::SearchBuilder||perl-DBIx-SearchBuilder||1.43-1.el4.rf||rpmforge
|-
|Log::Dispatch||perl-Log-Dispatch||2.11-1.2.el4.rf||rpmforge
|-
|Locale::Maketext::Lexicon||perl-Locale-Maketext-Lexicon||0.62-1.el4.rf||dries
|-
|Locale::Maketext::Fuzzy||perl-Locale-Maketext-Fuzzy||0.02-1.2.el4.rf||dries
|-
|Text::Wrapper||perl-Text-Wrapper||1.000-1.2.el4.rf||dries
|-
|Time-modules||perl-Time-modules||2003.1126-1.2.el4.rf||dries
|-
|Text::Autoformat||perl-Text-Autoformat||1.13-1.2.el4.rf||dries
|-
|Text::Quoted||perl-Text-Quoted||1.8-1.2.el4.rf||dries
|-
|Regexp::Common||perl-Regexp-Common||2.120-1.2.el4.rf||dries
|-
|HTML::Scrubber||perl-HTML-Scrubber||0.08-1.2.el4.rf||dries
|-
|Tree::Simple||perl-Tree-Simple||1.17-1.el4.rf||dries
|-
|HTML::TreeBuilder||perl-HTML-Tree||3.23-1.el4.rf||dries

|}

<pre>
# yum install perl-Apache-Session perl-HTML-Format perl-Class-ReturnValue
# yum install perl-Locale-Maketext-Lexicon perl-Locale-Maketext-Fuzzy
# yum install perl-Text-Wrapper perl-Time-modules
# yum install perl-Text-Autoformat perl-Text-Quoted perl-Regexp-Common
# yum install perl-HTML-Scrubber perl-Tree-Simple perl-HTML-Tree
</pre>

* Log::Dispatch

Use the SRPM from Fedora Core 5. They have the correct and properly patched version that supports mod_perl 2.

But first, a couple of prereqs.

<pre>
# yum install perl-File-Find-Rule perl-IO-String
# yum install perl-MIME-Lite perl-Mail-Sender perl-Mail-Sendmail
</pre>

Now build and install Log::Dispatch itself. (There seems to be another rpm too, but it need Apache::Log)

<pre>
# wget -O /usr/src/redhat/SRPMS/perl-Log-Dispatch-2.15-2.fc5.src.rpm http://download.fedora.redhat.com/pub/fedora/linux/extras/5/SRPMS/perl-Log-Dispatch-2.15-2.fc5.src.rpm

# rpmbuild --rebuild /usr/src/redhat/SRPMS/perl-Log-Dispatch-2.15-2.src.rpm
# rpm -ivh /usr/src/redhat/RPMS/noarch/perl-Log-Dispatch-2.15-2.noarch.rpm
</pre>

* DBIx::SearchBuilder

DBIx::searchBuilder is a little painful to install because it requires DBD::Oracle. You can just run "yum install perl-DBIx-SearchBuilder" if you want to go through the trouble of building and installing DBD::Oracle first. Again, that can be rather painful and isn't within the scope of this guide.

The alternative below is to force install the RPM for DBIx::SearchBuilder since we're not going to use Oracle anyway. You have to exclude it from future updates in yum otherwise you'll get dep failures everytime you do a "yum upgrade".

If you're not going to use RT, just skip DBIx::SearchBuilder altogether.

<pre>
# yum install perl-Want perl-Clone perl-Cache-Simple-TimedExpiry
# yum install perl-DBD-SQLite perl-capitalization perl-Class-Accessor

# rpm -ivh --nodeps http://apt.sw.be/redhat/el4/en/${BASEARCH}/dag/RPMS/perl-DBIx-SearchBuilder-1.43-1.el4.rf.noarch.rpm

# echo "exclude=perl-DBIx-SearchBuilder" >> /etc/yum.conf
</pre>

== System configuration ==

This is just following the directions with CentOS-specific commands.

<pre>
# groupadd freeside
# useradd -g freeside freeside
</pre>

With CentOS 4.4, postgresql wouldn't start if SELinux was enabled. We call "setenforce 0" here to temporarily disable it. Some claim that it only needs to be disabled the first time postgresql is started.

Enable postgresql at startup, disable selinux temporarily, and start postgresql.

<pre>
# chkconfig postgresql on
# setenfore 0
# service postgresql start
</pre>

Create the freeside datbase user for postgresql.

<pre>
# su -c "createuser -P freeside" - postgres
</pre>

== Installing Freeside ==

su to the freeside user, extract a copy of the freeside tarball or check out the code from CVS into the freeside user's home directory. You should have the freeside top-level Makefile in /home/freeside/freeside/Makefile or /home/freeside/freeside-1.7.0/Makefile at this point. 1.7.0 wasn't officially released at the time of writing, so we're using a version checked-out from CVS.

Edit freeside's top-level Makefile with your configuration. Here are some examples...

<pre>
FREESIDE_CONF = /etc/freeside
FREESIDE_LOG = /var/log/freeside
FREESIDE_LOCK = /var/lib/freeside
FREESIDE_CACHE = /var/lib/freeside
FREESIDE_EXPORT = /var/lib/freeside

APACHE_VERSION = 2
FREESIDE_DOCUMENT_ROOT = /var/www/freeside/html

INIT_FILE = /etc/init.d/freeside
INIT_INSTALL = /sbin/chkconfig freeside on

HTTPD_RESTART = /etc/init.d/httpd restart
APACHE_CONF = /etc/httpd-freeside/conf.d
</pre>

As the freeside user, create the database and make the perl modules.

<pre>
$ createdb -E sql_ascii freeside

$ make perl-modules
</pre>

As root, install the perl modules and create the initial config.

<pre>
# make install-perl-modules

# mkdir -m 770 /var/lib/freeside
# chown -R freeside:root /var/lib/freeside/
# make create-config
</pre>

== Apache Configuration ==

=== Creating Freeside's Apache Instance ===

The default Apache init script for CentOS doesn't make it very easy to setup multiple instances of Apache. A few small modifications take care of that problem.

Start by making a copy of the init script, as well as download the patch and apply it to your httpd-freeside init script. You can make a symlink if you'd like to eventually setup additional Apache instances.

<pre>
# ln -s /etc/init.d/httpd /etc/init.d/httpd-freeside

# cd /etc/init.d/
# wget -O /tmp/httpd-freeside.patch http://users.fire2wire.com/~khoff/freeside/1.7.0/httpd-freeside.patch
# patch < /tmp/httpd-freeside.patch
</pre>

Make a copy of the Apache server root.

<pre>
# cp -av /etc/httpd /etc/httpd-freeside
</pre>

You can remove any extra conf files from /etc/httpd-freeside/conf.d (webdav, php, etc.) if you're not using them. They'll only take up more memory and potentially make freeside slower.

=== /etc/httpd-freeside/conf/httpd.conf ===

Change the following Apache configuration directives in /etc/httpd-freeside/conf/httpd.conf to match our previous changes.

* ServerRoot "/etc/httpd-freeside"
* PidFile run/httpd-freeside.pid

We're changing the listening port in case you're using the default Apache configuration (and port) for something else. This can be remedied by binding to a specific IP address as well (eg. 192.168.0.2:80).

* Listen 8080

Freeside's instance of Apache needs to run as the freeside user and group.

* User freeside
* Group freeside

* DocumentRoot "/var/www/freeside/html"

* <Directory "/var/www/freeside/html">

* ErrorLog logs/freeside_error_log
* CustomLog logs/freeside_access_log combined

=== Install Docs and Freeside's Apache Includes ===

Inside the freeside source directory, run "make install-docs" and "make install-apache" as root.

<pre>
# make install-docs
# make install-apache
</pre>

Edit the config file that was just created (/etc/httpd-freeside/conf.d/freeside-base2.conf) by "make install-apache" and change the AuthUserFile directive to match our new path.

* AuthUserFile /etc/freeside/htpasswd

== Populating the Database ==

Populate the freeside database with the initial data, as the freeside user.

<pre>
$ freeside-setup -d example.com
</pre>

Create the freeside system users, as the freeside user.

<pre>
$ freeside-adduser -g 1 fs_queue
$ freeside-adduser -g 1 fs_daily
$ freeside-adduser -g 1 fs_selfservice
</pre>

Create whatever other freeside users you want, again, as the freeside user.

<pre>
freeside-adduser -g 1 username
htpasswd /etc/freeside/htpasswd username
</pre>

Repeat the last two commands as many times as you want for your internal staff's freeside accounts.

== Startup Configuration ==

We just need to make sure that our new instance of Apache and the freeside queue daemon start when we boot.

<pre>
# make install-init

# chkconfig freeside on
# chkconfig httpd-freeside on
</pre>

And last but not least...start freeside's Apache instance.

<pre>
# service httpd-freeside start
</pre>

Hopefully, Apache should start without errors. If you do get errors, check /var/log/httpd/freeside_error_log.

Assuming Apache started correctly, you should now be able to access freeside via http://<Your server's FQDN or IP>:8080/. You can login using the username and password you set earlier with htpasswd.

From here, consult the standard freeside install documentation in the wiki on how to proceed with initial configuration. Good luck!

== Problems ==

There might be some formatting issues as this was converted from TWiki to MediaWiki markup. If the syntax of a command doesn't look correct or doesn't make sense, it probably didn't get escaped correctly, or your web browser gobbled up some angle brackets, or both!

Freeside:Support:Consultants

2007-02-09T04:56:27Z

Jayce: Adding myself...

Ivan Kohler offers commercial installation, customization, support and training services through Freeside Internet Services. See [http://www.sisd.com/freeside/commercial.html Freeside Commercial services].

The following consultants or companies also offering commercial services have asked to be listed. If you would like to list yourself or your company, simply edit the Wiki and add yourself. An example template is at the bottom of the list.

Inclusion on this list in no way implies an affiliation or endorsement of any kind.

== Freeside Internet Services, Inc. ==
URL: http://www.sisd.com/freeside/commercial.html 
Name: Ivan Kohler 
Location: Truckee, CA, USA 
Contact: +1 415 462 1624 / ivan@sisd.com 
Payment methods accepted: Check, Paypal, Wire transfer 
Additional information: Original author. 
 

== Gerard J. Cerchio ==
URL: http://www.OB1Net.Net 
URL: http://www.circlesoft.com 
415 387 0367 
San Francisco CA 
User and Maintainer of our Freeside system for over 2 Years 
Payment: $200.00/hr check 

== Shiv Kumar ==
URL: http://www.outbackwifi.com 
Contact:shivkumarAToutbackwifi.com +91-11-26141600,+91-9312878533 
Location: New Delhi, India 
Consultant for Freeside+RT for over 2 years
Specializing in remote installation, configuration & commissioning on Linux & Solaris 
Payment: Electronic Transfer, Paypal 
Rates: Can be discussed 

== Daxal Communications ==
Scott Edwards 
URL: [http://www.surfthe.us/?from=sisd.com http://www.surfthe.us] 
Location: Salt Lake City, UT USA 
Contact: http://www.surfthe.us/contactus/ 
Handle: Supaplex on IRC.
Payment methods accepted: Wire, Credit Card, Cash, Money Order, Check. Rate varies on work. 
Additional information:
Wrote the patchs for IPv6 DNS, mason includes (from legacy CGI code), B:OP:PayflowPro tweaks.

== Direct Leap Technologies, Inc. ==
URL: [http://www.directleap.com/?from=sisd.com http://www.directleap.com/] 
Location: Toronto, Canada 
Contact: 1 (416) 405-8073 
We provide integration with large-scale and highly-available telephony systems and service provider infrastructure.

== Example Company (template) ==
Jason Hall 
URL: http://halls.lug-nut.com/jayce/ 
Location: Eagle Mountain, UT 
Contact: / jayce (at) lug-nut dot com / jabber - gtalk at email address 
Payment methods accepted: Check, Wire, Cash 
Handle: Jayce^

...add yourself here...

== Example Company (template) ==
John Doe 
URL: http://www.example.com/your/company/url/if/any 
Location: in Townsville, Country 
Contact: phone / email / IM details / whatever you want 
Payment methods accepted: Paypal 
Additional information: Wrote the patch for blah blah blah.