From 0c525f3ba7b2b6730b8939b950e4d76dd16802a9 Mon Sep 17 00:00:00 2001 From: cvs2git Date: Thu, 5 Jan 2006 09:34:30 +0000 Subject: This commit was manufactured by cvs2svn to create tag 'SQL_LEDGER_2_4_4'. --- httemplate/docs/ach.html | 10 - httemplate/docs/admin.html | 82 ---- httemplate/docs/billing.html | 68 --- httemplate/docs/config.html | 36 -- httemplate/docs/cvv2.html | 24 - httemplate/docs/export.html | 19 - httemplate/docs/ieak.html | 75 --- httemplate/docs/index.html | 36 -- httemplate/docs/install-rt.html | 78 --- httemplate/docs/install.html | 214 --------- httemplate/docs/legacy.html | 39 -- .../docs/man/FS/part_export/.cvs_is_on_crack | 0 httemplate/docs/overview-new.dia | Bin 2422 -> 0 bytes httemplate/docs/overview-new.png | Bin 29062 -> 0 bytes httemplate/docs/overview.dia | Bin 2800 -> 0 bytes httemplate/docs/overview.png | Bin 13064 -> 0 bytes httemplate/docs/passwd.html | 23 - httemplate/docs/schema.dia | Bin 16364 -> 0 bytes httemplate/docs/schema.html | 523 --------------------- httemplate/docs/schema.png | Bin 681043 -> 0 bytes httemplate/docs/selfservice.html | 78 --- httemplate/docs/session.html | 59 --- httemplate/docs/signup.html | 54 --- httemplate/docs/ssh.html | 16 - httemplate/docs/trouble.html | 26 - httemplate/docs/upgrade-1.4.2.html | 27 -- httemplate/docs/upgrade10.html | 93 ---- httemplate/docs/upgrade7.html | 24 - httemplate/docs/upgrade8.html | 394 ---------------- httemplate/docs/upgrade9.html | 28 -- 30 files changed, 2026 deletions(-) delete mode 100644 httemplate/docs/ach.html delete mode 100755 httemplate/docs/admin.html delete mode 100644 httemplate/docs/billing.html delete mode 100644 httemplate/docs/config.html delete mode 100644 httemplate/docs/cvv2.html delete mode 100755 httemplate/docs/export.html delete mode 100644 httemplate/docs/ieak.html delete mode 100644 httemplate/docs/index.html delete mode 100644 httemplate/docs/install-rt.html delete mode 100644 httemplate/docs/install.html delete mode 100755 httemplate/docs/legacy.html delete mode 100644 httemplate/docs/man/FS/part_export/.cvs_is_on_crack delete mode 100644 httemplate/docs/overview-new.dia delete mode 100644 httemplate/docs/overview-new.png delete mode 100644 httemplate/docs/overview.dia delete mode 100644 httemplate/docs/overview.png delete mode 100755 httemplate/docs/passwd.html delete mode 100644 httemplate/docs/schema.dia delete mode 100644 httemplate/docs/schema.html delete mode 100644 httemplate/docs/schema.png delete mode 100644 httemplate/docs/selfservice.html delete mode 100644 httemplate/docs/session.html delete mode 100644 httemplate/docs/signup.html delete mode 100755 httemplate/docs/ssh.html delete mode 100755 httemplate/docs/trouble.html delete mode 100644 httemplate/docs/upgrade-1.4.2.html delete mode 100644 httemplate/docs/upgrade10.html delete mode 100644 httemplate/docs/upgrade7.html delete mode 100644 httemplate/docs/upgrade8.html delete mode 100644 httemplate/docs/upgrade9.html (limited to 'httemplate/docs') diff --git a/httemplate/docs/ach.html b/httemplate/docs/ach.html deleted file mode 100644 index b8a17c87d..000000000 --- a/httemplate/docs/ach.html +++ /dev/null @@ -1,10 +0,0 @@ - - - - Electronic check (ACH) information - - - - - - diff --git a/httemplate/docs/admin.html b/httemplate/docs/admin.html deleted file mode 100755 index 9ce259c2b..000000000 --- a/httemplate/docs/admin.html +++ /dev/null @@ -1,82 +0,0 @@ - - Administration - - -

Administration

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

- - 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. - - - diff --git a/httemplate/docs/cvv2.html b/httemplate/docs/cvv2.html deleted file mode 100644 index 767098537..000000000 --- a/httemplate/docs/cvv2.html +++ /dev/null @@ -1,24 +0,0 @@ - - - - CVV2 information - - - - The CVV2 number (also called CVC2 or CID) is a three- or four-digit - security code used to reduce credit card fraud.

