Freeside - User contributions [en]

Freeside:2.3:Documentation

2012-10-30T21:45:46Z

Tetherow: /* Backend Installation */

= Note =

Most documentation links point to earlier versions until things are fully moved over. The information should still be applicable.

2.3 [[Freeside:2.3:Documentation:Installation|Install]] and [[Freeside:2.3:Documentation:Upgrading|Upgrade]] instructions and a [[Freeside:2.3:Changelog|Changelog]] are available.

= Installation and upgrades =

== Backend Installation ==

* [[Freeside:2.3:Documentation:Installation|New Installation]]
* [[Freeside:2.1:Documentation:RT Installation|Integrated RT Installation]]
* OS-specific installation guides (source)
** [[Freeside:2.3:Documentation:InstallingOnDebian6|Debian 6.0 "squeeze"]]
** [[Freeside:2.1:Documentation:Installation:Ubuntu|Ubuntu 10.4 LTS]]
**[[Freeside:2.1:Documentation:Installation:FreeBSD|FreeBSD 8.1]] - Feedback please!
* OS-specific installation guides (packages)
** (no packages yet) <strike>[[Freeside:1.9:Documentation:InstallingUsingAPT|Debian packages]]</strike>
** (no packages yet) <strike>[[Freeside:1.9:Documentation:InstallingUsingRPM|CentOS/RHEL RPM packages]]</strike>

== Signup and Self-service installation ==

* [[Freeside:2.1:Documentation:Self-Service Installation|Signup/Self-service Installation]]

== Distributor guides ==

* [[Freeside:Documentation:CreatingRPMRepo|Creating your own repository with Freeside RPMs]]

* [[Freeside:Documentation:MirroringRPMRepo|Creating and using a mirror of the Freeside Internet Services RPM repositories]]

* [[Freeside:Documentation:RPMBuildSystem|Documentation on the RPM build system]]

== Upgrading ==

* [[Freeside:2.3:Documentation:Upgrading|Upgrading from 2.1.X to 2.3.0]]
* [[Freeside:2.3.1:Documentation:Upgrading|Upgrading from 2.3.0 to 2.3.1]]
* [[Freeside:2.3.2:Documentation:Upgrading|Upgrading from 2.3.1 to 2.3.2]]
* [[Freeside:2.3.3:Documentation:Upgrading|Upgrading from 2.3.2 to 2.3.3]]
* [[Freeside:2.3.3:Documentation:Upgrading|Upgrading from 2.3.3 to 2.3.4]]

= User's Guide =

