From 701b161a5fb5356a32c765ea83202b003e9a99f1 Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 26 Oct 2004 12:33:39 +0000 Subject: slightly more up-to-date docs --- httemplate/docs/selfservice.html | 60 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 60 insertions(+) create mode 100644 httemplate/docs/selfservice.html (limited to 'httemplate/docs/selfservice.html') diff --git a/httemplate/docs/selfservice.html b/httemplate/docs/selfservice.html new file mode 100644 index 000000000..a4dc6aa78 --- /dev/null +++ b/httemplate/docs/selfservice.html @@ -0,0 +1,60 @@ + + Signup, self-service and reseller interfaces + + +

Signup, self-service and reseller interfaces

+For security reasons, the self-service interface should run on a public +machine, not the backend Freeside server. On the public machine, install: + +Then: + +Optional: + + -- cgit v1.2.1 From 9ef0fe556c750abdea4b10e720af0d23485a45d8 Mon Sep 17 00:00:00 2001 From: ivan Date: Fri, 10 Dec 2004 23:51:02 +0000 Subject: correct path to selfservice --- httemplate/docs/selfservice.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'httemplate/docs/selfservice.html') diff --git a/httemplate/docs/selfservice.html b/httemplate/docs/selfservice.html index a4dc6aa78..e533ed2ee 100644 --- a/httemplate/docs/selfservice.html +++ b/httemplate/docs/selfservice.html @@ -23,7 +23,7 @@ Then:
  • Set the signup_server-default_agentnum configuration value to a default agent number.
  • Set the signup_server-default_refnum to a default advertising source.
  • Add the user `freeside' to the the external machine. -
  • Copy or symlink the 
    fs_signup/FS-SelfService/cgi/
    directory into the web server's document space, for customer self-service and reseller access. Optionally, customize the .html templates. +
  • Copy or symlink the 
    fs_selfservice/FS-SelfService/cgi/
    directory into the web server's document space, for customer self-service and reseller access. Optionally, customize the .html templates.
  • Copy or symlink the 
    fs_signup/FS-SignupClient/cgi/
    directory into the web server's document space, for signups. Optionally, customize the .html templates.
  • 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) -- cgit v1.2.1 From b5fbaadb1cb2893660e460a1d4a3cabe02774de7 Mon Sep 17 00:00:00 2001 From: ivan Date: Sat, 12 Mar 2005 14:31:50 +0000 Subject: - bring prepaid support into this century (close: Bug#1124) - finally get rid of fs_signup (everything is in fs_selfservice now) (Bug#413) - organize main menu sysadmin section so it is slightly less confusing --- httemplate/docs/selfservice.html | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) (limited to 'httemplate/docs/selfservice.html') diff --git a/httemplate/docs/selfservice.html b/httemplate/docs/selfservice.html index e533ed2ee..6d17ead3f 100644 --- a/httemplate/docs/selfservice.html +++ b/httemplate/docs/selfservice.html @@ -16,19 +16,26 @@ machine, not the backend Freeside server. On the public machine, install:
  • HTTP::BrowserDetect
  • FS::SelfService (copy the fs_selfservice/FS-SelfService directory to the external machine, then: perl Makefile.PL; make; make install) -
  • FS::SignupClient (copy the fs_signup/FS-SignupClient 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 to a default advertising source.
    • 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, for customer self-service and reseller access. Optionally, customize the .html templates. -
    • Copy or symlink the 
      fs_signup/FS-SignupClient/cgi/
      directory into the web server's document space, for signups. Optionally, customize the .html templates. +
    • 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 +
    • 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 +
    • touch /usr/local/freeside/selfservice_socket; chown freeside /usr/local/freeside/selfservice_socket; chmod 600 /usr/local/freeside/selfservice_socket
    • Use suEXEC or setuid (see install.html for details) to run signup.cgi, selfservice.cgi, agent.cgi and passwd.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 an instance of 
      freeside-selfservice-server user machine agentnum refnum
      on the Freeside machine for each external machine. @@ -42,7 +49,7 @@ 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 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. + (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:
          -- cgit v1.2.1 From 4c80aee9030dc645c0e8e487ce496b9e35b06f91 Mon Sep 17 00:00:00 2001 From: ivan Date: Fri, 18 Mar 2005 09:58:11 +0000 Subject: selfservice uses HTML::Entities --- httemplate/docs/selfservice.html | 1 + 1 file changed, 1 insertion(+) (limited to 'httemplate/docs/selfservice.html') diff --git a/httemplate/docs/selfservice.html b/httemplate/docs/selfservice.html index 6d17ead3f..370704fe8 100644 --- a/httemplate/docs/selfservice.html +++ b/httemplate/docs/selfservice.html @@ -14,6 +14,7 @@ machine, not the backend Freeside server. On the public machine, install:
        • 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)
        -- cgit v1.2.1 From 36939d45fbe729c953a81354030bedcb17fad91f Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 29 Mar 2005 22:41:10 +0000 Subject: better self-service debugging, don't point to install.html for suEXEC/setuid in self-service setup docs --- httemplate/docs/selfservice.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'httemplate/docs/selfservice.html') diff --git a/httemplate/docs/selfservice.html b/httemplate/docs/selfservice.html index 370704fe8..f78c2bff2 100644 --- a/httemplate/docs/selfservice.html +++ b/httemplate/docs/selfservice.html @@ -37,7 +37,7 @@ Then:
      • 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/selfservice_socket; chown freeside /usr/local/freeside/selfservice_socket; chmod 600 /usr/local/freeside/selfservice_socket -
      • Use suEXEC or setuid (see install.html for details) to run signup.cgi, selfservice.cgi, agent.cgi and passwd.cgi as the freeside user. +
      • 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 agentnum refnum
        on the Freeside machine for each external machine.
          -- cgit v1.2.1 From 6f76f84db8de0e02253dfd551ae254c48855d3f6 Mon Sep 17 00:00:00 2001 From: ivan Date: Wed, 30 Mar 2005 01:32:25 +0000 Subject: separate out referring customer info to optional section, add a note on setting the agentnum via templte --- httemplate/docs/selfservice.html | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) (limited to 'httemplate/docs/selfservice.html') diff --git a/httemplate/docs/selfservice.html b/httemplate/docs/selfservice.html index f78c2bff2..34c2f8316 100644 --- a/httemplate/docs/selfservice.html +++ b/httemplate/docs/selfservice.html @@ -33,13 +33,12 @@ Then:
        • regcode.html - Registration code pre-signup
        • stateselect.html - State selection pre-signup
        -
      • 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/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 agentnum refnum
        on the Freeside machine for each external machine. +
      • 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. @@ -49,6 +48,10 @@ Then:
        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. -- cgit v1.2.1 From 2980b268139ad6103eca9d1bf17408054235910c Mon Sep 17 00:00:00 2001 From: ivan Date: Sun, 10 Apr 2005 13:01:37 +0000 Subject: add apache snippet to self-service install docs --- httemplate/docs/selfservice.html | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'httemplate/docs/selfservice.html') diff --git a/httemplate/docs/selfservice.html b/httemplate/docs/selfservice.html index 34c2f8316..674b1fb6e 100644 --- a/httemplate/docs/selfservice.html +++ b/httemplate/docs/selfservice.html @@ -33,7 +33,12 @@ Then:
        • regcode.html - Registration code pre-signup
        • stateselect.html - State selection pre-signup
        -
      • Enable CGI execution for files with the `.cgi' extension. (with Apache) +
      • 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! -- cgit v1.2.1 From a8f346a5aeb4f32fa40cfd9c08bf2631ff79286b Mon Sep 17 00:00:00 2001 From: ivan Date: Mon, 8 Aug 2005 03:15:18 +0000 Subject: add some docs on signup_server-payby and -realtime configuration values --- httemplate/docs/selfservice.html | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'httemplate/docs/selfservice.html') diff --git a/httemplate/docs/selfservice.html b/httemplate/docs/selfservice.html index 674b1fb6e..9dc8f2a5e 100644 --- a/httemplate/docs/selfservice.html +++ b/httemplate/docs/selfservice.html @@ -21,7 +21,9 @@ machine, not the backend Freeside server. On the public machine, install: Then: