Upgrading to 1.5.8

From 4c9e6e4863e2045d984933ab0e229b5dd500e1f7 Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 8 Feb 2006 03:50:42 +0000 Subject: slightly html-ize the 1.5.8 upgrade instructions --- httemplate/docs/index.html | 4 +- httemplate/docs/upgrade10.html | 116 +++++++++++++++++++++++------------------ 2 files changed, 66 insertions(+), 54 deletions(-) (limited to 'httemplate/docs') diff --git a/httemplate/docs/index.html b/httemplate/docs/index.html index 7254d76f3..bec62e34a 100644 --- a/httemplate/docs/index.html +++ b/httemplate/docs/index.html @@ -8,11 +8,9 @@

Configuration and setup

-this is incomplete
-
-NOTE: Version numbering has been simplified.  1.5.7 is the version after
-1.5.0pre6.  It is still a development version - releases with odd numbered 
-middle parts (NN in x.NN.x) are development versions, like Perl or Linux.
-
-If migrating from 1.5.7, see README.1.5.8 instead
-
-If migrating from 1.5.0pre6, see README.1.5.7 instead
-
-install DBD::Pg 1.32, 1.41 or later (not 1.40) (or, if you're using a Perl version before 5.6, you could try installing DBD::Pg 1.22 with this patch and commenting out the "use DBD::Pg 1.32" at the top of DBIx/DBSchema/DBD/Pg.pm)
-install DBIx::DBSchema 0.27 (or later)
-  (if you are running Pg version 7.2.x or earlier, install at least
-   DBIx::DBSchema 0.29)
-install Net::SSH 0.08
-install HTML::Widgets::SelectLayers 0.05
-install Business::CreditCard 0.28
-
-- If using Apache::ASP, add PerlSetVar RequestBinaryRead Off and PerlSetVar IncludesDir /your/freeside/document/root/ to your Apache configuration and make sure you are using Apache::ASP minimum version 2.55.
-- In httpd.conf, change <Files ~ \.cgi> to  <Files ~ (\.cgi|\.html)>
-- In httpd.conf, change AddHandler perl-script .cgi or SetHandler perl-script to AddHandler perl-script .cgi .html
-
-install NetAddr::IP, Chart::Base, Locale::SubCountry, Text::CSV_XS, 
+
+  Upgrading to 1.5.8
+
+
+Upgrading to 1.5.8 from 1.4.1 or 1.4.2
+
+Note: Version numbering has been simplified.  1.5.7 and 1.5.8 are the
+versions following 1.5.0pre6.  They are still development versions - releases
+with odd numbered middle parts (NN in x.NN.x) are development versions, like
+Perl or Linux.
+
+
+

+
+
+  If migrating from 1.5.0pre6, see README.1.5.7 instead
+  
If migrating from 1.5.7, see README.1.5.8 instead
+  
 install DBD::Pg 1.32, 1.41 or later (not 1.40) (or, if you're using a Perl version before 5.6, you could try installing DBD::Pg 1.22 with this patch and commenting out the "use DBD::Pg 1.32" at the top of DBIx/DBSchema/DBD/Pg.pm)
+  
 install DBIx::DBSchema 0.27 (or later) (if you are running Pg version 7.2.x or earlier, install at least DBIx::DBSchema 0.29)
+  
 install Net::SSH 0.08 or later
+  
 install HTML::Widgets::SelectLayers 0.05 or later
+  
 install Business::CreditCard 0.28 or later
+
+  
If using Apache::ASP, add PerlSetVar RequestBinaryRead Off and PerlSetVar IncludesDir /your/freeside/document/root/ to your Apache configuration and make sure you are using Apache::ASP minimum version 2.55.
+    
+      In httpd.conf, change <Files ~ \.cgi> to  <Files ~ (\.cgi|\.html)>
+      
In httpd.conf, change AddHandler perl-script .cgi or SetHandler perl-script to AddHandler perl-script .cgi .html
+    
+  
install NetAddr::IP, Chart::Base, Locale::SubCountry, Text::CSV_XS, 
 Spreadsheet::WriteExcel, IO-stringy (IO::Scalar), Frontier::RPC
 (Frontier::RPC2), MIME::Entity (MIME-tools), IPC::Run3, Net::Whois::Raw,
 JSON and Term::ReadKey
 
 
+  
Apply the following changes to your database:
+ INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 20, 'svc_external-id', 'en_US', 'External ID' );
 INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 21, 'svc_external-title', 'en_US', 'Title' );
 
 DROP INDEX cust_bill_pkg1;
+
 
-On recent Pg versions:
-
+  
On recent Pg versions:
+ ALTER TABLE cust_main ALTER COLUMN payinfo varchar(512) NULL;
 ALTER TABLE h_cust_main ALTER COLUMN payinfo varchar(512) NULL;
+
+On older Pg versions that don't support altering columns directly, you will need to dump the database, edit the schema definitions in the dump file, and reload.
 
-Or on older Pg versions that don't support altering columns directly:
-(dump database, edit & reload)
-
-On recent Pg versions:
-
+  
On recent Pg versions:
+ ALTER TABLE svc_forward ALTER COLUMN srcsvc DROP NOT NULL;
 ALTER TABLE h_svc_forward ALTER COLUMN srcsvc DROP NOT NULL;
 ALTER TABLE svc_forward ALTER COLUMN dstsvc DROP NOT NULL;
 ALTER TABLE h_svc_forward ALTER COLUMN dstsvc DROP NOT NULL;
 ALTER TABLE cust_main ALTER COLUMN zip DROP NOT NULL;
 ALTER TABLE h_cust_main ALTER COLUMN zip DROP NOT NULL;
-
+
 Or on Pg versions that don't support DROP NOT NULL (tested on 7.1 and 7.2 so far):
+ UPDATE pg_attribute SET attnotnull = FALSE WHERE ( attname = 'srcsvc' OR attname = 'dstsvc' ) AND ( attrelid = ( SELECT oid FROM pg_class WHERE relname = 'svc_forward' ) OR attrelid = ( SELECT oid FROM pg_class WHERE relname = 'h_svc_forward' ) );
 UPDATE pg_attribute SET attnotnull = FALSE WHERE ( attname = 'zip' ) AND ( attrelid = ( SELECT oid FROM pg_class WHERE relname = 'cust_main' ) OR attrelid = ( SELECT oid FROM pg_class WHERE relname = 'h_cust_main' ) );
+
 
-If you created your database with a version before 1.4.2, dump database, edit:
-- cust_main and h_cust_main: increase otaker from 8 to 32
-- cust_main and h_cust_main: change ss from char(11) to varchar(11) ( "character(11)" to "character varying(11)" )
-- cust_credit and h_cust_credit: increase otaker from 8 to 32
-- cust_pkg and h_cust_pkg: increase otaker from 8 to 32
-- cust_refund and h_cust_refund: increase otaker from 8 to 32
-- domain_record and h_domain_record: increase reczone from 80 to 255
-- domain_record and h_domain_record: change rectype from char to varchar ( "character(5)" to "character varying(5)" )
-- domain_record and h_domain_record: increase recdata from 80 to 255
-then reload
-
-mandatory again:
-
-make install-perl-modules to install the new libraries and CLI utilities
-run "freeside-upgrade username" to create the remaining new tables and columns
-
-optionally:
-
+  
 If you created your database with a version before 1.4.2, dump database, edit the following, then reload:
+    
+      cust_main and h_cust_main: increase otaker from 8 to 32
+      
cust_main and h_cust_main: change ss from char(11) to varchar(11) ( "character(11)" to "character varying(11)" )
+      
cust_credit and h_cust_credit: increase otaker from 8 to 32
+      
cust_pkg and h_cust_pkg: increase otaker from 8 to 32
+      
cust_refund and h_cust_refund: increase otaker from 8 to 32
+      
domain_record and h_domain_record: increase reczone from 80 to 255
+      
domain_record and h_domain_record: change rectype from char to varchar ( "character(5)" to "character varying(5)" )
+      
domain_record and h_domain_record: increase recdata from 80 to 255
+    
+
+
make install-perl-modules to install the new libraries and CLI utilities
+
run "freeside-upgrade username" to create the remaining new tables and columns
+
+
optionally:
+ CREATE INDEX cust_main4 ON cust_main ( daytime );
 CREATE INDEX cust_main5 ON cust_main ( night );
 CREATE INDEX cust_main6 ON cust_main ( fax );
@@ -89,5 +99,9 @@ CREATE INDEX cust_pay4 ON cust_pay (_date);
 CREATE INDEX part_referral1 ON part_referral ( disabled );
 CREATE INDEX part_pkg2 ON part_pkg ( promo_code );
 CREATE INDEX h_part_pkg2 ON h_part_pkg ( promo_code );
-
 
+
+
+
+
+
-- 
cgit v1.2.1


From eb035e51ad8df6b3301c81679a9f4b51b6ea4c4d Mon Sep 17 00:00:00 2001
From: ivan 
Date: Wed, 8 Feb 2006 03:50:53 +0000
Subject: remove ancient upgrade instructions

---
 httemplate/docs/upgrade7.html |  24 ---
 httemplate/docs/upgrade8.html | 394 ------------------------------------------
 2 files changed, 418 deletions(-)
 delete mode 100644 httemplate/docs/upgrade7.html
 delete mode 100644 httemplate/docs/upgrade8.html

(limited to 'httemplate/docs')

