From 022491d9d2723ca4d7d0718cdb1fd67e7652428e Mon Sep 17 00:00:00 2001 From: cvs2git Date: Wed, 7 Apr 2004 09:08:35 +0000 Subject: This commit was manufactured by cvs2svn to create tag 'NET_WHOIS_RAW_0_31'. --- httemplate/docs/ach.html | 12 - httemplate/docs/admin.html | 81 ---- httemplate/docs/billing.html | 54 --- httemplate/docs/config.html | 36 -- httemplate/docs/cvv2.html | 25 -- httemplate/docs/export.html | 55 --- httemplate/docs/ieak.html | 75 ---- httemplate/docs/index.html | 30 -- httemplate/docs/install.html | 212 ---------- httemplate/docs/legacy.html | 39 -- .../docs/man/FS/part_export/.cvs_is_on_crack | 0 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 14438 -> 0 bytes httemplate/docs/schema.html | 435 --------------------- httemplate/docs/schema.png | Bin 681043 -> 0 bytes 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 | 26 -- httemplate/docs/upgrade10.html | 222 ----------- httemplate/docs/upgrade7.html | 24 -- httemplate/docs/upgrade8.html | 392 ------------------- httemplate/docs/upgrade9.html | 28 -- 26 files changed, 1924 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.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.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/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 b79df78fe..000000000 --- a/httemplate/docs/ach.html +++ /dev/null @@ -1,12 +0,0 @@ - - - - Electronic check (ACH) information - - - -

-
- (close window) - - diff --git a/httemplate/docs/admin.html b/httemplate/docs/admin.html deleted file mode 100755 index 50beafe78..000000000 --- a/httemplate/docs/admin.html +++ /dev/null @@ -1,81 +0,0 @@ - - Administration - - -

Administration

- -

Open up the root of the Freeside document tree in your web - browser. For example, if you created the Freeside document tree in - /home/httpd/html/freeside, and your web browser's DocumentRoot is - /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. - -
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 - 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 - which may select from among this domain and the customer's domains. - -

- - - -

Create at least POP (Point of Presence) by selecting - View/Edit POPs from the main menu.	OR	If you are not doing dialup, set slipip to fixed and blank for all your - Service Definitions which have Table svc_acct.

- -

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

- - diff --git a/httemplate/docs/billing.html b/httemplate/docs/billing.html deleted file mode 100644 index 1d6f8c4fc..000000000 --- a/httemplate/docs/billing.html +++ /dev/null @@ -1,54 +0,0 @@ - - Billing - - -

Billing

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. -
Optional: Invoice template customization -
- 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. - -
  -
-
Batch credit card processing -
- After freeside-daily is run, a credit card batch will be in the cust_pay_batch table. Export this table to your credit card batching. -
- When your batch completes, erase the cust_pay_batch records in that batch and add any necessary paymants to the cust_pay table. Example code to add payments is: -
```
use FS::cust_pay;
-
-# loop over all records in batch
-
-my $payment=create FS::cust_pay (
-  'invnum' => $invnum,
-  'paid' => $paid,
-  '_date' => $_date,
-  'payby' => $payby,
-  'payinfo' => $payinfo,
-  'paybatch' => $paybatch,
-);
-
-my $error=$payment->insert;
-if ( $error ) {
-  #process error
-}
-
-# end loop
-
```
  -All fields except paybatch are contained in the cust_pay_batch table. You can use paybatch field to track particular batches and/or particular transactions within a batch. -
- -

- 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/cvv2.html b/httemplate/docs/cvv2.html deleted file mode 100644 index fe8a17f6f..000000000 --- a/httemplate/docs/cvv2.html +++ /dev/null @@ -1,25 +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 / Discover	American Express
- -	- -

- (close window) - - diff --git a/httemplate/docs/export.html b/httemplate/docs/export.html deleted file mode 100755 index 71e3acf1f..000000000 --- a/httemplate/docs/export.html +++ /dev/null @@ -1,55 +0,0 @@ - - File exporting - - -

File exporting

- NOTE: This file is OUT OF DATE with the landing of the new export code and is only here for reference. DO NOT follow these instructions. Instead use the new exports in the web interface. -

