src/afsweb/README.BETA1

   1 Installation instructions for Apache AFS Web Secure
   2 (Version 1 for Apache version 1.2.6)
   3
   4 Prerequisites:-
   5
   6 Ensure the following files exist:-
   7
   8  - weblog
   9  - weblog_starter
  10  - libapacheafs.a
  11  - mod_afs.c
  12
  13 In addition to these you should know the location of the AFS library
  14         libsys.a
  15
  16
  17 The mod_afs.c file should be in the apache src directory with all the other
  18 module files. weblog and weblog_starter should be in the same directory - this
  19 could be any directory (preferably outside AFS - if it is in AFS then
  20 system:anyuser should have the appropriate ACL on that directiry).
  21
  22 Editing the following files in the apache src and conf directories:-
  23
  24 1. Configuration (or the current Configuration file)
  25
  26         EXTRA_LIBS= <whatever you had here before> libapacheafs.a libsys.a
  27
  28 NOTE - specify the full path of these libraries - libsys.a is probably
  29 in /usr/afsws/lib/afs/libsys.a and you can put libapacheafs.a wherever you
  30 want.
  31
  32 At the end of the configuration file where the modules are add
  33
  34         Module afs_module           mod_afs.o
  35
  36 Optional: if you want the server to attempt to stop completely if AFS
  37 initialization fails then add -DSHUTDOWN_IF_AFS_FAILS to the EXTRA_CFLAGS line.
  38 Otherwise, on startup if the initialization procedure fails, the apache
  39 server will continue running but AFS authentication will always fail.
  40
  41 2. httpd.conf (or whatever configuration file the server uses on startup
  42    with the -f flag)
  43
  44 NOTE: ensure that you provide the entire path for the ErrorLog and PidFile
  45 Directives instead of attempting to have apache prepend ServerRoot.
  46
  47 See below for an explanation of arguments to these
  48 Apache Directives.
  49
  50 SetAFSDefaultCell     [cell]
  51 SetAFSMountpointDir   [dir]
  52 SetAFSCacheExpiration [time]
  53 SetAFSTokenExpiration [time]
  54 SetAFSWeblogPath      [path]
  55 SetAFSLocation        [loc]
  56
  57 <Location <loc>>
  58 SetHandler afs-Authentication
  59 </Location>
  60
  61 <Directory full path to [dir]>
  62 AllowOverride None
  63 </Directory>
  64
  65 NOTE:- SetAFSLocation <text> should be the same as the Location <text>
  66 and should be a path relative to the server-document-root
  67
  68 NOTE: loc and dir should *NOT* be the same. There should be no symbolic link,
  69 file or directory in the DocumentRoot directory with the same name as the loc
  70 directive.
  71
  72 cell: REQUIRED directive.
  73       Default AFS cell name. This cell will be used unless the user
  74       specifies a different cell by using the user@cellname syntax
  75       when prompted for a username and password. REQUIRED OPTION.
  76
  77 dir:  REQUIRED directive.
  78       Path to the directory or symbolic link relative to the server document
  79       root directory where the AFS cell mount points are. If you want symbolic
  80       links to be followed make sure you have the
  81         Options FollowSymLinks
  82       directive set.
  83
  84 time: OPTIONAL directive
  85       Seconds for AFS token cache expiration (cacheExpiration is for the local
  86       cache and tokenExpiration is for the AFS kernel cache manager).
  87
  88
  89 path: REQUIRED directive.
  90       The full or relative (to server binary) path for weblog binary.
  91
  92 loc:  REQUIRED directive.
  93       Some location relative to the server root
  94       MAKE SURE THAT THERE DOESN"T ALREADY EXIST A DIRECTORY BY
  95       THIS SAME NAME. This should be the same (case sensitive)
  96       as the argument to the Location directive. Eg. /afs
  97
  98
  99 Configure and make apache and start it up with the new config file.
 100
 101 NOTE: Add the following to the shutdown or stopd file to shutdown the
 102       weblog_starter process BEFORE the kill -TERM for httpd.pid
 103
 104         kill -TERM `cat <path to httpd.pid>.afs`
 105
 106 Eg. if the httpd.pid file is in /local/stronghold/apache/logs/httpd.pid
 107 then the stopd file should look something like this
 108
 109         kill -TERM `cat /local/stronghold/apache/logs/httpd.pid.afs`
 110
 111         kill -TERM `cat /local/stronghold/apache/logs/httpd.pid`
 112
 113
 114 POINTERS TO APACHE AND SSL:-
 115
 116 1. Apache Home Page http://www.apache.org
 117 2. Stronghold Home: http://www.c2.net International: http://www.int.c2.net
 118 3. Apache-SSL Home: http://www.apache-ssl.org
 119 4. SSLeay FAQ http://www.psy.uq.edu.au:8080/~ftp/Crypto/
 120