- - - - - - - - -
Visa / MasterCard / DiscoverAmerican Express
- Visa/MasterCard/Discover - - American Express -
- - 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. - - - diff --git a/httemplate/docs/ieak.html b/httemplate/docs/ieak.html deleted file mode 100644 index 00c53423c..000000000 --- a/httemplate/docs/ieak.html +++ /dev/null @@ -1,75 +0,0 @@ -

-this is incomplete
-mostly it should be merged into signup.html and fs_signup/ieak.template
-
-- download and install the IEAK from
-  http://www.microsoft.com/windows/ieak/default.asp
-
-- Good examples may be found in 
-  C:\Program Files\IEAK\toolkit\isp\server\ICW\signup\perl\signup08.pl
-  C:\Program Files\IEAK\toolkit\isp\server\ICW\reconfig\perl\reconfig04.pl
-  C:\Program Files\IEAK6\toolkit\isp\servless\basic\sample.ins
-  C:\Program Files\IEAK6\toolkit\isp\servless\advanced\4567.ins
-  C:\Program Files\IEAK6\toolkit\isp\servless\advanced\4568.ins
-  C:\Program Files\IEAK6\toolkit\isp\servless\advanced\7890.ins
-  C:\Program Files\IEAK6\toolkit\isp\servless\advanced\7891.ins
-
-- Full documentation on all the settings available in .INS files is
-  avaialble under Program Files | Microsoft IEAK 6 | IEAK Help 
-                  | Reference | Internet Settings (.ins) Files
-
-- Freeside will make the following substitutions before sending the file
-  to the user:
-
-  { $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
-
-- Simple example follows:
-
-[Entry]
-Entry Name = IEAK Sample
-[Phone]
-Dial_As_Is = No
-Phone_Number = { $exch }{ $loc }
-Area_Code = { $ac }
-Country_Code = 1
-Country_Id = 1
-[Server]
-Type = PPP
-SW_Compress = Yes
-PW_Encrypt = Yes
-Negotiate_TCP/IP = Yes
-Disable_LCP = No
-[TCP/IP]
-Specity_IP_Address = No
-Specity_Server_Address = No
-IP_Header_Compress = Yes
-Gateway_On_Remote = Yes
-[User]
-Name = { $username }
-Passowrd = { $password }
-Display_Password = Yes
-[Internet_Mail]
-Email_Name = { $email_name }
-Email_Address = { $username }@example.com
-POP_Server = mail.example.com
-POP_Server_Port_Number = 110
-POP_Logon_Password = { $password }
-SMTP_Server = mail.example.com
-SMTP_Server_Port_Number = 25
-Install_Mail = 1
-[URL]
-Help_Page = http://www.ieaksample.net/helpdesk
-Home_Page = http://www.ieaksample.net
-Search_Page = http://www.ieaksample,net/search
-[Favorites]
-IEAK Sample \\ IEAK Sample Home Page.url = http://acme.ieaksample.net/
-[Branding]
-Window_Title = Internet Explorer from Acme Internet Services
-
-
diff --git a/httemplate/docs/index.html b/httemplate/docs/index.html deleted file mode 100644 index 7254d76f3..000000000 --- a/httemplate/docs/index.html +++ /dev/null @@ -1,36 +0,0 @@ - - Freeside Documentation - - -

Freeside Documentation

- -

Installation and upgrades

- -

Configuration and setup

- -

Developer

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

- -

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 1f80db1a7..000000000 --- a/httemplate/docs/install.html +++ /dev/null @@ -1,214 +0,0 @@ - - Installation - - -

Installation

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

-Before installing, you need: - -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. -
- - - - - - - - - - - -
Mason (recommended)Apache::ASP (deprecated)
    -
  • 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>
    -
    -
    -
  • 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
    -<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 username to create the database tables, 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-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. -
- diff --git a/httemplate/docs/legacy.html b/httemplate/docs/legacy.html deleted file mode 100755 index 94efe53af..000000000 --- a/httemplate/docs/legacy.html +++ /dev/null @@ -1,39 +0,0 @@ - - Importing legacy data - - -

Importing legacy data

-In almost all cases, legacy data import will require writing custom code to deal with your particular legacy data. The example scripts here will probably not work "out-of-the-box", and are provided as a starting point only. -

Some import scripts may require installation of the Array-PrintCols and Term-Query (make test broken; install manually) modules.
-
    -
  • bin/bind.import - Import domain information from BIND named -
  • bin/passwd.import - Just import `passwd' and `shadow' or `master.passwd', no RADIUS import. -
  • bin/svc_acct.import - Import `passwd', ( `shadow' or `master.passwd' ) and RADIUS `users'. Before running bin/svc_acct.import, you need services (with table svc_acct) as follows: -
      -
    • Most accounts probably have entries in passwd and users (with Port-Limit nonexistant or 1) -
    • Some accounts have entries in passwd and users, but with Port-Limit 2 (or more) -
    • Some accounts might have entries in users only (Port-Limit 1) -
    • Some accounts might have entries in users only (Port-Limit >= 2) -
    • POP mail accounts have entries in passwd only, and have a particular shell. -
    • Everything else in passwd is a shell account. -
    - -
  • Importing customer data -
      -
    • Manually -
        -
      • Add a new customer -
      • Add one or more packages for this customer -
      • Enter a package by clicking on the package number -
      • Pick the `Link to existing' option -
      -
    • Batch - You will need to write a script to import your particular legacy data. You can use eg/TEMPLATE_cust_main.import as a starting point. -
    -