diff --git a/httemplate/docs/upgrade7.html b/httemplate/docs/upgrade7.html
deleted file mode 100644
index d9dcfe2ae..000000000
--- a/httemplate/docs/upgrade7.html
+++ /dev/null
@@ -1,24 +0,0 @@
-
-  Upgrading to 1.3.1
-
-
-Upgrading to 1.3.1 from 1.3.0
-
-  If migrating from 1.0.0, see these instructions first.
-  
If migrating from less than 1.1.4, see these instructions first.
-  
If migrating from less than 1.2.0, see these instructions first.
-  
If migrating from less than 1.2.2, see these instructions first.
-  
If migrating from less than 1.2.3, see these instructions first.
-  
If migrating from less than 1.3.0, see these instructions first.
-  
Back up your data and current Freeside installation.
-  
Copy or symlink htdocs to the new copy.
-  
Change to the FS directory in the new tarball, and build and install the
-      Perl modules:
-    -$ cd FS/
-$ perl Makefile.PL
-$ make
-$ su
-# make install UNINST=1
-  
Run bin/dbdef-create.
-
diff --git a/httemplate/docs/upgrade8.html b/httemplate/docs/upgrade8.html
deleted file mode 100644
index 9ca7cb7b9..000000000
--- a/httemplate/docs/upgrade8.html
+++ /dev/null
@@ -1,394 +0,0 @@
-
-  Upgrading to 1.4.0
-
-
-Upgrading to 1.4.0 from 1.3.1
-
-  If migrating from less than 1.3.1, see these instructions first.
-  
Backup your database and current Freeside installation. (with PostgreSQL) (with MySQL)
-  
mod_perl is now required.
-  
Install Time-Duration, Tie-IxHash and HTML-Widgets-SelectLayers (minimum version 0.02).
-  
Install Apache::ASP or HTML::Mason (use version 1.0x - Freeside is not yet compatible with version 1.1x).
-  
Install rsync
-
-
-  
-    
-  
-  
-    
-    
-  
-Apache::ASP Mason

-      Run make aspdocs
-      
Copy aspdocs/ to your web server's document space.
-      
Create a Global directory, such as /usr/local/etc/freeside/asp-global/
-      
Copy htetc/global.asa to the Global directory.
-      
Configure Apache for the Global directory and to execute .cgi files using Apache::ASP.  For example:
--<Directory /usr/local/apache/htdocs/freeside-asp>
-<Files ~ (\.cgi)>
-AddHandler perl-script .cgi
-PerlHandler Apache::ASP
-</Files>
-<Perl>
-$MLDBM::RemoveTaint = 1;
-</Perl>
-PerlSetVar Global /usr/local/etc/freeside/asp-global/
-</Directory>
-
-    
-      (use version 1.0x - Freeside is not yet compatible with version 1.1x)
-      
Run make masondocs
-      
Copy masondocs/ to your web server's document space.
-      
Copy htetc/handler.pl to your web server's configuration directory.
-      
Edit handler.pl and set an appropriate data_dir, such as /usr/local/etc/freeside/mason-data
-      
Configure Apache to use the handler.pl file and to execute .cgi files using HTML::Mason.  For example:
--<Directory /usr/local/apache/htdocs/freeside-mason>
-<Files ~ (\.cgi)>
-AddHandler perl-script .cgi
-PerlHandler HTML::Mason
-</Files>
-<Perl>
-require "/usr/local/apache/conf/handler.pl";
-</Perl>
-</Directory>
-
-    
-
-  Build and install the Perl modules:
-    -$ su
-# make install-perl-modules
-   
Apply the following changes to your database:
--CREATE TABLE svc_forward (
-  svcnum int NOT NULL,
-  srcsvc int NOT NULL,
-  dstsvc int NOT NULL,
-  dst varchar(80),
-  PRIMARY KEY (svcnum)
-);
-ALTER TABLE part_svc ADD svc_forward__srcsvc varchar(80) NULL;
-ALTER TABLE part_svc ADD svc_forward__srcsvc_flag char(1) NULL;
-ALTER TABLE part_svc ADD svc_forward__dstsvc varchar(80) NULL;
-ALTER TABLE part_svc ADD svc_forward__dstsvc_flag char(1) NULL;
-ALTER TABLE part_svc ADD svc_forward__dst varchar(80) NULL;
-ALTER TABLE part_svc ADD svc_forward__dst_flag char(1) NULL;
-
-CREATE TABLE cust_credit_bill (
-  creditbillnum int primary key,
-  crednum int not null,
-  invnum int not null,
-  _date int not null,
-  amount decimal(10,2) not null
-);
-
-CREATE TABLE cust_bill_pay (
-  billpaynum int primary key,
-  invnum int not null,
-  paynum int not null,
-  _date int not null,
-  amount decimal(10,2) not null
-);
-
-CREATE TABLE cust_credit_refund (
-  creditrefundnum int primary key,
-  crednum int not null,
-  refundnum int not null,
-  _date int not null,
-  amount decimal(10,2) not null
-);
-
-CREATE TABLE part_svc_column (
-  columnnum int primary key,
-  svcpart int not null,
-  columnname varchar(64) not null,
-  columnvalue varchar(80) null,
-  columnflag char(1) null
-);
-
-CREATE TABLE queue (
-  jobnum int primary key,
-  job text not null,
-  _date int not null,
-  status varchar(80) not null,
-  statustext text null,
-  svcnum int null
-);
-CREATE INDEX queue1 ON queue ( svcnum );
-CREATE INDEX queue2 ON queue ( status );
-
-CREATE TABLE queue_arg (
-  argnum int primary key,
-  jobnum int not null,
-  arg text null
-);
-CREATE INDEX queue_arg1 ON queue_arg ( jobnum );
-
-CREATE TABLE queue_depend (
-  dependnum int primary key,
-  jobnum int not null,
-  depend_jobnum int not null
-);
-CREATE INDEX queue_depend1 ON queue_depend ( jobnum );
-CREATE INDEX queue_depend2 ON queue_depend ( depend_jobnum );
-
-CREATE TABLE part_pop_local (
-  localnum int primary key,
-  popnum int not null,
-  city varchar(80) null,
-  state char(2) null,
-  npa char(3) not null,
-  nxx char(3) not null
-);
-CREATE UNIQUE INDEX part_pop_local1 ON part_pop_local ( npa, nxx );
-
-CREATE TABLE cust_bill_event (
-  eventnum int primary key,
-  invnum int not null,
-  eventpart int not null,
-  _date int not null,
-  status varchar(80) not null, 
-  statustext text
-);
-CREATE UNIQUE INDEX cust_bill_event1 ON cust_bill_event ( eventpart, invnum );
-CREATE INDEX cust_bill_event2 ON cust_bill_event ( invnum );
-
-CREATE TABLE part_bill_event (
-  eventpart int primary key,
-  payby char(4) not null,
-  event varchar(80) not null,
-  eventcode text null,
-  seconds int null,
-  weight int not null,
-  plan varchar(80) null,
-  plandata text null,
-  disabled char(1) null
-);
-CREATE INDEX part_bill_event1 ON part_bill_event ( payby );
-
-CREATE TABLE export_svc (
-  exportsvcnum int primary key,
-  exportnum int not null,
-  svcpart int not null
-);
-CREATE UNIQUE INDEX export_svc1 ON export_svc ( exportnum, svcpart );
-CREATE INDEX export_svc2 ON export_svc ( exportnum );
-CREATE INDEX export_svc3 ON export_svc ( svcpart );
-
-CREATE TABLE part_export (
-  exportnum int primary key,
-  machine varchar(80) not null,
-  exporttype varchar(80) not null,
-  nodomain char(1) NULL
-);
-CREATE INDEX part_export1 ON part_export ( machine );
-CREATE INDEX part_export2 ON part_export ( exporttype );
-
-CREATE TABLE part_export_option (
-  optionnum int primary key,
-  exportnum int not null,
-  optionname varchar(80) not null,
-  optionvalue text NULL
-);
-CREATE INDEX part_export_option1 ON part_export_option ( exportnum );
-CREATE INDEX part_export_option2 ON part_export_option ( optionname );
-
-CREATE TABLE radius_usergroup (
-  usergroupnum int primary key,
-  svcnum int not null,
-  groupname varchar(80) not null
-);
-CREATE INDEX radius_usergroup1 ON radius_usergroup ( svcnum );
-CREATE INDEX radius_usergroup2 ON radius_usergroup ( groupname );
-
-CREATE TABLE msgcat (
-  msgnum int primary key,
-  msgcode varchar(80) not null,
-  locale varchar(16) not null,
-  msg text not null
-);
-CREATE INDEX msgcat1 ON msgcat ( msgcode, locale );
-
-CREATE TABLE cust_tax_exempt (
-  exemptnum int primary key,
-  custnum int not null,
-  taxnum int not null,
-  year int not null,
-  month int not null,
-  amount decimal(10,2)
-);
-CREATE UNIQUE INDEX cust_tax_exempt1 ON cust_tax_exempt ( taxnum, year, month );
-
-ALTER TABLE svc_acct ADD domsvc integer NULL;
-ALTER TABLE part_svc ADD svc_acct__domsvc varchar(80) NULL;
-ALTER TABLE part_svc ADD svc_acct__domsvc_flag char(1) NULL;
-ALTER TABLE svc_domain ADD catchall integer NULL;
-ALTER TABLE cust_main ADD referral_custnum integer NULL;
-ALTER TABLE cust_main ADD comments text NULL;
-ALTER TABLE cust_pay ADD custnum integer;
-ALTER TABLE cust_pay_batch ADD paybatchnum integer;
-ALTER TABLE cust_refund ADD custnum integer;
-ALTER TABLE cust_pkg ADD manual_flag char(1) NULL;
-ALTER TABLE part_pkg ADD plan varchar(80) NULL;
-ALTER TABLE part_pkg ADD plandata text NULL;
-ALTER TABLE part_pkg ADD setuptax char(1) NULL;
-ALTER TABLE part_pkg ADD recurtax char(1) NULL;
-ALTER TABLE part_pkg ADD disabled char(1) NULL;
-ALTER TABLE part_svc ADD disabled char(1) NULL;
-ALTER TABLE cust_bill ADD closed char(1) NULL;
-ALTER TABLE cust_pay ADD closed char(1) NULL;
-ALTER TABLE cust_credit ADD closed char(1) NULL;
-ALTER TABLE cust_refund ADD closed char(1) NULL;
-ALTER TABLE cust_bill_event ADD status varchar(80);
-ALTER TABLE cust_bill_event ADD statustext text NULL;
-ALTER TABLE svc_acct ADD sec_phrase varchar(80) NULL;
-ALTER TABLE part_svc ADD svc_acct__sec_phrase varchar(80) NULL;
-ALTER TABLE part_svc ADD svc_acct__sec_phrase_flag char(1) NULL;
-ALTER TABLE part_pkg ADD taxclass varchar(80) NULL;
-ALTER TABLE cust_main_county ADD taxclass varchar(80) NULL;
-ALTER TABLE cust_main_county ADD exempt_amount decimal(10,2);
-CREATE INDEX cust_main3 ON cust_main ( referral_custnum );
-CREATE INDEX cust_credit_bill1 ON cust_credit_bill ( crednum );
-CREATE INDEX cust_credit_bill2 ON cust_credit_bill ( invnum );
-CREATE INDEX cust_bill_pay1 ON cust_bill_pay ( invnum );
-CREATE INDEX cust_bill_pay2 ON cust_bill_pay ( paynum );
-CREATE INDEX cust_credit_refund1 ON cust_credit_refund ( crednum );
-CREATE INDEX cust_credit_refund2 ON cust_credit_refund ( refundnum );
-CREATE UNIQUE INDEX cust_pay_batch_pkey ON cust_pay_batch ( paybatchnum );
-CREATE UNIQUE INDEX part_svc_column1 ON part_svc_column ( svcpart, columnname );
-CREATE INDEX cust_pay2 ON cust_pay ( paynum );
-CREATE INDEX cust_pay3 ON cust_pay ( custnum );
-CREATE INDEX cust_pay4 ON cust_pay ( paybatch );
-
-
-  
If you are using PostgreSQL, apply the following changes to your database:
--CREATE UNIQUE INDEX agent_pkey ON agent ( agentnum );
-CREATE UNIQUE INDEX agent_type_pkey ON agent_type ( typenum );
-CREATE UNIQUE INDEX cust_bill_pkey ON cust_bill ( invnum );
-CREATE UNIQUE INDEX cust_credit_pkey ON cust_credit ( crednum );
-CREATE UNIQUE INDEX cust_main_pkey ON cust_main ( custnum );
-CREATE UNIQUE INDEX cust_main_county_pkey ON cust_main_county ( taxnum );
-CREATE UNIQUE INDEX cust_main_invoice_pkey ON cust_main_invoice ( destnum );
-CREATE UNIQUE INDEX cust_pay_pkey ON cust_pay ( paynum );
-CREATE UNIQUE INDEX cust_pkg_pkey ON cust_pkg ( pkgnum );
-CREATE UNIQUE INDEX cust_refund_pkey ON cust_refund ( refundnum );
-CREATE UNIQUE INDEX cust_svc_pkey ON cust_svc ( svcnum );
-CREATE UNIQUE INDEX domain_record_pkey ON domain_record ( recnum );
-CREATE UNIQUE INDEX nas_pkey ON nas ( nasnum );
-CREATE UNIQUE INDEX part_pkg_pkey ON part_pkg ( pkgpart );
-CREATE UNIQUE INDEX part_referral_pkey ON part_referral ( refnum );
-CREATE UNIQUE INDEX part_svc_pkey ON part_svc ( svcpart );
-CREATE UNIQUE INDEX port_pkey ON port ( portnum );
-CREATE UNIQUE INDEX prepay_credit_pkey ON prepay_credit ( prepaynum );
-CREATE UNIQUE INDEX session_pkey ON session ( sessionnum );
-CREATE UNIQUE INDEX svc_acct_pkey ON svc_acct ( svcnum );
-CREATE UNIQUE INDEX svc_acct_pop_pkey ON svc_acct_pop ( popnum );
-CREATE UNIQUE INDEX svc_acct_sm_pkey ON svc_acct_sm ( svcnum );
-CREATE UNIQUE INDEX svc_domain_pkey ON svc_domain ( svcnum );
-CREATE UNIQUE INDEX svc_www_pkey ON svc_www ( svcnum );
-
-  
If you wish to enable service/shipping addresses, apply the following
-      changes to your database:
--ALTER TABLE cust_main ADD COLUMN ship_last varchar(80) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_first varchar(80) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_company varchar(80) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_address1 varchar(80) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_address2 varchar(80) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_city varchar(80) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_county varchar(80) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_state varchar(80) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_zip varchar(10) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_country char(2) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_daytime varchar(20) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_night varchar(20) NULL;
-ALTER TABLE cust_main ADD COLUMN ship_fax varchar(12) NULL;
-CREATE INDEX cust_main4 ON cust_main ( ship_last );
-CREATE INDEX cust_main5 ON cust_main ( ship_company );
-
-  
If you are using the signup server, reinstall it according to the instructions.  The 1.3.x signup server is not compatible with 1.4.x.
-  
Run bin/dbdef-create username
-  
If you have svc_acct_sm records or service definitions:
-    
-      Create a service definition with table svc_forward
-      
Run bin/fs-migrate-svc_acct_sm username
-    
-  
Or if you just have svc_acct records:
-    
-      Order and provision a package for your default domain and note down the Service # or svcnum.
-      
UPDATE svc_acct SET domsvc = svcnum
-      
Update your service definitions to have default (or fixed) domsvc.
-    
-  
Run bin/fs-migrate-payrefusername
-  
Run bin/fs-migrate-part_svcusername
-  
After running bin/fs-migrate-payref, apply the following changes to your database:
-  
-PostgreSQL MySQL, others

