Freeside - User contributions [en]

Freeside:2.1:Documentation:Administration

2012-09-16T22:42:44Z

Celestius: /* Daily and Monthly Scripts */

= Exports (provisioning) =

'''Exports''' allow you to provision services to remote machines, databases and APIs. Some exports, such as ''sqlradius'' and ''sqlradius_withdomain'', enable a feed for retrieving rating/usage data.

Exports can be added and edited under
: Configuration -> Provisioning, services and packages -> View/edit exports

Most exports place jobs in the job queue for new, modified or deleted services. Jobs are run by [[Freeside:1.9:Documentation:Developer/bin/freeside-queued|freeside-queued]]. This daemon needs to be running before exports are acted upon.

Some exports use SSH, SCP or SFTP to communicate with external machines. See the documentation on [[Freeside:1.9:Documentation:Administration:SSH_Keys|SSH keys]].

Click on ''Add a new export'' to create a new export. Select exports from the dropdown to show more information on each export, including available options, setup and usage.

Exports are activated by associating them with one or more '''service definitions'''.

Following is a list of which exports can be associated with each type of service.

==svc_acct==
* [[Freeside:1.9:Documentation:Administration:acct_plesk.pm|acct_plesk.pm]]: Real-time export to Plesk managed mail service
* acct_sql.pm: Real-time export of accounts to SQL databases .
* artera_turbo.pm:
* bsdshell.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* communigate_pro_singledomain.pm:
* cpanel.pm: Real-time export to Cpanel control panel.
* cp.pm: Real-time export to Critical Path Account Provisioning Protocol
* cyrus.pm: Real-time export to Cyrus IMAP server
* everyone_net.pm: Real-time export to Everyone.net outsourced mail service
* infostreet.pm: Real-time export to InfoStreet streetSmartAPI
* [[Freeside:1.9:Documentation:Administration:ldap.pm|ldap.pm]]: Real-time export to LDAP
* passwdfile.pm:
* radiator.pm: Real-time export to RADIATOR
* shellcommands.pm:
* shellcommands_withdomain.pm: Real-time export via remote SSH (vpopmail, ISPMan)
* sqlmail.pm: Real-time export to SQL-backed mail server
* sqlradius.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS)
* sqlradius_withdomain.pm: Real-time export to SQL-backed RADIUS (FreeRADIUS, ICRADIUS) with realms
* sysvshell.pm:
* textradius.pm:
* vpopmail.pm: Real-time export to vpopmail text files

