Difference between revisions of "Freeside:2.1:Documentation"

From Freeside
Jump to: navigation, search
(Upgrading)
Line 1: Line 1:
= Upgrading =
+
= Note =
  
== Upgrading from 1.9 to 2.1 ==
+
Some documentation links point to the 1.9 documentation until things are fully moved over.  The information should still be applicable.
  
=== Prerequisites ===
+
= Installation and upgrades =
  
* aptitude install gcc libmodule-versions-report-perl libtext-wikiformat-perl libhttp-server-simple-mason-perl libxml-rss-perl libnet-server-perl libhtml-rewriteattributes-perl libdata-ical-perl libperlio-eol-perl libgnupg-interface-perl libfile-sharedir-perl libcgi-pm-perl libmime-types-perl libdate-ical-perl libdatetime-set-perl libhook-lexwrap-perl libcalendar-simple-perl libsoap-lite-perl libpoe-perl libipc-run-safehandles-perl libdatetime-format-natural-perl libemail-sender-perl libemail-sender-transport-smtp-tls-perl libemail-simple-perl libmodule-versions-report-perl libhtml-defang-perl
+
== Backend Installation ==
* Or via CPAN
 
  
=== Freeside ===
+
* [[Freeside:1.9:Documentation:Installation|New Installation]]
 +
* [[Freeside:1.9:Documentation:RT Installation|Integrated RT Installation]]
 +
* OS-specific installation guides (source)
 +
** [[Freeside:1.9:Documentation:InstallingOnDebian5|Debian 5.0 "lenny"]]
 +
* OS-specific installation guides (packages)
 +
** [[Freeside:1.9:Documentation:InstallingUsingAPT|Debian packages]]
 +
** [[Freeside:1.9:Documentation:InstallingUsingRPM|CentOS/RHEL RPM packages]]
  
