diff options
| author | ivan <ivan> | 2000-01-28 22:51:17 +0000 |
|---|---|---|
| committer | ivan <ivan> | 2000-01-28 22:51:17 +0000 |
| commit | c2e9ca0ddbdcd3588f94c8c550120c73c0844bb1 (patch) | |
| tree | 336b2314f4e6a0d07d1f52e9a47a067b343edcf7 | |
| parent | b202e6a1fd3f2ef13f5bc8d77f44e2869083c494 (diff) | |
add signup server documentation, track full phone number
| -rw-r--r-- | htdocs/docs/index.html | 2 | ||||
| -rw-r--r-- | htdocs/docs/schema.html | 1 | ||||
| -rw-r--r-- | htdocs/docs/signup.html | 46 | ||||
| -rw-r--r-- | htdocs/docs/upgrade5.html | 27 |
4 files changed, 76 insertions, 0 deletions
diff --git a/htdocs/docs/index.html b/htdocs/docs/index.html index 88714dc71..21ec25755 100644 --- a/htdocs/docs/index.html +++ b/htdocs/docs/index.html @@ -9,6 +9,7 @@ <li><a href="upgrade2.html">Upgrading from 1.1.x to 1.1.4</a> <li><a href="upgrade3.html">Upgrading from 1.1.x to 1.2.x</a> <li><a href="upgrade4.html">Upgrading from 1.2.x to 1.2.2</a> + <li><a href="upgrade5.html">Upgrading from 1.2.2 to 1.3.0</a> <li><a href="config.html">Configuration files</a> <!-- <li><a href="admin.html">Administration</a> @@ -17,6 +18,7 @@ <li><a href="legacy.html">Importing legacy data</a> <li><a href="export.html">File exporting and remote setup</a> <li><a href="passwd.html">fs_passwd</a> + <li><a href="signup.html">Signup server</a> <li><a href="billing.html">Billing</a> <li><a href="trouble.html">Troubleshooting</a> <li><a href="schema.html">Schema reference</a> diff --git a/htdocs/docs/schema.html b/htdocs/docs/schema.html index 9558109e9..92965d795 100644 --- a/htdocs/docs/schema.html +++ b/htdocs/docs/schema.html @@ -198,6 +198,7 @@ <li>state <li>ac - area code <li>exch - exchange + <li>loc - rest of number </ul> <li><a name="svc_acct_sm">svc_acct_sm</a> - Domain mail aliases <ul> diff --git a/htdocs/docs/signup.html b/htdocs/docs/signup.html new file mode 100644 index 000000000..a00995994 --- /dev/null +++ b/htdocs/docs/signup.html @@ -0,0 +1,46 @@ +<head> + <title>Signup server</title> +</head> +<body> + <h1>Signup server</h1> +For security reasons, the signup server should run on an external public +webserver. On this machine, install: +<ul> + <li>A web server, such as <a href="http://www.apache-ssl.org">Apache-SSL</a> or <a href="http://www.apache.org">Apache</a> + <li><a href="ftp://ftp.cs.hut.fi/pub/ssh/">SSH</a> + <li><a href="http://www.perl.com/CPAN/doc/relinfo/INSTALL.html">Perl</a> (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.) + <li><a href="http://www.perl.com/CPAN/modules/by-module/Text/">Text::Template</a> + <li><a href="http://www.perl.com/CPAN/modules/by-author/IVAN/">HTTP::Headers::UserAgent</a> (version 2.0 or higher; not yet indexed correctly on CPAN) + + <li><a href="man/FS/SignupClient.html">FS::SignupClient</a> (copy the fs_signup/FS-SignupClient directory to the external machine, then: perl Makefile.PL; make; make install) +</ul> +Then: +<ul> + <li>Add the user `freeside' to the the external machine. + <li>Copy or symlink fs_signup/FS-SignupClient/cgi/signup.cgi into the web server's document space. + <li>Enable CGI execution for files with the `.cgi' extension. (with <a href="http://www.apache.org/docs/mod/mod_mime.html#addhandler">Apache</a>) + <li>Create the /usr/local/freeside directory on the external machine (owned by the freeside user). + <li>touch /usr/local/freeside/fs_signupd_socket; chown freeside /usr/local/freeside/fs_signupd_socket; chmod 600 /usr/local/freeside/fs_signupd_socket + <li>Use <a href="http://www.apache.org/docs/suexec.html">suEXEC</a> or <a href="http://www.perl.com/CPAN-local/doc/manual/html/pod/perlsec.html#Security_Bugs">setuid</a> (see <a href="install.html">install.html</a> for details) to run signup.cgi as the freeside user. + <li>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). + <li>Run <pre>fs_signup_server <i>user</i> <i>machine</i> <i>agentnum</i> <i>refnum</i></pre> on the Freeside machine. + <ul> + <li><i>user</i> is a user from the mapsecrets file. + <li><i>machine</i> is the name of the external machine. + <li><i>agentnum</i> and <i>refnum</i> are the <a href="schema.html#agent">agent</a> and <a href="schema.html#part_referral">referral</a>, respectively, to use for customers who sign up via this signup server. + </ul> +</ul> +Optional: +<ul> + <li>If you create a <b>/usr/local/freeside/ieak.template</b> file on the external machine, it will be sent to IE users with MIME type <i>application/x-Internet-signup</i>. This file will be processed with <a href="http://search.cpan.org/doc/MJD/Text-Template-1.23/Template.pm">Text::Template</a> with the following variables available: + <ul> + <li>$ac - area code of selected POP + <li>$exch - exchange of selected POP + <li>$loc - local part of selected POP + <li>$username + <li>$password + <li>$email_name - first and last name + </ul> +(an example file is included as <b>fs_signup/ieak.template</b>) +</ul> +</body> diff --git a/htdocs/docs/upgrade5.html b/htdocs/docs/upgrade5.html new file mode 100644 index 000000000..82a7602a3 --- /dev/null +++ b/htdocs/docs/upgrade5.html @@ -0,0 +1,27 @@ +<head> + <title>Upgrading to 1.3.0</title> +</head> +<body> +<h1>Upgrading to 1.3.0 from 1.2.2</h1> +<ul> + <li>If migrating from 1.0.0, see these <a href="upgrade.html">instructions</a> first. + <li>If migrating from less than 1.1.4, see these <a href="upgrade2.html">instructions</a> first. + <li>If migrating from less than 1.2.0, see these <a href="upgrade3.html">instructions</a> first. + <li>If migrating from less than 1.2.2, see these <a href="upgrade4.html">instructions</a> first. + <li>Back up your data and current Freeside installation. + <li>Apply the following changes to your database: +<pre> +ALTER TABLE svc_acct_pop ADD loc CHAR(4); +</pre> + <li>Copy or symlink htdocs to the new copy. + <li>Remove the symlink or directory <i>(your_site_perl_directory)</i>/FS. + <li>Change to the FS directory in the new tarball, and build and install the + Perl modules: + <pre> +$ cd FS/ +$ perl Makefile.PL +$ make +$ su +# make install</pre> + <li>Run bin/dbdef-create. This file uses MySQL-specific syntax. If you are running a different database engine you will need to modify it slightly. +</body> |