- - diff --git a/httemplate/docs/man/FS/part_export/.cvs_is_on_crack b/httemplate/docs/man/FS/part_export/.cvs_is_on_crack deleted file mode 100644 index e69de29bb..000000000 diff --git a/httemplate/docs/overview-new.dia b/httemplate/docs/overview-new.dia deleted file mode 100644 index d9989a359..000000000 Binary files a/httemplate/docs/overview-new.dia and /dev/null differ diff --git a/httemplate/docs/overview-new.png b/httemplate/docs/overview-new.png deleted file mode 100644 index bf815463b..000000000 Binary files a/httemplate/docs/overview-new.png and /dev/null differ diff --git a/httemplate/docs/overview.dia b/httemplate/docs/overview.dia deleted file mode 100644 index a0e34c30e..000000000 Binary files a/httemplate/docs/overview.dia and /dev/null differ diff --git a/httemplate/docs/overview.png b/httemplate/docs/overview.png deleted file mode 100644 index bf2dbc26c..000000000 Binary files a/httemplate/docs/overview.png and /dev/null differ diff --git a/httemplate/docs/passwd.html b/httemplate/docs/passwd.html deleted file mode 100755 index fc1dde956..000000000 --- a/httemplate/docs/passwd.html +++ /dev/null @@ -1,23 +0,0 @@ - - fs_passwd - - -

fs_passwd

-You may use fs_passwd/fs_passwd as a "passwd", "chfn" and "chsh" replacement on your shell machine(s) to cause password, gecos and shell changes to update your freeside machine. You can also use the fs_passwd/fs_passwd.html and fs_passwd/fs_passwd.cgi to run a public password change CGI on a public web server. This can pose a security risk if not configured correctly. Do not use this feature unless you understand what you are doing! -

Currently it is assumed that the the crypt(3) function in the C library is the same on the Freeside machine as on the target machine. -
    -
  • Create a freeside account on the shell or web machine(s). -
  • Setup SSH keys: -
      -
    • As the freeside user (on your freeside machine), generate an authentication key using ssh-keygen. Since this is for unattended operation, use a blank passphrase. -
    • Append the newly-created identity.pub file to ~freeside -/.ssh/authorized_keys on the shell or web machine(s). -
    • Some new SSH v2 implementation accept v2 style keys only. Use the -t option to ssh-keygen, and append the created id_dsa.pub or id_rsa.pub to ~freeside/.ssh/authorized_keys2 on the remote machine(s). -
    -
  • Copy fs_passwd/fs_passwdd to /usr/local/sbin on the shell or web machine(s). (chown freeside, chmod 500) -
  • Create /usr/local/freeside on the shell or web machine(s). (chown freeside, chmod 700) -
  • Run an iteration of "fs_passwd/fs_passwd_server user shell.machine" as the freeside user for each shell or web machine (this is a daemon process). user refers to a freeside user added by freeside-adduser. -
  • Copy fs_passwd/fs_passwd to /usr/local/bin on the shell machine(s). (chown freeside, chmod 4755). You may link it to passwd, chfn and chsh as well. -
  • Copy fs_passwd/fs_passwd.cgi to the cgi-bin directory on your web machine(s). Use suEXEC or suidperl to run fs_passwd.cgi as the freeside user. -
