Difference between revisions of "Freeside:2.1:Documentation"

From Freeside
Jump to: navigation, search
(→‎Prerequisites)
(→‎Backend Installation)
 
(24 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
= Upgrading =
+
= Note =
  
−
== Prerequisites ==
+
Some documentation links point to the 1.9 documentation until things are fully moved over.  The information should still be applicable.
  
−
* 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
+
= Installation and upgrades =
−
* Or via CPAN
 
  
−
== Freeside ==
+
== Backend Installation ==
  
−
* Edit the Makefile (copy/edit your old information from the previous version's Makefile when upgrading)
+
* [[Freeside:2.1:Documentation:Installation|New Installation]]
−
* <code>make install-perl-modules</code>
+
* [[Freeside:2.1:Documentation:RT Installation|Integrated RT Installation]]
−
* As the freeside UNIX user, run <code>freeside-upgrade username</code>, passing the username of an internal Freeside user.
+
* OS-specific installation guides (source)
−
* If freeside-upgrade hangs, try stopping Apache, all Freeside processes, and anything else connected to your database, especially on older PostgreSQL versions.
+
** [[Freeside:2.1:Documentation:InstallingOnDebian5|Debian 5.0 "lenny"]]
−
* <code>make install-docs</code>
+
** [[Freeside:2.1:Documentation:InstallingOnDebian6|Debian 6.0 "squeeze"]]
−
<!-- * 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. -->
+
** [[Freeside:2.1:Documentation:Installation:Ubuntu|Ubuntu 10.4 LTS]]
 +
**[[Freeside:2.1:Documentation:Installation:FreeBSD|FreeBSD 8.1]] - Feedback please!
 +
* OS-specific installation guides (packages)
 +
** (no 2.1 packages yet) <strike>[[Freeside:1.9:Documentation:InstallingUsingAPT|Debian packages]]</strike>
 +
** (no 2.1 packages yet) <strike>[[Freeside:1.9:Documentation:InstallingUsingRPM|CentOS/RHEL RPM packages]]</strike>
  
−
== RT ==
+
== Signup and 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>
+
* [[Freeside:2.1:Documentation:Self-Service Installation|Signup/Self-service Installation]]
−
* 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 ==
+
== Distributor guides ==
  
−
* Restart Apache and the Freeside daemons:
+
* [[Freeside:Documentation:CreatingRPMRepo|Creating your own repository with Freeside RPMs]]
−
  <pre>make deploy</pre>
 
  
−
== Edit configuration ==
+
* [[Freeside:Documentation:MirroringRPMRepo|Creating and using a mirror of the Freeside Internet Services RPM repositories]]
  
−
* 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.
+
* [[Freeside:Documentation:RPMBuildSystem|Documentation on the RPM build system]]
−
* 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 CARD or CHEK
 
−
** "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"
 
  
−
= Changelog =
+
== Upgrading ==
  
−
* [[Freeside:2.1:Changelog|2.1 Changelog]]
+
* [[Freeside:2.1:Documentation:Upgrading|Upgrading from 1.9.X to 2.1.x]]
−
* [[Freeside:2.1.1:Changelog|2.1.1 Changelog]]
+
* [[Freeside:2.1.1:Documentation:Upgrading|Upgrading from 2.1.0 to 2.1.1]]
 +
* [[Freeside:2.1.2:Documentation:Upgrading|Upgrading from 2.1.1 to 2.1.2]]
 +
* [[Freeside:2.1.3:Documentation:Upgrading|Upgrading from 2.1.2 to 2.1.3]]
  
−
= Known Issues =
+
= User's Guide =
  
−
* 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:
+
* [[Freeside:2.1:Documentation:User|User's Guide]] (help wanted)
−
<pre>
+
* [http://www.sisd.com/~ivan/freeside-slides Training presentation slides]
−
$RT::URI::freeside::URL = 'https://your/freeside/URL/';
 
  
−
$RT::URI::freeside::URL =~ m(^(https?://[^/]+)(/.*)$)i;
+
= Administrator's Guide =
−
Set($WebBaseURL, $1);
 
−
Set($WebPath, "$2/rt");
 
−
</pre>
 
  
−
* Ancient Firefox v2.x may have performance problems rendering RT?  (who cares?)
+
* [[Freeside:2.1:Documentation:Administration|Administrator's Guide]]
 +
* [[Freeside:Documentation:DisasterRecovery|Disaster Recovery]]
 +
* [[:Category:Freeside:1.9:Documentation:Template|Templates]] used and their fill in variables.
  
−
* freeside-upgrade failed on several things. The most notable was cust_pkg_reason. Fix like this:
+
= Developer's Guide =
−
<pre>
 
−
select distinct otaker from cust_pkg_reason; select distinct otaker from h_cust_pkg_reason;
 
−
</pre>
 
  
−
For each otaker that's a full name and not a username in the above output, do:
+
* [[Freeside:2.1:Documentation:Developer|Developer's Guide]]
  
−
<pre>
+
= Accounting Guide =
−
update cust_pkg_reason set otaker = (whatever their username is) where otaker = (whatever their full name is from above);
 
−
update h_cust_pkg_reason set otaker = (whatever their username is) where otaker = (whatever their full name is from above);
 
−
update cust_pkg_reason set action = '' where action is null;
 
−
update h_cust_pkg_reason set action = '' where action is null;
 
−
update cust_pkg_reason set usernum = 0 where usernum is null;
 
−
update h_cust_pkg_reason set usernum = 0 where usernum is null;
 
−
</pre>
 
  
−
If it's still failing, examine your data in h_cust_pkg and h_cust_pkg_reason and increase the fuzz factor in cust_pkg_reason::_upgrade_data as needed (e.g. I had to do $fuzz < 15 for one of the steps)
+
*[[Freeside:Documentation:Accounting|Accounting Guide]]
  
 
= Misc =
 
= Misc =
  
−
* Is it necessary to create an fs_bootstrap user??
+
* [[Freeside:Documentation:FAQ|Frequently Asked Questions]]
 +
* [[3rd_party_software|Third-party software]]
 +
* [[Freeside:2.1:Documentation:Administration:VoIP:Timed_Rates|New feature: Timed Rates]]
 +
* [[Freeside:2.1:Documentation:Administration:RT_Workflow|RT workflow features]]
 +
* [[Freeside:2.1:Documentation:Administration:Tips_and_Tricks|Tips and Tricks]]
 +
 
 +
* [[Freeside:1.9:Documentation|Version 1.9 documentation]] (previous maintenance version)
 +
* [[Freeside:2.3:Documentation|Version 2.3 documentation]] (upcoming development version)
 +
 
 +
= Changelog =
 +
 
 +
* [[Freeside:2.1:Changelog|2.1 Changelog]]
 +
* [[Freeside:2.1.1:Changelog|2.1.1 Changelog]]
 +
* [[Freeside:2.1.2:Changelog|2.1.2 Changelog]]
 +
* [[Freeside:2.1.3:Changelog|2.1.3 Changelog]]

Latest revision as of 07:11, 6 May 2011

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

Changelog

Retrieved from "http://freeside.biz/mediawiki/index.php?title=Freeside:2.1:Documentation&oldid=6386"