Documentation and FAQs

A real documentation will be available soon. Promised :)

README.txt
Walgen reads nested directories with JPEG photos
and displays them as a photo gallery.

FEATURES:
- image-autoscaling
- hiding of images and complete folders from anonymous
  users
- TTW access to all management functions
- clean XHTML/CSS

TODO:
- autorotation
- display of EXIF info
- DOCUMENTATION!!!

INSTALLATION:
1) Prerequisites:
    Notice: all version infos are taken from the system
    WAlGen was developped on, so YMMV...
    - python >= 2.3.4
    - apache2 >= 2.0.52 (apache1.3 support will follow soon)
    - mod_python >= 3.1.3
    - PIL >= 1.1.4

2) Copy *.py along with the templates folder to a directory
   readable by your httpd, for example /usr/share/walgen.
   Remember this path as you will need it for your apache
   config later.

CONFIGURATION:
1) Check out example.conf, it's well commented...

example.conf
<VirtualHost *:80>
    ServerName    gallery.domain.tld
    ServerAdmin   john-doe@domain.tld

    ### General options
    SetHandler mod_python
    # this makes sure the path for cookies is always set right
    PythonOption "ApplicationPath" "/"
    # adjust the import path for mod_python
    # you can skip this line if walgen is already     
    # withing sys.path, e.g. in /usr/lib/pythonX.X/site-packages
    PythonPath "['/usr/share/walgen'] + sys.path"
    # enable debugging
    #PythonDebug On
    # declare walgen as mod_python handler
    PythonHandler WalgenHandler
    ### walgen options
    # path to directory which should act as the root 
    # of the gallery
    PythonOption "WalgenAlbumDir" "/var/www/gallery" 
    # path to cache directory where resized images
    # and metadata will be stored at, make sure it's
    # writeable by the user your http runs as
    PythonOption "WalgenCacheDir" "/var/tmp/walgen/my_gallery"
    # sizes walgen should scale images to, see WalgenImage.VARIANTS
    PythonOption "WalgenImageSizes" "thumb small normal large huge" 
    # the character set for the gallery: if you plan to add
    # titles and descriptions to your albums and images in 
    # some other charset then ASCII     
    PythonOption "WalgenEncoding" "UTF-8"
    # walgen allows to edit your metadata TTW, if you'd
    # like to use this feature, you have to supply a path 
    # to a htpasswd file (format username:crypt(password)).
    # You can create one using apache's htpasswd program.
    PythonOption "WalgenHtpasswdPath" "/var/www/gallery/.htpasswd" 
    # Define users which should be allowed to edit metadata.
    # Separate usernames with colons, since colons are not allowed in 
    # htpasswd-style usernames
    PythonOption "WalgenAdmins" "admin:god:root"

    # You can just as well embed a walgen gallery into an 
    # existing site structure by defining the settings
    # above within a <Location /some/path>.. or a <Directory /some/dir>... 
</VirtualHost>