- diff --git a/httemplate/docs/schema.dia b/httemplate/docs/schema.dia deleted file mode 100644 index e00f59ce1..000000000 Binary files a/httemplate/docs/schema.dia and /dev/null differ diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html deleted file mode 100644 index cdb59a2e9..000000000 --- a/httemplate/docs/schema.html +++ /dev/null @@ -1,523 +0,0 @@ - - Schema reference - - -

Schema reference

- Schema diagram (1.4.1): as a giant .png or dia source (dia homepage). -
    -
  • agent - Agents are resellers of your service. Agents may be limited to a subset of your full offerings (via their agent type). -
      -
    • agentnum - primary key -
    • agent - name of this agent -
    • typenum - agent type -
    • prog - (unimplemented) -
    • freq - (unimplemented) -
    • disabled - Disabled flag, empty or 'Y' -
    • username - Username for the Agent interface -
    • _password - Password for the Agent interface -
    -
  • agent_type - Agent types define groups of packages that you can then assign to particular agents. -
      -
    • typenum - primary key -
    • atype - name of this agent type -
    -
  • cust_bill - Invoices. Declarations that a customer owes you money. The specific charges are itemized in cust_bill_pkg. -
      -
    • billpkgnum - primary_key -
    • invnum - primary key -
    • custnum - customer -
    • _date -
    • charged - amount of this invoice -
    • printed - how many times this invoice has been printed automatically -
    • closed - books closed flag, empty or `Y' -
    -
  • cust_bill_event - Invoice event history - -
  • part_bill_event - Invoice event definitions -
      -
    • eventpart - primary key -
    • payby - CARD, DCRD, CHEK, DCHK, LECB, BILL, or COMP -
    • event - event name -
    • eventcode - event action -
    • seconds - how long after the invoice date (cust_bill._date) events of this type are triggered -
    • weight - ordering for events with identical seconds -
    • plan - eventcode plan -
    • plandata - additional plan data -
    • disabled - Disabled flag, empty or `Y' -
    • taxclass - Texas tax class flag, empty or "none", "access", or "hosting" -
    -
  • cust_bill_pkg - Invoice line items -
      -
    • invnum - (multiple) key -
    • pkgnum - package or 0 for the special virtual sales tax package -
    • setup - setup fee -
    • recur - recurring fee -
    • sdate - starting date -
    • edate - ending date -
    • itemdesc - Line item description (currently used only when pkgnum is 0) -
    -
  • cust_bill_pkg_detail - Invoice line items detail -
      -
    • detailnum - primary key -
    • pkgnum - -
    • invnum - -
    • detail - Detail description -
    -
  • cust_credit - Credits. The equivalent of a negative cust_bill record. -
      -
    • crednum - primary key -
    • custnum - customer -
    • amount - amount credited -
    • _date -
    • otaker - order taker -
    • reason -
    • closed - books closed flag, empty or `Y' -
    -
  • cust_credit_bill - Credit invoice application. Links a credit to an invoice. -
      -
    • creditbillnum - primary key -
    • crednum - credit being applied -
    • invnum - invoice to which credit is applied -
    • amount - amount applied -
    • _date -
    -
  • cust_credit_bill - Refund payment application. Links a refund to a payment. -
      -
    • payrefundnum - primary key -
    • paynum - payment -
    • refundnum - refund -
    • amount - amount applied -
    • _date -
    -
  • cust_main - Customers -
      -
    • custnum - primary key -
    • agentnum - agent -
    • refnum - referral -
    • first - name -
    • last - name -
    • ss - social security number -
    • company -
    • address1 -
    • address2 -
    • city -
    • county -
    • state -
    • zip -
    • country -
    • daytime - phone -
    • night - phone -
    • fax - phone -
    • ship_first -
    • ship_last -
    • ship_company -
    • ship_address1 -
    • ship_address2 -
    • ship_city -
    • ship_county -
    • ship_state -
    • ship_zip -
    • ship_country -
    • ship_daytime -
    • ship_night -
    • ship_fax -
    • payby - CARD, DCHK, CHEK, DCHK, LECB, BILL, or COMP -
    • payinfo - card number, P.O.#, or comp issuer -
    • paycvv - Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card -
    • paydate - expiration date -
    • payname - billing name (name on card) -
    • tax - tax exempt, Y or null -
    • otaker - order taker -
    • referral_custnum -
    • comments -
    - (columns in italics are optional) -
  • cust_main_invoice - Invoice destinations for email invoices. Note that a customer can have many email destinations for their invoice (either literal or via svcnum), but only one postal destination. -
      -
    • destnum - primary key -
    • custnum - customer -
    • dest - Invoice destination. Freeside supports three types of invoice delivery: send directly to a service defined in Freeside, send to an arbitrary email address, or print the invoice to a printer and have someone send it out via snail mail. Freeside determines which method to use based on the contents of the dest field. If the contents are numeric, a svcnum pointing to a valid service is expected in the field. If the contents are a string, a literal email address is expected to be in the field. If the special keyword `POST' is present, the snail mail method is used (which is the default if no cust_main_invoice records exist). Snail mail invoices get their address information from cust_main and are printed with the printer defined in the configuration files. -
    -
  • cust_main_county - Tax rates -
      -
    • taxnum - primary key -
    • state -
    • county -
    • country -
    • tax - % rate -
    • taxclass -
    • exempt_amount -
    • taxname - if defined, printed on invoices instead of "Tax" -
    • setuptax - if 'Y', this tax does not apply to setup fees -
    • recurtax - if 'Y', this tax does not apply to recurring fees -
    -
  • cust_tax_exempt - Tax exemption record -
      -
    • exemptnum - primary key -
    • taxnum - tax rate -
    • year -
    • month -
    • amount -
    -
  • cust_pay - Payments. Money being transferred from a customer. -
      -
    • paynum - primary key -
    • custnum - customer -
    • paid - amount -
    • _date -
    • payby - CARD, CHEK, LECB, BILL, or COMP -
    • payinfo - card number, P.O.#, or comp issuer -
    • paybatch - text field for tracking card processor batches -
    • closed - books closed flag, empty or `Y' -
    -
  • cust_pay_void - Voided payments. -
      -
    • paynum - primary key -
    • custnum - customer -
    • paid - amount -
    • _date -
    • payby - CARD, CHEK, LECB, BILL, or COMP -
    • payinfo - card number, P.O.#, or comp issuer -
    • paybatch - text field for tracking card processor batches -
    • closed - books closed flag, empty or `Y' -
    • void_date -
    • reason -
    • otaker - order taker -
    -
  • cust_bill_pay - Applicaton of a payment to a specific invoice. -
      -
    • billpaynum -
    • invnum - invoice -
    • paynum - payment -
    • amount -
    • _date -
    -
  • cust_pay_batch - Pending batch -
      -
    • paybatchnum -
    • cardnum -
    • exp - card expiration -
    • amount -
    • invnum - invoice -
    • custnum - customer -
    • payname - name on card -
    • first - name -
    • last - name -
    • address1 -
    • address2 -
    • city -
    • state -
    • zip -
    • country -
    -
  • cust_pkg - Customer billing items -
      -
    • pkgnum - primary key -
    • custnum - customer -
    • pkgpart - Package definition -
    • setup - date -
    • bill - next bill date -
    • last_bill - last bill date -
    • susp - (past) suspension date -
    • expire - (future) cancellation date -
    • cancel - (past) cancellation date -
    • otaker - order taker -
    • manual_flag - If this field is set to 1, disables the automatic unsuspensiond of this package when using the unsuspendauto config file. -
    -
  • cust_refund - Refunds. The transfer of money to a customer; equivalent to a negative cust_pay record. -
      -
    • refundnum - primary key -
    • custnum - customer -
    • refund - amount -
    • _date -
    • payby - CARD, CHEK, LECB, BILL or COMP -
    • payinfo - card number, P.O.#, or comp issuer -
    • otaker - order taker -
    • closed - books closed flag, empty or `Y' -
    -
  • cust_credit_refund - Applicaton of a refund to a specific credit. -
      -
    • creditrefundnum - primary key -
    • crednum - credit -
    • refundnum - refund -
    • amount -
    • _date -
    -
  • cust_svc - Customer services - -
  • nas - Network Access Server (terminal server) -
      -
    • nasnum - primary key -
    • nas - NAS name -
    • nasip - NAS ip address -
    • nasfqdn - NAS fully-qualified domain name -
    • last - timestamp indicating the last instant the NAS was in a known state (used by the session monitoring). -
    -
  • part_pkg - Package definitions -
      -
    • pkgpart - primary key -
    • pkg - package name -
    • comment - non-customer visable package comment -
    • promo_code - promotional code -
    • deprecated setup - setup fee expression -
    • freq - recurring frequency (months) -
    • deprecated recur - recurring fee expression -
    • setuptax - Setup fee tax exempt flag, empty or `Y' -
    • recurtax - Recurring fee tax exempt flag, empty or `Y' -
    • plan - price plan -
    • deprecated plandata - additional price plan data -
    • disabled - Disabled flag, empty or `Y' -
    -
  • part_pkg_option - Package definition options -
      -
    • optionnum - primary key -
    • pkgpart - Package definition -
    • optionname - option name -
    • optionvalue - option value -
    -
  • reg_code - One-time registration codes -
      -
    • codenum - primary key -
    • code -
    • agentnum - Agent -
    -
  • reg_code_pkg - Registration code link to package definitions - -
  • part_referral - Referral listing -
      -
    • refnum - primary key -
    • referral - referral -
    -
  • part_svc - Service definitions -
      -
    • svcpart - primary key -
    • svc - name of this service -
    • svcdb - table used for this service: svc_acct, svc_forward, svc_domain, svc_charge or svc_wo -
    • disabled - Disabled flag, empty or `Y' - -
    -
  • part_svc_column -
      -
    • columnnum - primary key -
    • svcpart - Service definition -
    • columnname - column name in part_svc.svcdb table -
    • columnvalue - default or fixed value for the column -
    • columnflag - null, D or F -
    -
  • pkg_svc -
      -
    • pkgsvcnum - primary key -
    • pkgpart - Package definition -
    • svcpart - Service definition -
    • quantity - quantity of this service that this package includes -
    • primary_svc - blank or Y: primary service -
    -
  • export_svc - -
  • part_export - Export to external provisioning -
      -
    • exportnum - primary key -
    • machine - Machine name -
    • exporttype - Export type -
    • nodomain - blank or Y: usernames are exported to this service with no domain -
    -
  • part_export_option - provisioning options -
      -
    • optionnum - primary key -
    • exportnum - Export -
    • optionname - option name -
    • optionvalue - option value -
    -
  • port - individual port on a nas -
      -
    • portnum - primary key -
    • ip - IP address of this port -
    • nasport - port number on the NAS -
    • nasnum - NAS -
    -
  • prepay_credit - prepaid cards -
      -
    • prepaynum - primary key -
    • identifier - text or numeric string of prepaid card -
    • amount - amount of prepayment -
    • seconds - prepaid time instead of (or in addition to) monetary value -
    • agentnum - optional agent assignment for prepaid cards -
    -
  • session -
      -
    • sessionnum - primary key -
    • portnum - Port -
    • svcnum - Account -
    • login - timestamp indicating the beginning of this user session. -
    • logout - timestamp indicating the end of this user session. May be null, which indicates a currently open session. -
    - -
  • svc_acct - Accounts -
      -
    • svcnum - primary key -
    • username -
    • _password -
    • sec_phrase - security phrase -
    • popnum - Point of Presence -
    • uid -
    • gid -
    • finger - GECOS -
    • dir -
    • shell -
    • quota - (unimplementd) -
    • slipip - IP address -
    • seconds -
    • domsvc -
    • radius_Radius_Reply_Attribute - Radius-Reply-Attribute -
    • rc_Radius_Check_Attribute - Radius-Check-Attribute -
    -
  • svc_acct_pop - Points of Presence -
      -
    • popnum - primary key -
    • city -
    • state -
    • ac - area code -
    • exch - exchange -
    • loc - rest of number -
    -
  • part_pop_local - Local calling areas -
      -
    • localnum - primary key -
    • popnum - primary key -
    • city -
    • state -
    • npa - area code -
    • nxx - exchange -
    -
  • svc_domain - Domains - -
  • svc_forward - Mail forwarding aliases - -
  • domain_record - Domain zone detail -
      -
    • recnum - primary key -
    • svcnum - Domain (by svcnum) -
    • reczone - zone for this line -
    • recaf - address family, usually IN -
    • rectype - type for this record (A, MX, etc.) -
    • recdata - data for this record -
    -
  • svc_www - -
  • type_pkgs - -
  • queue - job queue -
      -
    • jobnum - primary key -
    • job -
    • _date -
    • status -
    • statustext -
    • svcnum -
    -
  • queue_arg - job arguments -
      -
    • argnum - primary key -
    • jobnum - job -
    • arg - argument -
    -
  • queue_depend - job dependancies -
      -
    • dependnum - primary key -
    • jobnum - source jobnum -
    • depend_jobnum - dependancy jobnum -
    -
  • radius_usergroup - Link users to RADIUS groups. -
      -
    • usergroupnum - primary key -
    • svcnum - account -
    • groupname -
    -
  • rate - Call rate plans -
      -
    • ratenum - primary key -
    • ratename -
    -
  • rate_detail - Call rate detail -
      -
    • ratedetailnum - primary key -
    • ratenum - rate plan -
    • orig_regionnum - call origination region -
    • dest_regionnum - call destination region -
    • min_included - included minutes -
    • min_charge - charge per minute -
    • sec_granularity - granularity in seconds, i.e. 6 or 60 -
    -
  • rate_region - Call rate region -
      -
    • regionnum - primary key -
    • regionname -
    -
  • rate_prefix - Call rate prefix -
      -
    • prefixnum - primary key -
    • regionnum - rate region -
    • countrycode -
    • npa -
    • nxx -
    -
  • msgcat - i18n message catalog -
      -
    • msgnum - primary key -
    • msgcode - message code -
    • locale - locale -
    • msg - Message text -
    -
  • clientapi_session - ClientAPI session store -
      -
    • sessionnum - primary key -
    • sessionid - session ID -
    • namespace - session namespace -
    -
  • clientapi_session_field - Client API session store data -
      -
    • fieldnum - primary key -
    • sessionnum - session -
    • fieldname -
    • fieldvalue -
    -
- diff --git a/httemplate/docs/schema.png b/httemplate/docs/schema.png deleted file mode 100644 index d0392e76f..000000000 Binary files a/httemplate/docs/schema.png and /dev/null differ 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: - -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 -
    - - -
- diff --git a/httemplate/docs/session.html b/httemplate/docs/session.html deleted file mode 100644 index 72e16424e..000000000 --- a/httemplate/docs/session.html +++ /dev/null @@ -1,59 +0,0 @@ - - Session monitor - - -

Session monitor

-

Installation

-For security reasons, the client portion of the session montior may run on one -or more external public machine(s). On these machines, install: -
    -
  • Perl (at l -east 5.004_05 for the 5.004 series or 5.005_03 for the 5.005 series. Don't enable experimental features like threads or the PerlIO abstraction layer.) -
  • FS::SessionClient (copy the fs_session/FS-SessionClient directory to the external machine, then: perl Makefile.PL; make; make install) -
-Then: -
    -
  • Add the user `freeside' to the the external machine. -
  • Create the /usr/local/freeside directory on the external machine (owned by the freeside user). -
  • touch /usr/local/freeside/fs_sessiond_socket; chown freeside /usr/local/freeside/fs_sessiond_socket; chmod 600 /usr/local/freeside/fs_sessiond_socket -
  • 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
    fs_session_server user machine
    on the Freeside machine. -
      -
    • user is a user from the mapsecrets file. -
    • machine is the name of the external machine. -
    -