* [[Freeside:2.1:Documentation:User|User's Guide]] (help wanted)
* [http://www.sisd.com/~ivan/freeside-slides Training presentation slides]

= Administrator's Guide =

* [[Freeside:2.1:Documentation:Administration|Administrator's Guide]]
* [[Freeside:Documentation:DisasterRecovery|Disaster Recovery]]
* [[:Category:Freeside:1.9:Documentation:Template|Templates]] used and their fill in variables.

= Developer's Guide =

* [[Freeside:2.1:Documentation:Developer|Developer's Guide]]

= Accounting Guide =

*[[Freeside:Documentation:Accounting|Accounting Guide]]

= Misc =

* [[Freeside:Documentation:FAQ|Frequently Asked Questions]]
* [[3rd_party_software|Third-party software]]
* [[Freeside:2.1:Documentation:Administration:VoIP:Timed_Rates|New feature: Timed Rates]]
* [[Freeside:2.1:Documentation:Administration:RT_Workflow|RT workflow features]]
* [[Freeside:2.1:Documentation:Administration:Tips_and_Tricks|Tips and Tricks]]

* [[Freeside:2.1:Documentation|Version 2.1 documentation]] (legacy version)

= Changelog =

* [[Freeside:2.3:Changelog|2.3 Changelog]]
* [[Freeside:2.3.1:Changelog|2.3.1 Changelog]]
* [[Freeside:2.3.2:Changelog|2.3.2 Changelog]]
* [[Freeside:2.3.3:Changelog|2.3.3 Changelog]]

Freeside:2.3:Documentation

2012-10-30T21:43:18Z

Tetherow: /* Backend Installation */

= Note =

Most documentation links point to earlier versions until things are fully moved over. The information should still be applicable.

2.3 [[Freeside:2.3:Documentation:Installation|Install]] and [[Freeside:2.3:Documentation:Upgrading|Upgrade]] instructions and a [[Freeside:2.3:Changelog|Changelog]] are available.

= Installation and upgrades =

== Backend Installation ==

* [[Freeside:2.3:Documentation:Installation|New Installation]]
* [[Freeside:2.1:Documentation:RT Installation|Integrated RT Installation]]
* OS-specific installation guides (source)
** [[Freeside:2.3:Documentation:InstallingOnUbuntu12.04|Ubuntu 12.04 "Precise Pangolin"]]
** [[Freeside:2.3:Documentation:InstallingOnDebian6|Debian 6.0 "squeeze"]]
** [[Freeside:2.1:Documentation:Installation:Ubuntu|Ubuntu 10.4 LTS]]
**[[Freeside:2.1:Documentation:Installation:FreeBSD|FreeBSD 8.1]] - Feedback please!
* OS-specific installation guides (packages)
** (no packages yet) <strike>[[Freeside:1.9:Documentation:InstallingUsingAPT|Debian packages]]</strike>
** (no packages yet) <strike>[[Freeside:1.9:Documentation:InstallingUsingRPM|CentOS/RHEL RPM packages]]</strike>

== Signup and Self-service installation ==

* [[Freeside:2.1:Documentation:Self-Service Installation|Signup/Self-service Installation]]

== Distributor guides ==

* [[Freeside:Documentation:CreatingRPMRepo|Creating your own repository with Freeside RPMs]]

* [[Freeside:Documentation:MirroringRPMRepo|Creating and using a mirror of the Freeside Internet Services RPM repositories]]

* [[Freeside:Documentation:RPMBuildSystem|Documentation on the RPM build system]]

== Upgrading ==

* [[Freeside:2.3:Documentation:Upgrading|Upgrading from 2.1.X to 2.3.0]]
* [[Freeside:2.3.1:Documentation:Upgrading|Upgrading from 2.3.0 to 2.3.1]]
* [[Freeside:2.3.2:Documentation:Upgrading|Upgrading from 2.3.1 to 2.3.2]]
* [[Freeside:2.3.3:Documentation:Upgrading|Upgrading from 2.3.2 to 2.3.3]]
* [[Freeside:2.3.3:Documentation:Upgrading|Upgrading from 2.3.3 to 2.3.4]]

= User's Guide =

* [[Freeside:2.1:Documentation:User|User's Guide]] (help wanted)
* [http://www.sisd.com/~ivan/freeside-slides Training presentation slides]

= Administrator's Guide =

* [[Freeside:2.1:Documentation:Administration|Administrator's Guide]]
* [[Freeside:Documentation:DisasterRecovery|Disaster Recovery]]
* [[:Category:Freeside:1.9:Documentation:Template|Templates]] used and their fill in variables.

= Developer's Guide =

* [[Freeside:2.1:Documentation:Developer|Developer's Guide]]

= Accounting Guide =

*[[Freeside:Documentation:Accounting|Accounting Guide]]

= Misc =

* [[Freeside:Documentation:FAQ|Frequently Asked Questions]]
* [[3rd_party_software|Third-party software]]
* [[Freeside:2.1:Documentation:Administration:VoIP:Timed_Rates|New feature: Timed Rates]]
* [[Freeside:2.1:Documentation:Administration:RT_Workflow|RT workflow features]]
* [[Freeside:2.1:Documentation:Administration:Tips_and_Tricks|Tips and Tricks]]

* [[Freeside:2.1:Documentation|Version 2.1 documentation]] (legacy version)

= Changelog =

* [[Freeside:2.3:Changelog|2.3 Changelog]]
* [[Freeside:2.3.1:Changelog|2.3.1 Changelog]]
* [[Freeside:2.3.2:Changelog|2.3.2 Changelog]]
* [[Freeside:2.3.3:Changelog|2.3.3 Changelog]]

Freeside:1.7:Documentation:RT Installation

2008-09-18T01:17:40Z

Tetherow: /* Installation */

== 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]

== Installation ==

* Create a new Unix group called 'rt'
* Edit the top-level Makefile, set RT_ENABLED to 1 and set the RT_DOMAIN, RT_TIMEZONE, and FREESIDE_URL variables.
* <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. Click on "Configuration", then "Global", and then "User Rights". Grant the "SuperUser" right to your RT login.
** Disable the temporary "root" user.

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

Freeside:1.7:Documentation:RT Installation

2008-09-18T01:15:17Z

Tetherow: /* 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]

== Installation ==

* Create a new Unix group called 'rt'
* Edit the top-level Makefile, set RT_ENABLED to 1 and set the RT_DOMAIN, RT_TIMEZONE, and FREESIDE_URL variables.
* <pre><nowiki>$ make configure-rt</nowiki></pre>
* <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. Click on "Configuration", then "Global", and then "User Rights". Grant the "SuperUser" right to your RT login.
** Disable the temporary "root" user.

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

Freeside:1.7:Documentation:Installation

2008-09-17T23:37:24Z

Tetherow: /* Modules of Indeterminate Popularity */

== Introduction ==

Install Freeside on a firewalled, private server, not a public (web, RADIUS, etc.) server.

Please note that these are the 1.7 installation instructions. Do not attempt to use them to install 1.5/1.6, or edit them to correct differences with those releases.

== Prerequisites ==

=== Packages ===

* [http://www.perl.org/ Perl], minimum version 5.8.4
* [http://httpd.apache.org/ Apache], SSL highly recommended)
* [http://perl.apache.org/ mod_perl]
** mod_perl v2 is now supported.
** If compiling your own mod_perl, make sure you set the EVERYTHING=1 compile-time option
* A '''transactional''' database engine [http://search.cpan.org/search?mode=module&query=DBD%3A%3A supported] by Perl's [http://dbi.perl.org/ DBI].
** [http://www.postgresql.org PostgreSQL] is recommended (v7.2 or later, v7.4 or later recommended).
** [http://www.mysql.com MySQL] (v4.1 or later, v5 recommended) is supported starting with Freeside 1.7.3. DBIx::DBSchema 0.35 or later is required.

''Note: the above only applies to the database used by the Freeside software itself. Freeside can integrate with RADIUS and other servers running a different database than the backend.''

* teTeX and Ghostscript (included with most distributions) (Optional, enables typeset invoices)

=== Perl modules ===

==== Popular modules you might want to check your distribution for ====

* [http://search.cpan.org/dist/libnet/ libnet] (CPAN: "install Net::Cmd")
* [http://search.cpan.org/dist/libwww-perl libwww-perl] (CPAN: "install Bundle::LWP")
** [http://search.cpan.org/dist/URI URI]
** [http://search.cpan.org/dist/HTML-Tagset HTML::Tagset]
** [http://search.cpan.org/dist/HTML-Parser HTML::Parser]
* [http://search.cpan.org/dist/HTML-Mason HTML::Mason]
* [http://search.cpan.org/dist/Text-Template Text::Template]
* [http://search.cpan.org/dist/DBI DBI]
** [http://search.cpan.org/search?mode=module&query=DBD%3A%3A DBD] for your database engine ([http://search.cpan.org/dist/DBD-Pg DBD::Pg] for PostgreSQL or [http://search.cpan.org/dist/DBD-mysql DBD::mysql] for MySQL)
* [http://search.cpan.org/dist/MailTools MailTools] (CPAN: "install Mail::Internet") (Freeside v1.7.2: use MailTools v1.77, not later versions) (Freeside 1.7.3: use MailTools v2.00 or later)
* [http://search.cpan.org/dist/MIME-tools MIME::Tools] (Note: do not use v5.423. Versions from 5.424 and later should be okay, as well as versions from 5.420 and older. Status of 5.421 and 5.422 is unknown.)
* [http://search.cpan.org/dist/TimeDate TimeDate] (CPAN: "install Date::Format")
* [http://search.cpan.org/dist/Locale-Codes Locale-Codes] (CPAN: "install Locale::Country")
* [http://search.cpan.org/dist/DateTime DateTime]

==== Modules of Indeterminate Popularity ====

* [http://search.cpan.org/dist/Chart Chart] (CPAN: "install Chart::Base")
* [http://search.cpan.org/dist/Cache-Cache Cache::Cache]
* [http://search.cpan.org/dist/NetAddr-IP NetAddr::IP]
* [http://search.cpan.org/dist/String-Approx String::Approx]
* [http://search.cpan.org/dist/Locale-SubCountry Locale::SubCountry]
* [http://search.cpan.org/dist/Frontier-RPC Frontier::RPC2]
* [http://search.cpan.org/dist/Term-ReadKey Term::ReadKey]
* [http://search.cpan.org/dist/DateManip Date::Manip]
* [http://search.cpan.org/dist/DateTime-Format-Strptime DateTime::Format::Strptime]
* [http://search.cpan.org/dist/Text-CSV_XS Text::CSV_XS]
* [http://search.cpan.org/dist/Spreadsheet-WriteExcel Spreadsheet::WriteExcel]
* [http://search.cpan.org/dist/Number-Format Number::Format]

==== Less common modules ====

* [http://search.cpan.org/dist/Business-CreditCard Business::CreditCard]
* [http://search.cpan.org/dist/Net-Whois-Raw Net::Whois::Raw]
* [http://search.cpan.org/dist/DBIx-DBSchema DBIx::DBSchema] (Freeside v1.7.2: use DBIx::DBSchema v0.32, not later versions) (Freeside 1.7.3: use current DBIx::DBSchema)
* [http://search.cpan.org/dist/Tie-IxHash Tie::IxHash]
* [http://search.cpan.org/dist/Crypt::PasswdMD5 Crypt::PasswdMD5]
* [http://search.cpan.org/dist/Time-Duration Time::Duration]
* [http://search.cpan.org/dist/File-CounterFile File::CounterFile]
* [http://search.cpan.org/dist/IPC-Run3 IPC::Run3]
* [http://search.cpan.org/dist/Net-SSH Net::SSH]
* [http://search.cpan.org/dist/String-ShellQuote String::ShellQuote]
* [http://search.cpan.org/dist/JSON JSON]
* [http://search.cpan.org/dist/HTML-Widgets-SelectLayers HTML::Widgets::SelectLayers]
* [http://search.cpan.org/dist/Color-Scheme Color::Scheme]
* [http://search.cpan.org/dist/Lingua-EN-NameParse Lingua::EN::NameParse]
* [http://search.cpan.org/dist/Lingua-EN-Inflect Lingua::EN::Inflect]

==== Optional modules ====

* [http://search.cpan.org/dist/Fax-Hylafax-Client Fax::Hylafax::Client] ''(Required if faxing invoices)''
* [http://search.cpan.org/dist/Apache-DBI Apache::DBI] ''(recommended for better web interface performance)''

== Installation ==

* Add the user and group `freeside' to your system.
* Allow the freeside user full access to the freeside database.
with PostgreSQL
<pre>
$ su postgres (pgsql on some distributions)
$ createuser -P freeside
Enter password for user "freeside":
Enter it again:
Shall the new user be allowed to create databases? (y/n) y
Shall the new user be allowed to create more new users? (y/n) n
CREATE USER
</pre>
or with Postgresql 8.3.1
<pre>
[ as postgres/pgsql user ]
$ 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
</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 the top-level Makefile:
** Set DATASOURCE to your DBI data source, for example, <code>DBI:Pg:dbname=freeside</code> for PostgresSQL or <code>DBI:mysql:freeside</code> for MySQL. See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.
** Set DB_PASSWORD to the freeside database user's password.

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

* Build and install the Perl modules:
<pre>
$ make perl-modules
$ su
# make install-perl-modules
</pre>

* Create the necessary configuration files:
<pre>
$ su
# make create-config
</pre>

* Ensure Apache has mod_perl enabled and is set to run as <code>User freeside</code>. If you have other things being served by Apache on this machine (hopefully internal things), it is recommended to run a '''separate''' iteration of Apache as the freeside user.

* Edit the Makefile and set <code>FREESIDE_DOCUMENT_ROOT</code>.

* Run
<pre>
# make install-docs
</pre>

* Edit the Makefile and set <code>APACHE_VERSION</code> to '''1''' (mod_perl v1.XX), '''1.99''' (mod_perl v2 prereleases up to and including 1.999_21, shipped with Debian 3.1, CentOS/RHEL 4, others), or '''2''' (mod_perl v2 proper and prereleases 1.999_22 and later).

* Edit the Makefile and set <code>APACHE_CONF</code> to the location of an Apache include directory (not a file). (If your Apache doesn't have an existing include directory, create one and add a line such as "<code>Include /etc/apache/conf.d</code>" to httpd.conf.)

* Run
<pre>
# make install-apache
</pre>

''Note: Do not attempt to restart Apache (httpd) yet.''

* 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 /usr/local/etc/freeside/htpasswd username
Password:
</pre>
Additional users can be added using the same command or from the web interface.

* freeside-queued was installed with the Perl modules. Start it now and ensure that is run upon system startup (Do this manually, or edit the top-level Makefile, replacing <code>INIT_FILE</code> with the appropriate location on your system and <code>QUEUED_USER</code> with the username of a Freeside user you created above, and run <code>make install-init</code>)

* Either [[Freeside:1.7:Documentation:RT_Installation|install the integrated RT ticketing system]], or delete the <code>ticket_system</code> file from your configuration directory (<code>/usr/local/etc/freeside/conf.''datasrc''</code>).

* Restart Apache (httpd) and log into the web interface using the username and password you entered above.

* Now proceed to the initial [[Freeside:1.7:Documentation:Administration|administration]] of your installation.