bin/svc_acct.export will create UNIX passwd, shadow and master.passwd files, ERPCD acp_passwd and acp_dialup files and a RADIUS users file in the /usr/local/etc/freeside/export.datasrc directory. Some RADIUS servers (such as Radiator, ICRADIUS and FreeRADIUS) will authenticate directly out of an SQL database. In these cases, -it is reccommended that you replicate (Replication in MySQL) the data to an external RADIUS machine or point icradius_secrets to the external machine rather than running the RADIUS server on your Freeside machine. Using the appropriate configuration settings, you can export these files to your remote machines unattended: -
- shellmachines - passwd and shadow are copied to the remote machine as /etc/passwd.new and /etc/shadow.new and then moved to /etc/passwd and /etc/shadow if no errors occur. -
- bsdshellmachines - passwd and master.passwd are copied to the remote machine as /etc/passwd.new and /etc/master.passwd.new and moved to /etc/passwd and /etc/master.passwd if no errors occur. -
- nismachines - passwd and shadow are copied to the /etc/global directory on the remote machine. If no errors occur, the command ( cd /var/yp; make; ) is executed on the remote machine. -
- erpcdmachines - acp_passwd and acp_dialup are copied to the /usr/annex directory on the remote machine. If no errors occur, the command ( kill -USR1 `cat /usr/annex/erpcd.pid` ) is executed on the remote machine. -
- radiusmachines - users is copied to the /etc/raddb directory on the remote machine. If no errors occur, the command ( builddbm ) is executed on the remote machine. -
- icradiusmachines - Turn this option on to enable radcheck table population - by default in the Freeside database, or in the database specified by the icradius_secrets config option (the radcheck table needs to be created manually). You do not need to use MySQL for your Freeside database to export to an ICRADIUS/FreeRADIUS MySQL database with this option.
  ADDITIONAL DEPRECATED FUNCTIONALITY (instead use MySQL replication or point icradius_secrets to the external database) - your ICRADIUS machines or FreeRADIUS (with MySQL authentication) machines, one per line. Machines listed in this file will have the radcheck table exported to them. Each line should contain four items, separted by whitespace: machine name, MySQL database name, MySQL username, and MySQL password. For example: "radius.isp.tld radius_db radius_user passw0rd"
  -
-
svc_acct.pm - If a shellmachine is defined, users can be created, modified and deleted remotely; see below. -
- Account creation - If the username, uid and dir fields are defined for a new user, the command(s) specified in the shellmachine-useradd configuration file are executed on shellmachine via ssh. If this file does not exist, useradd -d $dir -m -s $shell -u $uid $username is the default. If the file exists but is empty, cp -pr /etc/skel $dir; chown -R $uid.$gid $dir is the default instead. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $username, $uid, $gid, $dir, and $shell. -
- Account deletion - The command(s) specified in the shellmachine-userdel configuration file are executed on shellmachine via ssh. If this file does not exist, userdel $username is the default. If the file exists but is empty, rm -rf $dir is the default instead. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $username and $dir. -
- Account modification - If a user's home directory changes, the command(s) specified in the shellmachine-usermod configuration file are execute on shellmachine via ssh. If this file does not exist or is empty, [ -d $old_dir ] && mv $old_dir $new_dir || ( chmod u+t $old_dir; mkdir $new_dir; cd $old_dir; find . -depth -print | cpio -pdm $new_dir; chmod u-t $new_dir; chown -R $uid.$gid $new_dir; rm -rf $old_dir ) is the default. Otherwise the contents of the file are treated as a double-quoted perl string, with the following variables available: $old_dir, $new_dir, $uid and $gid. -
-
svc_acct.pm - Cyrus IMAP Server integration, enabled by the cyrus configuration file -
- Account creation - (Cyrus::IMAP::Admin should be installed locally) -
- Account deletion - (Cyrus::IMAP::Admin should be installed locally) -
- Account modification - (not yet implemented) -
-
bin/svc_acct_sm.export will create Qmail rcpthosts, recipientmap and virtualdomains files and Sendmail virtusertable and sendmail.cw files in the /usr/local/etc/freeside/export.datasrc directory. Using the appropriate configuration files, you can export these files to your remote machines unattemded: -
- qmailmachines - recipientmap, virtualdomains and rcpthosts are copied to the /var/qmail/control directory on the remote machine. Note: If you imported qmail configuration files, run the generated /usr/local/etc/freeside/export.datasrc/virtualdomains.FIX on a machine with your user home directories before exporting qmail configuration files. -
- shellmachine - The command [ -e homedir/.qmail-default ] || { touch homedir/.qmail-default; chown uid.gid homedir/.qmail-default; } will be run on this machine for users in the virtualdomains file. -
- sendmailmachines - sendmail.cw and virtusertable are copied to the remote machine as /etc/sendmail.cw.new and /etc/virtusertable.new. If no errors occur, they are moved to /etc/sendmail.cw and /etc/virtusertable and the command specified in the sendmailrestart configuration file is executed. (The path can be changed from the default /etc with the sendmailconfigpath configuration file.) -
-
svc_domain.pm - If the qmailmachines configuration file exists and a shellmachine is defined, user .qmail- files can be updated for catchall mailboxes. -
- The command
```
[ -e homedir/.qmail-domain-default ] || {
-    touch homedir/.qmail-domain-default;
-    chown uid.gid homedir/.qmail-domain-default;
-}
```
  is run. -