-

Usage

-
    -
  • Web -
      -
    • Copy FS-SessionClient/cgi/login.cgi and logout.cgi to your web - server's document space. -
    • Use suEXEC or setuid (see install.html for details) to run login.cgi and logout.cgi as the freeside user. -
    -
  • Command-line -
    freeside-login username ( portnum | ip | nasnum nasport )
    -freeside-logout username ( portnum | ip | nasnum nasport )
    -
      -
    • username is a customer username from the svc_acct table -
    • portnum, ip or nasport and nasnum uniquely identify a port in the port database table. -
    -
  • RADIUS - One of: -
      -
    • Run the freeside-sqlradius-radacctd daemon to import radacct - records from all configured sqlradius exports: - freeside-sqlradius-radacctd username -
    • Configure your RADIUS server's login and logout callbacks to use the command-line freeside-login and freeside-logout utilites. -
    • (incomplete)Use the fs_radlog/fs_radlogd tool to - import records from a text radacct file. -
    -
-

Callbacks

-
    -
  • Sesstion start - The command(s) specified in the session-start configuration file are executed on the Freeside machine. The contents of the file are treated as a double-quoted perl string, with the following variables available: $ip, $nasip and $nasfqdn, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on. -
  • Session end - The command(s) specified in the session-stop configuration file are executed on the Freeside machine. The contents of the file are treated as a double-quoted perl string, with the following variables available: $ip, $nasip and $nasfqdn, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on. -
