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