View of /trunk/cgi/README

PySignup - a simple signup sheet program written in Python
==========================================================

REQUIREMENTS
============

* Web server - Apache is recommended, but just about any web server should
  theoretically work
* Python - Python 2.3 or later
* CGI

INSTALL
=======

Installation is designed to be as simple as possible, the hardest part
will probably be configuring your webserver. You need to have a 
CGI-enabled directory that contains the PySignup files, many Web Servers
come with such a directory already set up (look for a directory named "cgi-bin" 
or something similar). CGI should be disabled for at least files with a .css
or .js extension, otherwise CSS/JavaScript will not work. You can test to see
if your directory is properly set up for running CGI scripts by opening 
index.py in a web browser. If "No settings file detected! Go to change.py to
create a settings file" is shown, then your directory is properly setup, 
otherwise, something is probably wrong.

Once your directory is properly enabled to use CGI, just open change.py
in your web browser, it will ask for a password: the default password is 
"pysignup", MAKE SURE TO CHANGE THIS using the link at the top. Once you've 
logged in, modify the different fields as you'd like (it will describe each
setting and what you should put), and then click the change button. Note that
most of the settings are probably fine left as is, but you will want to change
the location, nextevent, and sitename settings.

Finally, you should restrict web access to data.py, sessions.py, sqlite.db, 
settings.conf, and the backups directory for security reasons. If using 
Apache, just set createhtaccess to true using change.py.

CONFIGURATION
=============

So you have PySignup installed and working ok, but now you'd like to customize
it some. Well, there are several ways to do this: the best thing to do is just
go through the change.py web interface, and read through each setting. The
settings there provide numerous ways for customization. 

In particular, the "theme" setting in the "required" section can be set to any
of the included themes: blue, black, grey, and grass. Each of these will 
significantly change the colors of your PySignup site.

By putting something in the "message" setting, you can display a custom 
message to all users.

If you would like to use your own custom Cascading Style Sheets or JavaScript
with PySignup, create a file named user.css/user.js in the skins directory.

LICENSE NOTES
=============

All files are licensed under the GNU GPL version 3 or higher unless otherwise
marked. recaptcha.py is a 3rd party module and is licensed under the
MIT/X11 license, and configobj.py is also a 3rd party module which is
licensed under the terms of the BSD license.