-

Dropping expired users

-Run
bin/freeside-session-kill username
periodically from cron. - - diff --git a/httemplate/docs/signup.html b/httemplate/docs/signup.html deleted file mode 100644 index 97d7aa794..000000000 --- a/httemplate/docs/signup.html +++ /dev/null @@ -1,54 +0,0 @@ - - Signup server - - -

Signup server

-For security reasons, the signup server should run on an external public -webserver. On this machine, install: - -Then: -
    -
  • Add the user `freeside' to the the external machine. -
  • Copy or symlink fs_signup/FS-SignupClient/cgi/signup.cgi into the web server's document space. -
  • 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 -
  • Enable CGI execution for files with the `.cgi' extension. (with Apache) -
  • Create the /usr/local/freeside directory on the external machine (owned by the freeside user). -
  • touch /usr/local/freeside/fs_signupd_socket; chown freeside /usr/local/freeside/fs_signupd_socket; chmod 600 /usr/local/freeside/fs_signupd_socket -
  • Use suEXEC or setuid (see install.html for details) to run signup.cgi 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
    fs_signup_server user machine agentnum refnum
    on the Freeside machine. -
      -
    • user is a user from the mapsecrets file. -
    • machine is the name of the external machine. -
    • agentnum and refnum are the agent and referral, respectively, to use for customers who sign up via this signup server. -
    -