-
svc_forward.pm - Not yet documented; see manpage. -
svc_www.pm - Not yet documented; see manpage. -

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

- - - 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 648cb985b..000000000 --- a/httemplate/docs/index.html +++ /dev/null @@ -1,30 +0,0 @@ - - Documentation - - -

Documentation

- diff --git a/httemplate/docs/install.html b/httemplate/docs/install.html deleted file mode 100644 index 41aacc51b..000000000 --- a/httemplate/docs/install.html +++ /dev/null @@ -1,212 +0,0 @@ - - Installation - - -

Installation

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

-Before installing, you need: -

Perl -
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 -
A transactional database engine supported by Perl's DBI. -
- PostgreSQL is recommended (v7or later). -
- MySQL MINIMUM VERSION 4.1 is untested but may work. Versions before 4.1 do not support standard SQL subqueries and are NOT SUPPORTED. If you are a developer who wishes to contribute MySQL 3.x/4.0 support, see ticket #438 in the bug-tracking system and ask on the -devel mailing list. - - MySQL's default MyISAM and ISAM table types are not supported. If you want to use MySQL, you must use one of the new transaction-safe table types such as BDB or InnoDB, and set it as the default table type using the --default-table-type=BDB or --default-table-type=InnoDB mysqld command-line option or by setting default-table-type=BDB or default-table-type=InnoDB in the my.cnf option file. -
-
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, DBD::mysql for MySQL) -
- DBIx-DataSource -
- DBIx-DBSchema -
- Net-SSH -
- String-ShellQuote -
- Net-SCP -
- Apache::ASP or HTML::Mason -
- Tie-IxHash -
- Time-Duration -
- HTML-Widgets-SelectLayers -
- Storable - -
- NetAddr-IP -
- Chart -
- Crypt::PasswdMD5 -
- 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: -

-$ su
-# make create-database

- (or manually, with Postgres:) -

-$ su freeside
-$ createdb 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. -

- - - - - - - - -

Apache::ASP Mason

Apache::ASP	Mason
- Run `make aspdocs` - Copy `aspdocs/` to your web server's document space: - -cp aspdocs /usr/local/apache/htdocs/freeside-asp - - Create a Global directory, such as `/usr/local/etc/freeside/asp-global/`: - -mkdir /usr/local/etc/freeside/asp-global/ -chown freeside /usr/local/etc/freeside/asp-global/ - - Copy `htetc/global.asa` to the Global directory: - -cp htetc/global.asa /usr/local/etc/freeside/asp-global/global.asa - - Configure Apache for the Global directory and to execute .cgi files using Apache::ASP. For example: - -PerlModule Apache::ASP -# your freeside document root -<Directory /usr/local/apache/htdocs/freeside-asp> -<Files ~ (\.cgi\|\.html)> -SetHandler perl-script -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 /usr/local/apache/htdocs/freeside-asp -</Directory> - -	- Run `make masondocs` - Copy `masondocs/` to your web server's document space. (For example: `/usr/local/apache/htdocs/freeside-mason`) - Copy `htetc/handler.pl` to `/usr/local/etc/freeside` - Edit `handler.pl` and: - - set an appropriate `comp_root`, such as `/usr/local/apache/htdocs/freeside-mason` - set an appropriate `data_dir`, such as `/usr/local/etc/freeside/masondata` - - - Configure Apache to use the `handler.pl` file and to execute .cgi files using HTML::Mason. For example: - -PerlModule HTML::Mason -<Directory /usr/local/apache/htdocs/freeside-mason> -<Files ~ (\.cgi\|.html)> -SetHandler perl-script -PerlHandler HTML::Mason -</Files> -<Perl> -require "/usr/local/etc/freeside/handler.pl"; -</Perl> -</Directory> - -

