web/README

   1 /* ========================================================================
   2  * Copyright 2006-2007 University of Washington
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * ========================================================================
  11  */
  12
  13
  14 WEB ALPINE
  15 ----------
  16
  17 Web Alpine is the web-based component of the Alpine Mail System.  It
  18 rests on the same distributed email technology behind Alpine, but is
  19 accessible from almost any browser on the World Wide Web.
  20
  21 Web Alpine uses TCL to provide the programmatic interface between
  22 the Alpine-provided message store and the cgi-served web pages.
  23
  24
  25 REQUIRED SOFTWARE
  26 -----------------
  27
  28   Base system:
  29         C compiler
  30         Tcl scripting package and development tools
  31         OpenSSL
  32         Apache web server (though, presumably any CGI supporting
  33                            web server should work)
  34
  35   Optional:
  36         ispell application
  37           Used to support composer spell check functinoality.
  38           Featured not offered if ispell not present.
  39
  40         openLDAP
  41           Provides LDAP query services to support login
  42           personalization and user-session LDAP query support.
  43
  44         UW Pubcookie
  45           Provides central web-login management.  Note, additional
  46           configuration and installation steps are required.  See
  47           src/pubcookie/INSTALL for specific instructions.
  48
  49         Kerberos 5
  50           Required by UW-Pubcookie to provide authentication and
  51           proxy authorization for IMAP server access.  Proxy
  52           authentication only tested under UW imapd.
  53
  54
  55
  56 BUILING AND INSTALLING WEB ALPINE
  57 ---------------------------------
  58
  59 See the INSTALL file for basic instructions.
  60
  61
  62 DOCUMENTATION
  63 -------------
  64
  65 User documentation is contained within the application and is
  66 reasonably complete.  Technical documentation is extremely rough and
  67 likely unsatisfying.  It's probably worth reading, but ultimately
  68 configuration or other questions are best answered by reviewing the
  69 source (which itself, while working reasonably, is somewhat spotilly
  70 documented as well).
  71
  72
  73 SUPPORT AND FEEDBACK
  74 --------------------
  75
  76 Send comments and questions to <chappa@gmx.com>