-Optional: -
    -
  • 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_signup/ieak.template) See the section on internet settings files in the IEAK documentation for more information. -
  • If you create a /usr/local/freeside/success.html file on the external machine, it will be used as the success HTML page. Although template substiutions are available, a regular HTML file will work fine here, unlike signup.html. An example file is included as fs_signup/FS-SignupClient/cgi/success.html -
  • Variable substitutions available in ieak.template, cck.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 -
    -
  • If you create a /usr/local/freeside/signup.html file on the external machine, it will be used as a template for the form HTML. This requires the template to be constructed appropriately; probably best to start with the example file included as fs_signup/FS-SignupClient/cgi/signup.html. -
  • If there are any entries in the prepay_credit table, a user can enter a string matching the identifier column to receive the credit specified in the amount column, and/or the time specified in the seconds column (for use with the session monitor), after which that identifier is no longer valid. This can be used to implement pre-paid "calling card" type signups. The bin/generate-prepay script can be used to populate the prepay_credit table. -
- diff --git a/httemplate/docs/ssh.html b/httemplate/docs/ssh.html deleted file mode 100755 index d2c501e35..000000000 --- a/httemplate/docs/ssh.html +++ /dev/null @@ -1,16 +0,0 @@ - - Unattended SSH - - -

Unattended SSH

