From: ivan Date: Sat, 14 Oct 2006 09:55:09 +0000 (+0000) Subject: move signup/self-service install to wiki X-Git-Tag: freeside_1_7_2~1^2~293 X-Git-Url: http://git.freeside.biz/gitweb/?a=commitdiff_plain;h=792be9bdf5b5f71feb3369c0930b05cceb07e46e;p=freeside.git move signup/self-service install to wiki --- diff --git a/httemplate/docs/index.html b/httemplate/docs/index.html index d7b464346..e014e963d 100644 --- a/httemplate/docs/index.html +++ b/httemplate/docs/index.html @@ -8,6 +8,7 @@

Configuration and setup

@@ -20,7 +21,6 @@

Administration !-->

Exports -

Signup, self-service and reseller interfaces

Billing

Developer

diff --git a/httemplate/docs/selfservice.html b/httemplate/docs/selfservice.html deleted file mode 100644 index 9dc8f2a5e..000000000 --- a/httemplate/docs/selfservice.html +++ /dev/null @@ -1,78 +0,0 @@ - - Signup, self-service and reseller interfaces - - -

Signup, self-service and reseller interfaces

-For security reasons, the self-service interface should run on a public -machine, not the backend Freeside server. On the public machine, install: -

A web server, such as Apache (mod_ssl or Apache-SSL highly recommended) - -
SSH -
Perl. -
Text::Template -
Storable -
Business-CreditCard -
HTTP::BrowserDetect -
HTML::Parser - -
FS::SelfService (copy the fs_selfservice/FS-SelfService directory to the external machine, then: perl Makefile.PL; make; make install) -

-Then: -

Set the signup_server-default_agentnum configuration value to a default agent number. -
Set the signup_server-default_refnum configuration value to a default advertising source. -
Set the signup_server-payby configuration value to the acceptable payment types for signups. -
Set the signup_server-realtime configuration value to run billing for signups immediately. -
Add the user `freeside' to the the external machine. -
Copy or symlink the fs_selfservice/FS-SelfService/cgi/ directory into the web server's document space. Optionally, customize the .html templates. "Entry points" (useful places to link to) are: -
- signup.cgi - Signup -
- selfservice.cgi - Customer self-service -
- agent.cgi - Reseller interface -
- passwd.cgi - Simple password-changing interface -
- promocode.html - Promotional code pre-signup -
- regcode.html - Registration code pre-signup -
- stateselect.html - State selection pre-signup -
-

Enable CGI execution for files with the `.cgi' extension. (with Apache), for example:

-#directory where selfservice .cgi scripts and .html templates are located
-<Directory /var/www/selfservice>
-AddHandler cgi-script .cgi
-Options +ExecCGI
-</Directory>

Create the /usr/local/freeside directory on the external machine (owned by the freeside user). -
touch /usr/local/freeside/selfservice_socket; chown freeside /usr/local/freeside/selfservice_socket; chmod 600 /usr/local/freeside/selfservice_socket -
Use suEXEC or setuid to run signup.cgi, selfservice.cgi, agent.cgi and passwd.cgi as the freeside user. Do not run your public web server as the freeside user! -
Append the identity.pub from the freeside user on your freeside machine to the authorized_keys file of the newly created freeside user on the external machine(s). -
Run an instance of
```
freeside-selfservice-server user machine
```
on the Freeside machine for each external machine. -
- user is a user from the mapsecrets file. -
- machine is the name of the external machine. - - -
-

-Optional: -

You can install the files in the fs_selfservice/FS-SelfService/cgi/ directory multiple places in your web server's document space, and customize the .html templates differently for each. You can set the agentnum used for each signup by editing signup.html and including a hidden field with the agentnum: -
```
-  <INPUT TYPE="hidden" NAME="agentnum" VALUE="3">
```
-
When linking to signup.cgi, you can include a referring custnum in the URL as follows: http://public.web.server/path/signup.cgi?ref=1542 -
If you create a /usr/local/freeside/ieak.template file on the external machine, it will be sent to IE users with MIME type application/x-Internet-signup. This file will be processed with Text::Template with the variables listed below available. - (an example file is included as fs_selfservice/FS-SelfService/ieak.template) See the section on internet settings files in the IEAK documentation for more information. - -
Variable substitutions available in ieak.template and success.html: -
- $ac - area code of selected POP -
- $exch - exchange of selected POP -
- $loc - local part of selected POP -
- $username -
- $password -
- $email_name - first and last name -
- $pkg - package name -
- - -