==svc_domain==
* bind.pm: Batch export to BIND named
* bind_slave.pm: Batch export to slave BIND named
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* domain_shellcommands.pm: Run remote commands via SSH, for domains (qmail, ISPMan).
* domain_sql.pm: Real time export of domains to SQL databases .
* http.pm: Send an HTTP or HTTPS GET or POST request
* [[Freeside:1.9:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_forward==
* artera_turbo.pm:
* [[Freeside:1.9:Documentation:Administration:communigate_pro.pm|communigate_pro.pm]]: Real-time export to a CommuniGate Pro mail server
* forward_shellcommands.pm: Run remote commands via SSH, for forwards
* postfix.pm: Postfix text files
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_www==
* apache.pm: Export an Apache httpd.conf file snippet.
* [[Freeside:1.9:Documentation:Administration:www_plesk.pm|www_plesk.pm]]: Real-time export to Plesk managed hosting service
* www_shellcommands.pm: Run remote commands via SSH, for virtual web sites (directory maintenance, FrontPage, ISPMan)

==svc_broadband==
* nas_wrapper.pm: A meta-export that triggers other svc_broadband exports.
* [[Freeside:1.9:Documentation:Administration:prizm.pm|prizm.pm]]: Real-time export to Northbound Interface
* router.pm: Send a command to a router.
* snmp.pm: Sends SNMP SETs to an SNMP agent.
* trango.pm: Sends SNMP SETs to a Trango AP.

==svc_phone==
* globalpops_voip.pm:
* grandstream.pm: Grandstream phone and ATA provisioning. This [http://www.freeside.biz/blog/?p=11 blog article] is a start at documentation.
* indosoft.pm:
* internal_diddb.pm:
* netsapiens.pm:
* phone_shellcommands.pm:
* phone_sqlradius.pm:
* thirdlane.pm:
* vitelity.pm:

==svc_external==
* artera_turbo.pm:

==svc_dsl==
* ikano.pm: see [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]

= Services =

== Accounts (svc_acct) ==

* [[Freeside:1.9:Documentation:Administration:svc_acct:_password_encoding|Password encoding in 1.9]]

== Domains (svc_domain) ==

== Forwards (svc_forward) ==

== Hosting (svc_www) ==

== Broadband (svc_broadband) ==

== Phone (svc_phone) ==
[[Vitelity]]

== External (svc_external) ==

== DSL (svc_dsl) ==

* [[Freeside:2.1:Documentation:Administration:svc_dsl:ikano|Ikano DSL provisioning and qualifications]]

= Packages =

{{Freeside:1.9:Documentation:Administration:pkg_category}}

== Price Plans ==

=== Common price plans ===

* flat
* subscription
* prorate
* sqlradacct_hour
* [[voip_cdr]]
* prepaid

=== Wholesale price plans ===

* bulk

* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:agent | agent]]
* [[Freeside:1.9:Documentation:Administration:Packages:Price_Plans:cdr_termination |
cdr_termination ]]

=== Other price plans ===

* flat_delayed
* flat_introrate
* prorate_delayed

* base_delayed
* base_rate

* sql_external
* sql_generic

=== Price plans of questionable functionality ===

* flat_comission_cust
* flat_comission_pkg
* flat_comission

* voip_sqlradacct

* sesmon_hour
* sesmon_minute

== Misc ==

* Some notes on [[Freeside:1.9:Documentation:Administration:Upselling | Upselling]]

= Resellers =

= Employees =

== Employees ==

Go to Configuration -> Employees -> Employees to view the existing employees and add new ones. It is highly recommended to add a separate account for each person rather than using role accounts.

* To add a new employee, click on "Add an employee"
* Or to edit an existing group, click on the employee number or name in the list of employees.
* Enter or edit the username, password and name. If editing an existing employee and no password change is desired, the password fields can be left blank.
* Check the "Disable employee" box to disable this employee.
* In the "Employee groups" section, mark or unmark checkboxes to indicate the access groups for this employee.

== Employee groups and access control ==

To setup employee access control or agent/reseller virtualization, you need to setup employee groups. Go to Configuration -> Employees -> Employee groups to view the existing groups and add new ones. The system starts with a "Superuser" group which has access to all functionality for the first agent.

* To add a new group, click on "Add an employee group"
* Or to edit an existing group, click on the group number or name in the list of groups.
* Enter or edit the group name.
* In the "Group limited to these agent(s)" section, mark checkboxes next to the agents this employee group should be able to see. Employees in this group will only see customers of the selected agents in the system and reports.
* In the "Group access rights" section, mark or unmark checkboxes to indicate the access rights this employee group should have. Rights marked with an "*" are global rights which provide access to global data which is shared among all agents. Their use is not recommended for groups which are limited to a subset of agents.
* After adding a new group, don't forget to go back and add or edit employees to place them into the new group.

= Billing =

== Billing events ==
Billing events are the primary mechanism to implement your business rules. Rules such as resend invoices, retry cards, suspend or cancel accounts for non-payment, etc. are all handled by billing events.

At a high level, follow the following steps to create billing events:
* Add a new Billing Event (Configuration > Billing > Billing events)
* Name the event
* Choose the type of event:
** Package - Packages and associated dates (Including Commissions)
** Invoice - Invoice status and dates
** Customer - Customer Balances and Information
** Batch Payment - Batch payment results
** Statement - Send statement
* Choose whether to apply to one or all agents
* Choose the frequency for the system to check and see if the event should run.
* Choose appropriate filters.
* Choose appropriate actions.

The form is dynamic so changing the type of event will change the available filters and actions.

== Daily and Monthly Scripts ==
* The freeside-daily script should be run daily to bill customers and run invoice collection events.
** Typically, this is accomplished with an entry in the freeside user's crontab such as: <pre>0 0 * * * /usr/local/bin/freeside-daily</pre>
** If running freeside-daily manually, ensure the <code>TZ</code> variable is set to your timezone with a command such as: <pre>TZ="US/Pacific" freeside-daily fs_daily</pre>
* If any monthly events are enabled, the freeside-monthly script should be run monthly.
* Invoice events can also be used to implement agent-virtualized invoices. (add more info)
* Be sure to include the full path of freeside-daily in your cron job.

== Invoices ==

=== Typeset (LaTeX) invoice templates ===

==== Prerequisites ====

* Almost all distributions include the necessary prerequisites listed here, manual installation is practically never necessary.
* Install [http://www.ghostscript.com/ Ghostscript] (gs)
* Install [http://www.tug.org/tetex/ teTeX] or [http://www.tug.org/texlive/ TeX Live]
* Ensure that the <code>pslatex</code>, <code>dvips</code>, and <code>pdflatex</code> command line utilities were installed

==== Logo setup ====

The EPS logo is for PDF and printed invoices.

* For best results, save a '''vector format''' logo in EPS (Encapsulated PostScript) format.
** Your graphic artist can create vector image from a bitmap (tracing etc).
** Converting a bitmap such as a JPG can work (the bigger the better), but it may render in lower quality, blurry or with the "jaggies" (especially when actually printed, not just viewed as a PDF)
* Resize the logo to 90pt X 36pt: <code>epsffit -c 0 0 90 36 yourlogo.eps >logo.eps</code>
** ("no %%BoundingBox:" error? Fix with eps2eps)
* Upload the resized logo as the <code>logo.eps</code> configuration option.
* Problems? Try <code>bin/strip-eps <oldlogo.eps >trynewlogo.eps</code>

The PNG logo is for emailed and online invoices.

Freeside ships with a logo of 92 x 62. Any logo close to this size should work with the default HTML template.

{{Freeside:1.9:Documentation:Administration:invoice_layout}}

=== HTML invoice templates ===

* Convert your logo to PNG format and upload it as the <code>logo.png</code> configuration option.
{{Freeside:1.9:Documentation:Administration:invoice_templates|format=html}}

=== Plaintext invoice templates ===

* See the Text::Template documentation for details on the substitution language.
* You must call the invoice_lines() function at least once - pass it a number of lines, and it returns a list of array references, each of two elements: a service description column, and a price column. Alternatively, call invoice_lines() with no arguments, and pagination will be disabled - all invoice line items will print on one page, with no padding (recommended for email invoices).
* Descriptions of variables are available in [[Freeside:1.9:Documentation:Template:invoice_html|invoice_html]]

=== Misc ===

==== Manually setting next customer number sequence ====

* With PostgreSQL, to number customers starting at 5000: <pre>SELECT SETVAL(pg_get_serial_sequence('cust_main', 'custnum'), 4999);</pre>
* With MySQL, to number customers starting at 5000: <pre>ALTER TABLE cust_main AUTO_INCREMENT = 5000;</pre>

==== Manually setting next invoice number sequence ====

* With PostgreSQL, to number invoices starting at 5000: <pre>SELECT SETVAL(pg_get_serial_sequence('cust_bill', 'invnum'), 4999);</pre>
* With MySQL, to number invoices starting at 5000: <pre>ALTER TABLE cust_bill AUTO_INCREMENT = 5000;</pre>

== Payment Receipts ==

The [[Freeside:1.9:Documentation:Template:payment_receipt_email|payment_receipt_email]] template is used for manually applied payments.

== Credit cards and Electronic checks ==
* [[Freeside:1.9:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]
* [[Freeside:1.9:Documentation:Administration:Batch_Processing | Batch credit card and electronic check processing]]
* Credit card expiration alerts: Customize the ''alerter_template'' configuration option and run <code>freeside-expiration-alerter</code> daily.
* Credit card decline alerts: Customize the ''declinetemplate'' configuration option and set the ''emaildecline'' configuration option.

= Misc =

* Setting up [[Freeside:2.1:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]]
* Setting up [[Freeside:2.1:Documentation:Administration:Texas Tax | Texas Tax]]
* Setting up [[Freeside:2.1:Documentation:Administration:VoIP | VoIP]]
* Setting up [[Freeside:2.1:Documentation:Administration:Time billing | Time billing]]

* Setting up [[Freeside:2.1:Documentation:Administration:Commission|Commissions and Referrals]]
* Need to print to Windows printers? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].
* Setting up [[Freeside:2.1:Documentation:Administration:Slony | Slony replication and failover]]
* Using a non-standard [[Freeside:2.1:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]
* [[Bulk DID Orders]]

{{ContextSensitiveHelp}}

Freeside:1.7:Documentation:Developer/bin/freeside-daily

2012-08-01T07:48:38Z

Celestius: /* DESCRIPTION */

==NAME==
freeside-daily - Run daily billing and invoice collection events.

==SYNOPSIS==
<code>
freeside-daily [ -d 'date' ] [ -y days ] [ -p 'payby' ] [ -a agentnum ] [ -s ] [ -v ] [ -l level ] [ -m ] [ -r ] [ -k ] user [ custnum custnum ... ]
</code>
==DESCRIPTION==
Bills customers and runs invoice collection events. Should be run from crontab daily.

Bills customers. Searches for customers who are due for billing and calls the bill and collect methods of a cust_main object. See [[Freeside:1.7:Documentation:Developer/FS/cust main|FS::cust_main]].

<code>
-d: Pretend it's 'date'. Date is in any format Date::Parse is happy with,
but be careful.

-y: In addition to -d, which specifies an absolute date, the -y switch
specifies an offset, in days. For example, "-y 15" would increment the
"pretend date" 15 days from whatever was specified by the -d switch
(or now, if no -d switch was given).

-n: When used with "-d" and/or "-y", specifies that invoices should be dated
with today's date, regardless of the pretend date used to pre-generate
the invoices.

-p: Only process customers with the specified payby (I<CARD>, I<DCRD>, I<CHEK>, I<DCHK>, I<BILL>, I<COMP>, I<LECB>)

-a: Only process customers with the specified agentnum

-s: re-charge setup fees

-v: enable debugging

-l: debugging level

-m: Experimental multi-process mode uses the job queue for multi-process and/or multi-machine billing.

-r: Multi-process mode dry run option

-k: skip notify_flat_delay and vacuum
</code>
user: From the mapsecrets file - see config.html from the base documentation

custnum: if one or more customer numbers are specified, only bills those customers. Otherwise, bills all customers.

==BUGS==
==SEE ALSO==
[[Freeside:1.7:Documentation:Developer/FS/cust main|FS::cust_main]], config.html from the base documentation

Freeside:2.1:Documentation:RT Installation

2012-06-23T09:15:35Z

Celestius: /* Prerequisites */

== Introduction ==

These instructions document installation of the integrated internal RT ticketing system.

There is also support for running this integration against an external RT installation, but it is not (yet) documented.

Documentation contributions are welcome.

== Prerequisites ==

* [http://search.cpan.org/dist/Apache-Session Apache::Session]
* [http://search.cpan.org/dist/HTML-Tree HTML::TreeBuilder]
* [http://search.cpan.org/dist/HTML-Format HTML-Format] (CPAN: "install HTML::FormatText")
* [http://search.cpan.org/dist/Test-Inline Test::Inline]
* [http://search.cpan.org/dist/Class-ReturnValue Class::ReturnValue]
* [http://search.cpan.org/dist/DBIx-SearchBuilder DBIx::SearchBuilder]
* [http://search.cpan.org/dist/Log-Dispatch Log::Dispatch]
* [http://search.cpan.org/dist/Locale-Maketext-Lexicon Locale::Maketext::Lexicon]
* [http://search.cpan.org/dist/Locale-Maketext-Fuzzy Locale::Maketext::Fuzzy]
* [http://search.cpan.org/dist/Text-Wrapper Text::Wrapper]
* [http://search.cpan.org/dist/Time-modules Time-modules] (CPAN: "install Time::ParseDate")
* [http://search.cpan.org/dist/TermReadKey Term::ReadKey]
* [http://search.cpan.org/dist/Text-Autoformat Text::Autoformat]
* [http://search.cpan.org/dist/Text-Quoted Text::Quoted]
* [http://search.cpan.org/dist/Regexp-Common Regexp::Common]
* [http://search.cpan.org/dist/HTML-Scrubber HTML::Scrubber]
* [http://search.cpan.org/dist/Tree-Simple Tree::Simple]
* [http://search.cpan.org/dist/Crypt-SSLeay Crypt::SSLeay]
* [http://search.cpan.org/dist/GDGraph GD::Graph]
* [http://search.cpan.org/dist/UNIVERSAL-Require UNIVERSAL::require]
* [http://search.cpan.org/dist/XML-RSS XML::RSS]
* [http://search.cpan.org/dist/Calendar-Simple Calendar::Simple]
* [http://search.cpan.org/dist/GD-Graph GD::Graph]
* [http://search.cpan.org/dist/GD-Text GD::Text]
* [http://search.cpan.org/dist/CSS-Squish CSS::Squish]
* [http://search.cpan.org/perldoc?HTML%3A%3AElementTable HTML::ElementTable]

Missing prerequisites? Please add them.

== Installation ==

* Create a new Unix group called 'rt'
<pre>
addgroup rt
</pre>
* Edit the top-level Makefile (within the freeside source directory - NOT rt directory), set RT_ENABLED to 1 and set the RT_DOMAIN, RT_TIMEZONE, and FREESIDE_URL variables.
<pre>
cd freeside-X.X/
nano Makefile
</pre>

* <pre><nowiki>$ make configure-rt</nowiki></pre>
* If your database is not on the local machine you will need to edit /opt/rt3/etc/RT_SiteConfig.pm and set the DatabaseHost value
* <pre><nowiki># make create-rt</nowiki></pre>
** ''Authentication errors?''
*** ''Edit <code>pg_hba.conf</code>, change "<code>ident sameuser</code>" auth to "<code>trust</code>" for the line starting with "<code>local all all</code>"''
*** ''Restart Pg''
*** ''Revert the change back and restart Pg after this installation step''
* <pre><nowiki>make install-rt</nowiki></pre>
* Configure Apache: make sure APACHE_CONF and FREESIDE_DOCUMENT_ROOT are set correctly in the Makefile, then run:
<pre>
make install-apache
</pre>

* Restart Apache (httpd) and log into the Freeside web interface using the username and password you created during the first part of the installation.

* Set the '''ticket_system''' configuration value to <code>RT_Internal</code>. (You may also wish to set '''ticket_system-default_queueid''' once you have RT configured.)

=== Bootstrap RT's permissions ===
*Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
*From "Billing Main", go to Configuration > Employees > View/Edit employees and add a temporary "root" user. Note: the user name must be "root" (without the quotes).
* Log into your Freeside installation as the "root" user you just created, by closing all of your browser windows, or by using <code><nowiki>https://root@yourmachone/freeside/</nowiki></code> syntax if your browser supports it.
* Click on "Ticketing Main" on the Freeside main menu. Go to Configuration > Ticketing > Ticketing Global, and then "User Rights". Grant the "SuperUser" right to your normal RT/Freeside login.
* Go back to the freeside employee list and disable the temporary "root" user.

== Futher Reading ==
* Follow the [http://wiki.bestpractical.com/ regular RT documentation] to configure RT, setup the mailgate, etc.

Freeside:2.3:Documentation:Upgrading

2012-06-23T07:48:16Z

Celestius: /* 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
* (Other distributions) Install Geo::Coder::Googlev3, Geo::GoogleEarth::Pluggable and Net::SNMP

* <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:2.1:Documentation:Installation:Ubuntu

2011-11-17T02:11:13Z

Celestius:

== Summary ==
Tested with Ubuntu 10.4 LTS
Step by step instructions

== 1. Install the base system ==
- Only select the OpenSSH Package

== 2. Configure the network ==

Change the server to static IP
<pre>
nano /etc/network/interfaces
</pre>
Replace the below settings with you own ip addresses etc
<pre>
# This file describes the network interfaces available on your system
# and how to activate them. For more information, see interfaces(5).

# The loopback network interface
auto lo
iface lo inet loopback

# The primary network interface
auto eth0
iface eth0 inet static
address 192.168.0.100
netmask 255.255.255.0
network 192.168.0.0
broadcast 192.168.0.255
gateway 192.168.0.1
</pre>

Restart networking
<pre>
/etc/init.d/networking restart
</pre>

Set the hostname correctly
<pre>
nano /etc/hosts
</pre>

In this example the name of the host is ''server1.example.com''
<pre>
127.0.0.1 localhost.localdomain localhost
192.168.0.100 server1.example.com server1

# The following lines are desirable for IPv6 capable hosts
::1 localhost ip6-localhost ip6-loopback
fe00::0 ip6-localnet
ff00::0 ip6-mcastprefix
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters
</pre>

Use the name found in the hosts file and update the hostname file.
<pre>
echo server1.example.com > /etc/hostname
/etc/init.d/hostname restart
</pre>

==3. Update the system==

<pre>
apt-get update
apt-get upgrade
</pre>

==4. Install core packages==
Keep the system time correct
<pre>
apt-get install ntp ntpdate
</pre>

Apache2 etc
<pre>
apt-get install apache2 libapache2-mod-perl2 postgresql-8.4 build-essential texlive-base
</pre>

Common Perl Packages - Packages are much faster to install
<pre>
apt-get install libwww-perl liburi-perl libhtml-tagset-perl libhtml-parser-perl libdbd-pg-perl libtimedate-perl libdate-manip-perl libchart-perl
apt-get install libcache-cache-perl libdatetime-perl libdatetime-format-strptime-perl libdatetime-format-natural-perl libemail-sender-perl
apt-get install libhtml-mason-perl libmailtools-perl libmail-mboxparser-perl libnetaddr-ip-perl libnet-ping-external-perl
apt-get install libnumber-format-perl libnumber-format-perl libspreadsheet-writeexcel-perl libstring-approx-perl libtext-csv-xs-perl
apt-get install libtext-template-perl libnet-ping-external-perl libterm-readkey-perl libnet-ssleay-perl libhtml-tableextract-perl
</pre>
Additional Perl Packages
<pre>
apt-get install libfile-counterfile-perl libfile-policy-perl libipc-run-perl libipc-run3-perl libjson-perl
apt-get install liblingua-en-nameparse-perl liblingua-en-inflect-perl libnet-domain-tld-perl libnet-ssh2-perl
apt-get install libnet-whois-raw-perl libtime-duration-perl liblocale-subcountry-perl
</pre>
Modules not available as packages - Allow cpan to prepend any dependencies
- Cpan may complain about YAML you can optionally install this if you choose.
<pre>
cpan Authen::Passphrase Business::CreditCard Business::US::USPS::WebTools Color::Scheme Crypt::PasswdMD5 Frontier::RPC2 HTML::Defang Net::SSH
cpan HTML::Widgets::SelectLayers String::ShellQuote Tie::IxHash Apache::DBI Email::Sender::Transport::SMTP::TLS DBIx::DBSchema HTML::ElementTable
</pre>

==5. Prepare the system==

Download latest freeside tar and extract
<pre>
mkdir /freesidesource
cd /freesidesource
wget http://www.freeside.biz/freeside/freeside-2.1.1.tar.gz
tar -zxvf freeside-2.1.1.tar.gz
chmod 777 -R /freesidesource
</pre>

Add the freeside user
<pre>
adduser freeside
</pre>

Grant permissions to freeside in postgresql
 
'''''Note''' - If your freeside database user's password contains a $ symbol, it is currently not handled properly by the "make create-rt" step of the integrated RT ticketing system install''
<pre>
#su postgres
$createuser -P freeside
Enter password for new role:
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
$exit
</pre>

Edit the Makefile
Set DB_PASSWORD to the freeside database user's password.
<pre>
cd /freesidesource/freeside-2.1.1
nano Makefile
</pre>

Add the database
<pre>
#su freeside
$createdb -E Unicode freeside
exit
</pre>

Set the encoding
*Uncomment client_encoding and set it to Latin1
<pre>
nano /etc/postgresql/8.4/main/postgresql.conf
/etc/init.d/postgresql-8.4 restart
</pre>

Configure Apache
*Set user to freeside
<pre>
nano /etc/apache2/httpd.conf
</pre>
*Add
<pre>
User freeside
Group freeside
</pre>

==6. Install freeside==

Build and Install the Perl modules - stay as freeside user
<pre>
su freeside
cd /freesidesource/freeside-2.1.1
make perl-modules
su
make install-perl-modules
</pre>

Create config files
<pre>
make create-config
</pre>

Invoice Typesetting
<pre>
make install-texmf
</pre>

Install the Web Interface
<pre>
make install-docs
</pre>

Install Apache Config
<pre>
make install-apache
</pre>

Drop back to freeside permissions
<pre>
su freeside
</pre>

Initialize Data
<pre>
freeside-setup -d example.com
</pre>

Stay as freeside user and add additional users
<pre>
freeside-adduser -g 1 fs_queue
freeside-adduser -g 1 fs_daily
freeside-adduser -g 1 fs_selfservice
</pre>

Add first freeside user / administrator
<pre>
$ su freeside
$ freeside-adduser -g 1 username
$ htpasswd /usr/local/etc/freeside/htpasswd username
Password:
</pre>

=== RT ===
* Either [[Freeside:2.1:Documentation:RT_Installation:Ubuntu|install the integrated RT ticketing system]], or delete the <code>ticket_system</code> entry from your conf table.

EDIT - I have reports that the below still fails - just for now install the RT system to get everything going.

<pre>
su freeside
psql freeside
delete from conf where name = 'ticket_system';
</pre>

Reboot

== Trouble Shooting ==
* If freeside-setup fails its often due to a missing perl module - google the .pm filename and find and install the module

Freeside:2.1:Documentation:Installation:Ubuntu

2011-01-09T03:04:58Z

Celestius: /* 5. Prepare the system */

== Summary ==
Tested with Ubuntu 10.4 LTS
Step by step instructions

== 1. Install the base system ==
- Only select the OpenSSH Package

== 2. Configure the network ==

Change the server to static IP
<pre>
nano /etc/network/interfaces
</pre>
Replace the below settings with you own ip addresses etc
<pre>
# This file describes the network interfaces available on your system
# and how to activate them. For more information, see interfaces(5).

# The loopback network interface
auto lo
iface lo inet loopback

# The primary network interface
auto eth0
iface eth0 inet static
address 192.168.0.100
netmask 255.255.255.0
network 192.168.0.0
broadcast 192.168.0.255
gateway 192.168.0.1
</pre>

Restart networking
<pre>
/etc/init.d/networking restart
</pre>

Set the hostname correctly
<pre>
nano /etc/hosts
</pre>

<pre>
127.0.0.1 localhost.localdomain localhost
192.168.0.100 server1.example.com server1

# The following lines are desirable for IPv6 capable hosts
::1 localhost ip6-localhost ip6-loopback
fe00::0 ip6-localnet
ff00::0 ip6-mcastprefix
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters
</pre>

<pre>
echo server1.example.com > /etc/hostname
/etc/init.d/hostname restart
</pre>

==3. Update the system==

<pre>
apt-get update
apt-get upgrade
</pre>

==4. Install core packages==
Keep the system time correct
<pre>
apt-get install ntp ntpdate
</pre>

Apache2 etc
<pre>
apt-get install apache2 libapache2-mod-perl2 postgresql-8.4 build-essential texlive-base
</pre>

Common Perl Packages - Packages are much faster to install
<pre>
apt-get install libwww-perl liburi-perl libhtml-tagset-perl libhtml-parser-perl libdbd-pg-perl libtimedate-perl libdate-manip-perl libchart-perl
apt-get install libcache-cache-perl libdatetime-perl libdatetime-format-strptime-perl libdatetime-format-natural-perl libemail-sender-perl
apt-get install libhtml-mason-perl libmailtools-perl libmail-mboxparser-perl libnetaddr-ip-perl libnet-ping-external-perl
apt-get install libnumber-format-perl libnumber-format-perl libspreadsheet-writeexcel-perl libstring-approx-perl libtext-csv-xs-perl
apt-get install libtext-template-perl libnet-ping-external-perl libterm-readkey-perl libnet-ssleay-perl libhtml-tableextract-perl
</pre>
Additional Perl Packages
<pre>
apt-get install libfile-counterfile-perl libfile-policy-perl libipc-run-perl libipc-run3-perl libjson-perl
apt-get install liblingua-en-nameparse-perl liblingua-en-inflect-perl libnet-domain-tld-perl libnet-ssh2-perl
apt-get install libnet-whois-raw-perl libtime-duration-perl liblocale-subcountry-perl
</pre>
Modules not available as packages - Allow cpan to prepend any dependencies
<pre>
cpan Authen::Passphrase Business::CreditCard Business::US::USPS::WebTools Color::Scheme Crypt::PasswdMD5 Frontier::RPC2 HTML::Defang Net::SSH
cpan HTML::Widgets::SelectLayers String::ShellQuote Tie::IxHash Apache::DBI Email::Sender::Transport::SMTP::TLS DBIx::DBSchema HTML::ElementTable
</pre>

==5. Prepare the system==

Download latest freeside tar and extract
<pre>
mkdir /freesidesource
cd /freesidesource
wget http://www.freeside.biz/freeside/freeside-2.1.1.tar.gz
tar -zxvf freeside-2.1.1.tar.gz
</pre>

Add the freeside user
<pre>
adduser freeside
</pre>

Grant permissions to freeside in postgresql
 
'''''Note''' - If your freeside database user's password contains a $ symbol, it is currently not handled properly by the "make create-rt" step of the integrated RT ticketing system install''
<pre>
#su postgres
$createuser -P freeside
Enter password for new role:
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
$exit
</pre>

Edit the Makefile
Set DB_PASSWORD to the freeside database user's password.
<pre>
cd /freesidesource/freeside-2.1.1
nano Makefile
</pre>

Add the database
<pre>
#su freeside
$createdb -E Unicode freeside
exit
</pre>

Set the encoding
*Uncomment client_encoding and set it to Latin1
<pre>
nano /etc/postgresql/8.4/main/postgresql.conf
/etc/init.d/postgresql-8.4 restart
</pre>

Configure Apache
*Set user to freeside
<pre>
nano /etc/apache2/httpd.conf
</pre>
*Add
<pre>
User freeside
Group freeside
</pre>

==6. Install freeside==

Build and Install the Perl modules - stay as freeside user
<pre>
su freeside
cd /freesidesource/freeside-2.1.1
make perl-modules
su
make install-perl-modules
</pre>

Create config files
<pre>
make create-config
</pre>

Invoice Typesetting
<pre>
make install-texmf
</pre>

Install the Web Interface
<pre>
make install-docs
</pre>

Install Apache Config
<pre>
make install-apache
</pre>

Drop back to freeside permissions
<pre>
su freeside
</pre>

Initialize Data
<pre>
freeside-setup -d example.com
</pre>

Stay as freeside user and add additional users
<pre>
freeside-adduser -g 1 fs_queue
freeside-adduser -g 1 fs_daily
freeside-adduser -g 1 fs_selfservice
</pre>

Add first freeside user / administrator
<pre>
$ su freeside
$ freeside-adduser -g 1 username
$ htpasswd /usr/local/etc/freeside/htpasswd username
Password:
</pre>

=== RT ===
* Either [[Freeside:2.1:Documentation:RT_Installation:Ubuntu|install the integrated RT ticketing system]], or delete the <code>ticket_system</code> entry from your conf table.

EDIT - I have reports that the below still fails - just for now install the RT system to get everything going.

<pre>
su freeside
psql freeside
delete from conf where name = 'ticket_system';
</pre>

Reboot

== Trouble Shooting ==
* If freeside-setup fails its often due to a missing perl module - google the .pm filename and find and install the module

Freeside:2.1:Documentation:Installation:Ubuntu

2011-01-08T18:08:15Z

Celestius: /* 5. Prepare the system */

== Summary ==
Tested with Ubuntu 10.4 LTS
Step by step instructions

== 1. Install the base system ==
- Only select the OpenSSH Package

== 2. Configure the network ==

Change the server to static IP
<pre>
nano /etc/network/interfaces
</pre>
Replace the below settings with you own ip addresses etc
<pre>
# This file describes the network interfaces available on your system
# and how to activate them. For more information, see interfaces(5).

# The loopback network interface
auto lo
iface lo inet loopback

# The primary network interface
auto eth0
iface eth0 inet static
address 192.168.0.100
netmask 255.255.255.0
network 192.168.0.0
broadcast 192.168.0.255
gateway 192.168.0.1
</pre>

Restart networking
<pre>
/etc/init.d/networking restart
</pre>

Set the hostname correctly
<pre>
nano /etc/hosts
</pre>

<pre>
127.0.0.1 localhost.localdomain localhost
192.168.0.100 server1.example.com server1

# The following lines are desirable for IPv6 capable hosts
::1 localhost ip6-localhost ip6-loopback
fe00::0 ip6-localnet
ff00::0 ip6-mcastprefix
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters
</pre>

<pre>
echo server1.example.com > /etc/hostname
/etc/init.d/hostname restart
</pre>

==3. Update the system==

<pre>
apt-get update
apt-get upgrade
</pre>

==4. Install core packages==
Keep the system time correct
<pre>
apt-get install ntp ntpdate
</pre>

Apache2 etc
<pre>
apt-get install apache2 libapache2-mod-perl2 postgresql-8.4 build-essential texlive-base
</pre>

Common Perl Packages - Packages are much faster to install
<pre>
apt-get install libwww-perl liburi-perl libhtml-tagset-perl libhtml-parser-perl libdbd-pg-perl libtimedate-perl libdate-manip-perl libchart-perl
apt-get install libcache-cache-perl libdatetime-perl libdatetime-format-strptime-perl libdatetime-format-natural-perl libemail-sender-perl
apt-get install libhtml-mason-perl libmailtools-perl libmail-mboxparser-perl libnetaddr-ip-perl libnet-ping-external-perl
apt-get install libnumber-format-perl libnumber-format-perl libspreadsheet-writeexcel-perl libstring-approx-perl libtext-csv-xs-perl
apt-get install libtext-template-perl libnet-ping-external-perl libterm-readkey-perl libnet-ssleay-perl libhtml-tableextract-perl
</pre>
Additional Perl Packages
<pre>
apt-get install libfile-counterfile-perl libfile-policy-perl libipc-run-perl libipc-run3-perl libjson-perl
apt-get install liblingua-en-nameparse-perl liblingua-en-inflect-perl libnet-domain-tld-perl libnet-ssh2-perl
apt-get install libnet-whois-raw-perl libtime-duration-perl liblocale-subcountry-perl
</pre>
Modules not available as packages - Allow cpan to prepend any dependencies
<pre>
cpan Authen::Passphrase Business::CreditCard Business::US::USPS::WebTools Color::Scheme Crypt::PasswdMD5 Frontier::RPC2 HTML::Defang Net::SSH
cpan HTML::Widgets::SelectLayers String::ShellQuote Tie::IxHash Apache::DBI Email::Sender::Transport::SMTP::TLS DBIx::DBSchema HTML::ElementTable
</pre>

==5. Prepare the system==

Download latest freeside tar and extract
<pre>
mkdir /freesidesource
cd /freesidesource
wget http://www.freeside.biz/freeside/freeside-2.1.1.tar.gz
tar -zxvf freeside-2.1.1.tar.gz
</pre>

Add the freeside user
<pre>
adduser freeside
</pre>

Grant permissions to freeside in postgresql
 
'''''Note''' - If your freeside database user's password contains a $ symbol, it is currently not handled properly by the "make create-rt step" of the integrated RT ticketing system install''
<pre>
#su postgres
$createuser -P freeside
Enter password for new role:
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
$exit
</pre>

Edit the Makefile
Set DB_PASSWORD to the freeside database user's password.
<pre>
cd /freesidesource/freeside-2.1.1
nano Makefile
</pre>

Add the database
<pre>
#su freeside
$createdb -E Unicode freeside
exit
</pre>

Set the encoding
*Uncomment client_encoding and set it to Latin1
<pre>
nano /etc/postgresql/8.4/main/postgresql.conf
/etc/init.d/postgresql-8.4 restart
</pre>

Configure Apache
*Set user to freeside
<pre>
nano /etc/apache2/httpd.conf
</pre>
*Add
<pre>
User freeside
Group freeside
</pre>

==6. Install freeside==

Build and Install the Perl modules - stay as freeside user
<pre>
su freeside
cd /freesidesource/freeside-2.1.1
make perl-modules
su
make install-perl-modules
</pre>

Create config files
<pre>
make create-config
</pre>

Invoice Typesetting
<pre>
make install-texmf
</pre>

Install the Web Interface
<pre>
make install-docs
</pre>

Install Apache Config
<pre>
make install-apache
</pre>

Drop back to freeside permissions
<pre>
su freeside
</pre>

Initialize Data
<pre>
freeside-setup -d example.com
</pre>

Stay as freeside user and add additional users
<pre>
freeside-adduser -g 1 fs_queue
freeside-adduser -g 1 fs_daily
freeside-adduser -g 1 fs_selfservice
</pre>

Add first freeside user / administrator
<pre>
$ su freeside
$ freeside-adduser -g 1 username
$ htpasswd /usr/local/etc/freeside/htpasswd username
Password:
</pre>

=== RT ===
* Either [[Freeside:2.1:Documentation:RT_Installation:Ubuntu|install the integrated RT ticketing system]], or delete the <code>ticket_system</code> entry from your conf table.

EDIT - I have reports that the below still fails - just for now install the RT system to get everything going.

<pre>
su freeside
psql freeside
delete from conf where name = 'ticket_system';
</pre>

Reboot

== Trouble Shooting ==
* If freeside-setup fails its often due to a missing perl module - google the .pm filename and find and install the module

Freeside:2.1:Documentation:Installation:Ubuntu

2011-01-08T18:05:37Z

Celestius: /* 5. Prepare the system */

== Summary ==
Tested with Ubuntu 10.4 LTS
Step by step instructions

== 1. Install the base system ==
- Only select the OpenSSH Package

== 2. Configure the network ==

Change the server to static IP
<pre>
nano /etc/network/interfaces
</pre>
Replace the below settings with you own ip addresses etc
<pre>
# This file describes the network interfaces available on your system
# and how to activate them. For more information, see interfaces(5).

# The loopback network interface
auto lo
iface lo inet loopback

# The primary network interface
auto eth0
iface eth0 inet static
address 192.168.0.100
netmask 255.255.255.0
network 192.168.0.0
broadcast 192.168.0.255
gateway 192.168.0.1
</pre>

Restart networking
<pre>
/etc/init.d/networking restart
</pre>

Set the hostname correctly
<pre>
nano /etc/hosts
</pre>

<pre>
127.0.0.1 localhost.localdomain localhost
192.168.0.100 server1.example.com server1

# The following lines are desirable for IPv6 capable hosts
::1 localhost ip6-localhost ip6-loopback
fe00::0 ip6-localnet
ff00::0 ip6-mcastprefix
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters
</pre>

<pre>
echo server1.example.com > /etc/hostname
/etc/init.d/hostname restart
</pre>

==3. Update the system==

<pre>
apt-get update
apt-get upgrade
</pre>

==4. Install core packages==
Keep the system time correct
<pre>
apt-get install ntp ntpdate
</pre>

Apache2 etc
<pre>
apt-get install apache2 libapache2-mod-perl2 postgresql-8.4 build-essential texlive-base
</pre>

Common Perl Packages - Packages are much faster to install
<pre>
apt-get install libwww-perl liburi-perl libhtml-tagset-perl libhtml-parser-perl libdbd-pg-perl libtimedate-perl libdate-manip-perl libchart-perl
apt-get install libcache-cache-perl libdatetime-perl libdatetime-format-strptime-perl libdatetime-format-natural-perl libemail-sender-perl
apt-get install libhtml-mason-perl libmailtools-perl libmail-mboxparser-perl libnetaddr-ip-perl libnet-ping-external-perl
apt-get install libnumber-format-perl libnumber-format-perl libspreadsheet-writeexcel-perl libstring-approx-perl libtext-csv-xs-perl
apt-get install libtext-template-perl libnet-ping-external-perl libterm-readkey-perl libnet-ssleay-perl libhtml-tableextract-perl
</pre>
Additional Perl Packages
<pre>
apt-get install libfile-counterfile-perl libfile-policy-perl libipc-run-perl libipc-run3-perl libjson-perl
apt-get install liblingua-en-nameparse-perl liblingua-en-inflect-perl libnet-domain-tld-perl libnet-ssh2-perl
apt-get install libnet-whois-raw-perl libtime-duration-perl liblocale-subcountry-perl
</pre>
Modules not available as packages - Allow cpan to prepend any dependencies
<pre>
cpan Authen::Passphrase Business::CreditCard Business::US::USPS::WebTools Color::Scheme Crypt::PasswdMD5 Frontier::RPC2 HTML::Defang Net::SSH
cpan HTML::Widgets::SelectLayers String::ShellQuote Tie::IxHash Apache::DBI Email::Sender::Transport::SMTP::TLS DBIx::DBSchema HTML::ElementTable
</pre>

==5. Prepare the system==

Download latest freeside tar and extract
<pre>
mkdir /freesidesource
cd /freesidesource
wget http://www.freeside.biz/freeside/freeside-2.1.1.tar.gz
tar -zxvf freeside-2.1.1.tar.gz
</pre>

Add the freeside user
<pre>
adduser freeside
</pre>

Grant permissions to freeside in postgresql
 
'''''Note''' - If your freeside database user's password contains a $ symbol, it is currently not handled properly by the make create-rt step of the integrated RT ticketing system install''
<pre>
#su postgres
$createuser -P freeside
Enter password for new role:
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
$exit
</pre>

Edit the Makefile
Set DB_PASSWORD to the freeside database user's password.
<pre>
cd /freesidesource/freeside-2.1.1
nano Makefile
</pre>

Add the database
<pre>
#su freeside
$createdb -E Unicode freeside
exit
</pre>

Set the encoding
*Uncomment client_encoding and set it to Latin1
<pre>
nano /etc/postgresql/8.4/main/postgresql.conf
/etc/init.d/postgresql-8.4 restart
</pre>

Configure Apache
*Set user to freeside
<pre>
nano /etc/apache2/httpd.conf
</pre>
*Add
<pre>
User freeside
Group freeside
</pre>

==6. Install freeside==

Build and Install the Perl modules - stay as freeside user
<pre>
su freeside
cd /freesidesource/freeside-2.1.1
make perl-modules
su
make install-perl-modules
</pre>

Create config files
<pre>
make create-config
</pre>

Invoice Typesetting
<pre>
make install-texmf
</pre>

Install the Web Interface
<pre>
make install-docs
</pre>

Install Apache Config
<pre>
make install-apache
</pre>

Drop back to freeside permissions
<pre>
su freeside
</pre>

Initialize Data
<pre>
freeside-setup -d example.com
</pre>

Stay as freeside user and add additional users
<pre>
freeside-adduser -g 1 fs_queue
freeside-adduser -g 1 fs_daily
freeside-adduser -g 1 fs_selfservice
</pre>

Add first freeside user / administrator
<pre>
$ su freeside
$ freeside-adduser -g 1 username
$ htpasswd /usr/local/etc/freeside/htpasswd username
Password:
</pre>

=== RT ===
* Either [[Freeside:2.1:Documentation:RT_Installation:Ubuntu|install the integrated RT ticketing system]], or delete the <code>ticket_system</code> entry from your conf table.

EDIT - I have reports that the below still fails - just for now install the RT system to get everything going.

<pre>
su freeside
psql freeside
delete from conf where name = 'ticket_system';
</pre>

Reboot

== Trouble Shooting ==
* If freeside-setup fails its often due to a missing perl module - google the .pm filename and find and install the module

Freeside:2.1:Documentation:Installation:Ubuntu

2011-01-08T18:03:34Z

Celestius: /* 5. Prepare the system */

== Summary ==
Tested with Ubuntu 10.4 LTS
Step by step instructions

== 1. Install the base system ==
- Only select the OpenSSH Package

== 2. Configure the network ==

Change the server to static IP
<pre>
nano /etc/network/interfaces
</pre>
Replace the below settings with you own ip addresses etc
<pre>
# This file describes the network interfaces available on your system
# and how to activate them. For more information, see interfaces(5).

# The loopback network interface
auto lo
iface lo inet loopback

# The primary network interface
auto eth0
iface eth0 inet static
address 192.168.0.100
netmask 255.255.255.0
network 192.168.0.0
broadcast 192.168.0.255
gateway 192.168.0.1
</pre>

Restart networking
<pre>
/etc/init.d/networking restart
</pre>

Set the hostname correctly
<pre>
nano /etc/hosts
</pre>

<pre>
127.0.0.1 localhost.localdomain localhost
192.168.0.100 server1.example.com server1

# The following lines are desirable for IPv6 capable hosts
::1 localhost ip6-localhost ip6-loopback
fe00::0 ip6-localnet
ff00::0 ip6-mcastprefix
ff02::1 ip6-allnodes
ff02::2 ip6-allrouters
</pre>

<pre>
echo server1.example.com > /etc/hostname
/etc/init.d/hostname restart
</pre>

==3. Update the system==

<pre>
apt-get update
apt-get upgrade
</pre>

==4. Install core packages==
Keep the system time correct
<pre>
apt-get install ntp ntpdate
</pre>

Apache2 etc
<pre>
apt-get install apache2 libapache2-mod-perl2 postgresql-8.4 build-essential texlive-base
</pre>

Common Perl Packages - Packages are much faster to install
<pre>
apt-get install libwww-perl liburi-perl libhtml-tagset-perl libhtml-parser-perl libdbd-pg-perl libtimedate-perl libdate-manip-perl libchart-perl
apt-get install libcache-cache-perl libdatetime-perl libdatetime-format-strptime-perl libdatetime-format-natural-perl libemail-sender-perl
apt-get install libhtml-mason-perl libmailtools-perl libmail-mboxparser-perl libnetaddr-ip-perl libnet-ping-external-perl
apt-get install libnumber-format-perl libnumber-format-perl libspreadsheet-writeexcel-perl libstring-approx-perl libtext-csv-xs-perl
apt-get install libtext-template-perl libnet-ping-external-perl libterm-readkey-perl libnet-ssleay-perl libhtml-tableextract-perl
</pre>
Additional Perl Packages
<pre>
apt-get install libfile-counterfile-perl libfile-policy-perl libipc-run-perl libipc-run3-perl libjson-perl
apt-get install liblingua-en-nameparse-perl liblingua-en-inflect-perl libnet-domain-tld-perl libnet-ssh2-perl
apt-get install libnet-whois-raw-perl libtime-duration-perl liblocale-subcountry-perl
</pre>
Modules not available as packages - Allow cpan to prepend any dependencies
<pre>
cpan Authen::Passphrase Business::CreditCard Business::US::USPS::WebTools Color::Scheme Crypt::PasswdMD5 Frontier::RPC2 HTML::Defang Net::SSH
cpan HTML::Widgets::SelectLayers String::ShellQuote Tie::IxHash Apache::DBI Email::Sender::Transport::SMTP::TLS DBIx::DBSchema HTML::ElementTable
</pre>

==5. Prepare the system==

Download latest freeside tar and extract
<pre>
mkdir /freesidesource
cd /freesidesource
wget http://www.freeside.biz/freeside/freeside-2.1.1.tar.gz
tar -zxvf freeside-2.1.1.tar.gz
</pre>

Add the freeside user
<pre>
adduser freeside
</pre>

Grant permissions to freeside in postgresql
 
'''''Note''' - If your database password contains a $ symbol, it is currently not handled properly by the make create-rt step of the integrated RT ticketing system install''
<pre>
#su postgres
$createuser -P freeside
Enter password for new role:
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
$exit
</pre>

Edit the Makefile
Set DB_PASSWORD to the freeside database user's password.
<pre>
cd /freesidesource/freeside-2.1.1
nano Makefile
</pre>

Add the database
<pre>
#su freeside
$createdb -E Unicode freeside
exit
</pre>

Set the encoding
*Uncomment client_encoding and set it to Latin1
<pre>
nano /etc/postgresql/8.4/main/postgresql.conf
/etc/init.d/postgresql-8.4 restart
</pre>

Configure Apache
*Set user to freeside
<pre>
nano /etc/apache2/httpd.conf
</pre>
*Add
<pre>
User freeside
Group freeside
</pre>

==6. Install freeside==

Build and Install the Perl modules - stay as freeside user
<pre>
su freeside
cd /freesidesource/freeside-2.1.1
make perl-modules
su
make install-perl-modules
</pre>

Create config files
<pre>
make create-config
</pre>

Invoice Typesetting
<pre>
make install-texmf
</pre>

Install the Web Interface
<pre>
make install-docs
</pre>

Install Apache Config
<pre>
make install-apache
</pre>

Drop back to freeside permissions
<pre>
su freeside
</pre>

Initialize Data
<pre>
freeside-setup -d example.com
</pre>

Stay as freeside user and add additional users
<pre>
freeside-adduser -g 1 fs_queue
freeside-adduser -g 1 fs_daily
freeside-adduser -g 1 fs_selfservice
</pre>

Add first freeside user / administrator
<pre>
$ su freeside
$ freeside-adduser -g 1 username
$ htpasswd /usr/local/etc/freeside/htpasswd username
Password:
</pre>

=== RT ===
* Either [[Freeside:2.1:Documentation:RT_Installation:Ubuntu|install the integrated RT ticketing system]], or delete the <code>ticket_system</code> entry from your conf table.

EDIT - I have reports that the below still fails - just for now install the RT system to get everything going.

<pre>
su freeside
psql freeside
delete from conf where name = 'ticket_system';
</pre>

Reboot

== Trouble Shooting ==
* If freeside-setup fails its often due to a missing perl module - google the .pm filename and find and install the module

Freeside:2.1:Documentation:RT Installation:Ubuntu

2011-01-08T13:21:10Z

Celestius: /* Install Dependancies */

==Introduction==

Install RT on Ubuntu / Debian system - Tested with Ubuntu 10.4 Lts

==Install Dependancies==
* Install dependancy for Crypt::SSLeay
<pre>
apt-get install libssl-dev
</pre>
* Install Perl Modules
<pre>
cpan Apache::Session HTML::TreeBuilder HTML::FormatText Test::Inline Class::ReturnValue DBIx::SearchBuilder Log::Dispatch Locale::Maketext::Lexicon
cpan Locale::Maketext::Fuzzy Text::Wrapper Time::ParseDate Term::ReadKey Text::Autoformat Text::Quoted Regexp::Common HTML::Scrubber Tree::Simple
cpan Crypt::SSLeay GD::Graph UNIVERSAL::require XML::RSS Calendar::Simple GD::Graph GD::Text CSS::Squish
cpan File::ShareDir HTML::RewriteAttributes MIME::Types PerlIO::eol GnuPG::Interface Data::ICal Text::WikiFormat Net::Server
cpan HTTP::Server::Simple HTTP::Server::Simple::Mason Module::Versions::Report DateTime::Set IPC::Run::SafeHandles
</pre>

== Installation ==

* Create a new Unix group called 'rt'
<pre>
addgroup rt
</pre>
* Edit the top-level Makefile (within the freeside source directory - NOT rt directory), set RT_ENABLED to 1 and set the RT_DOMAIN, RT_TIMEZONE, and FREESIDE_URL variables.
<pre>
cd /freesidesource/freeside-X.X/
nano Makefile
</pre>

* <pre><nowiki>$ make configure-rt</nowiki></pre>
* If your database is not on the local machine you will need to edit /opt/rt3/etc/RT_SiteConfig.pm and set the DatabaseHost value
* <pre><nowiki># make create-rt</nowiki></pre>
** ''Authentication errors?''
*** ''Edit <code>pg_hba.conf</code>, change "<code>ident sameuser</code>" auth to "<code>trust</code>" for the line starting with "<code>local all all</code>"''
*** ''Restart Pg''
*** ''Revert the change back and restart Pg after this installation step''
* <pre><nowiki>make install-rt</nowiki></pre>
* Add the following to your httpd.conf:
<pre>
#replace /var/www/freeside with your freeside document root
<Directory /var/www/freeside/rt/NoAuth>
<Limit GET POST>
allow from all
Satisfy any
SetHandler perl-script
PerlHandler HTML::Mason
</Limit>
</Directory>

#replace /var/www/freeside with your freeside document root
<Directory /var/www/freeside/rt/REST/1.0/NoAuth>
<Limit GET POST>
allow from all
Satisfy any
SetHandler perl-script
PerlHandler HTML::Mason
</Limit>
</Directory>

#replace /var/www/freeside with your freeside document root
<DirectoryMatch "^%/var/www/freeside/rt/.*NoAuth/images">
SetHandler None
</DirectoryMatch>

#replace /var/www/freeside with your freeside document root
<Directory /var/www/freeside/rt/Ticket/Attachment>
SetHandler perl-script
PerlHandler HTML::Mason
</Directory>

#replace /var/www/freeside with your freeside document root
<Directory /var/www/freeside/rt/Search>
SetHandler perl-script
PerlHandler HTML::Mason
</Directory>
</pre>

* Restart Apache (httpd) and log into the Freeside web interface using the username and password you created during the first part of the installation.

* Set the '''ticket_system''' configuration value to <code>RT_Internal</code>. (You may also wish to set '''ticket_system-default_queueid''' once you have RT configured.)

=== Bootstrap RT's permissions ===
*Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
*From "Billing Main", go to Configuration > Employees > View/Edit employees and add a temporary "root" user. Note: the user name must be "root" (without the quotes).
* Log into your Freeside installation as the "root" user you just created, by closing all of your browser windows, or by using <code><nowiki>https://root@yourmachone/freeside/</nowiki></code> syntax if your browser supports it.
* Click on "Ticketing Main" on the Freeside main menu. Go to Configuration > Ticketing > Ticketing Global, and then "User Rights". Grant the "SuperUser" right to your normal RT/Freeside login.
* Go back to the freeside employee list and disable the temporary "root" user.

== Futher Reading ==
* Follow the [http://wiki.bestpractical.com/ regular RT documentation] to configure RT, setup the mailgate, etc.

Freeside:2.1:Documentation:RT Installation:Ubuntu

2011-01-08T13:07:03Z

Celestius: /* 1. Install Dependancies */

==Introduction==

Install RT on Ubuntu / Debian system - Tested with Ubuntu 10.4 Lts

==Install Dependancies==
Install dependancy for Crypt::SSLeay
<pre>
apt-get install libssl-dev
</pre>
Install Perl Modules
<pre>
cpan Apache::Session HTML::TreeBuilder HTML::FormatText Test::Inline Class::ReturnValue DBIx::SearchBuilder Log::Dispatch Locale::Maketext::Lexicon
cpan Locale::Maketext::Fuzzy Text::Wrapper Time::ParseDate Term::ReadKey Text::Autoformat Text::Quoted Regexp::Common HTML::Scrubber Tree::Simple
cpan Crypt::SSLeay GD::Graph UNIVERSAL::require XML::RSS Calendar::Simple GD::Graph GD::Text CSS::Squish
cpan File::ShareDir HTML::RewriteAttributes MIME::Types PerlIO::eol GnuPG::Interface Data::ICal Text::WikiFormat Net::Server
cpan HTTP::Server::Simple HTTP::Server::Simple::Mason Module::Versions::Report DateTime::Set IPC::Run::SafeHandles
</pre>

== Installation ==

* Create a new Unix group called 'rt'
<pre>
addgroup rt
</pre>
* Edit the top-level Makefile (within the freeside source directory - NOT rt directory), set RT_ENABLED to 1 and set the RT_DOMAIN, RT_TIMEZONE, and FREESIDE_URL variables.
<pre>
cd /freesidesource/freeside-X.X/
nano Makefile
</pre>

* <pre><nowiki>$ make configure-rt</nowiki></pre>
* If your database is not on the local machine you will need to edit /opt/rt3/etc/RT_SiteConfig.pm and set the DatabaseHost value
* <pre><nowiki># make create-rt</nowiki></pre>
** ''Authentication errors?''
*** ''Edit <code>pg_hba.conf</code>, change "<code>ident sameuser</code>" auth to "<code>trust</code>" for the line starting with "<code>local all all</code>"''
*** ''Restart Pg''
*** ''Revert the change back and restart Pg after this installation step''
* <pre><nowiki>make install-rt</nowiki></pre>
* Add the following to your httpd.conf:
<pre>
#replace /var/www/freeside with your freeside document root
<Directory /var/www/freeside/rt/NoAuth>
<Limit GET POST>
allow from all
Satisfy any
SetHandler perl-script
PerlHandler HTML::Mason
</Limit>
</Directory>

#replace /var/www/freeside with your freeside document root
<Directory /var/www/freeside/rt/REST/1.0/NoAuth>
<Limit GET POST>
allow from all
Satisfy any
SetHandler perl-script
PerlHandler HTML::Mason
</Limit>
</Directory>

#replace /var/www/freeside with your freeside document root
<DirectoryMatch "^%/var/www/freeside/rt/.*NoAuth/images">
SetHandler None
</DirectoryMatch>

#replace /var/www/freeside with your freeside document root
<Directory /var/www/freeside/rt/Ticket/Attachment>
SetHandler perl-script
PerlHandler HTML::Mason
</Directory>

#replace /var/www/freeside with your freeside document root
<Directory /var/www/freeside/rt/Search>
SetHandler perl-script
PerlHandler HTML::Mason
</Directory>
</pre>

* Restart Apache (httpd) and log into the Freeside web interface using the username and password you created during the first part of the installation.

* Set the '''ticket_system''' configuration value to <code>RT_Internal</code>. (You may also wish to set '''ticket_system-default_queueid''' once you have RT configured.)

=== Bootstrap RT's permissions ===
*Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
*From "Billing Main", go to Configuration > Employees > View/Edit employees and add a temporary "root" user. Note: the user name must be "root" (without the quotes).
* Log into your Freeside installation as the "root" user you just created, by closing all of your browser windows, or by using <code><nowiki>https://root@yourmachone/freeside/</nowiki></code> syntax if your browser supports it.
* Click on "Ticketing Main" on the Freeside main menu. Go to Configuration > Ticketing > Ticketing Global, and then "User Rights". Grant the "SuperUser" right to your normal RT/Freeside login.
* Go back to the freeside employee list and disable the temporary "root" user.

== Futher Reading ==
* Follow the [http://wiki.bestpractical.com/ regular RT documentation] to configure RT, setup the mailgate, etc.