-
Unattended remote login - Freeside can login to remote machines unattended using SSH. This can pose a security risk if not configured correctly, and will allow an intruder who breaks into your freeside machine full access to your remote machines. Do not use this feature unless you understand what you are doing! -
    -
  • As the freeside user (on your freeside machine), generate an authentication key using ssh-keygen. Since this is for unattended operation, use a blank passphrase. -
  • Append the newly-created identity.pub file to ~root/.ssh/authorized_keys (or the appopriate ~username/.ssh/authorized_keys) on the remote machine(s). -
  • Some new SSH v2 implementation accept v2 style keys only. Use the -t option to ssh-keygen, and append the created id_dsa.pub or id_rsa.pub to ~root/.ssh/authorized_keys2 (or the appopriate ~username/.ssh/authorized_keys) on the remote machine(s). -
  • You may need to set PermitRootLogin without-password (meaning with keys only) in your sshd_config file on the remote machine(s). -
  • You may want to set ForwardX11 = no in ~root/.ssh/config to prevent spurious errors if your distribution turns on X11 forwarding by default. -
- - - 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. -
- 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 ac2c6238d..000000000 --- a/httemplate/docs/upgrade10.html +++ /dev/null @@ -1,93 +0,0 @@ -
    -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, 
    -Spreadsheet::WriteExcel, IO-stringy (IO::Scalar), Frontier::RPC
    -(Frontier::RPC2), MIME::Entity (MIME-tools), IPC::Run3, Net::Whois::Raw,
    -JSON and Term::ReadKey
    -
    -
    -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;
    -
    -Or on older Pg versions that don't support altering columns directly:
    -(dump database, edit & 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:
    -- 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:
    -
    -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/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

      - - - - - - - - - -
      Apache::ASPMason
        -
      • 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: - -
        PostgreSQLMySQL, 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...) -
      - 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