* Edit the Makefile (copy/edit your old information from the previous version's Makefile when upgrading)
+
== Signup and Self-service installation ==
* <code>make install-perl-modules</code>
 
* As the freeside UNIX user, run <code>freeside-upgrade username</code>, passing the username of an internal Freeside user.
 
* If freeside-upgrade hangs, try stopping Apache, all Freeside processes, and anything else connected to your database, especially on older PostgreSQL versions.
 
* <code>make install-docs</code>
 
<!-- * You may want to check your ACLs under Configuration->Employees->View/Edit employee groups and grant some of the new rights to one or more groups. -->
 
  
=== RT ===
+
* [[Freeside:1.9:Documentation:Self-Service Installation|Signup/Self-service Installation]]
  
* <code>mv /opt/rt3/etc/RT_SiteConfig.pm /opt/rt3/etc/RT_SiteConfig.pm.3.6</code><br>or add:<br><code>Set($WebDefaultStylesheet, 'freeside2.1');</code>
+
== Distributor guides ==
* In RT_SiteConfig.pm, every old-style variable (e.g. $RT::blah = x) must be changed to Set(blah,'x'), etc.
 
* <code>make configure-rt; make deploy</code>
 
* <code>cd rt; su freeside -c '/opt/rt3/sbin/rt-setup-database --dba freeside --prompt-for-dba-password --action upgrade'</code> WARNING: the freeside unix user must have write permission to the rt source directory
 
* Clear mason cache dir: <code>rm -fr /usr/local/etc/freeside/masondata/obj</code>
 
  
=== Restart ===
+
* [[Freeside:Documentation:CreatingRPMRepo|Creating your own repository with Freeside RPMs]]
  
* Restart Apache and the Freeside daemons:
+
* [[Freeside:Documentation:MirroringRPMRepo|Creating and using a mirror of the Freeside Internet Services RPM repositories]]
  <pre>make deploy</pre>
 
  
=== Edit configuration ===
+
* [[Freeside:Documentation:RPMBuildSystem|Documentation on the RPM build system]]
  
* You may want to check your ACLs under Configuration->Employees->View/Edit employee groups and grant some of the new rights to one or more groups.
+
== Upgrading ==
* Add an "Invoice eligible for automatic collection" condition to all "Run card", "Run check" and "Add card or check to a pending batch" events.
 
* Create a new invoice send event, with the default conditions plus:
 
** customer payment type "Credit card (automatic)" or "Electronic check (automatic)"
 
** "Invoice ineligible for automatic collection"
 
* To fix Cc: and Bcc: on ticket comments, go to Configuration->Ticketing->Ticketing Global, click on "Scrips", and add a new scrip "On Comment Notify Other Recipients as Comment"
 
  
== Upgrading from 2.1.0 to 2.1.1 ==
+
* [[Freeside:2.1:Documentation:Upgrading|Upgrading from 1.9.X to 2.1.x]]
 +
* [[Freeside:2.1.1:Documentation:Upgrading|Upgrading from 2.1.0 to 2.1.1]]
 +
 
 +
= User's Guide =
 +
 
 +
* [[Freeside:1.9:Documentation:User|User's Guide]] (help wanted)
 +
* [http://www.sisd.com/~ivan/freeside-slides Training presentation slides]
 +
 
 +
= Administrator's Guide =
 +
 
 +
* [[Freeside:1.9:Documentation:Administration|Administrator's Guide]]
 +
* [[Freeside:Documentation:DisasterRecovery|Disaster Recovery]]
 +
* [[:Category:Freeside:1.9:Documentation:Template|Templates]] used and their fill in variables.
 +
 
 +
= Developer's Guide =
 +
 
 +
* [[Freeside:1.9:Documentation:Developer|Developer's Guide]]
 +
 
 +
= Accounting Guide =
 +
 
 +
*[[Freeside:Documentation:Accounting|Accounting Guide]]
 +
 
 +
= Misc =
 +
 
 +
* [[Freeside:Documentation:FAQ|Frequently Asked Questions]]
 +
* [[3rd_party_software|Third-party software]]
 +
 
 +
* [[Freeside:1.9:Documentation|Version 1.9 documentation]]
 +
 
 +
 
 +
{{ContextSensitiveHelp}}
  
* <code>make install-perl-modules</code>
 
* As the freeside UNIX user, run <code>freeside-upgrade username</code>, passing the username of an internal Freeside user.
 
* If freeside-upgrade hangs, try stopping Apache, all Freeside processes, and anything else connected to your database, especially on older PostgreSQL versions.
 
* <code>make install-docs</code>
 
* Restart Apache and the Freeside daemons.
 
  
 
= Changelog =
 
= Changelog =
Line 52: Line 67:
 
* [[Freeside:2.1.1:Changelog|2.1.1 Changelog]]
 
* [[Freeside:2.1.1:Changelog|2.1.1 Changelog]]
  
= Known Issues =
 
 
* Bad RT links under Configuraiton -> Ticketing -> Ticketing Global?  Make sure the URL section in <code>/opt/rt3/etc/RT_SiteConfig.pm</code> is new-style:
 
<pre>
 
$RT::URI::freeside::URL = 'https://your/freeside/URL/';
 
 
$RT::URI::freeside::URL =~ m(^(https?://[^/]+)(/.*)$)i;
 
Set($WebBaseURL, $1);
 
Set($WebPath, "$2/rt");
 
</pre>
 
 
* Ancient Firefox v2.x may have performance problems rendering RT?  (who cares?)
 
  
 
= Misc =
 
= Misc =
  
* Is it necessary to create an fs_bootstrap user??
 
 
* [[Freeside:2.1:Documentation:Administration:VoIP:Timed_Rates|New feature: Timed Rates]]
 
* [[Freeside:2.1:Documentation:Administration:VoIP:Timed_Rates|New feature: Timed Rates]]

Revision as of 17:08, 29 September 2010

Note

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

Installation and upgrades

Backend Installation

Signup and Self-service installation

Distributor guides

Upgrading

User's Guide

Administrator's Guide

Developer's Guide

Accounting Guide

Misc


This page is part of the Freeside Context Sensitive Help. Please review the Editing Guidelines before making modifications to this page.


Changelog


Misc