Run make aspdocs -

Copy aspdocs/ to your web server's document space: -

-cp aspdocs /usr/local/apache/htdocs/freeside-asp
-

Create a Global directory, such as /usr/local/etc/freeside/asp-global/: -

-mkdir /usr/local/etc/freeside/asp-global/
-chown freeside /usr/local/etc/freeside/asp-global/
-

Copy htetc/global.asa to the Global directory: -

-cp htetc/global.asa /usr/local/etc/freeside/asp-global/global.asa
-

Configure Apache for the Global directory and to execute .cgi files using Apache::ASP. For example: -

-PerlModule Apache::ASP
-# your freeside document root
-<Directory /usr/local/apache/htdocs/freeside-asp>
-<Files ~ (\.cgi|\.html)>
-SetHandler perl-script
-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 /usr/local/apache/htdocs/freeside-asp
-</Directory>
-

Run make masondocs -
Copy masondocs/ to your web server's document space. (For example: /usr/local/apache/htdocs/freeside-mason) -
Copy htetc/handler.pl to /usr/local/etc/freeside -
Edit handler.pl and: -
- set an appropriate comp_root, such as /usr/local/apache/htdocs/freeside-mason -
- set an appropriate data_dir, such as /usr/local/etc/freeside/masondata -
- -

Configure Apache to use the handler.pl file and to execute .cgi files using HTML::Mason. For example: -

-PerlModule HTML::Mason
-<Directory /usr/local/apache/htdocs/freeside-mason>
-<Files ~ (\.cgi|.html)>
-SetHandler perl-script
-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): -
```
-<Directory /usr/local/apache/htdocs/freeside-asp>
-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 -
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.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 746561550..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 b38031777..000000000 --- a/httemplate/docs/schema.html +++ /dev/null @@ -1,435 +0,0 @@ - - Schema reference - - -

Schema reference

- Schema diagram: 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. -
- 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 -
- eventnum - primary key -
- invnum - invoice -
- eventpart - event definition -
- _date -
- status -
- statustext -
-
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_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_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 -
- svcnum - primary key -
- pkgnum - package -
- svcpart - Service definition -
-
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 -
- setup - setup fee expression -
- freq - recurring frequency (months) -
- 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 -
- plandata - additional price plan data -
- disabled - Disabled flag, empty or `Y' -
-
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 -
- pkgpart - Package definition -
- svcpart - Service definition -
- quantity - quantity of this service that this package includes -
- primary_svc - blank or Y: primary service -
-
export_svc -
- exportsvcnum - primary key -
- svcpart - Service definition -
- exportnum - Export -
-
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 -
- prepaynum - primary key -
- identifier - text or numeric string used to receive this credit -
- amount - amount of credit -
-
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 -
- svcnum - primary key -
- domain -
-
svc_forward - Mail forwarding aliases -
- svcnum - primary key -
- srcsvc - svcnum of the source of this forward -
- src - literal source (username or full email address) -
- dstsvc - svcnum of the destination of this forward -
- dst - literal destination (username or full email address) -
-
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 -
- svcnum - primary key -
- recnum - host -
- usersvc - account -
-
type_pkgs -
- typenum - agent type -
- pkgpart - Package definition -
-
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 -
-
msgcat - i18n message catalog -
- msgnum - primary key -
- msgcode - message code -
- locale - locale -
- msg - Message text -
-

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