--CREATE TABLE cust_pay_temp (
-  paynum int primary key,
-  custnum int not null,
-  paid decimal(10,2) not null,
-  _date int null,
-  payby char(4) not null,
-  payinfo varchar(16) null,
-  paybatch varchar(80) null,
-  closed char(1) null
-);
-INSERT INTO cust_pay_temp SELECT paynum, custnum, paid, _date, payby, payinfo, paybatch, closed FROM cust_pay;
-DROP TABLE cust_pay;
-ALTER TABLE cust_pay_temp RENAME TO cust_pay;
-CREATE UNIQUE INDEX cust_pay1 ON cust_pay (paynum);
-CREATE TABLE cust_refund_temp (
-  refundnum int primary key,
-  custnum int not null,
-  _date int null,
-  refund decimal(10,2) not null,
-  otaker varchar(8) not null,
-  reason varchar(80) not null,
-  payby char(4) not null,
-  payinfo varchar(16) null,
-  paybatch varchar(80) null,
-  closed char(1) null
-);
-INSERT INTO cust_refund_temp SELECT refundnum, custnum, _date, refund, otaker, reason, payby, payinfo, '', closed from cust_refund;
-DROP TABLE cust_refund;
-ALTER TABLE cust_refund_temp RENAME TO cust_refund;
-CREATE UNIQUE INDEX cust_refund1 ON cust_refund (refundnum);
-
- 
--ALTER TABLE cust_pay DROP COLUMN invnum;
-ALTER TABLE cust_refund DROP COLUMN crednum;
-
-
-  
IMPORTANT: After applying the second set of database changes, run bin/dbdef-create username again.
-  
IMPORTANT: run bin/create-history-tables username
-  
IMPORTANT: After running bin/create-history-tables, run bin/dbdef-create username again.
-  
As the freeside UNIX user, run bin/populate-msgcat username to populate the message catalog
-
-  
set the locale configuration value to en_US.
-  
the mxmachines, nsmachines, arecords and cnamerecords configuration values have been deprecated.  Set the defaultrecords configuration value instead.
-  
Create the `/usr/local/etc/freeside/cache.datasrc' directory
-      (owned by the freeside user).
-  
freeside-queued was installed with the Perl modules.  Start it now and ensure that is run upon system startup.
-  
Set appropriate invoice events for your site.  At the very least, you'll want to set some invoice events "After 0 days": a BILL invoice event to print invoices, a CARD invoice event to batch or run cards real-time, and a COMP invoice event to "pay" complimentary customers.  If you were using the -i option to freeside-bill it should be removed.
-  
Use freeside-daily instead of freeside-bill.
-  
If you would like Freeside to notify your customers when their credit
-  cards and other billing arrangements are about to expire, arrange for
-  freeside-expiration-alerter to be run daily by cron or similar
-  facility.  The message it sends can be configured from the
-  Configuration choice of the main menu as alerter_template.
-  
Export has been rewritten.  If you were using the icradiusmachines,
-  icradius_mysqldest, icradius_mysqlsource, or icradius_secrets files, add
-  an appropriate "sqlradius" export to all relevant Service Definitions
-  instead.  Use MySQL replication or
-  point the "sqlradius" export directly at your external ICRADIUS or FreeRADIUS
-  database (or through an SSL-necrypting proxy...)
-
-
-- 
cgit v1.2.1


From a2b0b3e8500b08a5cf017c85693d9649853f8569 Mon Sep 17 00:00:00 2001
From: ivan 
Date: Thu, 16 Feb 2006 21:43:02 +0000
Subject: automate more of the initial data adding...

---
 httemplate/docs/admin.html   | 45 ++------------------------------------------
 httemplate/docs/install.html | 11 ++---------
 2 files changed, 4 insertions(+), 52 deletions(-)

(limited to 'httemplate/docs')

diff --git a/httemplate/docs/admin.html b/httemplate/docs/admin.html
index 9ce259c2b..2aa934812 100755
--- a/httemplate/docs/admin.html
+++ b/httemplate/docs/admin.html
@@ -11,49 +11,8 @@
   /home/httpd/html, open https://your_host/freeside/. Replace
   "your_host" with the name or network address of your web server.
   
Select Configuration from the main menu and update your configuration values.
-  
Next you must create a service definition.  An example of a service
-  definition would be a dial-up account or a domain.  First, it is
-  necessary to create a domain definition.  Click on View/Edit service
-  definitions and Add a new service definition with Table
-  svc_domain (and no modifiers).
 
-  
Now that you have created your first service, you must create a package
-  including this service which you can sell to customers.  Zero, one, or many
-  services are bundled into a package.  Click on View/Edit package
-  definitions and Add a new package definition which includes
-  quantity 1 of the svc_domain service you created above.
-
-  
After you create your first package, then you must define who is
-  able to sell that package by creating an agent type.  An example of
-  an agent type would be an internal sales representitive which sells
-  regular and promotional packages, as opposed to an external sales
-  representitive which would only sell regular packages of services.  Click on
-  View/Edit agent types and Add a new agent type.  Allow this
-  agent type to sell the package you created above.
-
-  
After creating a new agent type, you must create an agent.  Click on
-  View/Edit agents and Add a new agent.
-
-  
Set up at least one Advertising source.  Advertising sources will help
-  you keep track of how effective your advertising is, tracking where customers
-  heard of your service offerings.  You must create at least one advertising 
-  source.  If you do not wish to use the referral functionality, simply create
-  a single advertising source only.  Click on View/Edit advertising
-  sources and Add a new advertising source.
-
-  
Click on New Customer and create a new customer for your system
-  accounts with billing type Complimentary.  Leave the First
-  package dropdown set to (none).
-
-  
From the Customer View screen of the newly created customer, order the
-  package you defined above.
-
-  
From the Package View screen of the newly created package, choose
-  (Provision) to add the customer's service for this new package.
-
-  
Add your own domain.
-
-  
Go back to View/Edit service definitions on the main menu, and
+  
Go to View/Edit service definitions on the main menu, and
   Add a new service definition with Table svc_acct.
   Select your domain in the domsvc Modifier.  Set Fixed to define
   a service locked-in to this domain, or Default to define a service
@@ -69,7 +28,7 @@
 
   
If you are using Freeside to keep track of sales taxes, define tax
   information for your locales by clicking on the View/Edit locales and tax
-  rates on the main menu.
+  rates on the main menu.
 
   
If you would like Freeside to notify your customers when their credit
   cards and other billing arrangements are about to expire, arrange for
diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html
index 1f80db1a7..02572759e 100644
--- a/httemplate/docs/install.html
+++ b/httemplate/docs/install.html
@@ -196,17 +196,10 @@ require valid-user
 $ su
 # freeside-adduser fs_queue
 # freeside-adduser fs_selfservice
-  
As the freeside UNIX user, run freeside-setup username to create the database tables, passing the username of a Freeside user you created above:
+  
As the freeside UNIX user, run freeside-setup -d domain.name username to create the database tables and initial data, passing the username of a Freeside user you created above:
  $ su freeside
-$ freeside-setup username
-
-  Alternately, use the -s option to enable shipping addresses: freeside-setup -s username
-  
As the freeside UNIX user, run bin/populate-msgcat username (in the untar'ed freeside directory) to populate the message catalog, passing the username of a Freeside user you created above:
--$ su freeside
-$ cd /path/to/freeside/
-$ bin/populate-msgcat username
+$ freeside-setup -d example.com username
 
   
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 INIT_FILE with the appropriate location on your systemand QUEUED_USER with the username of a Freeside user you created above, and run make install-init)
   
Now proceed to the initial administration of your installation.
-- 
cgit v1.2.1


From 6d27649c93f3f83c14611c790281a7b667062fc0 Mon Sep 17 00:00:00 2001
From: ivan 
Date: Sat, 18 Feb 2006 04:32:57 +0000
Subject: Mason it is

---
 httemplate/docs/install.html | 39 ++-------------------------------------
 1 file changed, 2 insertions(+), 37 deletions(-)

(limited to 'httemplate/docs')

diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html
index 02572759e..6e366cbbb 100644
--- a/httemplate/docs/install.html
+++ b/httemplate/docs/install.html
@@ -52,7 +52,7 @@ Before installing, you need:
       
Net-SSH
       
String-ShellQuote
       
Net-SCP
-      
HTML::Mason (recommended, enables full functionality) or Apache::ASP (deprecated, integrated RT ticketing will not be available)
+      
HTML::Mason
       
Tie-IxHash
       
Time-Duration
       
HTML-Widgets-SelectLayers
@@ -123,15 +123,7 @@ $ su
     
Run a separate iteration of Apache[-SSL] with mod_perl enabled as the freeside user.
     
Edit the Makefile and set TEMPLATE to asp or mason.  Also set FREESIDE_DOCUMENT_ROOT.
     
Run  make install-docs.
-
-
-  
-    
-  
-  
-
-    
-
-    
-
-  
-Mason (recommended) Apache::ASP (deprecated)

-      Configure Apache:
+
Configure Apache:
  PerlModule HTML::Mason
 # your freeside docuemnt root
@@ -145,33 +137,6 @@ require "/usr/local/etc/freeside/handler.pl";
 </Perl>
 </Directory>
 
-    
-      Configure Apache:
--PerlModule Apache::ASP
-# your freeside document root
-<Directory /var/www/freeside>
-<Files ~ (\.cgi|\.html)>
-AddHandler perl-script .cgi .html
-PerlHandler Apache::ASP
-</Files>
-<Perl>
-$MLDBM::RemoveTaint = 1;
-</Perl>
-PerlSetVar Global /usr/local/etc/freeside/asp-global/
-PerlSetVar Debug 2
-PerlSetVar RequestBinaryRead Off
-# your freeside document root
-PerlSetVar IncludesDir /var/www/freeside
-</Directory>
-
-    
-
 Restrict access to this web interface - see the Apache documentation on user authentication.    For example, to configure user authentication with mod_auth (flat files), add something like the following to your Apache httpd.conf file, adjusting for your actual paths:
  #your freeside document root
-- 
cgit v1.2.1


From c509ea790c3d0631a0e1f79527ec937e419e380e Mon Sep 17 00:00:00 2001
From: ivan 
Date: Tue, 18 Apr 2006 19:33:38 +0000
Subject: add JSON to initial install instructions

---
 httemplate/docs/install.html | 1 +
 1 file changed, 1 insertion(+)

(limited to 'httemplate/docs')

diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html
index 6e366cbbb..78172e8e4 100644
--- a/httemplate/docs/install.html
+++ b/httemplate/docs/install.html
@@ -71,6 +71,7 @@ Before installing, you need:
       IPC::Run3
       
Term::ReadKey
 
+      
JSON
       
Fax::Hylafax::Client (Required if using FAX invoice destinations)
       
Apache::DBI (optional but recommended for better webinterface performance)
     
-- 
cgit v1.2.1


From e65c6a26ca778166aec2b2d1dd3012ab84fa611a Mon Sep 17 00:00:00 2001
From: ivan 
Date: Sun, 7 May 2006 20:27:21 +0000
Subject: first pass at sales reports per agent and package class

---
 httemplate/docs/upgrade10.html | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'httemplate/docs')

diff --git a/httemplate/docs/upgrade10.html b/httemplate/docs/upgrade10.html
index 8d90ab7a2..7cd1d8e50 100644
--- a/httemplate/docs/upgrade10.html
+++ b/httemplate/docs/upgrade10.html
@@ -31,7 +31,7 @@ Perl or Linux.
   install NetAddr::IP, Chart::Base, Locale::SubCountry, Text::CSV_XS, 
 Spreadsheet::WriteExcel, IO-stringy (IO::Scalar), Frontier::RPC
 (Frontier::RPC2), MIME::Entity (MIME-tools), IPC::Run3, Net::Whois::Raw,
-JSON and Term::ReadKey
+JSON, Term::ReadKey and Color::Scheme
 
 
   
Apply the following changes to your database:
-- 
cgit v1.2.1


From 50f25b285b2caf77d267ed66f03e56924ad7229f Mon Sep 17 00:00:00 2001
From: jeff 
Date: Sat, 20 May 2006 20:06:30 +0000
Subject: first stab at BoM download

---
 httemplate/docs/schema.html    | 10 ++++++++--
 httemplate/docs/upgrade10.html |  8 ++++++++
 2 files changed, 16 insertions(+), 2 deletions(-)

(limited to 'httemplate/docs')

diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html
index cdb59a2e9..d9e35efc7 100644
--- a/httemplate/docs/schema.html
+++ b/httemplate/docs/schema.html
@@ -199,10 +199,16 @@
         
amount
         
_date

Apache::ASP	Mason
- Run `make aspdocs` - Copy `aspdocs/` to your web server's document space. - Create a Global directory, such as `/usr/local/etc/freeside/asp-global/` - Copy `htetc/global.asa` to the Global directory. - Configure Apache for the Global directory and to execute .cgi files using Apache::ASP. For example: - -<Directory /usr/local/apache/htdocs/freeside-asp> -<Files ~ (\.cgi)> -AddHandler perl-script .cgi -PerlHandler Apache::ASP -</Files> -<Perl> -$MLDBM::RemoveTaint = 1; -</Perl> -PerlSetVar Global /usr/local/etc/freeside/asp-global/ -</Directory> - -	- (use version 1.0x - Freeside is not yet compatible with version 1.1x) - Run `make masondocs` - Copy `masondocs/` to your web server's document space. - Copy `htetc/handler.pl` to your web server's configuration directory. - Edit `handler.pl` and set an appropriate `data_dir`, such as `/usr/local/etc/freeside/mason-data` - Configure Apache to use the `handler.pl` file and to execute .cgi files using HTML::Mason. For example: - -<Directory /usr/local/apache/htdocs/freeside-mason> -<Files ~ (\.cgi)> -AddHandler perl-script .cgi -PerlHandler HTML::Mason -</Files> -<Perl> -require "/usr/local/apache/conf/handler.pl"; -</Perl> -</Directory> - -

PostgreSQL	MySQL, others
- -CREATE TABLE cust_pay_temp ( - paynum int primary key, - custnum int not null, - paid decimal(10,2) not null, - _date int null, - payby char(4) not null, - payinfo varchar(16) null, - paybatch varchar(80) null, - closed char(1) null -); -INSERT INTO cust_pay_temp SELECT paynum, custnum, paid, _date, payby, payinfo, paybatch, closed FROM cust_pay; -DROP TABLE cust_pay; -ALTER TABLE cust_pay_temp RENAME TO cust_pay; -CREATE UNIQUE INDEX cust_pay1 ON cust_pay (paynum); -CREATE TABLE cust_refund_temp ( - refundnum int primary key, - custnum int not null, - _date int null, - refund decimal(10,2) not null, - otaker varchar(8) not null, - reason varchar(80) not null, - payby char(4) not null, - payinfo varchar(16) null, - paybatch varchar(80) null, - closed char(1) null -); -INSERT INTO cust_refund_temp SELECT refundnum, custnum, _date, refund, otaker, reason, payby, payinfo, '', closed from cust_refund; -DROP TABLE cust_refund; -ALTER TABLE cust_refund_temp RENAME TO cust_refund; -CREATE UNIQUE INDEX cust_refund1 ON cust_refund (refundnum); - -	- -ALTER TABLE cust_pay DROP COLUMN invnum; -ALTER TABLE cust_refund DROP COLUMN crednum; - -

Mason (recommended)	Apache::ASP (deprecated)
- Configure Apache: + Configure Apache: PerlModule HTML::Mason # your freeside docuemnt root @@ -145,33 +137,6 @@ require "/usr/local/etc/freeside/handler.pl"; </Perl> </Directory> -	- Configure Apache: - -PerlModule Apache::ASP -# your freeside document root -<Directory /var/www/freeside> -<Files ~ (\.cgi\|\.html)> -AddHandler perl-script .cgi .html -PerlHandler Apache::ASP -</Files> -<Perl> -$MLDBM::RemoveTaint = 1; -</Perl> -PerlSetVar Global /usr/local/etc/freeside/asp-global/ -PerlSetVar Debug 2 -PerlSetVar RequestBinaryRead Off -# your freeside document root -PerlSetVar IncludesDir /var/www/freeside -</Directory> - -

-
cust_pay_batch - Pending batch +
pay_batch - Pending batch +
+
batchnum +
status +
+
cust_pay_batch - Pending batch members

paybatchnum -
cardnum +
batchnum +
payinfo - account number
exp - card expiration
amount
invnum - invoice diff --git a/httemplate/docs/upgrade10.html b/httemplate/docs/upgrade10.html index 7cd1d8e50..2a4b0d975 100644 --- a/httemplate/docs/upgrade10.html +++ b/httemplate/docs/upgrade10.html @@ -46,6 +46,14 @@ DROP INDEX cust_bill_pkg1;
ALTER TABLE cust_main ALTER COLUMN payinfo varchar(512) NULL; ALTER TABLE h_cust_main ALTER COLUMN payinfo varchar(512) NULL; +ALTER TABLE cust_pay_batch ADD COLUMN batchnum int NOT NULL; +ALTER TABLE cust_pay_batch ALTER COLUMN batchnum SET NOT NULL; +ALTER TABLE cust_pay_batch ADD COLUMN payinfo varchar(512) NULL; +UPDATE cust_pay_batch SET payinfo = cardnum; +ALTER TABLE cust_pay_batch DROP COLUMN cardnum; +ALTER TABLE h_cust_pay_batch ADD COLUMN payinfo varchar(512) NULL; +UPDATE h_cust_pay_batch SET payinfo = cardnum; +ALTER TABLE h_cust_pay_batch DROP COLUMN cardnum;
On older Pg versions that don't support altering columns directly, you will need to dump the database, edit the schema definitions in the dump file, and reload. -- cgit v1.2.1 From 3a68d152457d4656ccaa41246e52b8584b000e19 Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 27 Jun 2006 14:19:16 +0000 Subject: going to wikiland --- httemplate/docs/index.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'httemplate/docs') diff --git a/httemplate/docs/index.html b/httemplate/docs/index.html index bec62e34a..1693b6d9b 100644 --- a/httemplate/docs/index.html +++ b/httemplate/docs/index.html @@ -6,7 +6,7 @@
Installation and upgrades

-
New Installation +
New Installation
Installing integrated RT ticketing
Upgrading from 1.4.0 to 1.4.1
Upgrading from 1.4.1 to 1.4.2 -- cgit v1.2.1 From 6c375156081be5d2023001ed8eaac9b6db568e95 Mon Sep 17 00:00:00 2001 From: jeff Date: Wed, 9 Aug 2006 06:43:02 +0000 Subject: batch refactor --- httemplate/docs/schema.html | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'httemplate/docs') diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html index d9e35efc7..cd4914a6c 100644 --- a/httemplate/docs/schema.html +++ b/httemplate/docs/schema.html @@ -203,11 +203,14 @@

batchnum
status +
download +
upload

cust_pay_batch - Pending batch members

paybatchnum
batchnum +
payby - CARD, CHEK, LECB, BILL, or COMP
payinfo - account number
exp - card expiration
amount @@ -222,6 +225,7 @@
state
zip
country +
status

cust_pkg - Customer billing items
-- cgit v1.2.1 From 0a632c6bfa376fbcfdf311122669991565877d2b Mon Sep 17 00:00:00 2001 From: ivan Date: Mon, 21 Aug 2006 09:47:49 +0000 Subject: we're off to see the wiki, the wonderful wiki of oz --- httemplate/docs/index.html | 2 +- httemplate/docs/install-rt.html | 78 ------------------ httemplate/docs/install.html | 173 ---------------------------------------- 3 files changed, 1 insertion(+), 252 deletions(-) delete mode 100644 httemplate/docs/install-rt.html delete mode 100644 httemplate/docs/install.html (limited to 'httemplate/docs') diff --git a/httemplate/docs/index.html b/httemplate/docs/index.html index 1693b6d9b..ee290ee0f 100644 --- a/httemplate/docs/index.html +++ b/httemplate/docs/index.html @@ -7,7 +7,7 @@
Installation and upgrades

New Installation -
Installing integrated RT ticketing +
Installing integrated RT ticketing
Upgrading from 1.4.0 to 1.4.1
Upgrading from 1.4.1 to 1.4.2
Upgrading from 1.4.1 (or 1.4.2) to 1.5.8 diff --git a/httemplate/docs/install-rt.html b/httemplate/docs/install-rt.html deleted file mode 100644 index da0941a09..000000000 --- a/httemplate/docs/install-rt.html +++ /dev/null @@ -1,78 +0,0 @@ - - Installing integrated RT ticketing - - -
Installing integrated RT ticketing
- -
Integrated ticketing is an new feature and these instructions are preliminary. Documentation contributions are welcome. - -
There is also support for running this integration against an external RT installation, but it is not (yet) documented. - -
Perl minimum version 5.8.3 is required. HTML::Mason is required. - -
Install the following perl modules: -
-
Apache::Session -
HTML::TreeBuilder (HTML-Tree) -
HTML::FormatText (HTML-Format) -
Test::Inline -
Class::ReturnValue -
DBIx::SearchBuilder -
Log::Dispatch -
Locale::Maketext::Lexicon -
Locale::Maketext::Fuzzy -
Text::Wrapper -
Time::ParseDate (Time-modules) -
Term::ReadKey (TermReadKey) -
Text::Autoformat -
Text::Quoted -
Regexp::Common -
HTML::Scrubber -
Tree::Simple -
- -
Create a new Unix group called 'rt' - -
Edit the top-level Makefile, set RT_ENABLED to 1 and set the RT_DOMAIN, RT_TIMEZONE, and FREESIDE_URL variables. - -
make configure-rt -make create-rt -make install-rt -
- -
Add the following to your httpd.conf: -
-# replace /var/www/freeside with your freeside document root -<DirectoryMatch "^/var/www/freeside/rt/.*NoAuth"> -<Limit GET POST> -allow from all -Satisfy any -SetHandler perl-script -PerlHandler HTML::Mason -</Limit> -</DirectoryMatch> -# replace /var/www/freeside with your freeside document root -<DirectoryMatch "^/var/www/freeside/rt/.*NoAuth/images"> -SetHandler None -</DirectoryMatch> -# replace /var/www/freeside with your freeside document root -<Directory /var/www/freeside/rt/Ticket/Attachment> -SetHandler perl-script -PerlHandler HTML::Mason -</Directory> -
- -
Set the ticket_system configuration value to RT_Internal. 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 -
Run freeside-adduser -h /usr/local/etc/freeside/htpasswd root and set a (temporary) password -
Log into your Freeside installation as the "root" user you just created, by closing your browser or using https://root@yourmachone/freeside/ syntax. -
Click on "Ticketing Main" on the Freeside main menu. Click on "Configuration", then "Global", and then "User Rights". Grant the "SuperUser" right to your RT login. -
Remove the temporary "root" user from /usr/local/etc/freeside/mapsecrets and /usr/local/etc/freeside/htpasswd -
- -
Follow the regular RT documentation to configure RT, setup the mailgate, etc. - - diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html deleted file mode 100644 index 78172e8e4..000000000 --- a/httemplate/docs/install.html +++ /dev/null @@ -1,173 +0,0 @@ - - Installation - - -
Installation
-Note: Install Freeside on a firewalled, private server, not a public (web, RADIUS, etc.) server.

-Before installing, you need: -
-
Perl, minimum version 5.005_03. (5.8.3 for the integrated RT ticketing) -
Apache (mod_ssl or Apache-SSL highly recommended) -
mod_perl (if compiling your own mod_perl, make sure you set the EVERYTHING=1 compile-time option) -
SSH (OpenSSH is recommended. SSH Communications Security commercial SSH version 3 has been reported incompatible with Freeside.) -
rsync -
Optional, enables typeset invoices: teTeX and Ghostscript (included with most distributions). -
A transactional database engine supported by Perl's DBI. -
-
PostgreSQL is recommended (v7.2 or later, 7.4 or later recommended). -
MySQL is not currently supported. Developers intersted in maintaining MySQL support are welcome to ask on the -devel mailing list; many things work, but MySQL support needs a maintainer to update it for recent (and future) changes. - -
- Note: the above only applies to the database used by the Freeside software itself. Freeside can integrate with RADIUS and other servers running MySQL or any other DBI-supported database. -
Perl modules (CPAN will query, download and build perl modules automatically) -
- -
MIME-Base64 -
Digest-MD5 - -
URI -
HTML-Tagset -
HTML-Parser -
libnet -
Locale-Codes -
Net-Whois-Raw -
libwww-perl -
Business-CreditCard - -
MailTools -
TimeDate -
DateManip -
File-CounterFile -
FreezeThaw -
String-Approx -
Text-Template -
DBI -
DBD for your database engine (DBD::Pg for PostgreSQL) - -
DBIx-DBSchema -
Net-SSH -
String-ShellQuote -
Net-SCP -
HTML::Mason -
Tie-IxHash -
Time-Duration -
HTML-Widgets-SelectLayers -
Storable -
Cache::Cache -
NetAddr-IP -
Chart -
Crypt::PasswdMD5 -
Locale::SubCountry -
Frontier::RPC -
Text::CSV_XS -
Spreadsheet::WriteExcel -
IO-stringy (IO::Scalar) -
Frontier::RPC (Frontier::RPC2) -
MIME::Entity (MIME-tools) -
IPC::Run3 -
Term::ReadKey - -
JSON -
Fax::Hylafax::Client (Required if using FAX invoice destinations) -
Apache::DBI (optional but recommended for better webinterface performance) -
-
-Install the Freeside distribution: -
-
Add the user and group `freeside' to your system. -
Allow the freeside user full access to the freeside database. -
-
with PostgreSQL: -
-$ su postgres (pgsql on some distributions) -$ createuser -P freeside -Enter password for user "freeside": -Enter it again: -Shall the new user be allowed to create databases? (y/n) y -Shall the new user be allowed to create more new users? (y/n) n -CREATE USER
-
with MySQL: -
-$ 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';
-
- -
Edit the top-level Makefile: -
-
Set DATASOURCE to your DBI data source, for example, DBI:Pg:dbname=freeside for PostgresSQL or DBI:mysql:freeside for MySQL. See the DBI manpage and the manpage for your DBD for the exact syntax of your DBI data source. -
Set DB_PASSWORD to the freeside database user's password. -
-
Add the freeside database to your database engine: -
-
with Postgres: -
-$ su freeside -$ createdb -E sql_ascii freeside
-
with MySQL: -
-$ mysqladmin -u freeside -p create freeside
-
-
Build and install the Perl modules: -
-$ make perl-modules -$ su -# make install-perl-modules
-
Create the necessary configuration files:
-$ su -# make create-config -
-
Run a separate iteration of Apache[-SSL] with mod_perl enabled as the freeside user. -
Edit the Makefile and set TEMPLATE to asp or mason. Also set FREESIDE_DOCUMENT_ROOT. -
Run make install-docs. -
Configure Apache: -
-PerlModule HTML::Mason -# your freeside docuemnt root -<Directory /var/www/freeside> -<Files ~ (\.cgi|\.html)> -AddHandler perl-script .cgi .html -PerlHandler HTML::Mason -</Files> -<Perl> -require "/usr/local/etc/freeside/handler.pl"; -</Perl> -</Directory> -
-
Restrict access to this web interface - see the Apache documentation on user authentication. For example, to configure user authentication with mod_auth (flat files), add something like the following to your Apache httpd.conf file, adjusting for your actual paths: -
-#your freeside document root -<Directory /var/www/freeside> -AuthName Freeside -AuthType Basic -AuthUserFile /usr/local/etc/freeside/htpasswd -require valid-user -</Directory> -
-
Create one or more Freeside users (your internal sales/tech folks, not customer accounts). These users are setup using using Apache authentication, not UNIX user accounts. For example, using mod_auth (flat files): -
-
First user: -
$ su -# freeside-adduser -c -h /usr/local/etc/freeside/htpasswd username
-
Additional users: -
$ su -# freeside-adduser -h /usr/local/etc/freeside/htpasswd username
-
- (using other auth types, add each user to your Apache authentication and then run: freeside-adduser username) -
Create the Freeside system users: -
$ su -# freeside-adduser fs_queue -# freeside-adduser fs_selfservice
-
As the freeside UNIX user, run freeside-setup -d domain.name username to create the database tables and initial data, passing the username of a Freeside user you created above: -
-$ su freeside -$ freeside-setup -d example.com username -
-
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 INIT_FILE with the appropriate location on your systemand QUEUED_USER with the username of a Freeside user you created above, and run make install-init) -
Now proceed to the initial administration of your installation. -
- -- cgit v1.2.1 From 85ddc2243f666cb7d0c8b4ddb91305932a9b4705 Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 22 Aug 2006 12:23:43 +0000 Subject: get rid of old upgrade instructions --- httemplate/docs/index.html | 4 +- httemplate/docs/upgrade-1.4.2.html | 27 --------- httemplate/docs/upgrade10.html | 115 ------------------------------------- httemplate/docs/upgrade9.html | 28 --------- 4 files changed, 1 insertion(+), 173 deletions(-) delete mode 100644 httemplate/docs/upgrade-1.4.2.html delete mode 100644 httemplate/docs/upgrade10.html delete mode 100644 httemplate/docs/upgrade9.html (limited to 'httemplate/docs') diff --git a/httemplate/docs/index.html b/httemplate/docs/index.html index ee290ee0f..d7b464346 100644 --- a/httemplate/docs/index.html +++ b/httemplate/docs/index.html @@ -8,9 +8,7 @@

