X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=httemplate%2Fdocs%2Fsignup.html;h=5168f47d6a8691729214aab04a4a8851d2f3fa87;hb=dcf30bca55c04f22b752deab57a70ee710f2fd32;hp=a40b1f9631868d3cb271a08b9030a620595a3183;hpb=51984ac3d3da3006809c6866fdecd4ad83610731;p=freeside.git
diff --git a/httemplate/docs/signup.html b/httemplate/docs/signup.html
index a40b1f963..5168f47d6 100644
--- a/httemplate/docs/signup.html
+++ b/httemplate/docs/signup.html
@@ -9,7 +9,9 @@ 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
+ Text::Template
+ Storable
+ Business-CreditCard
HTTP::Headers::UserAgent (version 2.0 or higher; not yet indexed correctly on CPAN)
FS::SignupClient (copy the fs_signup/FS-SignupClient directory to the external machine, then: perl Makefile.PL; make; make install)
@@ -18,6 +20,7 @@ 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
@@ -32,26 +35,22 @@ Then:
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 following variables available:
-
- - $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
-
- (an example file is included as fs_signup/ieak.template)
- - If you create a /usr/local/freeside/cck.template file on the external machine, the variables defined will be sent to Netscape users with MIME type application/x-netscape-autoconfigure-dialer-v2. This file will be processed with Text::Template with the following variables available:
-
- - $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
-
+ - 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 IEAK documentation for more information.
+
- If you create a /usr/local/freeside/cck.template file on the external machine, the variables defined will be sent to Netscape users with MIME type application/x-netscape-autoconfigure-dialer-v2. This file will be processed with Text::Template with the variables listed below available.
(an example file is included as fs_signup/cck.template). See the Netscape 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.