A web server, such as Apache-SSL or Apache -
SSH -
Perl (at least 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.) -
Text::Template -
Storable -
Business-CreditCard -
HTTP::BrowserDetect - -
FS::SignupClient (copy the fs_signup/FS-SignupClient directory to the external machine, then: perl Makefile.PL; make; make 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 eb40df8b3..000000000 --- a/httemplate/docs/upgrade-1.4.2.html +++ /dev/null @@ -1,26 +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. -
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 205866e73..000000000 --- a/httemplate/docs/upgrade10.html +++ /dev/null @@ -1,222 +0,0 @@ -
-this is incomplete - -install DBD::Pg 1.32 (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.23 -install Net::SSH 0.08 -- 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. - -install NetAddr::IP, Chart::Base, IPC::ShareLite and Locale::SubCountry - -CREATE TABLE cust_bill_pkg_detail ( - detailnum serial, - pkgnum int NOT NULL, - invnum int NOT NULL, - detail varchar(80), - PRIMARY KEY (detailnum) -); -CREATE INDEX cust_bill_pkg_detail1 ON cust_bill_pkg_detail ( pkgnum, invnum ); - -CREATE TABLE part_virtual_field ( - vfieldpart int NOT NULL, - dbtable varchar(32) NOT NULL, - name varchar(32) NOT NULL, - check_block text, - list_source text, - length integer, - label varchar(80), - PRIMARY KEY (vfieldpart) -); - -CREATE TABLE virtual_field ( - recnum integer NOT NULL, - vfieldpart integer NOT NULL, - value varchar(128) NOT NULL, - PRIMARY KEY (vfieldpart, recnum) -); - -CREATE TABLE router ( - routernum serial, - routername varchar(80), - svcnum int, - PRIMARY KEY (routernum) -); - -CREATE TABLE part_svc_router ( - svcpart int NOT NULL, - routernum int NOT NULL -); - -CREATE TABLE addr_block ( - blocknum serial, - routernum int NOT NULL, - ip_gateway varchar(15) NOT NULL, - ip_netmask int NOT NULL, - PRIMARY KEY (blocknum) -); -CREATE UNIQUE INDEX addr_block1 ON addr_block ( blocknum, routernum ); - -CREATE TABLE svc_broadband ( - svcnum int NOT NULL, - blocknum int NOT NULL, - speed_up int NOT NULL, - speed_down int NOT NULL, - ip_addr varchar(15), - PRIMARY KEY (svcnum) -); - -CREATE TABLE acct_snarf ( - snarfnum serial, - svcnum int NOT NULL, - machine varchar(255) NULL, - protocol varchar(80) NULL, - username varchar(80) NULL, - _password varchar(80) NULL, - PRIMARY KEY (snarfnum) -); -CREATE INDEX acct_snarf1 ON acct_snarf ( svcnum ); - -CREATE TABLE svc_external ( - svcnum int NOT NULL, - id int NOT NULL, - title varchar(80), - PRIMARY KEY (svcnum) -); - -CREATE TABLE part_pkg_temp ( - pkgpart serial NOT NULL, - pkg varchar(80) NOT NULL, - "comment" varchar(80) NOT NULL, - setup text NULL, - freq varchar(80) NOT NULL, - recur text NULL, - setuptax char(1) NULL, - recurtax char(1) NULL, - plan varchar(80) NULL, - plandata text NULL, - disabled char(1) NULL, - taxclass varchar(80) NULL, - PRIMARY KEY (pkgpart) -); -INSERT INTO part_pkg_temp SELECT * from part_pkg; -DROP TABLE part_pkg; -ALTER TABLE part_pkg_temp RENAME TO part_pkg; -CREATE INDEX part_pkg1 ON part_pkg(disabled); - -On modern Pg: -ALTER TABLE part_pkg DROP CONSTRAINT part_pkg_temp_pkey; -ALTER TABLE part_pkg ADD PRIMARY KEY (pkgpart); -select setval('public.part_pkg_temp_pkgpart_seq', ( select max(pkgpart) from part_pkg) ); - -Or on Pg versions that don't support DROP CONSTRAINT and ADD PRIMARY KEY (tested on 7.1 so far): -DROP INDEX part_pkg_temp_pkey; -CREATE UNIQUE INDEX part_pkg_pkey ON part_pkg (pkgpart); -select setval('part_pkg_temp_pkgpart_seq', ( select max(pkgpart) from part_pkg) ); - -CREATE TABLE h_part_pkg_temp ( - historynum serial NOT NULL, - history_date int, - history_user varchar(80) NOT NULL, - history_action varchar(80) NOT NULL, - pkgpart int NOT NULL, - pkg varchar(80) NOT NULL, - "comment" varchar(80) NOT NULL, - setup text NULL, - freq varchar(80) NOT NULL, - recur text NULL, - setuptax char(1) NULL, - recurtax char(1) NULL, - plan varchar(80) NULL, - plandata text NULL, - disabled char(1) NULL, - taxclass varchar(80) NULL, - PRIMARY KEY (historynum) -); -INSERT INTO h_part_pkg_temp SELECT * from h_part_pkg; -DROP TABLE h_part_pkg; -ALTER TABLE h_part_pkg_temp RENAME TO h_part_pkg; -CREATE INDEX h_part_pkg1 ON h_part_pkg(disabled); - -On modern Pg: -ALTER TABLE h_part_pkg DROP CONSTRAINT h_part_pkg_temp_pkey; -ALTER TABLE h_part_pkg ADD PRIMARY KEY (historynum); -select setval('public.h_part_pkg_temp_historynum_seq', ( select max(historynum) from h_part_pkg) ); - -Or on Pg versions that don't support DROP CONSTRAINT and ADD PRIMARY KEY (tested on 7.1 so far): -DROP INDEX h_part_pkg_temp_pkey; -CREATE UNIQUE INDEX h_part_pkg_pkey ON h_part_pkg (historynum); -select setval('h_part_pkg_temp_historynum_seq', ( select max(historynum) from h_part_pkg) ); - - -DROP INDEX cust_bill_pkg1; - -ALTER TABLE cust_bill_pkg ADD itemdesc varchar(80) NULL; -ALTER TABLE h_cust_bill_pkg ADD itemdesc varchar(80) NULL; -ALTER TABLE cust_main_county ADD taxname varchar(80) NULL; -ALTER TABLE h_cust_main_county ADD taxname varchar(80) NULL; -ALTER TABLE cust_main_county ADD setuptax char(1) NULL; -ALTER TABLE h_cust_main_county ADD setuptax char(1) NULL; -ALTER TABLE cust_main_county ADD recurtax char(1) NULL; -ALTER TABLE h_cust_main_county ADD recurtax char(1) NULL; -ALTER TABLE cust_pkg ADD last_bill int NULL; -ALTER TABLE h_cust_pkg ADD last_bill int NULL; -ALTER TABLE agent ADD disabled char(1) NULL; -ALTER TABLE h_agent ADD disabled char(1) NULL; -ALTER TABLE agent ADD username varchar(80) NULL; -ALTER TABLE h_agent ADD username varchar(80) NULL; -ALTER TABLE agent ADD _password varchar(80) NULL; -ALTER TABLE h_agent ADD _password varchar(80) NULL; -ALTER TABLE cust_main ADD paycvv varchar(4) NULL; -ALTER TABLE h_cust_main ADD paycvv varchar(4) NULL; -ALTER TABLE part_referral ADD disabled char(1) NULL; -ALTER TABLE h_part_referral ADD disabled char(1) NULL; -CREATE INDEX part_referral1 ON part_referral ( disabled ); -ALTER TABLE pkg_svc ADD primary_svc char(1) NULL; -ALTER TABLE h_pkg_svc ADD primary_svc char(1) NULL; -ALTER TABLE svc_forward ADD src varchar(255) NULL; -ALTER TABLE h_svc_forward ADD src varchar(255) NULL; - -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; - -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' ) ); - -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 - -optionally: - - CREATE INDEX cust_main6 ON cust_main ( daytime ); - CREATE INDEX cust_main7 ON cust_main ( night ); - CREATE INDEX cust_main8 ON cust_main ( fax ); - CREATE INDEX cust_main9 ON cust_main ( ship_daytime ); - CREATE INDEX cust_main10 ON cust_main ( ship_night ); - CREATE INDEX cust_main11 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); - - serial columns - -mandatory again: - -dbdef-create username -create-history-tables username cust_bill_pkg_detail router part_svc_router addr_block svc_broadband acct_snarf svc_external -dbdef-create username - -apache - fix sections to include .html also - -
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 cf60a8582..000000000 --- a/httemplate/docs/upgrade8.html +++ /dev/null @@ -1,392 +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 -); -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...) -
- 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