FS - Freeside Perl modules
Freeside perl modules and CLI utilities.
the FS::Conf manpage - Freeside configuration values
the FS::ConfItem manpage - Freeside configuration option meta-data.
the FS::UID manpage - User class (not yet OO)
the FS::CGI manpage - Non OO-subroutines for the web interface.
the FS::Record manpage - Database record base class
the FS::svc_acct_pop manpage - POP (Point of Presence, not Post Office Protocol) class
the FS::part_pop_local manpage - Local calling area class
the FS::part_referral manpage - Referral class
the FS::cust_main_county manpage - Locale (tax rate) class
the FS::svc_Common manpage - Service base class
the FS::svc_acct manpage - Account (shell, RADIUS, POP3) class
the FS::svc_domain manpage - Domain class
the FS::domain_record manpage - DNS zone entries
the FS::svc_forward manpage - Mail forwarding class
the FS::svc_acct_sm manpage - (Depreciated) Vitual mail alias class
the FS::svc_www manpage - Web virtual host class.
the FS::part_svc manpage - Service definition class
the FS::part_svc_column manpage - Column constraint class
the FS::part_export manpage - External provisioning export class
the FS::part_export_option manpage - Export option class
the FS::part_pkg manpage - Package (billing item) definition class
the FS::pkg_svc manpage - Class linking package (billing item) definitions (see the FS::part_pkg manpage) with service definitions (see the FS::part_svc manpage)
the FS::agent manpage - Agent (reseller) class
the FS::agent_type manpage - Agent type class
the FS::type_pkgs manpage - Class linking agent types (see the FS::agent_type manpage) with package (billing item) definitions (see the FS::part_pkg manpage)
the FS::cust_svc manpage - Service class
the FS::cust_pkg manpage - Package (billing item) class
the FS::cust_main manpage - Customer class
the FS::cust_main_invoice manpage - Invoice destination class
the FS::cust_bill manpage - Invoice class
the FS::cust_bill_pkg manpage - Invoice line item class
the FS::part_bill_event manpage - Invoice event definition class
the FS::cust_bill_event manpage - Completed invoice event class
the FS::cust_pay manpage - Payment class
the FS::cust_bill_pay manpage - Payment application class
the FS::cust_credit manpage - Credit class
the FS::cust_refund manpage - Refund class
the FS::cust_credit_refund manpage - Refund application class
the FS::cust_credit_bill manpage - Credit invoice application class
the FS::cust_pay_batch manpage - Credit card transaction queue class
the FS::prepay_credit manpage - Prepaid ``calling card'' credit class.
the FS::nas manpage - Network Access Server class
the FS::port manpage - NAS port class
the FS::session manpage - User login session class
the FS::queue manpage - Job queue
the FS::queue_arg manpage - Job arguments
the FS::MailAdminServer manpage
the FS::UI::Base manpage - User-interface base class
the FS::UI::Gtk manpage - Gtk user-interface class
the FS::UI::CGI manpage - CGI (HTML) user-interface class
the FS::UI::agent manpage - agent table user-interface class
To quote perl(1), ``If you're intending to read these straight through for the first time, the suggested order will tend to reduce the number of forward references.''
If you've never used OO modules before, http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html might help you out.
Freeside is a billing and administration package for Internet Service Providers.
The Freeside home page is at <http://www.sisd.com/freeside>.
The main documentation is in httemplate/docs.
A mailing list for users is available. Send a blank message to <ivan-freeside-subscribe@sisd.com> to subscribe.
A mailing list for developers is available. It is intended to be lower volume and higher SNR than the users list. Send a blank message to <ivan-freeside-devel-subscribe@sisd.com> to subscribe.
Commercial support is available; see <http://www.sisd.com/freeside/commercial.html>.
Primarily Ivan Kohler <ivan@sisd.com>, with help from many kind folks.
See the CREDITS file in the Freeside distribution for a (hopefully) complete list and the individal files for details.
perl(1), main Freeside documentation in htdocs/docs/
Those modules which would be useful separately should be pulled out, renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH and Net::SCP...