Freeside - User contributions [en]

Main Page

2024-07-16T01:23:13Z

Ivan: /* Versions */

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

:'''Maintenance Version:''' 3.92
::released May 11, 2017
::v3.x will be end-of-life mid-202x

:'''Current Version:''' 4.2
::released Mar 19, 2017

:'''Future:''' 5.x / git master
::202x?

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

=== Documentation ===

* [[Freeside:3:Documentation|3.x Documentation]]
* [[Freeside:4:Documentation|4.x Documentation]]

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

===Training===
*[[Training syllabus]]

=== Specs in progress ===
* [[Use Cases]]
* [[Business::FraudDetect]]
* [[Event_Refactor]]
* [[UI_Refactor]]
* [[Website_Refactor]]
* [[Browser_support]]
* [[Test Suite]]

=== Historical ===
* [[Batch_Refactor]]
* [[Broadband_Services_Spec]]
* [[Virtual_to_Real_Fields]]
* [[part_pkg Mixin Refactor]]
* A new [[Version_Control_System]]
* [[RPM_Build_system]]

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

Main Page

2024-07-16T01:22:47Z

Ivan: /* Freeside */

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

:'''Maintenance Version:''' 3.92
::released May 11, 2017
::v3.x will be end-of-life after Q4 2017

:'''Current Version:''' 4.2
::released Mar 19, 2017

:'''Future:''' 5.x / git master
::202x?

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

=== Documentation ===

* [[Freeside:3:Documentation|3.x Documentation]]
* [[Freeside:4:Documentation|4.x Documentation]]

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

===Training===
*[[Training syllabus]]

=== Specs in progress ===
* [[Use Cases]]
* [[Business::FraudDetect]]
* [[Event_Refactor]]
* [[UI_Refactor]]
* [[Website_Refactor]]
* [[Browser_support]]
* [[Test Suite]]

=== Historical ===
* [[Batch_Refactor]]
* [[Broadband_Services_Spec]]
* [[Virtual_to_Real_Fields]]
* [[part_pkg Mixin Refactor]]
* A new [[Version_Control_System]]
* [[RPM_Build_system]]

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

Freeside:4:Documentation:InstallingOnDebian12

2024-07-16T01:20:21Z

Ivan: /* Restart freeside */

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 12.x "bookworm"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-bullseye/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-stretch-testing/ ./ #XXX (no bullseye-specific repo yet) -testing only for now on deb 12, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
* See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.
* Example:
<pre>
DBI:Pg:dbname=freeside
freeside
db_password_if_set
</pre>

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Start freeside =

* <code>/etc/init.d/freeside start</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* <code>service apache2 restart</code>
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4:Documentation:InstallingOnDebian11

2024-07-16T01:20:06Z

Ivan: /* Restart freeside */

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 11.x "bullseye"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-bullseye/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-stretch-testing/ ./ #XXX (no bullseye-specific repo yet) -testing only for now on deb 11, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
* See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.
* Example:
<pre>
DBI:Pg:dbname=freeside
freeside
db_password_if_set
</pre>

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Start freeside =

* <code>/etc/init.d/freeside start</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* <code>service apache2 restart</code>
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4:Documentation:InstallingOnDebian10

2024-07-16T01:19:52Z

Ivan: /* Restart freeside */

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 10.x "buster"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-buster/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-stretch-testing/ ./ #XXX (no buster-specific repo yet) -testing only for now on deb 10, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
** See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Start freeside =

* <code>/etc/init.d/freeside start</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* <code>service apache2 restart</code>
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4:Documentation:InstallingOnDebian11

2024-07-16T01:17:56Z

Ivan: /* Configure package repositories */

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 11.x "bullseye"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-bullseye/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-stretch-testing/ ./ #XXX (no bullseye-specific repo yet) -testing only for now on deb 11, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
* See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.
* Example:
<pre>
DBI:Pg:dbname=freeside
freeside
db_password_if_set
</pre>

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Restart freeside =

* <code>/etc/init.d/freeside restart</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* <code>service apache2 restart</code>
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4:Documentation:InstallingOnDebian12

2024-07-16T01:17:45Z

Ivan: Created page with "= Configure package repositories = * Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 12.x "bookworm"): <pre> deb [trusted=yes] http://pkg.free..."

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 12.x "bookworm"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-bullseye/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-stretch-testing/ ./ #XXX (no bullseye-specific repo yet) -testing only for now on deb 12, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
* See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.
* Example:
<pre>
DBI:Pg:dbname=freeside
freeside
db_password_if_set
</pre>

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Restart freeside =

* <code>/etc/init.d/freeside restart</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* <code>service apache2 restart</code>
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4:Documentation

2024-07-16T00:57:04Z

Ivan: /* Packages */

= Note =

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

= Installation and upgrades =

== Backend Installation ==

=== Packages ===

* <strike>[[Freeside:4:Documentation:InstallingOnDebian10|Debian 10 "buster"]]</strike>
* [[Freeside:4:Documentation:InstallingOnDebian11|Debian 11 "bullseye"]]
* [[Freeside:4:Documentation:InstallingOnDebian12|Debian 12 "bookworm"]]

=== Source ===

* [[Freeside:4:Documentation:Installation|New Installation]]
* [[Freeside:3:Documentation:RT Installation|Integrated RT Installation]]
* [[Freeside:3:Documentation:Torrus Installation|Integrated Torrus Installation]]

== Signup and Self-service installation ==

* [[Freeside:3:Documentation:Self-Service Installation|Signup/Self-service Installation]]
* [[Freeside:3:Documentation:Self-Service access without service|Self-Service access without package/service]]
* [[Freeside:3:Documentation:NG_Self-Service| Next generation self-service portal]] (Work in progress)

== Upgrading ==

* [[Freeside:4:Documentation:Upgrading|Upgrading from 3.3 or later to 4.x]]
* [[Freeside:3:Documentation:Upgrading|Upgrading between 4.x versions]]

= Users =

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

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Appointments]]

= Administrator =

== Reference ==

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

== New features in v4 ==

* [[Freeside:4:Documentation:Administrator:Multi-currency|Multi-currency]]
* Emails triggered by system log events can be set up at Configuration -> Miscellaneous -> System log emails

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Administrator:Fees|Automated fees]]
* [[Freeside:4:Documentation:Cacti|Cacti Integration]]
* [[Freeside:4:Documentation:MagicMail|MagicMail Integration]]

= Developer =

== Reference ==

* [[Freeside:3:Documentation:Developer|Developer's Guide]]
* [[Freeside:3:Documentation:Billing_Internals|Billing Internals]] (walkthrough of the core invoice generation code)

== New features in v4 ==

* [[Freeside:4:Documentation:Developer:Authentication_Plugins|Authentication Plugins]]
* [[Freeside:4:Documentation:TaxEngine|Tax Engines]]

= Accounting Guide =

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

= Misc old stuff =

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

= Changelog =

* [[Freeside:4.0:Changelog|4.0 Changelog]]
* [[Freeside:4.1:Changelog|4.1 Changelog]]
* [[Freeside:4.2:Changelog|4.2 Changelog]]
* [[Freeside:4.3:Changelog|4.3 Changelog]]

Freeside:4:Documentation

2024-07-15T23:09:08Z

Ivan: /* Backend Installation */

= Note =

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

= Installation and upgrades =

== Backend Installation ==

=== Packages ===

* [[Freeside:4:Documentation:InstallingOnDebian10|Debian 10 "buster"]]
* [[Freeside:4:Documentation:InstallingOnDebian11|Debian 11 "bullseye"]]

=== Source ===

* [[Freeside:4:Documentation:Installation|New Installation]]
* [[Freeside:3:Documentation:RT Installation|Integrated RT Installation]]
* [[Freeside:3:Documentation:Torrus Installation|Integrated Torrus Installation]]

== Signup and Self-service installation ==

* [[Freeside:3:Documentation:Self-Service Installation|Signup/Self-service Installation]]
* [[Freeside:3:Documentation:Self-Service access without service|Self-Service access without package/service]]
* [[Freeside:3:Documentation:NG_Self-Service| Next generation self-service portal]] (Work in progress)

== Upgrading ==

* [[Freeside:4:Documentation:Upgrading|Upgrading from 3.3 or later to 4.x]]
* [[Freeside:3:Documentation:Upgrading|Upgrading between 4.x versions]]

= Users =

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

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Appointments]]

= Administrator =

== Reference ==

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

== New features in v4 ==

* [[Freeside:4:Documentation:Administrator:Multi-currency|Multi-currency]]
* Emails triggered by system log events can be set up at Configuration -> Miscellaneous -> System log emails

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Administrator:Fees|Automated fees]]
* [[Freeside:4:Documentation:Cacti|Cacti Integration]]
* [[Freeside:4:Documentation:MagicMail|MagicMail Integration]]

= Developer =

== Reference ==

* [[Freeside:3:Documentation:Developer|Developer's Guide]]
* [[Freeside:3:Documentation:Billing_Internals|Billing Internals]] (walkthrough of the core invoice generation code)

== New features in v4 ==

* [[Freeside:4:Documentation:Developer:Authentication_Plugins|Authentication Plugins]]
* [[Freeside:4:Documentation:TaxEngine|Tax Engines]]

= Accounting Guide =

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

= Misc old stuff =

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

= Changelog =

* [[Freeside:4.0:Changelog|4.0 Changelog]]
* [[Freeside:4.1:Changelog|4.1 Changelog]]
* [[Freeside:4.2:Changelog|4.2 Changelog]]
* [[Freeside:4.3:Changelog|4.3 Changelog]]

Freeside:4:Documentation:InstallingOnDebian11

2024-07-03T19:36:38Z

Ivan: /* Database Access */

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 11.x "bullseye"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-bullseye/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-stretch-testing/ ./ #XXX (no bullseye-specific repo yet) -testing only for now on deb 10, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
* See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.
* Example:
<pre>
DBI:Pg:dbname=freeside
freeside
db_password_if_set
</pre>

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Restart freeside =

* <code>/etc/init.d/freeside restart</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* <code>service apache2 restart</code>
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4:Documentation:InstallingOnDebian11

2024-07-03T19:34:27Z

Ivan: /* Configure package repositories */

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 11.x "bullseye"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-bullseye/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-stretch-testing/ ./ #XXX (no bullseye-specific repo yet) -testing only for now on deb 10, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
** See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Restart freeside =

* <code>/etc/init.d/freeside restart</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* <code>service apache2 restart</code>
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4:Documentation:InstallingOnDebian11

2024-07-03T19:34:10Z

Ivan: /* Configure package repositories */

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 11.x "bullseye"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-buster/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-stretch-testing/ ./ #XXX (no buster-specific repo yet) -testing only for now on deb 10, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
** See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Restart freeside =

* <code>/etc/init.d/freeside restart</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* <code>service apache2 restart</code>
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4:Documentation

2024-07-03T19:33:08Z

Ivan: /* Backend Installation */

= Note =

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

= Installation and upgrades =

== Backend Installation ==

=== Packages ===

* [[Freeside:4:Documentation:InstallingOnDebian10|Debian 10 "buster"]]
* [[Freeside:4:Documentation:InstallingOnDebian10|Debian 11 "bullseye"]]

=== Source ===

* [[Freeside:4:Documentation:Installation|New Installation]]
* [[Freeside:3:Documentation:RT Installation|Integrated RT Installation]]
* [[Freeside:3:Documentation:Torrus Installation|Integrated Torrus Installation]]

== Signup and Self-service installation ==

* [[Freeside:3:Documentation:Self-Service Installation|Signup/Self-service Installation]]
* [[Freeside:3:Documentation:Self-Service access without service|Self-Service access without package/service]]
* [[Freeside:3:Documentation:NG_Self-Service| Next generation self-service portal]] (Work in progress)

== Upgrading ==

* [[Freeside:4:Documentation:Upgrading|Upgrading from 3.3 or later to 4.x]]
* [[Freeside:3:Documentation:Upgrading|Upgrading between 4.x versions]]

= Users =

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

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Appointments]]

= Administrator =

== Reference ==

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

== New features in v4 ==

* [[Freeside:4:Documentation:Administrator:Multi-currency|Multi-currency]]
* Emails triggered by system log events can be set up at Configuration -> Miscellaneous -> System log emails

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Administrator:Fees|Automated fees]]
* [[Freeside:4:Documentation:Cacti|Cacti Integration]]
* [[Freeside:4:Documentation:MagicMail|MagicMail Integration]]

= Developer =

== Reference ==

* [[Freeside:3:Documentation:Developer|Developer's Guide]]
* [[Freeside:3:Documentation:Billing_Internals|Billing Internals]] (walkthrough of the core invoice generation code)

== New features in v4 ==

* [[Freeside:4:Documentation:Developer:Authentication_Plugins|Authentication Plugins]]
* [[Freeside:4:Documentation:TaxEngine|Tax Engines]]

= Accounting Guide =

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

= Misc old stuff =

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

= Changelog =

* [[Freeside:4.0:Changelog|4.0 Changelog]]
* [[Freeside:4.1:Changelog|4.1 Changelog]]
* [[Freeside:4.2:Changelog|4.2 Changelog]]
* [[Freeside:4.3:Changelog|4.3 Changelog]]

Freeside:4:Documentation:InstallingOnDebian11

2024-07-03T19:32:10Z

Ivan: Created page with "= Configure package repositories = * Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 10.x "buster"): <pre> deb [trusted=yes] http://pkg.freesi..."

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 10.x "buster"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-buster/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-stretch-testing/ ./ #XXX (no buster-specific repo yet) -testing only for now on deb 10, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
** See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Restart freeside =

* <code>/etc/init.d/freeside restart</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* <code>service apache2 restart</code>
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:3:Documentation:Administration

2022-11-10T22:48:01Z

Ivan: /* Resellers */

= 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:3: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:3: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:3: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:3: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:3: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:3: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:3:Documentation:Administration:opensrs.pm|opensrs.pm]]: OpenSRS integration
* sqlmail.pm: Real-time export to SQL-backed mail server

