wiki:Help/RegistrationSetup

Setting Up the Registration Module

This will usually be handled by the installation process

This document will guide you with the installation of the built-in user registration module for ESTEST. The registration module source code and scripts is located in estest/www/registration.

Prerequisites

To use the built-in registration module the ESTEST administrator will need

  1. A personal GPG key to encrypt temporary user data, sections 2-3 of this web page describes how to obtain a GPG key and decrypt/encrypt data.
  2. Edit the configuration file myconfig.py, a sample configuration is given below
    registration={}
    registration["sysadmin_email"]="estest.dev@gmail.com"
    registration["use_gpg_pass"]=True
    registration["gpg_recipiant"]="estest.dev@gmail.com"
    registration["gpg_tmp_store_dir"]="/home/tmp/estest/registration/cache"
    registration["trac_htdigest_file"]="/home/estrac/passwd/trac.htpasswd"
    registration["trac_htdigest_realm"]="trac"
    
    registration["subprocess_env"]={"exist_bin_dir":"/home/opt/eXist/bin/"}
    registration["signature"]="Team ESTEST"
    

If you don't have a Trac setup, leave those variables as empty strings.

  1. A local SMTP server (if one isn't already installed), we use sendmail

Apache HTTPD Setup

Add two directories to your httpd configuration file

Alias /registration/public /path/to/estest/www/registration/public
<Directory "/path/to/estest/www/registration/public">
  Options -Indexes +ExecCGI
  AddHandler cgi-script .cgi
  AllowOverride None
  Order allow,deny
  Allow from all
</Directory>

Alias /registration/private /path/to/estest/www/registration/private
<Directory "/path/to/estest/www/registration/private">
  Options -Indexes +ExecCGI
  AddHandler cgi-script .cgi
  AllowOverride None
  Order allow,deny
  Allow from localhost
</Directory>

Notice the private directory containing the admin.cgi script should only be accessible to the server localhost. See User Management to see how this admin script is used. Restart the web server and check the configuration is working by filling out a dummy registration.

Trac Setup (optional)

We describe how to setup the Account Management Plugin for Trac 11. Visit the plugin homepage and install on the Trac server. Then make the following edits to the Trac configuration file trac.ini

[account-manager]
force_passwd_change = true
htdigest_realm = trac
password_file = /path/to/trac.htpasswd
password_store = HtDigestStore
persistent_sessions = false

[components]
trac.web.auth.loginmodule = disabled
acct_mgr.admin.accountmanageradminpage = enabled
acct_mgr.api.accountmanager = enabled
acct_mgr.htfile.htdigeststore = enabled
acct_mgr.pwhash.htdigesthashmethod = enabled
acct_mgr.web_ui.accountmodule = enabled
acct_mgr.web_ui.loginmodule = enabled

Create the htdigest password file if one doesn't already exist and initialize it with the current list of users. Use the absolute path to this file in the password_file configuration variable. Also disable any authentication used previously for Trac set in the httpd configuration file

Last modified 7 years ago Last modified on 11/22/10 14:39:05