New Installation
Installing integrated RT ticketing -
Upgrading from 1.4.0 to 1.4.1 -
Upgrading from 1.4.1 to 1.4.2 -
Upgrading from 1.4.1 (or 1.4.2) to 1.5.8 +
Upgrading from 1.5.8 or 1.6.X

Configuration and setup

diff --git a/httemplate/docs/upgrade-1.4.2.html b/httemplate/docs/upgrade-1.4.2.html deleted file mode 100644 index a24661142..000000000 --- a/httemplate/docs/upgrade-1.4.2.html +++ /dev/null @@ -1,27 +0,0 @@ - - Upgrading to 1.4.2 - - -
Upgrading to 1.4.2 from 1.4.1
-
-
If migrating from less than 1.4.1, see these instructions first. -
Back up your data and current Freeside installation. -
Install Locale::SubCountry -
Install IPC::ShareLite -
Install HTML::Widgets::SelectLayers 0.04. -
Install DBIx::DBSchema 0.23. -
Install DBD::Pg 1.32. -
Install Cache::Cache. -
Install Net::SSH 0.08. -
Install Crypt::PasswdMD5 -
Install Net::Whois::Raw -
CGI.pm minimum version 2.47 is required. You will probably need to install a current CGI.pm from CPAN if you are using Perl 5.005 or earlier. -
File::Temp minimum version 0.14 is required. You will probably need to install a currrent File::Temp from CPAN if you are using Perl 5.6 or earlier. -
If using Apache::ASP, add PerlSetVar RequestBinaryRead Off to your Apache configuration and make sure you are using Apache::ASP minimum version 2.55. -
Run make aspdocs or make masondocs. -
Copy aspdocs/ or masondocs/ to your web server's document space. -
Run make install-perl-modules. -
The signup server and password server are deprecated in 1.4.2. Their functionality has been incorperated into the self-service server. Edit or reinstall your init script, and set the "signup_server-default_agentnum" and "signup_server-default_refnum" configuration options. The FS::SignupClient interface is still available as a compatibility wrapper, so you should be able to continue to use your current signup.cgi. -
Optional: To use typeset invoices, install tetex and ghostscript, and copy conf/invoice_latex, conf/invoice_latexnotes, and conf/invoice_latexfooter to /usr/local/etc/freeside/conf./ -
Restart Apache and freeside-queued. - diff --git a/httemplate/docs/upgrade10.html b/httemplate/docs/upgrade10.html deleted file mode 100644 index 2a4b0d975..000000000 --- a/httemplate/docs/upgrade10.html +++ /dev/null @@ -1,115 +0,0 @@ - - Upgrading to 1.5.8 - - -
Upgrading to 1.5.8 from 1.4.1 or 1.4.2
- -Note: Version numbering has been simplified. 1.5.7 and 1.5.8 are the -versions following 1.5.0pre6. They are still development versions - releases -with odd numbered middle parts (NN in x.NN.x) are development versions, like -Perl or Linux. - - -
- -
-
If migrating from 1.5.0pre6, see README.1.5.7 instead -
If migrating from 1.5.7, see README.1.5.8 instead -
install DBD::Pg 1.32, 1.41 or later (not 1.40) (or, if you're using a Perl version before 5.6, you could try installing DBD::Pg 1.22 with this patch and commenting out the "use DBD::Pg 1.32" at the top of DBIx/DBSchema/DBD/Pg.pm) -
install DBIx::DBSchema 0.27 (or later) (if you are running Pg version 7.2.x or earlier, install at least DBIx::DBSchema 0.29) -
install Net::SSH 0.08 or later -
install HTML::Widgets::SelectLayers 0.05 or later -
install Business::CreditCard 0.28 or later - -
If using Apache::ASP, add PerlSetVar RequestBinaryRead Off and PerlSetVar IncludesDir /your/freeside/document/root/ to your Apache configuration and make sure you are using Apache::ASP minimum version 2.55. -
-
In httpd.conf, change <Files ~ \.cgi> to <Files ~ (\.cgi|\.html)> -
In httpd.conf, change AddHandler perl-script .cgi or SetHandler perl-script to AddHandler perl-script .cgi .html -
-
install NetAddr::IP, Chart::Base, Locale::SubCountry, Text::CSV_XS, -Spreadsheet::WriteExcel, IO-stringy (IO::Scalar), Frontier::RPC -(Frontier::RPC2), MIME::Entity (MIME-tools), IPC::Run3, Net::Whois::Raw, -JSON, Term::ReadKey and Color::Scheme - - -
Apply the following changes to your database: -
-INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 20, 'svc_external-id', 'en_US', 'External ID' ); -INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 21, 'svc_external-title', 'en_US', 'Title' ); - -DROP INDEX cust_bill_pkg1; -
- -
On recent Pg versions: -
-ALTER TABLE cust_main ALTER COLUMN payinfo varchar(512) NULL; -ALTER TABLE h_cust_main ALTER COLUMN payinfo varchar(512) NULL; -ALTER TABLE cust_pay_batch ADD COLUMN batchnum int NOT NULL; -ALTER TABLE cust_pay_batch ALTER COLUMN batchnum SET NOT NULL; -ALTER TABLE cust_pay_batch ADD COLUMN payinfo varchar(512) NULL; -UPDATE cust_pay_batch SET payinfo = cardnum; -ALTER TABLE cust_pay_batch DROP COLUMN cardnum; -ALTER TABLE h_cust_pay_batch ADD COLUMN payinfo varchar(512) NULL; -UPDATE h_cust_pay_batch SET payinfo = cardnum; -ALTER TABLE h_cust_pay_batch DROP COLUMN cardnum; -
-On older Pg versions that don't support altering columns directly, you will need to dump the database, edit the schema definitions in the dump file, and reload. - -
On recent Pg versions: -
-ALTER TABLE svc_forward ALTER COLUMN srcsvc DROP NOT NULL; -ALTER TABLE h_svc_forward ALTER COLUMN srcsvc DROP NOT NULL; -ALTER TABLE svc_forward ALTER COLUMN dstsvc DROP NOT NULL; -ALTER TABLE h_svc_forward ALTER COLUMN dstsvc DROP NOT NULL; -ALTER TABLE cust_main ALTER COLUMN zip DROP NOT NULL; -ALTER TABLE h_cust_main ALTER COLUMN zip DROP NOT NULL; -
-Or on Pg versions that don't support DROP NOT NULL (tested on 7.1 and 7.2 so far): -
-UPDATE pg_attribute SET attnotnull = FALSE WHERE ( attname = 'srcsvc' OR attname = 'dstsvc' ) AND ( attrelid = ( SELECT oid FROM pg_class WHERE relname = 'svc_forward' ) OR attrelid = ( SELECT oid FROM pg_class WHERE relname = 'h_svc_forward' ) ); -UPDATE pg_attribute SET attnotnull = FALSE WHERE ( attname = 'zip' ) AND ( attrelid = ( SELECT oid FROM pg_class WHERE relname = 'cust_main' ) OR attrelid = ( SELECT oid FROM pg_class WHERE relname = 'h_cust_main' ) ); -
- -
If you created your database with a version before 1.4.2, dump database, edit the following, then reload: -
-
cust_main and h_cust_main: increase otaker from 8 to 32 -
cust_main and h_cust_main: change ss from char(11) to varchar(11) ( "character(11)" to "character varying(11)" ) -
cust_credit and h_cust_credit: increase otaker from 8 to 32 -
cust_pkg and h_cust_pkg: increase otaker from 8 to 32 -
cust_refund and h_cust_refund: increase otaker from 8 to 32 -
domain_record and h_domain_record: increase reczone from 80 to 255 -
domain_record and h_domain_record: change rectype from char to varchar ( "character(5)" to "character varying(5)" ) -
domain_record and h_domain_record: increase recdata from 80 to 255 -
- -
make install-perl-modules to install the new libraries and CLI utilities -
run "freeside-upgrade username" to create the remaining new tables and columns - -
optionally: -
-CREATE INDEX cust_main4 ON cust_main ( daytime ); -CREATE INDEX cust_main5 ON cust_main ( night ); -CREATE INDEX cust_main6 ON cust_main ( fax ); -CREATE INDEX cust_main7 ON cust_main ( refnum ); -CREATE INDEX cust_main8 ON cust_main ( county ); -CREATE INDEX cust_main9 ON cust_main ( state ); -CREATE INDEX cust_main10 ON cust_main ( country ); -CREATE INDEX cust_main11 ON cust_main ( ship_last ); -CREATE INDEX cust_main12 ON cust_main ( ship_company ); -CREATE INDEX cust_main13 ON cust_main ( ship_daytime ); -CREATE INDEX cust_main14 ON cust_main ( ship_night ); -CREATE INDEX cust_main15 ON cust_main ( ship_fax ); -CREATE INDEX agent2 ON agent ( disabled ); -CREATE INDEX part_bill_event2 ON part_bill_event ( disabled ); -CREATE INDEX cust_pay4 ON cust_pay (_date); -CREATE INDEX part_referral1 ON part_referral ( disabled ); -CREATE INDEX part_pkg2 ON part_pkg ( promo_code ); -CREATE INDEX h_part_pkg2 ON h_part_pkg ( promo_code ); -
- -
- - - diff --git a/httemplate/docs/upgrade9.html b/httemplate/docs/upgrade9.html deleted file mode 100644 index 6a8fd965d..000000000 --- a/httemplate/docs/upgrade9.html +++ /dev/null @@ -1,28 +0,0 @@ - - Upgrading to 1.4.1 - - -
Upgrading to 1.4.1 from 1.4.0
-
-
If migrating from less than 1.4.0, see these instructions first. -
Back up your data and current Freeside installation. -
Run make aspdocs or make masondocs. -
Copy aspdocs/ or masondocs/ to your web server's document space. -
Run make install-perl-modules. -
Install Net::SSH minimum version 0.07 -
Apply the following changes to your database: -
-INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 18, 'daytime', 'en_US', 'Day Phone' ); -INSERT INTO msgcat ( msgnum, msgcode, locale, msg ) VALUES ( 19, 'night', 'en_US', 'Night Phone' ); -
-
Optionally, apply the following changes to your database (performance improvements): -
-CREATE INDEX part_pkg1 ON part_pkg ( disabled ); -CREATE INDEX part_svc1 ON part_svc ( disabled ); -CREATE INDEX cust_bill2 ON cust_bill ( _date ); -
-
If you want to use ACH (electronic checks), you will need to make changes to your database. The easiest way to make these changes is to dump your database (with pg_dump), change the payinfo field in the cust_pay, cust_refund, h_cust_pay and h_cust_refund tables from varchar(16) to varchar(80), reload the database from the dump. -
If you will be doing bind exports you should make additional changes to your database. Follow the directions above to dump the database and change the reczone and recdata fields in the domain_record and h_domain_record tables from varchar(80) to varchar(255). -
If you made changes to your db schema from a dump as listed above run dbdef-create. -
Restart Apache and freeside-queued. - -- cgit v1.2.1 From 3ce7691203a7737406bf2d4442f7fd84b81f847e Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 23 Aug 2006 22:25:39 +0000 Subject: Will things ever be the same again? It's the final masonize --- httemplate/docs/trouble.html | 26 -------------------------- 1 file changed, 26 deletions(-) delete mode 100755 httemplate/docs/trouble.html (limited to 'httemplate/docs') diff --git a/httemplate/docs/trouble.html b/httemplate/docs/trouble.html deleted file mode 100755 index fce743928..000000000 --- a/httemplate/docs/trouble.html +++ /dev/null @@ -1,26 +0,0 @@ - - Troubleshooting - - -
Troubleshooting
-
-
When troubleshooting the web interface, helpful information is often in your web server's error log. -
If bin/svc_acct.import fails with an "Out of memory!" error using MySQL, upgrede MySQL and recompile the Perl DBD. There was a memory leak in some older versions of MySQL. -
If you get tons of errors in your web server's error log like this: -
-Ambiguous use of value => resolved to "value" => -at /usr/lib/perl5/site_perl/File/CounterFile.pm line 132. -
- This clutters up your log files but is otherwise harmless. Upgrade to the latest File::CounterFile. -
If you get errors like this: -
-UID.pm: Can't open /var/spool/freeside/conf/secrets: Permission denied -at /your/path/site_perl/FS/UID.pm line 26. -BEGIN failed--compilation aborted at -/your/path/edit/process/part_svc.cgi line 15. -
- Then the scripts are not running as the freeside freeside user. See -the New Installation section of the documentation. -
If you receive `can not connect to server' errors using MySQL on a system that doesn't support native threading, you may need to specify the full hostname in your DBI datasource. See the MySQL documentation, DBI manpage and the DBD::mysql manpage for details. -
- -- cgit v1.2.1 From 792be9bdf5b5f71feb3369c0930b05cceb07e46e Mon Sep 17 00:00:00 2001 From: ivan Date: Sat, 14 Oct 2006 09:55:09 +0000 Subject: move signup/self-service install to wiki --- httemplate/docs/index.html | 2 +- httemplate/docs/selfservice.html | 78 ---------------------------------------- 2 files changed, 1 insertion(+), 79 deletions(-) delete mode 100644 httemplate/docs/selfservice.html (limited to 'httemplate/docs') diff --git a/httemplate/docs/index.html b/httemplate/docs/index.html index d7b464346..e014e963d 100644 --- a/httemplate/docs/index.html +++ b/httemplate/docs/index.html @@ -8,6 +8,7 @@

New Installation
Installing integrated RT ticketing +
Signup/Self-service installation
Upgrading from 1.5.8 or 1.6.X

Configuration and setup
@@ -20,7 +21,6 @@
Administration !-->
Exports -
Signup, self-service and reseller interfaces
Billing

Developer
diff --git a/httemplate/docs/selfservice.html b/httemplate/docs/selfservice.html deleted file mode 100644 index 9dc8f2a5e..000000000 --- a/httemplate/docs/selfservice.html +++ /dev/null @@ -1,78 +0,0 @@ - - Signup, self-service and reseller interfaces - - -
Signup, self-service and reseller interfaces
-For security reasons, the self-service interface should run on a public -machine, not the backend Freeside server. On the public machine, install: -
-
A web server, such as Apache (mod_ssl or Apache-SSL highly recommended) - -
SSH -
Perl. -
Text::Template -
Storable -
Business-CreditCard -
HTTP::BrowserDetect -
HTML::Parser - -
FS::SelfService (copy the fs_selfservice/FS-SelfService directory to the external machine, then: perl Makefile.PL; make; make install) -
-Then: -
-
Set the signup_server-default_agentnum configuration value to a default agent number. -
Set the signup_server-default_refnum configuration value to a default advertising source. -
Set the signup_server-payby configuration value to the acceptable payment types for signups. -
Set the signup_server-realtime configuration value to run billing for signups immediately. -
Add the user `freeside' to the the external machine. -
Copy or symlink the fs_selfservice/FS-SelfService/cgi/ directory into the web server's document space. Optionally, customize the .html templates. "Entry points" (useful places to link to) are: -
-
signup.cgi - Signup -
selfservice.cgi - Customer self-service -
agent.cgi - Reseller interface -
passwd.cgi - Simple password-changing interface -
promocode.html - Promotional code pre-signup -
regcode.html - Registration code pre-signup -
stateselect.html - State selection pre-signup -
-
Enable CGI execution for files with the `.cgi' extension. (with Apache), for example:
-#directory where selfservice .cgi scripts and .html templates are located -<Directory /var/www/selfservice> -AddHandler cgi-script .cgi -Options +ExecCGI -</Directory>
-
Create the /usr/local/freeside directory on the external machine (owned by the freeside user). -
touch /usr/local/freeside/selfservice_socket; chown freeside /usr/local/freeside/selfservice_socket; chmod 600 /usr/local/freeside/selfservice_socket -
Use suEXEC or setuid to run signup.cgi, selfservice.cgi, agent.cgi and passwd.cgi as the freeside user. Do not run your public web server as the freeside user! -
Append the identity.pub from the freeside user on your freeside machine to the authorized_keys file of the newly created freeside user on the external machine(s). -
Run an instance of
freeside-selfservice-server user machine
on the Freeside machine for each external machine. -
-
user is a user from the mapsecrets file. -
machine is the name of the external machine. - - -
-
-Optional: -
-
You can install the files in the fs_selfservice/FS-SelfService/cgi/ directory multiple places in your web server's document space, and customize the .html templates differently for each. You can set the agentnum used for each signup by editing signup.html and including a hidden field with the agentnum: -
- <INPUT TYPE="hidden" NAME="agentnum" VALUE="3">
-
When linking to signup.cgi, you can include a referring custnum in the URL as follows: http://public.web.server/path/signup.cgi?ref=1542 -
If you create a /usr/local/freeside/ieak.template file on the external machine, it will be sent to IE users with MIME type application/x-Internet-signup. This file will be processed with Text::Template with the variables listed below available. - (an example file is included as fs_selfservice/FS-SelfService/ieak.template) See the section on internet settings files in the IEAK documentation for more information. - -
Variable substitutions available in ieak.template and success.html: -
-
$ac - area code of selected POP -
$exch - exchange of selected POP -
$loc - local part of selected POP -
$username -
$password -
$email_name - first and last name -
$pkg - package name -
- - -
- -- cgit v1.2.1 From 609fe46a015c92be8a93c1b05a2fb67133bfd22b Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 18 Oct 2006 09:30:39 +0000 Subject: removing obsolete config.html, moving info from export.html into wiki --- httemplate/docs/config.html | 36 ------------------------------------ httemplate/docs/export.html | 19 ------------------- 2 files changed, 55 deletions(-) delete mode 100644 httemplate/docs/config.html delete mode 100755 httemplate/docs/export.html (limited to 'httemplate/docs') diff --git a/httemplate/docs/config.html b/httemplate/docs/config.html deleted file mode 100644 index 9caf3bb3a..000000000 --- a/httemplate/docs/config.html +++ /dev/null @@ -1,36 +0,0 @@ - - Configuration files - - -
Configuration files
-Configuration is now done by the top-level Makefile and web interface. The instructions below are no longer necessary. -
-
Create the /usr/local/etc/freeside directory to hold your configuration. -
Setting up Apache user authetication is mandatory. -
Create the /usr/local/etc/freeside/mapsecrets file, which maps Apache users to a secrets file which contains a DBI data source, username and password. Every -line in /usr/local/etc/freeside/mapsecrets should contain a username and -filename, separated by whitespace. Note that these are not local usernames - -they are passed from Apache. -Apache user authetication is mandatory. For example, if you had the Apache users admin, -john, and sam, -you mapsecrets file might look like: -
-admin secretfile -john secretfile -sam secretfile -
-
Next, the filename(s) referenced in /usr/local/etc/freeside/mapsecrets file should be created in the /usr/local/etc/freeside/ directory. Each file contains three lines: DBI data source (for example, - DBI:mysql:freeside or DBI:Pg:host=localhost;dbname=freeside), database username, and database password. - These files should not be world readable. See the DBI manpage and the manpage for your DBD for the exact syntax of a DBI data source. In a normal installation such as the example above, a single file /usr/local/etc/freeside/secretfile would be created - for example: -
-DBI:Pg:host=localhost;dbname=freeside -dbusername -dbpassword -
-
Create the /usr/local/etc/freeside/conf.datasource directory, for example, /usr/local/etc/freeside/conf.DBI:Pg:host=localhost;dbname=freeside (remember to backslash-escape the ; character when creating directories in the shell: -
mkdir /usr/local/etc/freeside/conf.DBI:Pg:host=localhost\;dbname=freeside -
-
The rest of the configuration can be done with the web interface. Select Configuration from the main menu and update your configuration values. -
- - diff --git a/httemplate/docs/export.html b/httemplate/docs/export.html deleted file mode 100755 index c6c6abd0d..000000000 --- a/httemplate/docs/export.html +++ /dev/null @@ -1,19 +0,0 @@ - - Exports - - -
Exports
-
Exports allow you to provision services to remote machines, databases and - APIs. Some exports, such as sqlradius and - sqlradius_withdomain, enable a feed for retreiving rating/usage data. -
Exports can be added and edited under - Sysadmin | View/Edit Exports. -
Selecting an export on the - Sysadmin | View/Edit Exports | Add a new export page will - show more information on that specific export, including available - options, setup and usage. -
Exports are activated by associating them with one or more service - definitions: Sysadmin | View/Edit Service definitions. - - - -- cgit v1.2.1 From 59c7e4fede19e591f290fba7b81f510b364de6b8 Mon Sep 17 00:00:00 2001 From: ivan Date: Fri, 29 Dec 2006 08:30:26 +0000 Subject: link more docs to wiki --- httemplate/docs/index.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'httemplate/docs') diff --git a/httemplate/docs/index.html b/httemplate/docs/index.html index e014e963d..3b419de00 100644 --- a/httemplate/docs/index.html +++ b/httemplate/docs/index.html @@ -20,8 +20,8 @@ -
Exports -
Billing +
Exports +
Billing

Developer

-- cgit v1.2.1 From ce7b8ef4800672537139d7bc853421aec391c140 Mon Sep 17 00:00:00 2001 From: ivan Date: Thu, 15 Feb 2007 01:09:47 +0000 Subject: removing docs moved to wiki --- httemplate/docs/billing.html | 68 -------------------------------------------- 1 file changed, 68 deletions(-) delete mode 100644 httemplate/docs/billing.html (limited to 'httemplate/docs') diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html deleted file mode 100644 index adaac17dc..000000000 --- a/httemplate/docs/billing.html +++ /dev/null @@ -1,68 +0,0 @@ - - Billing - - -
Billing
-
-
Add one or more Invoice events implmenting your business rules for re-sending invoices, retrying cards, suspending, etc. -
You can bill individual customers by clicking on the Bill now link on the main customer view. -
The freeside-daily script should be run daily to bill customers and run invoice collection events. -
Real-time credit card processing: Install the Business::OnlinePayment module for your processor. Configure the business-onlinepayment configuration option. Disable the default Batch card invoice event and add one for Business::OnlinePayment. -
Optional: Credit card expiration alerts: Customize alerter_template configuration option and run freeside-expiration-alerter daily. -
Credit card decline alerts: Customize the declinetemplate configuration option and set the emaildecline configuration option. -
Typeset (LaTeX) invoice templates -
-
Install teTeX and Ghostscript (included with most distributions). -
Place your logo in EPS (Encapsulated PostScript) format with size 90pt X 36pt (epsffit -c 0 0 90 33 yourlogo.eps >logo.eps) at /usr/local/etc/freeside/conf.your_datasrc/logo.eps. -
Edit the invoice_latexreturnaddress, invoice_latexfooter, invoice_latexnotes, and invoice_latexsmallfooter configuration options. If you are adventurous, edit invoice_latex as well. -
-
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). -
In addition, the following variables are available: -
-
$invnum - invoice number -
$date - as a UNIX timestamp (see Date::Format for conversion functions). -
$page - current page -
$total_pages - total pages -
@address - A six-element array containing the customer name, company, and address. - -
-
-
HTML invoice templates -
-
Place your logo in PNG format at /usr/local/etc/freeside/conf.your_datasrc/logo.png. -
HTML invoices also use Text::Template. -
Edit the invoice_html configuration option. -
The following configuration options can be set to override the default behaviour of using the invoice_latex* data: invoice_htmlreturnaddress, and invoice_htmlfooter, invoice_htmlnotes. -
- -
- -- cgit v1.2.1