==svc_forward==
* artera_turbo.pm:
* [[Freeside:3: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:3: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:3: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:
* [[Freeside:Documentation:Administration:vitelity.pm|vitelity.pm]]: Vitelity provisioning

==svc_external==
* artera_turbo.pm:

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

= Services =

== Generic ==

=== Accounts (svc_acct) ===

Accounts - anything with a username (mailbox, shell, RADIUS, etc.)

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

=== Hardware (svc_hardware) ===

Equipment supplied to customers

=== External (svc_external) ===

Externally-tracked service

== Access ==

=== DSL (svc_dsl) ===

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

=== Broadband (svc_broadband) ===

Fixed wireless broadband

* [[Freeside:4:Documentation:Administration:svc_broadband.pm|svc_broadband.pm]]
* [[Freeside:4:Documentation:Administration:svc_broadband.pm#Automatically_Assign_IP_Addresses|Automatically Assign IP Addresses]]

=== Cable (svc_cable) ===

=== DISH Network (svc_dish) ===

== Telephony ==

=== Customer phone number / DID (svc_phone) ===

* [[Freeside:Documentation:Administration:Phone devices|Phone devices]]

=== Customer PBX (svc_pbx) ===

=== Phone circuit (svc_circuit) ===

== Hosting ==

=== Domains (svc_domain) ===

=== Certificate (svc_cert) ===

=== Forwards (svc_forward) ===

=== Mailing list (svc_mailinglist) ===

=== Site hosting (svc_www) ===

== Colocation ==

=== Customer router/switch port (svc_port) ===

= Packages =

{{Freeside:3:Documentation:Administration:pkg_category}}

== Price Plans ==

=== Common price plans ===

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

=== Wholesale price plans ===

* bulk

* [[Freeside:3:Documentation:Administration:Packages:Price_Plans:agent | agent]]
* [[Freeside:3: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:3:Documentation:Administration:Upselling | Upselling]]

= Customers =

== Address normalization ==

* Census Bureau - free, no account needed. To use, go to Configuration -> Settings, in the "UI" section, and set "address_standardize_method" to "U.S. Census Bureau".

* Postal Service - free, account required. To use, go http://www.usps.com/webtools/ register and agree not to use the API for batch purposes. Then, go to Configuration -> Settings, in the "UI" section, and set "address_standardize_method" to "U.S. Postal Serivce", and set "usps_webtools-userid" and "usps_webtools-password" to your credentials.

* Melissa WebSmart - paid commercial service. http://www.melissadata.com/ To use, after purchasing an account from MelissaData,go to Configuration -> Settings, in the "UI" section, and set "address_standardize_method" to "Melissa WebSmart", and set "melissa-userid" to your credentials. Optionally, "melissa-enable_geocoding" may be turned on to use Melissa for geolocation and census coding as well, instead of the default free services.

= Resellers =

=== Wholesaler configuration ===
[[Freeside:3:Documentation:Administration:Wholesaler|Using agents for setting up Wholesalers]]

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

Go to Configuration -> Ticketing -> Ticketing users
* Click on the Create link in the upper right hand corner
* Enter the same username as the Employee name above
* Enter any other information (Real name, Email address, etc. )
* Check both boxes in the access control box
* Click the Create button
(Be sure to add the ticketing user to the appropriate ticketing groups)

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

= Installers / Appointments =

== Installers ==

* Designate some employees as installers (Configuration -> Employees -> Employees)
* Edit their schedules (Configuration -> Employees -> Installer availability)

== Ticketing ==

* Setup a queue for appointments (installations, removals, etc.), or use existing per agent queues
* Make sure the installer employees can own / see / edit tickets in this
queue (add them to a ticketing group with OwnTicket / SeeQueue on that queue or global, etc.)
* not yet <strike>XXX future todo some sort of ill-defined thing with configuring a custom field to designate install / recall / service call / removal</strike>

== Packages ==

not yet; package(+location)-specific appointments are a future TODO
<strike>
* Setup a package category for packages that can schedule appointments
* In the package category, select a queue for appointments or pick "Agent-specific queue"
</strike>

== Employee rights ==

* Upgrade should do this / should be available in a default install, but may not be implemented yet
* Give one or more employee groups "View appointments" and "Make appointment" (in Customer package rights)

= 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:3: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:3: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:3: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>

== Taxes ==

[[Freeside:3:Documentation:Administration:Tax_Districts | District based taxes]]

== Payment Receipts ==

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

== Credit cards and Electronic checks ==
* [[Freeside:3:Documentation:Administration:Real-time_Processing | Real-time credit card and electronic check processing]]
* [[Freeside:3: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 =

These things should probably find a home properly filed in a section above.

== Invoicing and Payments ==

* Setting up [[Freeside:3:Documentation:Administration:Encrypted Credit Cards | Encrypted Credit Cards]] (default in new installs, highly recommended for older installs upgrading)
* Setting up [[Freeside:3:Documentation:Administration:Texas Tax | Texas Tax]]
* Need to print to Windows printers, and the PDF spool is not for you? Follow steps 1-4 of [http://iharder.sourceforge.net/current/macosx/winmacprinter/ Share Your Windows Printer].

== Refunds for automatic payments ==

A refund to an automatic payment can be made within the time limitation set by the payment gateway by using the refund link next to the payment:

<pre>05/19/2015 Payment by fs_queue (Credit card #411111xxxxxx1111) applied to Invoice #228 (05/19/15) (view receipt) (refund) (void) (unapply) - $24.60 $0.00</pre>

On the refund page the Amount defaults to the amount of the payment. If only a partial refund is to be made then change this to the proper amount:

<pre>
Refund
Date 05/19/2015
Amount $10.00 by Credit card
Reason Package amount incorrect
</pre>

For this example we will only refund a part of the payment as illustrated above. It is usually a good idea to add a Reason that provides additional information for the refund.

Once you have the refund fields filled out click the Post refund button

This will unapply the payment from the invoice leaving the balance of the payment available for application to an invoice:

<pre>
05/19/2015 Open Invoice #228 (Balance 25.21) (void)
( View invoice events ) $25.21 $25.21
05/19/2015 Payment by nkennedy (Credit card #411111xxxxxx1111)
10.00 refunded on 05/19/2015
15.21 unapplied
(view receipt) (apply) (refund) (void) - $25.21 $0.00
05/19/2015 Refund by nkennedy (Credit card #411111xxxxxx1111) (view receipt) $10.00 $10.00
</pre>

Use the apply link to apply the remaining payment to the invoice. This will bring up the Apply Payment window where you can select the invoice to apply the payment to:

<pre>
Payment #77
Date: 05/19/2015
Amount: $25.21
Unapplied amount: $15.21

Apply to:
Invoice: #228 - 05/19/2015 - $25.21
Amount: $15.21
</pre>

After you click the Apply button you are left with the original invoice with a balance due from the refunded payment:

<pre>
05/19/2015 Open Invoice #228 (Balance 10.00) (void)
( View invoice events ) $25.21 $25.21
05/19/2015 Payment by nkennedy (Credit card #411111xxxxxx1111)
10.00 refunded on 05/19/2015
15.21 applied to Invoice #228 (05/19/15)
(view receipt) (refund) (void) (unapply) - $25.21 $0.00
05/19/2015 Refund by nkennedy (Credit card #411111xxxxxx1111) (view receipt) $10.00 $10.00
</pre>

To balance the invoice you can use the Enter Credit link to issue a credit that can be applied to the invoice:

<pre>
Enter Credit

Date 05/19/2015 10:03:26 AM
Amount $10.00
Reason Package Error
Additional info Credit for package error
Auto-apply to invoices yes
</pre>

When entering the credit you can select a credit reason that was previously defined at Configuration -> Billing -> Credit Reasons or you can create a reason on the fly.
You can also add a small note in the "Additional info" field which will print on the customers invoice. Please keept this short as long text will get truncated on PDF invoices to prevent formatting issues.

Once the credit is applied the customers account will be balanced out:

<pre>
05/19/2015 Invoice #228 (Balance 0.00) (void)
( View invoice events ) $25.21 $25.21
05/19/2015 Payment by nkennedy (Credit card #411111xxxxxx1111)
10.00 refunded on 05/19/2015
15.21 applied to Invoice #228 (05/19/15)
(view receipt) (refund) (void) (unapply) - $25.21 $0.00
05/19/2015 Refund by nkennedy (Credit card #411111xxxxxx1111) (view receipt) $10.00 $10.00
05/19/2015 Credit by nkennedy (Package Error Credit for package error) applied to Invoice #228 (05/19/15) (delete) (unapply) (void) - $10.00 $0.00
</pre>

If you need to have taxes calculated as part of the refund you can start with issuing a credit using the Credit line items link. This will allow you to select the line item on the invoice and enter the amount to credit that entry.
Follow the rest of the instructions for re-applying the payment to the invoice and the left over balance is the amount you need to use after following the refund link on the payment.

== Commissions ==


* Setting up [[Freeside:3:Documentation:Administration:Commission|Commissions and Referrals]]

== VoIP ==

* Setting up [[Freeside:3:Documentation:Administration:VoIP | VoIP]]
* [[Simple Bulk DID Orders]]
* [[Bulk DID Orders]]
* [[Freeside:3:Documentation:Administration:VoIP:e911|e911 Providers]]

== RADIUS ==

* Setting up [[Freeside:3.0:Documentation:Administration:FreeRadius | FreeRadius]]

== Torrus Network monitoring ==

* [[Freeside:3:Documentation:Torrus_Installation | Installation]]
* [[Freeside:3:Documentation:Torrus_Administration | Administration]]

== System Log ==

The system log can be viewed by navigating the main menu to: Report -> Logs -> System logs

Freeside can be configured to generate E-Mail notices for system log entries.

=== To configure E-Mail Notices ===

# Navigate the main menu to Configuration -> Miscellaneous -> System log emails
# Click the ''Add log email condition'' link
# Enter the E-Mail address to receive notices
# Specify the Log Context and Minimum Log Level to generate notices
# Choose if notices must match the specific chosen context
# Click the ``Add log emailcondition`` button

'''Only match most specific context:''' Selecting this check box reduces the number of E-Mail events for some contexts. Log events are hierarchical. A specific log event may have multiple contexts. A single event may be both a ''daily'' event, and also a ''Cron::upload'' event, for example. With this checkbox selected, the example event would only trigger an E-Mail notification for the ''Cron::upload'' context, and not the ''daily'' context.

Change or remove the E-Mail notice by selecting a notice within the ''Log email condition'' configuration page

== Old / uncommon ==

* Setting up [[Freeside:3:Documentation:Administration:Time billing | Time billing]]
* Using a non-standard [[Freeside:3:Documentation:Administration:PostgreSQL_Schema | PostgreSQL Schema]]
* Setting up [[Freeside:3:Documentation:Administration:Slony | Slony replication and failover]] (old - PostgreSQL native replication is a more current solution)

{{ContextSensitiveHelp}}

Freeside:4.3:Changelog

2022-09-08T00:27:27Z

Ivan:

= Notes =

This is the changelog for the 4.3 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_4_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 4.3.
* Debian 9 (stretch) support has been added.
* Debian 10 (buster) support has been added.

= Employee security =

* Google Authenticator 2FA support for employee logins

= UI =

* More UI styling and cleanup

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* In suspension and cancellation popups, show information about which services will be unprovisioned to external systems.
* Option to carry discounts through package changes
* Improve bulk package edit UI
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Streamlined amount selection UI for payments
* Use new-style message templates for payment receipts
* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Discounts ==

* Discounts on one-time charges

== Invoices ==

* Option to relocate the payment coupon to the top
* Show taxes per section when using invoice sections
* Re-factored invoice substitutions to correct multiple edge cases with summaries, fees, sections, custom templates and custom substitutions.

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019, 2020. and 2021+
* 2022 update for FCC 477 reporting
* New customer referral report
* New customer time span report
* New future card charges report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Search payments by customer location fields
* Search by number of referred customers and their status
* Backdate FCC 477 deployment zones
* Search packages by suspension reasons
* Added revenue difference to package churn report
* Deposit slips

= VoIP/Telco =

* FreeSWITCH CDRs
* Asterisk v12 CDRs
* Broadsoft R22 CDRs
* Ooma integration
* Acme Packet CDRs
* ANI networks CDRs
* ThinQ CDRs
* TeleAPI CDRs
* Extended Vitelity integration with E911 and LNP (porting)
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Integration with [http://csilongwood.com/ Compliance Solutions] tax rating service as an alternative to SureTax or Avalara.
* Improved Washington state taxation
* Bulk edit tax rates
* Taxation option on pre-discount amounts

= Quotations =

* Add quotation description
* Show a total first payment possible range for prorated packages
* PDF and residential quotation fixes
* Add option for a default close date

= Customer self-service =

* Fix self-service contact login
* Directly change contact passwords in backend without an end-customer reset email
* New wordpress plugin, for adding self-service functionality to wordpress sites
* Option to disable changing electronic check information
* Option to disable package changes per agent

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Access control to disable new activity indicator in header
* Added AutoreplyOrCorrespondence template [[https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence]]
* Added ticket action Quiet Resolve
* Added ability to attach a file to Quick Ticket Creation
* Request Tracker updated from 4.2.13 to <strike>4.2.16</strike> 4.2.14
** [http://docs.bestpractical.com/release-notes/rt/4.2.14 4.2.14 Release Notes]
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.15 4.2.15 Release Notes]</strike> notyet
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.16 4.2.16 Release Notes]</strike> notyet

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services
* Email and RT ticket export hooks for Fiber, DSL and circuit services

= Billing events =

* New conditions: residential/commercial, number of referred customers, check customer tag (for all event types), contract end date
* Improved discount action: package class selection, once per customer option
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags
* New action: send SMS (via carrier email gateway)

= Misc =

* Fixed customer import
* Added contact import
* Fixed fees
* Added svc_realestate service for tracking real estate rentals
* API documentation now installed and viewable locally in each installation
* Configuration setting ("dashboard-topnote") to display at the top of the main page

Freeside:3.93:Changelog

2022-02-28T01:51:42Z

Ivan:

= Notes =

This is the changelog for the 3.93 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_3_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 3.93.
* Debian 9 (stretch) support has been added.

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* Option to carry discounts through package changes
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Invoices ==

* Show taxes per section when using invoice sections

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018-2022
* 2022 update for FCC 477 reporting
* New customer referral report
* New customer time span report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Added revenue difference to package churn report

= VoIP/Telco =

* ANI networks CDRs
* Broadsoft R22 CDRs
* ThinQ CDRs
* TelAPI CDRs
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Bulk edit tax rates

= Quotations =

* Add quotation description
* PDF quotation fixes
* Add option for a default close date

= Customer self-service =

* Directly change contact passwords in backend without an end-customer reset email
* Option to disable package changes per agent
* Option to disable changing electronic check information

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Added ability to attach a file to Quick Ticket Creation
* <strike>Request tracker updated from 4.0.24 to 4.0.25</strike> notyet
** [http://docs.bestpractical.com/release-notes/rt/4.0.25 4.0.25 Release Notes]

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services
* Email and RT ticket export hooks for Fiber, DSL and circuit services

= Billing events =

* New conditions: number of referred customers, check customer tag (for all event types), contract end date
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags

= Misc =

* Added contact import
* API documentation now installed and viewable locally in each installation

Freeside:4.3:Changelog

2022-02-28T01:51:37Z

Ivan:

= Notes =

This is the changelog for the 4.3 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_4_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 4.3.
* Debian 9 (stretch) support has been added.
* Debian 10 (buster) support has been added.

= UI =

* More UI styling and cleanup

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* In suspension and cancellation popups, show information about which services will be unprovisioned to external systems.
* Option to carry discounts through package changes
* Improve bulk package edit UI
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Streamlined amount selection UI for payments
* Use new-style message templates for payment receipts
* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Discounts ==

* Discounts on one-time charges

== Invoices ==

* Option to relocate the payment coupon to the top
* Show taxes per section when using invoice sections
* Re-factored invoice substitutions to correct multiple edge cases with summaries, fees, sections, custom templates and custom substitutions.

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019, 2020. and 2021+
* 2022 update for FCC 477 reporting
* New customer referral report
* New customer time span report
* New future card charges report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Search payments by customer location fields
* Search by number of referred customers and their status
* Backdate FCC 477 deployment zones
* Search packages by suspension reasons
* Added revenue difference to package churn report
* Deposit slips

= VoIP/Telco =

* FreeSWITCH CDRs
* Asterisk v12 CDRs
* Broadsoft R22 CDRs
* Ooma integration
* Acme Packet CDRs
* ANI networks CDRs
* ThinQ CDRs
* TeleAPI CDRs
* Extended Vitelity integration with E911 and LNP (porting)
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Integration with [http://csilongwood.com/ Compliance Solutions] tax rating service as an alternative to SureTax or Avalara.
* Improved Washington state taxation
* Bulk edit tax rates
* Taxation option on pre-discount amounts

= Quotations =

* Add quotation description
* Show a total first payment possible range for prorated packages
* PDF and residential quotation fixes
* Add option for a default close date

= Customer self-service =

* Fix self-service contact login
* Directly change contact passwords in backend without an end-customer reset email
* New wordpress plugin, for adding self-service functionality to wordpress sites
* Option to disable changing electronic check information
* Option to disable package changes per agent

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Access control to disable new activity indicator in header
* Added AutoreplyOrCorrespondence template [[https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence]]
* Added ticket action Quiet Resolve
* Added ability to attach a file to Quick Ticket Creation
* Request Tracker updated from 4.2.13 to <strike>4.2.16</strike> 4.2.14
** [http://docs.bestpractical.com/release-notes/rt/4.2.14 4.2.14 Release Notes]
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.15 4.2.15 Release Notes]</strike> notyet
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.16 4.2.16 Release Notes]</strike> notyet

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services
* Email and RT ticket export hooks for Fiber, DSL and circuit services

= Billing events =

* New conditions: residential/commercial, number of referred customers, check customer tag (for all event types), contract end date
* Improved discount action: package class selection, once per customer option
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags
* New action: send SMS (via carrier email gateway)

= Misc =

* Fixed customer import
* Added contact import
* Fixed fees
* Added svc_realestate service for tracking real estate rentals
* API documentation now installed and viewable locally in each installation
* Configuration setting ("dashboard-topnote") to display at the top of the main page

Freeside:4.3:Changelog

2021-04-22T02:57:56Z

Ivan:

= Notes =

This is the changelog for the 4.3 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_4_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 4.3.
* Debian 9 (stretch) support has been added.
* Debian 10 (buster) support has been added.

= UI =

* More UI styling and cleanup

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* In suspension and cancellation popups, show information about which services will be unprovisioned to external systems.
* Option to carry discounts through package changes
* Improve bulk package edit UI
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Streamlined amount selection UI for payments
* Use new-style message templates for payment receipts
* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Discounts ==

* Discounts on one-time charges

== Invoices ==

* Option to relocate the payment coupon to the top
* Show taxes per section when using invoice sections
* Re-factored invoice substitutions to correct multiple edge cases with summaries, fees, sections, custom templates and custom substitutions.

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019, 2020. and 2021+
* New customer referral report
* New customer time span report
* New future card charges report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Search payments by customer location fields
* Search by number of referred customers and their status
* Backdate FCC 477 deployment zones
* FCC 477 updates for current reporting
* Search packages by suspension reasons
* Added revenue difference to package churn report
* Deposit slips

= VoIP/Telco =

* FreeSWITCH CDRs
* Asterisk v12 CDRs
* Broadsoft R22 CDRs
* Ooma integration
* Acme Packet CDRs
* ANI networks CDRs
* ThinQ CDRs
* TeleAPI CDRs
* Extended Vitelity integration with E911 and LNP (porting)
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Integration with [http://csilongwood.com/ Compliance Solutions] tax rating service as an alternative to SureTax or Avalara.
* Improved Washington state taxation
* Bulk edit tax rates
* Taxation option on pre-discount amounts

= Quotations =

* Add quotation description
* Show a total first payment possible range for prorated packages
* PDF and residential quotation fixes
* Add option for a default close date

= Customer self-service =

* Fix self-service contact login
* Directly change contact passwords in backend without an end-customer reset email
* New wordpress plugin, for adding self-service functionality to wordpress sites
* Option to disable changing electronic check information
* Option to disable package changes per agent

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Access control to disable new activity indicator in header
* Added AutoreplyOrCorrespondence template [[https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence]]
* Added ticket action Quiet Resolve
* Added ability to attach a file to Quick Ticket Creation
* Request Tracker updated from 4.2.13 to <strike>4.2.16</strike> 4.2.14
** [http://docs.bestpractical.com/release-notes/rt/4.2.14 4.2.14 Release Notes]
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.15 4.2.15 Release Notes]</strike> notyet
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.16 4.2.16 Release Notes]</strike> notyet

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services
* Email and RT ticket export hooks for Fiber, DSL and circuit services

= Billing events =

* New conditions: residential/commercial, number of referred customers, check customer tag (for all event types), contract end date
* Improved discount action: package class selection, once per customer option
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags
* New action: send SMS (via carrier email gateway)

= Misc =

* Fixed customer import
* Added contact import
* Fixed fees
* Added svc_realestate service for tracking real estate rentals
* API documentation now installed and viewable locally in each installation
* Configuration setting ("dashboard-topnote") to display at the top of the main page

Freeside:4.3:Changelog

2021-04-22T02:42:20Z

Ivan: /* VoIP/Telco */

= Notes =

This is the changelog for the 4.3 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_4_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 4.3.
* Debian 9 (stretch) support has been added.
* Debian 10 (buster) support has been added.

= UI =

* More UI styling and cleanup

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* In suspension and cancellation popups, show information about which services will be unprovisioned to external systems.
* Option to carry discounts through package changes
* Improve bulk package edit UI
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Streamlined amount selection UI for payments
* Use new-style message templates for payment receipts
* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Discounts ==

* Discounts on one-time charges

== Invoices ==

* Option to relocate the payment coupon to the top
* Show taxes per section when using invoice sections
* Re-factored invoice substitutions to correct multiple edge cases with summaries, fees, sections, custom templates and custom substitutions.

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019, 2020. and 2021+
* New customer referral report
* New customer time span report
* New future card charges report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Search payments by customer location fields
* Search by number of referred customers and their status
* Backdate FCC 477 deployment zones
* Search packages by suspension reasons
* Added revenue difference to package churn report
* Deposit slips

= VoIP/Telco =

* FreeSWITCH CDRs
* Asterisk v12 CDRs
* Broadsoft R22 CDRs
* Ooma integration
* Acme Packet CDRs
* ANI networks CDRs
* ThinQ CDRs
* TeleAPI CDRs
* Extended Vitelity integration with E911 and LNP (porting)
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Integration with [http://csilongwood.com/ Compliance Solutions] tax rating service as an alternative to SureTax or Avalara.
* Improved Washington state taxation
* Bulk edit tax rates
* Taxation option on pre-discount amounts

= Quotations =

* Add quotation description
* Show a total first payment possible range for prorated packages
* PDF and residential quotation fixes
* Add option for a default close date

= Customer self-service =

* Fix self-service contact login
* Directly change contact passwords in backend without an end-customer reset email
* New wordpress plugin, for adding self-service functionality to wordpress sites
* Option to disable changing electronic check information
* Option to disable package changes per agent

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Access control to disable new activity indicator in header
* Added AutoreplyOrCorrespondence template [[https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence]]
* Added ticket action Quiet Resolve
* Added ability to attach a file to Quick Ticket Creation
* Request Tracker updated from 4.2.13 to <strike>4.2.16</strike> 4.2.14
** [http://docs.bestpractical.com/release-notes/rt/4.2.14 4.2.14 Release Notes]
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.15 4.2.15 Release Notes]</strike> notyet
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.16 4.2.16 Release Notes]</strike> notyet

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services
* Email and RT ticket export hooks for Fiber, DSL and circuit services

= Billing events =

* New conditions: residential/commercial, number of referred customers, check customer tag (for all event types), contract end date
* Improved discount action: package class selection, once per customer option
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags
* New action: send SMS (via carrier email gateway)

= Misc =

* Fixed customer import
* Added contact import
* Fixed fees
* Added svc_realestate service for tracking real estate rentals
* API documentation now installed and viewable locally in each installation
* Configuration setting ("dashboard-topnote") to display at the top of the main page

Freeside:4.3:Changelog

2021-04-22T02:41:52Z

Ivan: /* Reporting */

= Notes =

This is the changelog for the 4.3 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_4_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 4.3.
* Debian 9 (stretch) support has been added.
* Debian 10 (buster) support has been added.

= UI =

* More UI styling and cleanup

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* In suspension and cancellation popups, show information about which services will be unprovisioned to external systems.
* Option to carry discounts through package changes
* Improve bulk package edit UI
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Streamlined amount selection UI for payments
* Use new-style message templates for payment receipts
* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Discounts ==

* Discounts on one-time charges

== Invoices ==

* Option to relocate the payment coupon to the top
* Show taxes per section when using invoice sections
* Re-factored invoice substitutions to correct multiple edge cases with summaries, fees, sections, custom templates and custom substitutions.

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019, 2020. and 2021+
* New customer referral report
* New customer time span report
* New future card charges report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Search payments by customer location fields
* Search by number of referred customers and their status
* Backdate FCC 477 deployment zones
* Search packages by suspension reasons
* Added revenue difference to package churn report
* Deposit slips

= VoIP/Telco =

* FreeSWITCH CDRs
* Asterisk v12 CDRs
* Broadsoft R22 CDRs
* Ooma integration
* Acme Packet CDRs
* ANI networks CDRs
* ThinQ CDRs
* TelAPI CDRs
* Extended Vitelity integration with E911 and LNP (porting)
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Integration with [http://csilongwood.com/ Compliance Solutions] tax rating service as an alternative to SureTax or Avalara.
* Improved Washington state taxation
* Bulk edit tax rates
* Taxation option on pre-discount amounts

= Quotations =

* Add quotation description
* Show a total first payment possible range for prorated packages
* PDF and residential quotation fixes
* Add option for a default close date

= Customer self-service =

* Fix self-service contact login
* Directly change contact passwords in backend without an end-customer reset email
* New wordpress plugin, for adding self-service functionality to wordpress sites
* Option to disable changing electronic check information
* Option to disable package changes per agent

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Access control to disable new activity indicator in header
* Added AutoreplyOrCorrespondence template [[https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence]]
* Added ticket action Quiet Resolve
* Added ability to attach a file to Quick Ticket Creation
* Request Tracker updated from 4.2.13 to <strike>4.2.16</strike> 4.2.14
** [http://docs.bestpractical.com/release-notes/rt/4.2.14 4.2.14 Release Notes]
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.15 4.2.15 Release Notes]</strike> notyet
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.16 4.2.16 Release Notes]</strike> notyet

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services
* Email and RT ticket export hooks for Fiber, DSL and circuit services

= Billing events =

* New conditions: residential/commercial, number of referred customers, check customer tag (for all event types), contract end date
* Improved discount action: package class selection, once per customer option
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags
* New action: send SMS (via carrier email gateway)

= Misc =

* Fixed customer import
* Added contact import
* Fixed fees
* Added svc_realestate service for tracking real estate rentals
* API documentation now installed and viewable locally in each installation
* Configuration setting ("dashboard-topnote") to display at the top of the main page

Freeside:4.3:Changelog

2021-02-12T01:07:56Z

Ivan:

= Notes =

This is the changelog for the 4.3 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_4_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 4.3.
* Debian 9 (stretch) support has been added.
* Debian 10 (buster) support has been added.

= UI =

* More UI styling and cleanup

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* In suspension and cancellation popups, show information about which services will be unprovisioned to external systems.
* Option to carry discounts through package changes
* Improve bulk package edit UI
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Streamlined amount selection UI for payments
* Use new-style message templates for payment receipts
* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Discounts ==

* Discounts on one-time charges

== Invoices ==

* Option to relocate the payment coupon to the top
* Show taxes per section when using invoice sections
* Re-factored invoice substitutions to correct multiple edge cases with summaries, fees, sections, custom templates and custom substitutions.

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019, and 2020+
* New customer referral report
* New customer time span report
* New future card charges report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Search payments by customer location fields
* Search by number of referred customers and their status
* Backdate FCC 477 deployment zones
* Search packages by suspension reasons
* Added revenue difference to package churn report
* Deposit slips

= VoIP/Telco =

* FreeSWITCH CDRs
* Asterisk v12 CDRs
* Broadsoft R22 CDRs
* Ooma integration
* Acme Packet CDRs
* ANI networks CDRs
* ThinQ CDRs
* TelAPI CDRs
* Extended Vitelity integration with E911 and LNP (porting)
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Integration with [http://csilongwood.com/ Compliance Solutions] tax rating service as an alternative to SureTax or Avalara.
* Improved Washington state taxation
* Bulk edit tax rates
* Taxation option on pre-discount amounts

= Quotations =

* Add quotation description
* Show a total first payment possible range for prorated packages
* PDF and residential quotation fixes
* Add option for a default close date

= Customer self-service =

* Fix self-service contact login
* Directly change contact passwords in backend without an end-customer reset email
* New wordpress plugin, for adding self-service functionality to wordpress sites
* Option to disable changing electronic check information
* Option to disable package changes per agent

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Access control to disable new activity indicator in header
* Added AutoreplyOrCorrespondence template [[https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence]]
* Added ticket action Quiet Resolve
* Added ability to attach a file to Quick Ticket Creation
* Request Tracker updated from 4.2.13 to <strike>4.2.16</strike> 4.2.14
** [http://docs.bestpractical.com/release-notes/rt/4.2.14 4.2.14 Release Notes]
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.15 4.2.15 Release Notes]</strike> notyet
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.16 4.2.16 Release Notes]</strike> notyet

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services
* Email and RT ticket export hooks for Fiber, DSL and circuit services

= Billing events =

* New conditions: residential/commercial, number of referred customers, check customer tag (for all event types), contract end date
* Improved discount action: package class selection, once per customer option
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags
* New action: send SMS (via carrier email gateway)

= Misc =

* Fixed customer import
* Added contact import
* Fixed fees
* Added svc_realestate service for tracking real estate rentals
* API documentation now installed and viewable locally in each installation
* Configuration setting ("dashboard-topnote") to display at the top of the main page

Freeside:4:Documentation:InstallingOnDebian9

2020-05-20T20:42:36Z

Ivan: /* Install */

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 9.x "stretch"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-stretch/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-stretch-testing/ ./ #XXX -testing only for now on deb 9, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui libparams-classify-perl=0.013-5.3
apt-mark hold freeside freeside-lib freeside-webui libparams-classify-perl
aptitude hold freeside freeside-lib freeside-webui libparams-classify-perl
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
** See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Restart freeside =

* <code>/etc/init.d/freeside restart</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* Restart Apache
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4.3:Changelog

2020-05-19T00:43:28Z

Ivan: /* Ticketing */

= Notes =

This is the changelog for the 4.3 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_4_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 4.3.
* Debian 9 (stretch) support has been added.
* Debian 10 (buster) support has been added.

= UI =

* More UI styling and cleanup

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* In suspension and cancellation popups, show information about which services will be unprovisioned to external systems.
* Option to carry discounts through package changes
* Improve bulk package edit UI
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Streamlined amount selection UI for payments
* Use new-style message templates for payment receipts
* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Discounts ==

* Discounts on one-time charges

== Invoices ==

* Option to relocate the payment coupon to the top
* Show taxes per section when using invoice sections
* Re-factored invoice substitutions to correct multiple edge cases with summaries, fees, sections, custom templates and custom substitutions.

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019, and 2020+
* New customer referral report
* New customer time span report
* New future card charges report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Search payments by customer location fields
* Search by number of referred customers and their status
* Backdate FCC 477 deployment zones
* Search packages by suspension reasons
* Added revenue difference to package churn report

= VoIP/Telco =

* FreeSWITCH CDRs
* Asterisk v12 CDRs
* Broadsoft R22 CDRs
* Ooma integration
* Acme Packet CDRs
* ANI networks CDRs
* ThinQ CDRs
* TelAPI CDRs
* Extended Vitelity integration with E911 and LNP (porting)
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Integration with [http://csilongwood.com/ Compliance Solutions] tax rating service as an alternative to SureTax or Avalara.
* Improved Washington state taxation
* Bulk edit tax rates
* Taxation option on pre-discount amounts

= Quotations =

* Add quotation description
* Show a total first payment possible range for prorated packages
* PDF and residential quotation fixes
* Add option for a default close date

= Customer self-service =

* Fix self-service contact login
* Directly change contact passwords in backend without an end-customer reset email
* New wordpress plugin, for adding self-service functionality to wordpress sites
* Option to disable changing electronic check information
* Option to disable package changes per agent

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Access control to disable new activity indicator in header
* Added AutoreplyOrCorrespondence template [[https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence]]
* Added ticket action Quiet Resolve
* Added ability to attach a file to Quick Ticket Creation
* Request Tracker updated from 4.2.13 to <strike>4.2.16</strike> 4.2.14
** [http://docs.bestpractical.com/release-notes/rt/4.2.14 4.2.14 Release Notes]
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.15 4.2.15 Release Notes]</strike> notyet
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.16 4.2.16 Release Notes]</strike> notyet

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services
* Email and RT ticket export hooks for Fiber, DSL and circuit services

= Billing events =

* New conditions: residential/commercial, number of referred customers, check customer tag (for all event types), contract end date
* Improved discount action: package class selection, once per customer option
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags
* New action: send SMS (via carrier email gateway)

= Misc =

* Fixed customer import
* Added contact import
* Fixed fees
* Added svc_realestate service for tracking real estate rentals
* API documentation now installed and viewable locally in each installation

Freeside:4.3:Changelog

2020-05-19T00:43:16Z

Ivan: /* Ticketing */

= Notes =

This is the changelog for the 4.3 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_4_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 4.3.
* Debian 9 (stretch) support has been added.
* Debian 10 (buster) support has been added.

= UI =

* More UI styling and cleanup

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* In suspension and cancellation popups, show information about which services will be unprovisioned to external systems.
* Option to carry discounts through package changes
* Improve bulk package edit UI
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Streamlined amount selection UI for payments
* Use new-style message templates for payment receipts
* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Discounts ==

* Discounts on one-time charges

== Invoices ==

* Option to relocate the payment coupon to the top
* Show taxes per section when using invoice sections
* Re-factored invoice substitutions to correct multiple edge cases with summaries, fees, sections, custom templates and custom substitutions.

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019, and 2020+
* New customer referral report
* New customer time span report
* New future card charges report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Search payments by customer location fields
* Search by number of referred customers and their status
* Backdate FCC 477 deployment zones
* Search packages by suspension reasons
* Added revenue difference to package churn report

= VoIP/Telco =

* FreeSWITCH CDRs
* Asterisk v12 CDRs
* Broadsoft R22 CDRs
* Ooma integration
* Acme Packet CDRs
* ANI networks CDRs
* ThinQ CDRs
* TelAPI CDRs
* Extended Vitelity integration with E911 and LNP (porting)
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Integration with [http://csilongwood.com/ Compliance Solutions] tax rating service as an alternative to SureTax or Avalara.
* Improved Washington state taxation
* Bulk edit tax rates
* Taxation option on pre-discount amounts

= Quotations =

* Add quotation description
* Show a total first payment possible range for prorated packages
* PDF and residential quotation fixes
* Add option for a default close date

= Customer self-service =

* Fix self-service contact login
* Directly change contact passwords in backend without an end-customer reset email
* New wordpress plugin, for adding self-service functionality to wordpress sites
* Option to disable changing electronic check information
* Option to disable package changes per agent

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Access control to disable new activity indicator in header
* Added AutoreplyOrCorrespondence template [[https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence]]
* Added ticket action Quiet Resolve
* Added ability to attach a file to Quick Ticket Creation
* Request Tracker updated from 4.2.13 to <strike>4.2.16</strike>4.2.14
** [http://docs.bestpractical.com/release-notes/rt/4.2.14 4.2.14 Release Notes]
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.15 4.2.15 Release Notes]</strike> notyet
** <strike>[http://docs.bestpractical.com/release-notes/rt/4.2.16 4.2.16 Release Notes]</strike> notyet

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services
* Email and RT ticket export hooks for Fiber, DSL and circuit services

= Billing events =

* New conditions: residential/commercial, number of referred customers, check customer tag (for all event types), contract end date
* Improved discount action: package class selection, once per customer option
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags
* New action: send SMS (via carrier email gateway)

= Misc =

* Fixed customer import
* Added contact import
* Fixed fees
* Added svc_realestate service for tracking real estate rentals
* API documentation now installed and viewable locally in each installation

Freeside:4.3:Changelog

2020-05-19T00:39:23Z

Ivan: /* Provisioning exports */

= Notes =

This is the changelog for the 4.3 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_4_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 4.3.
* Debian 9 (stretch) support has been added.
* Debian 10 (buster) support has been added.

= UI =

* More UI styling and cleanup

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* In suspension and cancellation popups, show information about which services will be unprovisioned to external systems.
* Option to carry discounts through package changes
* Improve bulk package edit UI
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Streamlined amount selection UI for payments
* Use new-style message templates for payment receipts
* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Discounts ==

* Discounts on one-time charges

== Invoices ==

* Option to relocate the payment coupon to the top
* Show taxes per section when using invoice sections
* Re-factored invoice substitutions to correct multiple edge cases with summaries, fees, sections, custom templates and custom substitutions.

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019, and 2020+
* New customer referral report
* New customer time span report
* New future card charges report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Search payments by customer location fields
* Search by number of referred customers and their status
* Backdate FCC 477 deployment zones
* Search packages by suspension reasons
* Added revenue difference to package churn report

= VoIP/Telco =

* FreeSWITCH CDRs
* Asterisk v12 CDRs
* Broadsoft R22 CDRs
* Ooma integration
* Acme Packet CDRs
* ANI networks CDRs
* ThinQ CDRs
* TelAPI CDRs
* Extended Vitelity integration with E911 and LNP (porting)
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Integration with [http://csilongwood.com/ Compliance Solutions] tax rating service as an alternative to SureTax or Avalara.
* Improved Washington state taxation
* Bulk edit tax rates
* Taxation option on pre-discount amounts

= Quotations =

* Add quotation description
* Show a total first payment possible range for prorated packages
* PDF and residential quotation fixes
* Add option for a default close date

= Customer self-service =

* Fix self-service contact login
* Directly change contact passwords in backend without an end-customer reset email
* New wordpress plugin, for adding self-service functionality to wordpress sites
* Option to disable changing electronic check information
* Option to disable package changes per agent

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Access control to disable new activity indicator in header
* Added AutoreplyOrCorrespondence template [[https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence]]
* Added ticket action Quiet Resolve
* Added ability to attach a file to Quick Ticket Creation
* Request Tracker updated from 4.2.13 to 4.2.14
** [http://docs.bestpractical.com/release-notes/rt/4.2.14 4.2.14 Release Notes]

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services
* Email and RT ticket export hooks for Fiber, DSL and circuit services

= Billing events =

* New conditions: residential/commercial, number of referred customers, check customer tag (for all event types), contract end date
* Improved discount action: package class selection, once per customer option
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags
* New action: send SMS (via carrier email gateway)

= Misc =

* Fixed customer import
* Added contact import
* Fixed fees
* Added svc_realestate service for tracking real estate rentals
* API documentation now installed and viewable locally in each installation

Freeside:3.93:Changelog

2020-05-19T00:39:11Z

Ivan: /* Provisioning exports */

= Notes =

This is the changelog for the 3.93 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_3_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 3.93.
* Debian 9 (stretch) support has been added.

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* Option to carry discounts through package changes
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Invoices ==

* Show taxes per section when using invoice sections

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019 and 2020
* New customer referral report
* New customer time span report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Added revenue difference to package churn report

= VoIP/Telco =

* ANI networks CDRs
* Broadsoft R22 CDRs
* ThinQ CDRs
* TelAPI CDRs
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Bulk edit tax rates

= Quotations =

* Add quotation description
* PDF quotation fixes
* Add option for a default close date

= Customer self-service =

* Directly change contact passwords in backend without an end-customer reset email
* Option to disable package changes per agent
* Option to disable changing electronic check information

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Added ability to attach a file to Quick Ticket Creation
* <strike>Request tracker updated from 4.0.24 to 4.0.25</strike> notyet
** [http://docs.bestpractical.com/release-notes/rt/4.0.25 4.0.25 Release Notes]

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services
* Email and RT ticket export hooks for Fiber, DSL and circuit services

= Billing events =

* New conditions: number of referred customers, check customer tag (for all event types), contract end date
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags

= Misc =

* Added contact import
* API documentation now installed and viewable locally in each installation

Freeside:4.3:Changelog

2020-05-19T00:37:54Z

Ivan: /* Packages */

= Notes =

This is the changelog for the 4.3 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_4_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 4.3.
* Debian 9 (stretch) support has been added.
* Debian 10 (buster) support has been added.

= UI =

* More UI styling and cleanup

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* In suspension and cancellation popups, show information about which services will be unprovisioned to external systems.
* Option to carry discounts through package changes
* Improve bulk package edit UI
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Streamlined amount selection UI for payments
* Use new-style message templates for payment receipts
* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Discounts ==

* Discounts on one-time charges

== Invoices ==

* Option to relocate the payment coupon to the top
* Show taxes per section when using invoice sections
* Re-factored invoice substitutions to correct multiple edge cases with summaries, fees, sections, custom templates and custom substitutions.

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019, and 2020+
* New customer referral report
* New customer time span report
* New future card charges report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Search payments by customer location fields
* Search by number of referred customers and their status
* Backdate FCC 477 deployment zones
* Search packages by suspension reasons
* Added revenue difference to package churn report

= VoIP/Telco =

* FreeSWITCH CDRs
* Asterisk v12 CDRs
* Broadsoft R22 CDRs
* Ooma integration
* Acme Packet CDRs
* ANI networks CDRs
* ThinQ CDRs
* TelAPI CDRs
* Extended Vitelity integration with E911 and LNP (porting)
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Integration with [http://csilongwood.com/ Compliance Solutions] tax rating service as an alternative to SureTax or Avalara.
* Improved Washington state taxation
* Bulk edit tax rates
* Taxation option on pre-discount amounts

= Quotations =

* Add quotation description
* Show a total first payment possible range for prorated packages
* PDF and residential quotation fixes
* Add option for a default close date

= Customer self-service =

* Fix self-service contact login
* Directly change contact passwords in backend without an end-customer reset email
* New wordpress plugin, for adding self-service functionality to wordpress sites
* Option to disable changing electronic check information
* Option to disable package changes per agent

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Access control to disable new activity indicator in header
* Added AutoreplyOrCorrespondence template [[https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence]]
* Added ticket action Quiet Resolve
* Added ability to attach a file to Quick Ticket Creation
* Request Tracker updated from 4.2.13 to 4.2.14
** [http://docs.bestpractical.com/release-notes/rt/4.2.14 4.2.14 Release Notes]

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services

= Billing events =

* New conditions: residential/commercial, number of referred customers, check customer tag (for all event types), contract end date
* Improved discount action: package class selection, once per customer option
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags
* New action: send SMS (via carrier email gateway)

= Misc =

* Fixed customer import
* Added contact import
* Fixed fees
* Added svc_realestate service for tracking real estate rentals
* API documentation now installed and viewable locally in each installation

Freeside:3.93:Changelog

2020-05-19T00:37:32Z

Ivan: /* Packages */

= Notes =

This is the changelog for the 3.93 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_3_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 3.93.
* Debian 9 (stretch) support has been added.

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* Option to carry discounts through package changes
* Release held packages upon unsuspension
* Bulk package cancellation

== Payments ==

* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Invoices ==

* Show taxes per section when using invoice sections

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019 and 2020
* New customer referral report
* New customer time span report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Added revenue difference to package churn report

= VoIP/Telco =

* ANI networks CDRs
* Broadsoft R22 CDRs
* ThinQ CDRs
* TelAPI CDRs
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Bulk edit tax rates

= Quotations =

* Add quotation description
* PDF quotation fixes
* Add option for a default close date

= Customer self-service =

* Directly change contact passwords in backend without an end-customer reset email
* Option to disable package changes per agent
* Option to disable changing electronic check information

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Added ability to attach a file to Quick Ticket Creation
* <strike>Request tracker updated from 4.0.24 to 4.0.25</strike> notyet
** [http://docs.bestpractical.com/release-notes/rt/4.0.25 4.0.25 Release Notes]

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services

= Billing events =

* New conditions: number of referred customers, check customer tag (for all event types), contract end date
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags

= Misc =

* Added contact import
* API documentation now installed and viewable locally in each installation

Freeside:4.3:Changelog

2020-05-19T00:36:58Z

Ivan: /* Packages */

= Notes =

This is the changelog for the 4.3 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_4_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 4.3.
* Debian 9 (stretch) support has been added.
* Debian 10 (buster) support has been added.

= UI =

* More UI styling and cleanup

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* In suspension and cancellation popups, show information about which services will be unprovisioned to external systems.
* Option to carry discounts through package changes
* Improve bulk package edit UI
* Bulk package cancellation

== Payments ==

* Streamlined amount selection UI for payments
* Use new-style message templates for payment receipts
* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Discounts ==

* Discounts on one-time charges

== Invoices ==

* Option to relocate the payment coupon to the top
* Show taxes per section when using invoice sections
* Re-factored invoice substitutions to correct multiple edge cases with summaries, fees, sections, custom templates and custom substitutions.

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019, and 2020+
* New customer referral report
* New customer time span report
* New future card charges report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Search payments by customer location fields
* Search by number of referred customers and their status
* Backdate FCC 477 deployment zones
* Search packages by suspension reasons
* Added revenue difference to package churn report

= VoIP/Telco =

* FreeSWITCH CDRs
* Asterisk v12 CDRs
* Broadsoft R22 CDRs
* Ooma integration
* Acme Packet CDRs
* ANI networks CDRs
* ThinQ CDRs
* TelAPI CDRs
* Extended Vitelity integration with E911 and LNP (porting)
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Integration with [http://csilongwood.com/ Compliance Solutions] tax rating service as an alternative to SureTax or Avalara.
* Improved Washington state taxation
* Bulk edit tax rates
* Taxation option on pre-discount amounts

= Quotations =

* Add quotation description
* Show a total first payment possible range for prorated packages
* PDF and residential quotation fixes
* Add option for a default close date

= Customer self-service =

* Fix self-service contact login
* Directly change contact passwords in backend without an end-customer reset email
* New wordpress plugin, for adding self-service functionality to wordpress sites
* Option to disable changing electronic check information
* Option to disable package changes per agent

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Access control to disable new activity indicator in header
* Added AutoreplyOrCorrespondence template [[https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence https://rt-wiki.bestpractical.com/wiki/AutoreplyOrCorrespondence]]
* Added ticket action Quiet Resolve
* Added ability to attach a file to Quick Ticket Creation
* Request Tracker updated from 4.2.13 to 4.2.14
** [http://docs.bestpractical.com/release-notes/rt/4.2.14 4.2.14 Release Notes]

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services

= Billing events =

* New conditions: residential/commercial, number of referred customers, check customer tag (for all event types), contract end date
* Improved discount action: package class selection, once per customer option
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags
* New action: send SMS (via carrier email gateway)

= Misc =

* Fixed customer import
* Added contact import
* Fixed fees
* Added svc_realestate service for tracking real estate rentals
* API documentation now installed and viewable locally in each installation

Freeside:3.93:Changelog

2020-05-19T00:36:46Z

Ivan: /* Packages */

= Notes =

This is the changelog for the 3.93 release.

For a more detailed, raw log of changes, see [http://freeside.biz/gitweb/?p=freeside.git;a=shortlog;h=refs/heads/FREESIDE_3_BRANCH the git log]

= OS Support =

* Debian 7 (wheezy) support has been dropped. Please upgrade to Debian 8 (jessie) before upgrading to 3.93.
* Debian 9 (stretch) support has been added.

= Customers =

== Locations ==

* Census block coding: Fix map-based census coding for unknown locations (previously used the US Census service site which is now gone, built an internal re-implementation)
* Google maps integration fixes for new API key requirements (also need to put a card on file and enable with Google)

== Packages ==

* Option to carry discounts through package changes
* Bulk package cancellation

== Payments ==

* Option for flat credit card surcharge in addition to percentage
* Option to surcharge for back-office payment processing (i.e. for a pay-by-phone "convenience fee")

== Invoices ==

* Show taxes per section when using invoice sections

== Attachments ==

* Optimized attachment upload, allowing larger attachments

== Change history ==

* Included notes, tags and contact changes

= Reporting =

* Include 2018, 2019 and 2020
* New customer referral report
* New customer time span report
* New event fee report
* Improved customer contact report
* Improved wireless broadband service report
* Added revenue difference to package churn report

= VoIP/Telco =

* ANI networks CDRs
* Broadsoft R22 CDRs
* ThinQ CDRs
* TelAPI CDRs
* Update VoIP Innovations CDR import for new hostname and SSL requirement
* Option to mark CDRs for reprocessing when voiding an invoice

= Taxation =

* Bulk edit tax rates

= Quotations =

* Add quotation description
* PDF quotation fixes
* Add option for a default close date

= Customer self-service =

* Directly change contact passwords in backend without an end-customer reset email
* Option to disable package changes per agent
* Option to disable changing electronic check information

= Ticketing =

* Automatically create a customer contact for new ticketing Requestors
* Added ability to attach a file to Quick Ticket Creation
* <strike>Request tracker updated from 4.0.24 to 4.0.25</strike> notyet
** [http://docs.bestpractical.com/release-notes/rt/4.0.25 4.0.25 Release Notes]

= Provisioning exports =

* Saisei integration
* Expect-style SSH scripting for interacting with remote systems which cannot run scripts (e.g. Cisco routers)
* HTTP/HTTPS export hooks for Fiber, DSL, cable, phone, circuit, hardware and svc_external services

= Billing events =

* New conditions: number of referred customers, check customer tag (for all event types), contract end date
* Made HTTP/HTTPS POST and email actions available for all event types
* New actions: add and remove customer tags

= Misc =

* Added contact import
* API documentation now installed and viewable locally in each installation

Freeside:4:Documentation

2020-04-27T05:11:45Z

Ivan: /* Backend Installation */

= Note =

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

= Installation and upgrades =

== Backend Installation ==

=== Packages ===

* [[Freeside:4:Documentation:InstallingOnDebian9|Debian 9 "stretch"]]
* [[Freeside:4:Documentation:InstallingOnDebian10|Debian 10 "buster"]]

=== Source ===

* [[Freeside:4:Documentation:Installation|New Installation]]
* [[Freeside:3:Documentation:RT Installation|Integrated RT Installation]]
* [[Freeside:3:Documentation:Torrus Installation|Integrated Torrus Installation]]

== Signup and Self-service installation ==

* [[Freeside:3:Documentation:Self-Service Installation|Signup/Self-service Installation]]
* [[Freeside:3:Documentation:Self-Service access without service|Self-Service access without package/service]]
* [[Freeside:3:Documentation:NG_Self-Service| Next generation self-service portal]] (Work in progress)

== Upgrading ==

* [[Freeside:4:Documentation:Upgrading|Upgrading from 3.3 or later to 4.x]]
* [[Freeside:3:Documentation:Upgrading|Upgrading between 4.x versions]]

= Users =

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

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Appointments]]

= Administrator =

== Reference ==

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

== New features in v4 ==

* [[Freeside:4:Documentation:Administrator:Multi-currency|Multi-currency]]
* Emails triggered by system log events can be set up at Configuration -> Miscellaneous -> System log emails

== Features in v3 and v4 that somehow got documented here ==

* [[Freeside:4:Documentation:Administrator:Fees|Automated fees]]
* [[Freeside:4:Documentation:Cacti|Cacti Integration]]
* [[Freeside:4:Documentation:MagicMail|MagicMail Integration]]

= Developer =

== Reference ==

* [[Freeside:3:Documentation:Developer|Developer's Guide]]
* [[Freeside:3:Documentation:Billing_Internals|Billing Internals]] (walkthrough of the core invoice generation code)

== New features in v4 ==

* [[Freeside:4:Documentation:Developer:Authentication_Plugins|Authentication Plugins]]
* [[Freeside:4:Documentation:TaxEngine|Tax Engines]]

= Accounting Guide =

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

= Misc old stuff =

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

= Changelog =

* [[Freeside:4.0:Changelog|4.0 Changelog]]
* [[Freeside:4.1:Changelog|4.1 Changelog]]
* [[Freeside:4.2:Changelog|4.2 Changelog]]
* [[Freeside:4.3:Changelog|4.3 Changelog]]

Freeside:4:Documentation:InstallingOnDebian10

2020-04-26T22:13:43Z

Ivan:

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 10.x "buster"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-buster/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-stretch-testing/ ./ #XXX (no buster-specific repo yet) -testing only for now on deb 10, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
** See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Restart freeside =

* <code>/etc/init.d/freeside restart</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* <code>service apache2 restart</code>
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4:Documentation:InstallingOnDebian10

2020-04-26T00:18:25Z

Ivan: /* Apache & Web GUI */

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 9.x "stretch"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-buster/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-buster-testing/ ./ #XXX -testing only for now on deb 10, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
** See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Restart freeside =

* <code>/etc/init.d/freeside restart</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* <code>service apache2 restart</code>
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4:Documentation:InstallingOnDebian10

2020-04-26T00:12:03Z

Ivan: /* Install */

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 9.x "stretch"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-buster/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-buster-testing/ ./ #XXX -testing only for now on deb 10, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
aptitude hold 'freeside*'
apt-mark hold 'freeside*'
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
** See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Restart freeside =

* <code>/etc/init.d/freeside restart</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* Restart Apache
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.

Freeside:4:Documentation:Installation

2020-04-11T21:15:50Z

Ivan: /* Apache & Web GUI */

== Introduction ==

These are from-scratch installation instructions for the raw source code. They are suitable for intermediate-to-advanced sysadmins. Folks looking for easy installation are advised to try the VMware appliance or Debian packages instead.

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

== Prerequisites ==

=== Packages ===

* [http://www.perl.org/ Perl], minimum version 5.10.1 (minimum version regularly tested is 5.14.2)
* [http://httpd.apache.org/ Apache], SSL highly recommended
* [http://perl.apache.org/ mod_perl]
** 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.
** [http://www.mysql.com MySQL] and [http://www.mariadb.org/ MariaDB] was previously supported, but is not currently maintained in v4. Code contributions or commercial sponsorship are welcome to bring this support up-to-date.

''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.''

* TeX (teTeX / TeX Live) and Ghostscript (included with most distributions) (Optional, enables typeset invoices)
* [http://www.qsl.net/kd2bd/splat.html Splat!] (Optional, enables WISP coverage mapping)

=== Perl modules ===

==== Popular modules ====

These modules are included in most distributions.


* [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/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/DateManip Date::Manip]
* [http://search.cpan.org/dist/DateTime DateTime]
* [http://search.cpan.org/dist/Frontier-RPC Frontier::RPC2]
* [http://search.cpan.org/dist/GD-Barcode GD::Barcode]
* [http://search.cpan.org/dist/IPC-Run IPC::Run]
* [http://search.cpan.org/dist/IPC-Run3 IPC::Run3]
* [http://search.cpan.org/dist/JSON JSON]
* [http://search.cpan.org/dist/MailTools MailTools] (CPAN: "install Mail::Internet")
* [http://search.cpan.org/dist/MIME-tools MIME::Tools] (Note: do not use version 5.423)
* [http://search.cpan.org/dist/Net-SNMP Net::SNMP]
* [http://search.cpan.org/dist/SOAP-Lite SOAP::Lite]
* [http://search.cpan.org/dist/TimeDate TimeDate] (CPAN: "install Date::Format")
* [http://search.cpan.org/dist/XML-LibXML XML::LibXML]
* [http://search.cpan.org/dist/XML-Simple XML::Simple]

==== Common modules ====

These modules are included in many distributions.


* [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/DateTime-Format-Strptime DateTime::Format::Strptime]
* [http://search.cpan.org/dist/DateTime-Format-Natural DateTime-Format-Natural]
* [http://search.cpan.org/dist/Email-Sender Email::Sender]
* [http://search.cpan.org/dist/Email-Sender-Transport-SMTP-TLS Email::Sender::Transport::SMTP::TLS]
* [http://search.cpan.org/dist/Excel-Writer-XLSX Excel::Writer::XLSX]
* [http://search.cpan.org/dist/HTML-Mason HTML::Mason]
* [http://search.cpan.org/dist/Locale-Codes Locale-Codes] (CPAN: "install Locale::Country")
* [http://search.cpan.org/dist/Locale-SubCountry Locale::SubCountry] (NOTE: not yet compatible with version 2.xx; use [http://backpan.cpantesters.org/authors/id/K/KI/KIMRYAN/Locale-SubCountry-1.66.tar.gz 1.66 from BackPan])
* [http://search.cpan.org/dist/Log-Dispatch Log::Dispatch]
* [http://search.cpan.org/dist/NetAddr-IP NetAddr::IP]
* [http://search.cpan.org/dist/Net-Ping Net::Ping]
* [http://search.cpan.org/dist/Net-Ping-External Net::Ping::External]
* [http://search.cpan.org/dist/Number-Format Number::Format]
* [http://search.cpan.org/dist/Spreadsheet-WriteExcel Spreadsheet::WriteExcel]
* [http://search.cpan.org/dist/String-Approx String::Approx]
* [http://search.cpan.org/dist/Text-CSV_XS Text::CSV_XS]
* [http://search.cpan.org/dist/Term-ReadKey Term::ReadKey]
* [http://search.cpan.org/dist/Text-Template Text::Template]

==== Additional modules ====



* [http://search.cpan.org/dist/Authen-Passphrase Authen::Passphrase]
* [http://search.cpan.org/dist/Business-CreditCard Business::CreditCard]
* [http://search.cpan.org/dist/Business-US-USPS-WebTools Business::US::USPS::WebTools]
* [http://search.cpan.org/dist/CAM-PDF CAM::PDF]
* [http://search.cpan.org/dist/Color-Scheme Color::Scheme]
* [http://search.cpan.org/dist/Crypt-PasswdMD5 Crypt::PasswdMD5]
* [http://search.cpan.org/dist/Crypt-OpenSSL-RSA Crypt::OpenSSL::RSA]
* [http://search.cpan.org/dist/Date-Simple Date::Simple]
* [http://search.cpan.org/dist/DateTime-Format-ICal DateTime::Format::ICal]
* [http://search.cpan.org/dist/DateTime-Set DateTime::Set]
* [http://search.cpan.org/dist/DBIx-DBSchema DBIx::DBSchema]
* [http://search.cpan.org/dist/File-CounterFile File::CounterFile]
* [http://search.cpan.org/dist/File-Slurp File::Slurp]
* [http://search.cpan.org/dist/Geo-Coder-Googlev3 Geo::Coder::Googlev3]
* [http://search.cpan.org/dist/Geo-GoogleEarth-Pluggable Geo::GoogleEarth::Pluggable]
* [http://search.cpan.org/dist/HTML-Defang HTML::Defang]
* [http://search.cpan.org/dist/HTML-ElementTable HTML::ElementTable]
* [http://search.cpan.org/dist/HTML-TableExtract HTML::TableExtract]
* [http://search.cpan.org/dist/HTML-Widgets-SelectLayers HTML::Widgets::SelectLayers]
* [http://search.cpan.org/dist/IO-Scalar IO::Scalar]
* [http://search.cpan.org/dist/IO-String IO::String]
* [http://search.cpan.org/dist/IPC-Run-SafeHandles IPC::Run::SafeHandles]
* [http://search.cpan.org/dist/Lingua-EN-NameParse Lingua::EN::NameParse]
* [http://search.cpan.org/dist/Lingua-EN-Inflect Lingua::EN::Inflect]
* [http://search.cpan.org/dist/Net-Domain-TLD Net::Domain::TLD]
* [http://search.cpan.org/dist/Net-OpenSSH Net::OpenSSH]
* [http://search.cpan.org/dist/Net-SSH Net::SSH]
* [http://search.cpan.org/dist/Net-Whois-Raw Net::Whois::Raw]
* [http://search.cpan.org/dist/String-ShellQuote String::ShellQuote]
* [http://search.cpan.org/dist/Tie-IxHash Tie::IxHash]
* [http://search.cpan.org/dist/Time-Duration Time::Duration]
* [http://search.cpan.org/dist/XML-LibXML-LazyBuilder XML::LibXML::LazyBuilder]
* [http://search.cpan.org/dist/Net-HTTPS-Any Net::HTTPS::Any]

==== Optional modules ====

* [http://search.cpan.org/dist/Apache-DBI Apache::DBI] ''(recommended for better web interface performance)''
* [http://search.cpan.org/dist/Fax-Hylafax-Client Fax::Hylafax::Client] ''(only if faxing invoices)''
* [http://search.cpan.org/dist/POE POE] ''(only if using alternate standalone XML-RPC server)''
* [http://search.cpan.org/dist/Sys::SigAction Sys::SigAction] ''(only if port combining with network monitoring)''
* [http://freeside.biz/gitlist/Map-Splat.git Map::Splat] and [http://www.qsl.net/kd2bd/splat.html Splat!] ''(for WISP coverage mapping)''

==== Note on missing modules ====

Prerequisites missing from the documentation? Please add them (in the appropriate section).

== Download Freeside ==
* Get the source from one of the normal places
**[http://www.freeside.biz/freeside/developers.html Open source link from the home page]
**[http://www.freeside.biz/freeside/git.html Anonymous git]
* Uncompress the tarball

== Installation ==

=== System User ===
* Add the user and group `freeside' to your system.
=== Database User ===
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</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>
=== Database Access ===
*Edit the top-level Makefile:
** Configure the DATASOURCE to your DBI data source
*** Set the DB_TYPE (Pg or 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.

=== Database ===
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>
or with MySQL:
<pre>
$ mysqladmin -u freeside -p create freeside
</pre>

=== Perl Modules ===
* Build and install the Perl modules:
<pre>
$ make perl-modules
$ su
# make install-perl-modules
</pre>
=== Basic configuration Files ===
* Create the necessary configuration files:
<pre>
$ su
# make create-config
</pre>

=== Invoice Typesetting ===
* If you are using typeset invoices, install fslongtable.sty:
<pre>
$ su
# make install-texmf
</pre>

=== Apache & Web GUI ===
* Configuration
** Enable mod_perl and mod_rewrite
** Enable mpm_prefork (disable mpm_event/mpm_worker)
** 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>.

* To install the web interface, run:
<pre>
$ su
# make install-docs
</pre>

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

=== RT ===
* It is recommended to [[Freeside:4:Documentation:RT_Installation|install the integrated RT ticketing system]], even if you will not be using it. Alternatively, if you are interested in working on fixes to run without integrated ticketing, delete the <code>ticket_system</code> entry from your conf table.

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

=== Apache configuration ===

* To install the apache configs, run:
<pre>
$ su
# make install-apache
</pre>

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

=== Initialize Data ===
* 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>

=== Additional System Users ===
* 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
$ freeside-adduser -g 1 fs_api
</pre>

=== Create Freeside Users ===
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

=== Queue Daemon ===

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

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

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

Freeside:4:Documentation:Installation

2020-04-11T21:14:46Z

Ivan: /* Installation */

== Introduction ==

These are from-scratch installation instructions for the raw source code. They are suitable for intermediate-to-advanced sysadmins. Folks looking for easy installation are advised to try the VMware appliance or Debian packages instead.

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

== Prerequisites ==

=== Packages ===

* [http://www.perl.org/ Perl], minimum version 5.10.1 (minimum version regularly tested is 5.14.2)
* [http://httpd.apache.org/ Apache], SSL highly recommended
* [http://perl.apache.org/ mod_perl]
** 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.
** [http://www.mysql.com MySQL] and [http://www.mariadb.org/ MariaDB] was previously supported, but is not currently maintained in v4. Code contributions or commercial sponsorship are welcome to bring this support up-to-date.

''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.''

* TeX (teTeX / TeX Live) and Ghostscript (included with most distributions) (Optional, enables typeset invoices)
* [http://www.qsl.net/kd2bd/splat.html Splat!] (Optional, enables WISP coverage mapping)

=== Perl modules ===

==== Popular modules ====

These modules are included in most distributions.


* [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/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/DateManip Date::Manip]
* [http://search.cpan.org/dist/DateTime DateTime]
* [http://search.cpan.org/dist/Frontier-RPC Frontier::RPC2]
* [http://search.cpan.org/dist/GD-Barcode GD::Barcode]
* [http://search.cpan.org/dist/IPC-Run IPC::Run]
* [http://search.cpan.org/dist/IPC-Run3 IPC::Run3]
* [http://search.cpan.org/dist/JSON JSON]
* [http://search.cpan.org/dist/MailTools MailTools] (CPAN: "install Mail::Internet")
* [http://search.cpan.org/dist/MIME-tools MIME::Tools] (Note: do not use version 5.423)
* [http://search.cpan.org/dist/Net-SNMP Net::SNMP]
* [http://search.cpan.org/dist/SOAP-Lite SOAP::Lite]
* [http://search.cpan.org/dist/TimeDate TimeDate] (CPAN: "install Date::Format")
* [http://search.cpan.org/dist/XML-LibXML XML::LibXML]
* [http://search.cpan.org/dist/XML-Simple XML::Simple]

==== Common modules ====

These modules are included in many distributions.


* [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/DateTime-Format-Strptime DateTime::Format::Strptime]
* [http://search.cpan.org/dist/DateTime-Format-Natural DateTime-Format-Natural]
* [http://search.cpan.org/dist/Email-Sender Email::Sender]
* [http://search.cpan.org/dist/Email-Sender-Transport-SMTP-TLS Email::Sender::Transport::SMTP::TLS]
* [http://search.cpan.org/dist/Excel-Writer-XLSX Excel::Writer::XLSX]
* [http://search.cpan.org/dist/HTML-Mason HTML::Mason]
* [http://search.cpan.org/dist/Locale-Codes Locale-Codes] (CPAN: "install Locale::Country")
* [http://search.cpan.org/dist/Locale-SubCountry Locale::SubCountry] (NOTE: not yet compatible with version 2.xx; use [http://backpan.cpantesters.org/authors/id/K/KI/KIMRYAN/Locale-SubCountry-1.66.tar.gz 1.66 from BackPan])
* [http://search.cpan.org/dist/Log-Dispatch Log::Dispatch]
* [http://search.cpan.org/dist/NetAddr-IP NetAddr::IP]
* [http://search.cpan.org/dist/Net-Ping Net::Ping]
* [http://search.cpan.org/dist/Net-Ping-External Net::Ping::External]
* [http://search.cpan.org/dist/Number-Format Number::Format]
* [http://search.cpan.org/dist/Spreadsheet-WriteExcel Spreadsheet::WriteExcel]
* [http://search.cpan.org/dist/String-Approx String::Approx]
* [http://search.cpan.org/dist/Text-CSV_XS Text::CSV_XS]
* [http://search.cpan.org/dist/Term-ReadKey Term::ReadKey]
* [http://search.cpan.org/dist/Text-Template Text::Template]

==== Additional modules ====



* [http://search.cpan.org/dist/Authen-Passphrase Authen::Passphrase]
* [http://search.cpan.org/dist/Business-CreditCard Business::CreditCard]
* [http://search.cpan.org/dist/Business-US-USPS-WebTools Business::US::USPS::WebTools]
* [http://search.cpan.org/dist/CAM-PDF CAM::PDF]
* [http://search.cpan.org/dist/Color-Scheme Color::Scheme]
* [http://search.cpan.org/dist/Crypt-PasswdMD5 Crypt::PasswdMD5]
* [http://search.cpan.org/dist/Crypt-OpenSSL-RSA Crypt::OpenSSL::RSA]
* [http://search.cpan.org/dist/Date-Simple Date::Simple]
* [http://search.cpan.org/dist/DateTime-Format-ICal DateTime::Format::ICal]
* [http://search.cpan.org/dist/DateTime-Set DateTime::Set]
* [http://search.cpan.org/dist/DBIx-DBSchema DBIx::DBSchema]
* [http://search.cpan.org/dist/File-CounterFile File::CounterFile]
* [http://search.cpan.org/dist/File-Slurp File::Slurp]
* [http://search.cpan.org/dist/Geo-Coder-Googlev3 Geo::Coder::Googlev3]
* [http://search.cpan.org/dist/Geo-GoogleEarth-Pluggable Geo::GoogleEarth::Pluggable]
* [http://search.cpan.org/dist/HTML-Defang HTML::Defang]
* [http://search.cpan.org/dist/HTML-ElementTable HTML::ElementTable]
* [http://search.cpan.org/dist/HTML-TableExtract HTML::TableExtract]
* [http://search.cpan.org/dist/HTML-Widgets-SelectLayers HTML::Widgets::SelectLayers]
* [http://search.cpan.org/dist/IO-Scalar IO::Scalar]
* [http://search.cpan.org/dist/IO-String IO::String]
* [http://search.cpan.org/dist/IPC-Run-SafeHandles IPC::Run::SafeHandles]
* [http://search.cpan.org/dist/Lingua-EN-NameParse Lingua::EN::NameParse]
* [http://search.cpan.org/dist/Lingua-EN-Inflect Lingua::EN::Inflect]
* [http://search.cpan.org/dist/Net-Domain-TLD Net::Domain::TLD]
* [http://search.cpan.org/dist/Net-OpenSSH Net::OpenSSH]
* [http://search.cpan.org/dist/Net-SSH Net::SSH]
* [http://search.cpan.org/dist/Net-Whois-Raw Net::Whois::Raw]
* [http://search.cpan.org/dist/String-ShellQuote String::ShellQuote]
* [http://search.cpan.org/dist/Tie-IxHash Tie::IxHash]
* [http://search.cpan.org/dist/Time-Duration Time::Duration]
* [http://search.cpan.org/dist/XML-LibXML-LazyBuilder XML::LibXML::LazyBuilder]
* [http://search.cpan.org/dist/Net-HTTPS-Any Net::HTTPS::Any]

==== Optional modules ====

* [http://search.cpan.org/dist/Apache-DBI Apache::DBI] ''(recommended for better web interface performance)''
* [http://search.cpan.org/dist/Fax-Hylafax-Client Fax::Hylafax::Client] ''(only if faxing invoices)''
* [http://search.cpan.org/dist/POE POE] ''(only if using alternate standalone XML-RPC server)''
* [http://search.cpan.org/dist/Sys::SigAction Sys::SigAction] ''(only if port combining with network monitoring)''
* [http://freeside.biz/gitlist/Map-Splat.git Map::Splat] and [http://www.qsl.net/kd2bd/splat.html Splat!] ''(for WISP coverage mapping)''

==== Note on missing modules ====

Prerequisites missing from the documentation? Please add them (in the appropriate section).

== Download Freeside ==
* Get the source from one of the normal places
**[http://www.freeside.biz/freeside/developers.html Open source link from the home page]
**[http://www.freeside.biz/freeside/git.html Anonymous git]
* Uncompress the tarball

== Installation ==

=== System User ===
* Add the user and group `freeside' to your system.
=== Database User ===
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</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>
=== Database Access ===
*Edit the top-level Makefile:
** Configure the DATASOURCE to your DBI data source
*** Set the DB_TYPE (Pg or 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.

=== Database ===
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>
or with MySQL:
<pre>
$ mysqladmin -u freeside -p create freeside
</pre>

=== Perl Modules ===
* Build and install the Perl modules:
<pre>
$ make perl-modules
$ su
# make install-perl-modules
</pre>
=== Basic configuration Files ===
* Create the necessary configuration files:
<pre>
$ su
# make create-config
</pre>

=== Invoice Typesetting ===
* If you are using typeset invoices, install fslongtable.sty:
<pre>
$ su
# make install-texmf
</pre>

=== Apache & Web GUI ===
* Configuration
** Enable mod_perl and mod_rewrite
** Enable mpm_prefork (disable mpm_event/mpm_worker)
** 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>.

* To install the web interface, run:
<pre>
$ su
# make install-docs
</pre>

* Edit the Makefile and set <code>APACHE_VERSION</code> to '''2''' (Apache 2.0 through 2.3), or '''2.4''' (Apache 2.4 or 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.)

=== RT ===
* It is recommended to [[Freeside:4:Documentation:RT_Installation|install the integrated RT ticketing system]], even if you will not be using it. Alternatively, if you are interested in working on fixes to run without integrated ticketing, delete the <code>ticket_system</code> entry from your conf table.

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

=== Apache configuration ===

* To install the apache configs, run:
<pre>
$ su
# make install-apache
</pre>

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

=== Initialize Data ===
* 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>

=== Additional System Users ===
* 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
$ freeside-adduser -g 1 fs_api
</pre>

=== Create Freeside Users ===
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

=== Queue Daemon ===

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

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

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

Freeside:4:Documentation:RT Installation

2020-04-11T20:11:49Z

Ivan:

== 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/dist/HTML-Element-Extended 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>peer</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>

=== Bootstrap RT's permissions ===

* Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
* Bootstrap your RT Login, replace ivan with your freeside employee account

<pre>
sudo su freeside -c psql

insert into acl ( principaltype, principalid, rightname, objecttype, objectid )
values ( 'Group',
( select id from groups where instance = ( select id from users where name = 'ivan' )
and domain = 'ACLEquivalence' and type = 'UserEquiv' ),
'SuperUser', 'RT::System', 1 );
\q

</pre>

== Futher Reading ==

* Follow the [http://wiki.bestpractical.com/ regular RT documentation] to configure RT, setup the mailgate, etc.
* Set '''ticket_system-default_queueid''' once you have RT configured.

Freeside:4:Documentation:Installation

2020-04-11T20:10:15Z

Ivan: /* Apache & Web GUI */

== Introduction ==

These are from-scratch installation instructions for the raw source code. They are suitable for intermediate-to-advanced sysadmins. Folks looking for easy installation are advised to try the VMware appliance or Debian packages instead.

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

== Prerequisites ==

=== Packages ===

* [http://www.perl.org/ Perl], minimum version 5.10.1 (minimum version regularly tested is 5.14.2)
* [http://httpd.apache.org/ Apache], SSL highly recommended
* [http://perl.apache.org/ mod_perl]
** 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.
** [http://www.mysql.com MySQL] and [http://www.mariadb.org/ MariaDB] was previously supported, but is not currently maintained in v4. Code contributions or commercial sponsorship are welcome to bring this support up-to-date.

''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.''

* TeX (teTeX / TeX Live) and Ghostscript (included with most distributions) (Optional, enables typeset invoices)
* [http://www.qsl.net/kd2bd/splat.html Splat!] (Optional, enables WISP coverage mapping)

=== Perl modules ===

==== Popular modules ====

These modules are included in most distributions.


* [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/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/DateManip Date::Manip]
* [http://search.cpan.org/dist/DateTime DateTime]
* [http://search.cpan.org/dist/Frontier-RPC Frontier::RPC2]
* [http://search.cpan.org/dist/GD-Barcode GD::Barcode]
* [http://search.cpan.org/dist/IPC-Run IPC::Run]
* [http://search.cpan.org/dist/IPC-Run3 IPC::Run3]
* [http://search.cpan.org/dist/JSON JSON]
* [http://search.cpan.org/dist/MailTools MailTools] (CPAN: "install Mail::Internet")
* [http://search.cpan.org/dist/MIME-tools MIME::Tools] (Note: do not use version 5.423)
* [http://search.cpan.org/dist/Net-SNMP Net::SNMP]
* [http://search.cpan.org/dist/SOAP-Lite SOAP::Lite]
* [http://search.cpan.org/dist/TimeDate TimeDate] (CPAN: "install Date::Format")
* [http://search.cpan.org/dist/XML-LibXML XML::LibXML]
* [http://search.cpan.org/dist/XML-Simple XML::Simple]

==== Common modules ====

These modules are included in many distributions.


* [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/DateTime-Format-Strptime DateTime::Format::Strptime]
* [http://search.cpan.org/dist/DateTime-Format-Natural DateTime-Format-Natural]
* [http://search.cpan.org/dist/Email-Sender Email::Sender]
* [http://search.cpan.org/dist/Email-Sender-Transport-SMTP-TLS Email::Sender::Transport::SMTP::TLS]
* [http://search.cpan.org/dist/Excel-Writer-XLSX Excel::Writer::XLSX]
* [http://search.cpan.org/dist/HTML-Mason HTML::Mason]
* [http://search.cpan.org/dist/Locale-Codes Locale-Codes] (CPAN: "install Locale::Country")
* [http://search.cpan.org/dist/Locale-SubCountry Locale::SubCountry] (NOTE: not yet compatible with version 2.xx; use [http://backpan.cpantesters.org/authors/id/K/KI/KIMRYAN/Locale-SubCountry-1.66.tar.gz 1.66 from BackPan])
* [http://search.cpan.org/dist/Log-Dispatch Log::Dispatch]
* [http://search.cpan.org/dist/NetAddr-IP NetAddr::IP]
* [http://search.cpan.org/dist/Net-Ping Net::Ping]
* [http://search.cpan.org/dist/Net-Ping-External Net::Ping::External]
* [http://search.cpan.org/dist/Number-Format Number::Format]
* [http://search.cpan.org/dist/Spreadsheet-WriteExcel Spreadsheet::WriteExcel]
* [http://search.cpan.org/dist/String-Approx String::Approx]
* [http://search.cpan.org/dist/Text-CSV_XS Text::CSV_XS]
* [http://search.cpan.org/dist/Term-ReadKey Term::ReadKey]
* [http://search.cpan.org/dist/Text-Template Text::Template]

==== Additional modules ====



* [http://search.cpan.org/dist/Authen-Passphrase Authen::Passphrase]
* [http://search.cpan.org/dist/Business-CreditCard Business::CreditCard]
* [http://search.cpan.org/dist/Business-US-USPS-WebTools Business::US::USPS::WebTools]
* [http://search.cpan.org/dist/CAM-PDF CAM::PDF]
* [http://search.cpan.org/dist/Color-Scheme Color::Scheme]
* [http://search.cpan.org/dist/Crypt-PasswdMD5 Crypt::PasswdMD5]
* [http://search.cpan.org/dist/Crypt-OpenSSL-RSA Crypt::OpenSSL::RSA]
* [http://search.cpan.org/dist/Date-Simple Date::Simple]
* [http://search.cpan.org/dist/DateTime-Format-ICal DateTime::Format::ICal]
* [http://search.cpan.org/dist/DateTime-Set DateTime::Set]
* [http://search.cpan.org/dist/DBIx-DBSchema DBIx::DBSchema]
* [http://search.cpan.org/dist/File-CounterFile File::CounterFile]
* [http://search.cpan.org/dist/File-Slurp File::Slurp]
* [http://search.cpan.org/dist/Geo-Coder-Googlev3 Geo::Coder::Googlev3]
* [http://search.cpan.org/dist/Geo-GoogleEarth-Pluggable Geo::GoogleEarth::Pluggable]
* [http://search.cpan.org/dist/HTML-Defang HTML::Defang]
* [http://search.cpan.org/dist/HTML-ElementTable HTML::ElementTable]
* [http://search.cpan.org/dist/HTML-TableExtract HTML::TableExtract]
* [http://search.cpan.org/dist/HTML-Widgets-SelectLayers HTML::Widgets::SelectLayers]
* [http://search.cpan.org/dist/IO-Scalar IO::Scalar]
* [http://search.cpan.org/dist/IO-String IO::String]
* [http://search.cpan.org/dist/IPC-Run-SafeHandles IPC::Run::SafeHandles]
* [http://search.cpan.org/dist/Lingua-EN-NameParse Lingua::EN::NameParse]
* [http://search.cpan.org/dist/Lingua-EN-Inflect Lingua::EN::Inflect]
* [http://search.cpan.org/dist/Net-Domain-TLD Net::Domain::TLD]
* [http://search.cpan.org/dist/Net-OpenSSH Net::OpenSSH]
* [http://search.cpan.org/dist/Net-SSH Net::SSH]
* [http://search.cpan.org/dist/Net-Whois-Raw Net::Whois::Raw]
* [http://search.cpan.org/dist/String-ShellQuote String::ShellQuote]
* [http://search.cpan.org/dist/Tie-IxHash Tie::IxHash]
* [http://search.cpan.org/dist/Time-Duration Time::Duration]
* [http://search.cpan.org/dist/XML-LibXML-LazyBuilder XML::LibXML::LazyBuilder]
* [http://search.cpan.org/dist/Net-HTTPS-Any Net::HTTPS::Any]

==== Optional modules ====

* [http://search.cpan.org/dist/Apache-DBI Apache::DBI] ''(recommended for better web interface performance)''
* [http://search.cpan.org/dist/Fax-Hylafax-Client Fax::Hylafax::Client] ''(only if faxing invoices)''
* [http://search.cpan.org/dist/POE POE] ''(only if using alternate standalone XML-RPC server)''
* [http://search.cpan.org/dist/Sys::SigAction Sys::SigAction] ''(only if port combining with network monitoring)''
* [http://freeside.biz/gitlist/Map-Splat.git Map::Splat] and [http://www.qsl.net/kd2bd/splat.html Splat!] ''(for WISP coverage mapping)''

==== Note on missing modules ====

Prerequisites missing from the documentation? Please add them (in the appropriate section).

== Download Freeside ==
* Get the source from one of the normal places
**[http://www.freeside.biz/freeside/developers.html Open source link from the home page]
**[http://www.freeside.biz/freeside/git.html Anonymous git]
* Uncompress the tarball

== Installation ==

=== System User ===
* Add the user and group `freeside' to your system.
=== Database User ===
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</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>
=== Database Access ===
*Edit the top-level Makefile:
** Configure the DATASOURCE to your DBI data source
*** Set the DB_TYPE (Pg or 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.

=== Database ===
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>
or with MySQL:
<pre>
$ mysqladmin -u freeside -p create freeside
</pre>

=== Perl Modules ===
* Build and install the Perl modules:
<pre>
$ make perl-modules
$ su
# make install-perl-modules
</pre>
=== Basic configuration Files ===
* Create the necessary configuration files:
<pre>
$ su
# make create-config
</pre>

=== Invoice Typesetting ===
* If you are using typeset invoices, install fslongtable.sty:
<pre>
$ su
# make install-texmf
</pre>

=== Apache & Web GUI ===
* Configuration
** Enable mod_perl and mod_rewrite
** 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>.

* To install the web interface, run:
<pre>
$ su
# make install-docs
</pre>

* Edit the Makefile and set <code>APACHE_VERSION</code> to '''2''' (Apache 2.0 through 2.3), or '''2.4''' (Apache 2.4 or 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.)

=== RT ===
* It is recommended to [[Freeside:4:Documentation:RT_Installation|install the integrated RT ticketing system]], even if you will not be using it. Alternatively, if you are interested in working on fixes to run without integrated ticketing, delete the <code>ticket_system</code> entry from your conf table.

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

* To install the apache configs, run:
<pre>
$ su
# make install-apache
</pre>

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

=== Initialize Data ===
* 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>

=== Additional System Users ===
* 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
$ freeside-adduser -g 1 fs_api
</pre>

=== Create Freeside Users ===
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

=== Queue Daemon ===

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

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

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

Freeside:4:Documentation:Installation

2020-04-11T20:02:17Z

Ivan: /* Installation */

== Introduction ==

These are from-scratch installation instructions for the raw source code. They are suitable for intermediate-to-advanced sysadmins. Folks looking for easy installation are advised to try the VMware appliance or Debian packages instead.

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

== Prerequisites ==

=== Packages ===

* [http://www.perl.org/ Perl], minimum version 5.10.1 (minimum version regularly tested is 5.14.2)
* [http://httpd.apache.org/ Apache], SSL highly recommended
* [http://perl.apache.org/ mod_perl]
** 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.
** [http://www.mysql.com MySQL] and [http://www.mariadb.org/ MariaDB] was previously supported, but is not currently maintained in v4. Code contributions or commercial sponsorship are welcome to bring this support up-to-date.

''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.''

* TeX (teTeX / TeX Live) and Ghostscript (included with most distributions) (Optional, enables typeset invoices)
* [http://www.qsl.net/kd2bd/splat.html Splat!] (Optional, enables WISP coverage mapping)

=== Perl modules ===

==== Popular modules ====

These modules are included in most distributions.


* [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/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/DateManip Date::Manip]
* [http://search.cpan.org/dist/DateTime DateTime]
* [http://search.cpan.org/dist/Frontier-RPC Frontier::RPC2]
* [http://search.cpan.org/dist/GD-Barcode GD::Barcode]
* [http://search.cpan.org/dist/IPC-Run IPC::Run]
* [http://search.cpan.org/dist/IPC-Run3 IPC::Run3]
* [http://search.cpan.org/dist/JSON JSON]
* [http://search.cpan.org/dist/MailTools MailTools] (CPAN: "install Mail::Internet")
* [http://search.cpan.org/dist/MIME-tools MIME::Tools] (Note: do not use version 5.423)
* [http://search.cpan.org/dist/Net-SNMP Net::SNMP]
* [http://search.cpan.org/dist/SOAP-Lite SOAP::Lite]
* [http://search.cpan.org/dist/TimeDate TimeDate] (CPAN: "install Date::Format")
* [http://search.cpan.org/dist/XML-LibXML XML::LibXML]
* [http://search.cpan.org/dist/XML-Simple XML::Simple]

==== Common modules ====

These modules are included in many distributions.


* [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/DateTime-Format-Strptime DateTime::Format::Strptime]
* [http://search.cpan.org/dist/DateTime-Format-Natural DateTime-Format-Natural]
* [http://search.cpan.org/dist/Email-Sender Email::Sender]
* [http://search.cpan.org/dist/Email-Sender-Transport-SMTP-TLS Email::Sender::Transport::SMTP::TLS]
* [http://search.cpan.org/dist/Excel-Writer-XLSX Excel::Writer::XLSX]
* [http://search.cpan.org/dist/HTML-Mason HTML::Mason]
* [http://search.cpan.org/dist/Locale-Codes Locale-Codes] (CPAN: "install Locale::Country")
* [http://search.cpan.org/dist/Locale-SubCountry Locale::SubCountry] (NOTE: not yet compatible with version 2.xx; use [http://backpan.cpantesters.org/authors/id/K/KI/KIMRYAN/Locale-SubCountry-1.66.tar.gz 1.66 from BackPan])
* [http://search.cpan.org/dist/Log-Dispatch Log::Dispatch]
* [http://search.cpan.org/dist/NetAddr-IP NetAddr::IP]
* [http://search.cpan.org/dist/Net-Ping Net::Ping]
* [http://search.cpan.org/dist/Net-Ping-External Net::Ping::External]
* [http://search.cpan.org/dist/Number-Format Number::Format]
* [http://search.cpan.org/dist/Spreadsheet-WriteExcel Spreadsheet::WriteExcel]
* [http://search.cpan.org/dist/String-Approx String::Approx]
* [http://search.cpan.org/dist/Text-CSV_XS Text::CSV_XS]
* [http://search.cpan.org/dist/Term-ReadKey Term::ReadKey]
* [http://search.cpan.org/dist/Text-Template Text::Template]

==== Additional modules ====



* [http://search.cpan.org/dist/Authen-Passphrase Authen::Passphrase]
* [http://search.cpan.org/dist/Business-CreditCard Business::CreditCard]
* [http://search.cpan.org/dist/Business-US-USPS-WebTools Business::US::USPS::WebTools]
* [http://search.cpan.org/dist/CAM-PDF CAM::PDF]
* [http://search.cpan.org/dist/Color-Scheme Color::Scheme]
* [http://search.cpan.org/dist/Crypt-PasswdMD5 Crypt::PasswdMD5]
* [http://search.cpan.org/dist/Crypt-OpenSSL-RSA Crypt::OpenSSL::RSA]
* [http://search.cpan.org/dist/Date-Simple Date::Simple]
* [http://search.cpan.org/dist/DateTime-Format-ICal DateTime::Format::ICal]
* [http://search.cpan.org/dist/DateTime-Set DateTime::Set]
* [http://search.cpan.org/dist/DBIx-DBSchema DBIx::DBSchema]
* [http://search.cpan.org/dist/File-CounterFile File::CounterFile]
* [http://search.cpan.org/dist/File-Slurp File::Slurp]
* [http://search.cpan.org/dist/Geo-Coder-Googlev3 Geo::Coder::Googlev3]
* [http://search.cpan.org/dist/Geo-GoogleEarth-Pluggable Geo::GoogleEarth::Pluggable]
* [http://search.cpan.org/dist/HTML-Defang HTML::Defang]
* [http://search.cpan.org/dist/HTML-ElementTable HTML::ElementTable]
* [http://search.cpan.org/dist/HTML-TableExtract HTML::TableExtract]
* [http://search.cpan.org/dist/HTML-Widgets-SelectLayers HTML::Widgets::SelectLayers]
* [http://search.cpan.org/dist/IO-Scalar IO::Scalar]
* [http://search.cpan.org/dist/IO-String IO::String]
* [http://search.cpan.org/dist/IPC-Run-SafeHandles IPC::Run::SafeHandles]
* [http://search.cpan.org/dist/Lingua-EN-NameParse Lingua::EN::NameParse]
* [http://search.cpan.org/dist/Lingua-EN-Inflect Lingua::EN::Inflect]
* [http://search.cpan.org/dist/Net-Domain-TLD Net::Domain::TLD]
* [http://search.cpan.org/dist/Net-OpenSSH Net::OpenSSH]
* [http://search.cpan.org/dist/Net-SSH Net::SSH]
* [http://search.cpan.org/dist/Net-Whois-Raw Net::Whois::Raw]
* [http://search.cpan.org/dist/String-ShellQuote String::ShellQuote]
* [http://search.cpan.org/dist/Tie-IxHash Tie::IxHash]
* [http://search.cpan.org/dist/Time-Duration Time::Duration]
* [http://search.cpan.org/dist/XML-LibXML-LazyBuilder XML::LibXML::LazyBuilder]
* [http://search.cpan.org/dist/Net-HTTPS-Any Net::HTTPS::Any]

==== Optional modules ====

* [http://search.cpan.org/dist/Apache-DBI Apache::DBI] ''(recommended for better web interface performance)''
* [http://search.cpan.org/dist/Fax-Hylafax-Client Fax::Hylafax::Client] ''(only if faxing invoices)''
* [http://search.cpan.org/dist/POE POE] ''(only if using alternate standalone XML-RPC server)''
* [http://search.cpan.org/dist/Sys::SigAction Sys::SigAction] ''(only if port combining with network monitoring)''
* [http://freeside.biz/gitlist/Map-Splat.git Map::Splat] and [http://www.qsl.net/kd2bd/splat.html Splat!] ''(for WISP coverage mapping)''

==== Note on missing modules ====

Prerequisites missing from the documentation? Please add them (in the appropriate section).

== Download Freeside ==
* Get the source from one of the normal places
**[http://www.freeside.biz/freeside/developers.html Open source link from the home page]
**[http://www.freeside.biz/freeside/git.html Anonymous git]
* Uncompress the tarball

== Installation ==

=== System User ===
* Add the user and group `freeside' to your system.
=== Database User ===
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</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>
=== Database Access ===
*Edit the top-level Makefile:
** Configure the DATASOURCE to your DBI data source
*** Set the DB_TYPE (Pg or 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.

=== Database ===
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>
or with MySQL:
<pre>
$ mysqladmin -u freeside -p create freeside
</pre>

=== Perl Modules ===
* Build and install the Perl modules:
<pre>
$ make perl-modules
$ su
# make install-perl-modules
</pre>
=== Basic configuration Files ===
* Create the necessary configuration files:
<pre>
$ su
# make create-config
</pre>

=== Invoice Typesetting ===
* If you are using typeset invoices, install fslongtable.sty:
<pre>
$ su
# make install-texmf
</pre>

=== Apache & Web GUI ===
* Configuration
** Enable mod_perl
** 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>.

* To install the web interface, run:
<pre>
$ su
# make install-docs
</pre>

* Edit the Makefile and set <code>APACHE_VERSION</code> to '''2''' (Apache 2.0 through 2.3), or '''2.4''' (Apache 2.4 or 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.)

=== RT ===
* It is recommended to [[Freeside:4:Documentation:RT_Installation|install the integrated RT ticketing system]], even if you will not be using it. Alternatively, if you are interested in working on fixes to run without integrated ticketing, delete the <code>ticket_system</code> entry from your conf table.

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

* To install the apache configs, run:
<pre>
$ su
# make install-apache
</pre>

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

=== Initialize Data ===
* 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>

=== Additional System Users ===
* 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
$ freeside-adduser -g 1 fs_api
</pre>

=== Create Freeside Users ===
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

=== Queue Daemon ===

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

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

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

Freeside:4:Documentation:RT Installation

2020-04-11T20:01:42Z

Ivan:

Freeside:4:Documentation:Installation

2020-04-11T19:59:24Z

Ivan: /* RT */

== Introduction ==

These are from-scratch installation instructions for the raw source code. They are suitable for intermediate-to-advanced sysadmins. Folks looking for easy installation are advised to try the VMware appliance or Debian packages instead.

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

== Prerequisites ==

=== Packages ===

* [http://www.perl.org/ Perl], minimum version 5.10.1 (minimum version regularly tested is 5.14.2)
* [http://httpd.apache.org/ Apache], SSL highly recommended
* [http://perl.apache.org/ mod_perl]
** 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.
** [http://www.mysql.com MySQL] and [http://www.mariadb.org/ MariaDB] was previously supported, but is not currently maintained in v4. Code contributions or commercial sponsorship are welcome to bring this support up-to-date.

''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.''

* TeX (teTeX / TeX Live) and Ghostscript (included with most distributions) (Optional, enables typeset invoices)
* [http://www.qsl.net/kd2bd/splat.html Splat!] (Optional, enables WISP coverage mapping)

=== Perl modules ===

==== Popular modules ====

These modules are included in most distributions.


* [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/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/DateManip Date::Manip]
* [http://search.cpan.org/dist/DateTime DateTime]
* [http://search.cpan.org/dist/Frontier-RPC Frontier::RPC2]
* [http://search.cpan.org/dist/GD-Barcode GD::Barcode]
* [http://search.cpan.org/dist/IPC-Run IPC::Run]
* [http://search.cpan.org/dist/IPC-Run3 IPC::Run3]
* [http://search.cpan.org/dist/JSON JSON]
* [http://search.cpan.org/dist/MailTools MailTools] (CPAN: "install Mail::Internet")
* [http://search.cpan.org/dist/MIME-tools MIME::Tools] (Note: do not use version 5.423)
* [http://search.cpan.org/dist/Net-SNMP Net::SNMP]
* [http://search.cpan.org/dist/SOAP-Lite SOAP::Lite]
* [http://search.cpan.org/dist/TimeDate TimeDate] (CPAN: "install Date::Format")
* [http://search.cpan.org/dist/XML-LibXML XML::LibXML]
* [http://search.cpan.org/dist/XML-Simple XML::Simple]

==== Common modules ====

These modules are included in many distributions.


* [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/DateTime-Format-Strptime DateTime::Format::Strptime]
* [http://search.cpan.org/dist/DateTime-Format-Natural DateTime-Format-Natural]
* [http://search.cpan.org/dist/Email-Sender Email::Sender]
* [http://search.cpan.org/dist/Email-Sender-Transport-SMTP-TLS Email::Sender::Transport::SMTP::TLS]
* [http://search.cpan.org/dist/Excel-Writer-XLSX Excel::Writer::XLSX]
* [http://search.cpan.org/dist/HTML-Mason HTML::Mason]
* [http://search.cpan.org/dist/Locale-Codes Locale-Codes] (CPAN: "install Locale::Country")
* [http://search.cpan.org/dist/Locale-SubCountry Locale::SubCountry] (NOTE: not yet compatible with version 2.xx; use [http://backpan.cpantesters.org/authors/id/K/KI/KIMRYAN/Locale-SubCountry-1.66.tar.gz 1.66 from BackPan])
* [http://search.cpan.org/dist/Log-Dispatch Log::Dispatch]
* [http://search.cpan.org/dist/NetAddr-IP NetAddr::IP]
* [http://search.cpan.org/dist/Net-Ping Net::Ping]
* [http://search.cpan.org/dist/Net-Ping-External Net::Ping::External]
* [http://search.cpan.org/dist/Number-Format Number::Format]
* [http://search.cpan.org/dist/Spreadsheet-WriteExcel Spreadsheet::WriteExcel]
* [http://search.cpan.org/dist/String-Approx String::Approx]
* [http://search.cpan.org/dist/Text-CSV_XS Text::CSV_XS]
* [http://search.cpan.org/dist/Term-ReadKey Term::ReadKey]
* [http://search.cpan.org/dist/Text-Template Text::Template]

==== Additional modules ====



* [http://search.cpan.org/dist/Authen-Passphrase Authen::Passphrase]
* [http://search.cpan.org/dist/Business-CreditCard Business::CreditCard]
* [http://search.cpan.org/dist/Business-US-USPS-WebTools Business::US::USPS::WebTools]
* [http://search.cpan.org/dist/CAM-PDF CAM::PDF]
* [http://search.cpan.org/dist/Color-Scheme Color::Scheme]
* [http://search.cpan.org/dist/Crypt-PasswdMD5 Crypt::PasswdMD5]
* [http://search.cpan.org/dist/Crypt-OpenSSL-RSA Crypt::OpenSSL::RSA]
* [http://search.cpan.org/dist/Date-Simple Date::Simple]
* [http://search.cpan.org/dist/DateTime-Format-ICal DateTime::Format::ICal]
* [http://search.cpan.org/dist/DateTime-Set DateTime::Set]
* [http://search.cpan.org/dist/DBIx-DBSchema DBIx::DBSchema]
* [http://search.cpan.org/dist/File-CounterFile File::CounterFile]
* [http://search.cpan.org/dist/File-Slurp File::Slurp]
* [http://search.cpan.org/dist/Geo-Coder-Googlev3 Geo::Coder::Googlev3]
* [http://search.cpan.org/dist/Geo-GoogleEarth-Pluggable Geo::GoogleEarth::Pluggable]
* [http://search.cpan.org/dist/HTML-Defang HTML::Defang]
* [http://search.cpan.org/dist/HTML-ElementTable HTML::ElementTable]
* [http://search.cpan.org/dist/HTML-TableExtract HTML::TableExtract]
* [http://search.cpan.org/dist/HTML-Widgets-SelectLayers HTML::Widgets::SelectLayers]
* [http://search.cpan.org/dist/IO-Scalar IO::Scalar]
* [http://search.cpan.org/dist/IO-String IO::String]
* [http://search.cpan.org/dist/IPC-Run-SafeHandles IPC::Run::SafeHandles]
* [http://search.cpan.org/dist/Lingua-EN-NameParse Lingua::EN::NameParse]
* [http://search.cpan.org/dist/Lingua-EN-Inflect Lingua::EN::Inflect]
* [http://search.cpan.org/dist/Net-Domain-TLD Net::Domain::TLD]
* [http://search.cpan.org/dist/Net-OpenSSH Net::OpenSSH]
* [http://search.cpan.org/dist/Net-SSH Net::SSH]
* [http://search.cpan.org/dist/Net-Whois-Raw Net::Whois::Raw]
* [http://search.cpan.org/dist/String-ShellQuote String::ShellQuote]
* [http://search.cpan.org/dist/Tie-IxHash Tie::IxHash]
* [http://search.cpan.org/dist/Time-Duration Time::Duration]
* [http://search.cpan.org/dist/XML-LibXML-LazyBuilder XML::LibXML::LazyBuilder]
* [http://search.cpan.org/dist/Net-HTTPS-Any Net::HTTPS::Any]

==== Optional modules ====

* [http://search.cpan.org/dist/Apache-DBI Apache::DBI] ''(recommended for better web interface performance)''
* [http://search.cpan.org/dist/Fax-Hylafax-Client Fax::Hylafax::Client] ''(only if faxing invoices)''
* [http://search.cpan.org/dist/POE POE] ''(only if using alternate standalone XML-RPC server)''
* [http://search.cpan.org/dist/Sys::SigAction Sys::SigAction] ''(only if port combining with network monitoring)''
* [http://freeside.biz/gitlist/Map-Splat.git Map::Splat] and [http://www.qsl.net/kd2bd/splat.html Splat!] ''(for WISP coverage mapping)''

==== Note on missing modules ====

Prerequisites missing from the documentation? Please add them (in the appropriate section).

== Download Freeside ==
* Get the source from one of the normal places
**[http://www.freeside.biz/freeside/developers.html Open source link from the home page]
**[http://www.freeside.biz/freeside/git.html Anonymous git]
* Uncompress the tarball

== Installation ==

=== System User ===
* Add the user and group `freeside' to your system.
=== Database User ===
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</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>
=== Database Access ===
*Edit the top-level Makefile:
** Configure the DATASOURCE to your DBI data source
*** Set the DB_TYPE (Pg or 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.

=== Database ===
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>
or with MySQL:
<pre>
$ mysqladmin -u freeside -p create freeside
</pre>

=== Perl Modules ===
* Build and install the Perl modules:
<pre>
$ make perl-modules
$ su
# make install-perl-modules
</pre>
=== Basic configuration Files ===
* Create the necessary configuration files:
<pre>
$ su
# make create-config
</pre>

=== Invoice Typesetting ===
* If you are using typeset invoices, install fslongtable.sty:
<pre>
$ su
# make install-texmf
</pre>

=== Apache & Web GUI ===
* Configuration
** Enable mod_perl
** 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>.

* To install the web interface, run:
<pre>
$ su
# make install-docs
</pre>

* Edit the Makefile and set <code>APACHE_VERSION</code> to '''2''' (Apache 2.0 through 2.3), or '''2.4''' (Apache 2.4 or 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.)

* To install the apache configs, run:
<pre>
$ su
# make install-apache
</pre>

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

=== RT ===
* It is recommended to [[Freeside:4:Documentation:RT_Installation|install the integrated RT ticketing system]], even if you will not be using it. Alternatively, if you are interested in working on fixes to run without integrated ticketing, delete the <code>ticket_system</code> entry from your conf table.

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

=== Initialize Data ===
* 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>

=== Additional System Users ===
* 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
$ freeside-adduser -g 1 fs_api
</pre>

=== Create Freeside Users ===
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

=== Queue Daemon ===

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

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

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

Freeside:4:Documentation:RT Installation

2020-04-11T19:59:14Z

Ivan: Created page with "== Introduction == These instructions document installation of the integrated internal RT ticketing system. There is also support for running this integration against an e..."

== 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/dist/HTML-Element-Extended 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>peer</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.

=== Bootstrap RT's permissions ===

* Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
* Bootstrap your RT Login, replace ivan with your freeside employee account

<pre>
sudo su freeside -c psql

insert into acl ( principaltype, principalid, rightname, objecttype, objectid )
values ( 'Group',
( select id from groups where instance = ( select id from users where name = 'ivan' )
and domain = 'ACLEquivalence' and type = 'UserEquiv' ),
'SuperUser', 'RT::System', 1 );
\q

</pre>

== Futher Reading ==
* Follow the [http://wiki.bestpractical.com/ regular RT documentation] to configure RT, setup the mailgate, etc.
* Set '''ticket_system-default_queueid''' once you have RT configured.

Freeside:3:Documentation:RT Installation

2020-04-11T19:58:20Z

Ivan:

== 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/dist/HTML-Element-Extended 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>peer</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.

=== Bootstrap RT's permissions ===

* Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
* Bootstrap your RT Login, replace ivan with your freeside employee account

<pre>
sudo su freeside -c psql

insert into acl ( principaltype, principalid, rightname, objecttype, objectid )
values ( 'Group',
( select id from groups where instance = ( select id from users where name = 'ivan' )
and domain = 'ACLEquivalence' and type = 'UserEquiv' ),
'SuperUser', 'RT::System', 1 );
\q

</pre>

== Futher Reading ==
* Follow the [http://wiki.bestpractical.com/ regular RT documentation] to configure RT, setup the mailgate, etc.
* Set '''ticket_system-default_queueid''' once you have RT configured.

Freeside:3:Documentation:RT Installation

2020-04-11T19:58:02Z

Ivan: /* Bootstrap RT's permissions */

== 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/dist/HTML-Element-Extended 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>peer</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.

=== Bootstrap RT's permissions ===

* Click on "Ticketing Main" on the Freeside main menu to auto-create an RT login for your username
* Login to the web interface, click on "Ticketing main"
* Bootstrap your RT Login, replace ivan with your freeside employee account

<pre>
sudo su freeside -c psql

insert into acl ( principaltype, principalid, rightname, objecttype, objectid )
values ( 'Group',
( select id from groups where instance = ( select id from users where name = 'ivan' )
and domain = 'ACLEquivalence' and type = 'UserEquiv' ),
'SuperUser', 'RT::System', 1 );
\q

</pre>

== Futher Reading ==
* Follow the [http://wiki.bestpractical.com/ regular RT documentation] to configure RT, setup the mailgate, etc.
* Set '''ticket_system-default_queueid''' once you have RT configured.

Freeside:3:Documentation:RT Installation

2020-04-11T19:52:55Z

Ivan:

== 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/dist/HTML-Element-Extended 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>peer</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.

=== 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 > Employees, click on "Add an employee" and add a temporary SuperUser "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, using a different browser, 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". Enter your normal RT/Freeside login in the box labeled ADD USER, click on the "Rights for Administrators" tab, check the "Do anything and everything" box (SuperUser) and then click "Save Changes"
* As your regular user, go back to the freeside employee list, click on the "root" user and set it to disabled

== Futher Reading ==
* Follow the [http://wiki.bestpractical.com/ regular RT documentation] to configure RT, setup the mailgate, etc.
* Set '''ticket_system-default_queueid''' once you have RT configured.

Freeside:3:Documentation:RT Installation

2020-04-11T19:52:29Z

Ivan:

== 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/dist/HTML-Element-Extended 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>peer</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.

=== 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 > Employees, click on "Add an employee" and add a temporary SuperUser "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, using a different browser, 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". Enter your normal RT/Freeside login in the box labeled ADD USER, click on the "Rights for Administrators" tab, check the "Do anything and everything" box (SuperUser) and then click "Save Changes"
* As your regular user, go back to the freeside employee list, click on the "root" user and set it to disabled

== Futher Reading ==
* Follow the [http://wiki.bestpractical.com/ regular RT documentation] to configure RT, setup the mailgate, etc.
* Set '''ticket_system-default_queueid''' once you have RT configured.

Freeside:3:Documentation:RT Installation

2020-04-11T19:49:53Z

Ivan:

== 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/dist/HTML-Element-Extended 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>peer</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 > Employees, click on "Add an employee" and add a temporary SuperUser "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, using a different browser, 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". Enter your normal RT/Freeside login in the box labeled ADD USER, click on the "Rights for Administrators" tab, check the "Do anything and everything" box (SuperUser) and then click "Save Changes"
* As your regular user, go back to the freeside employee list, click on the "root" user and set it to disabled

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

Freeside:4:Documentation:Installation

2020-04-11T19:39:42Z

Ivan:

== Introduction ==

These are from-scratch installation instructions for the raw source code. They are suitable for intermediate-to-advanced sysadmins. Folks looking for easy installation are advised to try the VMware appliance or Debian packages instead.

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

== Prerequisites ==

=== Packages ===

* [http://www.perl.org/ Perl], minimum version 5.10.1 (minimum version regularly tested is 5.14.2)
* [http://httpd.apache.org/ Apache], SSL highly recommended
* [http://perl.apache.org/ mod_perl]
** 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.
** [http://www.mysql.com MySQL] and [http://www.mariadb.org/ MariaDB] was previously supported, but is not currently maintained in v4. Code contributions or commercial sponsorship are welcome to bring this support up-to-date.

''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.''

* TeX (teTeX / TeX Live) and Ghostscript (included with most distributions) (Optional, enables typeset invoices)
* [http://www.qsl.net/kd2bd/splat.html Splat!] (Optional, enables WISP coverage mapping)

=== Perl modules ===

==== Popular modules ====

These modules are included in most distributions.


* [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/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/DateManip Date::Manip]
* [http://search.cpan.org/dist/DateTime DateTime]
* [http://search.cpan.org/dist/Frontier-RPC Frontier::RPC2]
* [http://search.cpan.org/dist/GD-Barcode GD::Barcode]
* [http://search.cpan.org/dist/IPC-Run IPC::Run]
* [http://search.cpan.org/dist/IPC-Run3 IPC::Run3]
* [http://search.cpan.org/dist/JSON JSON]
* [http://search.cpan.org/dist/MailTools MailTools] (CPAN: "install Mail::Internet")
* [http://search.cpan.org/dist/MIME-tools MIME::Tools] (Note: do not use version 5.423)
* [http://search.cpan.org/dist/Net-SNMP Net::SNMP]
* [http://search.cpan.org/dist/SOAP-Lite SOAP::Lite]
* [http://search.cpan.org/dist/TimeDate TimeDate] (CPAN: "install Date::Format")
* [http://search.cpan.org/dist/XML-LibXML XML::LibXML]
* [http://search.cpan.org/dist/XML-Simple XML::Simple]

==== Common modules ====

These modules are included in many distributions.


* [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/DateTime-Format-Strptime DateTime::Format::Strptime]
* [http://search.cpan.org/dist/DateTime-Format-Natural DateTime-Format-Natural]
* [http://search.cpan.org/dist/Email-Sender Email::Sender]
* [http://search.cpan.org/dist/Email-Sender-Transport-SMTP-TLS Email::Sender::Transport::SMTP::TLS]
* [http://search.cpan.org/dist/Excel-Writer-XLSX Excel::Writer::XLSX]
* [http://search.cpan.org/dist/HTML-Mason HTML::Mason]
* [http://search.cpan.org/dist/Locale-Codes Locale-Codes] (CPAN: "install Locale::Country")
* [http://search.cpan.org/dist/Locale-SubCountry Locale::SubCountry] (NOTE: not yet compatible with version 2.xx; use [http://backpan.cpantesters.org/authors/id/K/KI/KIMRYAN/Locale-SubCountry-1.66.tar.gz 1.66 from BackPan])
* [http://search.cpan.org/dist/Log-Dispatch Log::Dispatch]
* [http://search.cpan.org/dist/NetAddr-IP NetAddr::IP]
* [http://search.cpan.org/dist/Net-Ping Net::Ping]
* [http://search.cpan.org/dist/Net-Ping-External Net::Ping::External]
* [http://search.cpan.org/dist/Number-Format Number::Format]
* [http://search.cpan.org/dist/Spreadsheet-WriteExcel Spreadsheet::WriteExcel]
* [http://search.cpan.org/dist/String-Approx String::Approx]
* [http://search.cpan.org/dist/Text-CSV_XS Text::CSV_XS]
* [http://search.cpan.org/dist/Term-ReadKey Term::ReadKey]
* [http://search.cpan.org/dist/Text-Template Text::Template]

==== Additional modules ====



* [http://search.cpan.org/dist/Authen-Passphrase Authen::Passphrase]
* [http://search.cpan.org/dist/Business-CreditCard Business::CreditCard]
* [http://search.cpan.org/dist/Business-US-USPS-WebTools Business::US::USPS::WebTools]
* [http://search.cpan.org/dist/CAM-PDF CAM::PDF]
* [http://search.cpan.org/dist/Color-Scheme Color::Scheme]
* [http://search.cpan.org/dist/Crypt-PasswdMD5 Crypt::PasswdMD5]
* [http://search.cpan.org/dist/Crypt-OpenSSL-RSA Crypt::OpenSSL::RSA]
* [http://search.cpan.org/dist/Date-Simple Date::Simple]
* [http://search.cpan.org/dist/DateTime-Format-ICal DateTime::Format::ICal]
* [http://search.cpan.org/dist/DateTime-Set DateTime::Set]
* [http://search.cpan.org/dist/DBIx-DBSchema DBIx::DBSchema]
* [http://search.cpan.org/dist/File-CounterFile File::CounterFile]
* [http://search.cpan.org/dist/File-Slurp File::Slurp]
* [http://search.cpan.org/dist/Geo-Coder-Googlev3 Geo::Coder::Googlev3]
* [http://search.cpan.org/dist/Geo-GoogleEarth-Pluggable Geo::GoogleEarth::Pluggable]
* [http://search.cpan.org/dist/HTML-Defang HTML::Defang]
* [http://search.cpan.org/dist/HTML-ElementTable HTML::ElementTable]
* [http://search.cpan.org/dist/HTML-TableExtract HTML::TableExtract]
* [http://search.cpan.org/dist/HTML-Widgets-SelectLayers HTML::Widgets::SelectLayers]
* [http://search.cpan.org/dist/IO-Scalar IO::Scalar]
* [http://search.cpan.org/dist/IO-String IO::String]
* [http://search.cpan.org/dist/IPC-Run-SafeHandles IPC::Run::SafeHandles]
* [http://search.cpan.org/dist/Lingua-EN-NameParse Lingua::EN::NameParse]
* [http://search.cpan.org/dist/Lingua-EN-Inflect Lingua::EN::Inflect]
* [http://search.cpan.org/dist/Net-Domain-TLD Net::Domain::TLD]
* [http://search.cpan.org/dist/Net-OpenSSH Net::OpenSSH]
* [http://search.cpan.org/dist/Net-SSH Net::SSH]
* [http://search.cpan.org/dist/Net-Whois-Raw Net::Whois::Raw]
* [http://search.cpan.org/dist/String-ShellQuote String::ShellQuote]
* [http://search.cpan.org/dist/Tie-IxHash Tie::IxHash]
* [http://search.cpan.org/dist/Time-Duration Time::Duration]
* [http://search.cpan.org/dist/XML-LibXML-LazyBuilder XML::LibXML::LazyBuilder]
* [http://search.cpan.org/dist/Net-HTTPS-Any Net::HTTPS::Any]

==== Optional modules ====

* [http://search.cpan.org/dist/Apache-DBI Apache::DBI] ''(recommended for better web interface performance)''
* [http://search.cpan.org/dist/Fax-Hylafax-Client Fax::Hylafax::Client] ''(only if faxing invoices)''
* [http://search.cpan.org/dist/POE POE] ''(only if using alternate standalone XML-RPC server)''
* [http://search.cpan.org/dist/Sys::SigAction Sys::SigAction] ''(only if port combining with network monitoring)''
* [http://freeside.biz/gitlist/Map-Splat.git Map::Splat] and [http://www.qsl.net/kd2bd/splat.html Splat!] ''(for WISP coverage mapping)''

==== Note on missing modules ====

Prerequisites missing from the documentation? Please add them (in the appropriate section).

== Download Freeside ==
* Get the source from one of the normal places
**[http://www.freeside.biz/freeside/developers.html Open source link from the home page]
**[http://www.freeside.biz/freeside/git.html Anonymous git]
* Uncompress the tarball

== Installation ==

=== System User ===
* Add the user and group `freeside' to your system.
=== Database User ===
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</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>
=== Database Access ===
*Edit the top-level Makefile:
** Configure the DATASOURCE to your DBI data source
*** Set the DB_TYPE (Pg or 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.

=== Database ===
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>
or with MySQL:
<pre>
$ mysqladmin -u freeside -p create freeside
</pre>

=== Perl Modules ===
* Build and install the Perl modules:
<pre>
$ make perl-modules
$ su
# make install-perl-modules
</pre>
=== Basic configuration Files ===
* Create the necessary configuration files:
<pre>
$ su
# make create-config
</pre>

=== Invoice Typesetting ===
* If you are using typeset invoices, install fslongtable.sty:
<pre>
$ su
# make install-texmf
</pre>

=== Apache & Web GUI ===
* Configuration
** Enable mod_perl
** 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>.

* To install the web interface, run:
<pre>
$ su
# make install-docs
</pre>

* Edit the Makefile and set <code>APACHE_VERSION</code> to '''2''' (Apache 2.0 through 2.3), or '''2.4''' (Apache 2.4 or 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.)

* To install the apache configs, run:
<pre>
$ su
# make install-apache
</pre>

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

=== RT ===
* It is recommended to [[Freeside:3:Documentation:RT_Installation|install the integrated RT ticketing system]], even if you will not be using it. Alternatively, if you are interested in working on fixes to run without integrated ticketing, delete the <code>ticket_system</code> entry from your conf table.

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

=== Initialize Data ===
* 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>

=== Additional System Users ===
* 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
$ freeside-adduser -g 1 fs_api
</pre>

=== Create Freeside Users ===
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

=== Queue Daemon ===

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

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

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

Freeside:4:Documentation:InstallingOnDebian10

2020-04-02T00:12:44Z

Ivan:

= Configure package repositories =
* Add the following apt sources to <code>/etc/apt/sources.list</code> (for Debian 9.x "stretch"):

<pre>
deb [trusted=yes] http://pkg.freeside.biz/freeside-buster/ ./
deb [trusted=yes] http://pkg.freeside.biz/freeside4-buster-testing/ ./ #XXX -testing only for now on deb 10, -stable when 4.3 releases
</pre>

* Run <code>aptitude update</code>.

= Install =

<pre>
aptitude install freeside freeside-lib freeside-webui
apt-mark hold freeside*
</pre>

= Database setup =

== Database User ==
* Allow the freeside user full access to the freeside database.
with Postgresql:
<pre>
[ as postgres/pgsql user ]
$ createuser -P -d freeside
Enter password for new role:
Enter it again:
</pre>


== Database Access ==
* Configure /usr/local/etc/freeside/secrets if necessary. This file contains three lines: DBI datasource, username and password
** See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source.

== Database ==
* Add the freeside database to your database engine:
with Postgres:
<pre>
$ su freeside
$ createdb -E UTF8 freeside
</pre>


= Bootstrap Freeside =

== Freeside database ==

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

== RT database ==

* As the freeside UNIX user, run:
<pre>
$ su freeside
$ /opt/rt3/sbin/rt-setup-database --action schema
$ /opt/rt3/sbin/rt-setup-database --action coredata
$ /opt/rt3/sbin/rt-setup-database --action insert --datafile /opt/rt3/etc/initialdata
</pre>

== System users ==
* 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
$ freeside-adduser -g 1 fs_api
</pre>

== Employees ==
* Create one or more Freeside users (your internal sales/tech folks, not customer accounts):
<pre>
$ su freeside
$ freeside-adduser -g 1 username password
</pre>
Additional users can be added using the same command or from the web interface.

= Restart freeside =

* <code>/etc/init.d/freeside restart</code>

= Apache & Web GUI =
* Edit /etc/apache2/envvars and set APACHE_RUN_USER and APACHE_RUN_GROUP to <code>freeside</code>
* <code>a2enconf freeside-base2.4</code>
* <code>a2enconf freeside-rt</code>
* <code>a2dismod mpm_event</code>
* <code>a2enmod mpm_prefork</code>
* <code>a2enmod rewrite</code>
* <code>a2enmod perl</code>
* <code>chown freeside /var/lock/apache2</code>
* Restart Apache
* The web interface will be available at /freeside

= Next steps =
* Log into the web interface using the username and password you entered above.
* Proceed to the initial [[Freeside:3:Documentation:Administration|administration]] of your installation.