DEVEL15-cvsignore-happiness-20060801
[openafs.git] / README
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 Short instructions for sites upgrading from a previous version of AFS:
9 % ./configure --enable-transarc-paths
10 % make
11 % make dest
12
13 will create a Transarc-style dest tree in ${SYS_NAME}/dest where
14 ${SYS_NAME} is the AFS sysname of the system you built for.
15 This assumes if you're building for Linux that your kernel source is
16 in /usr/src/linux.
17
18 Otherwise, please read on.
19
20 Building OpenAFS on UNIX and LINUX
21 ----------------------------------
22
23 A. Creating the proper directory structure.
24
25    Uncompress the source into a directory of your choice. A directory
26    in afs space is also valid. In the directory that you uncompressed the
27    source in, you will only have an src/ directory.
28
29    1. Pick a system to build for, and note its default AFS sys_name.
30       A directory will be automatically created for binaries to be written 
31       into with this name when you build.
32
33       alpha_dux40
34       alpha_dux50 (only tested on 5.0A, does not work with 5.1)
35       i386_fbsd_42, i386_fbsd_43, i386_fbsd_44, i386_fbsd_45,
36          i386_fbsd_46, i386_fbsd_47, i386_fbsd_50, i386_fbsd_51,
37          i386_fbsd_52, i386_fbsd_53, i386_fbsd_60
38       i386_linux22, i386_linux24, i386_linux26
39       i386_umlinux22, i386_umlinux24
40       i386_obsd31, i386_obsd32, i386_obsd33, i386_obsd34, i386_obsd35,
41          i386_obsd36, i386_obsd37, i386_obsd38
42       rs_aix42
43       sgi_65 (file server not tested)
44       sun4_413 (No client support, no fileserver support, db servers only)
45       sun4x_56, sun4x_57, sun4x_58, sun4x_59 (logging UFS not supported 
46          for mixed-use partitions containing client cache)
47       ppc_darwin_70
48       ppc_linux22, ppc_linux24
49       alpha_linux22, alpha_linux24 
50       ia64_linux24, ia64_linux26
51       sparc_linux22, sparc_linux24
52       sparc64_linux22, sparc64_linux24
53       hp_ux110 (See notes below for information on getting missing header)
54       hp_ux102 (Client port possible, but db servers and utilities work)
55
56    2. Using configure in the top level directory, configure for your
57       AFS system type, providing the necessary flags:
58       % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
59
60       If you do not have the "configure" script you can re-create it by
61       running regen.sh.  You will need autoconf to do this.
62
63       For some systems you need also provide the path in which your kernel
64       headers for your configured kernel can be found.  See the
65       system-specific Notes sections below for details.
66
67       Be prepared to provide the switches --enable-obsolete and
68       --enable-insecure if you require the use of any bundled but obsolete
69       or insecure software included with OpenAFS. See README.OBSOLETE and
70       README.SECURITY for more details.
71
72   There are two modes for directory path handling: "Transarc mode" and "default mode":
73   - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
74     by putting client configuaration files in /usr/vice/etc, and server
75     files in /usr/afs under the traditional directory layout.
76   - In default mode, files are located in standardized locations, usually
77     under $(prefix).
78   - Client programs, libraries, and related files always go in standard
79     directories under $(prefix).  This rule covers things that would go
80     into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
81   - Other files get located in the following places:
82
83     Directory     Transarc Mode              Default Mode
84     ============  =========================  ==============================
85     viceetcdir    /usr/vice/etc              $(sysconfdir)/openafs
86     afssrvdir     /usr/afs/bin (servers)     $(libexecdir)/openafs
87     afsconfdir    /usr/afs/etc               $(sysconfdir)/openafs/server
88     afslocaldir   /usr/afs/local             $(localstatedir)/openafs
89     afsdbdir      /usr/afs/db                $(localstatedir)/openafs/db
90     afslogdir     /usr/afs/logs              $(localstatedir)/openafs/logs
91     afsbosconfig  $(afslocaldir)/BosConfig   $(afsconfdir)/BosConfig
92     afsbosserver  $(afsbindir)/bosserver     $(sbindir)/bosserver
93
94
95 B  Building
96
97    1. Now, you can build OpenAFS. 
98
99       % make
100
101    2. Install your build using either "make install" to install 
102       into the current system (you will need to be root, and files
103       will be placed as appropriate for Transarc or standard paths),
104       "make install DESTDIR=/some/path" to install into an alternate 
105       directory tree, or if you configured with --enable-transarc-paths
106       make dest to create a complete binary tree in the dest directory      
107       under the directory named for the sys_name you built for,
108       e.g. sun4x_57/dest or i386_linux22/dest 
109
110    2. As appropriate you can clean up or, if you're using Linux, build for
111       another kernel version.
112       To clean up:
113          % make clean
114
115 C  Problems
116
117    If you have a problem building this source, you may want to visit
118    http://www.openafs.org/ to see if any problems have been reported 
119    or to find out how to get more help.
120
121    Mailing lists have been set up to help; More details can be found
122    on the openafs.org site.
123
124 D  Linux Notes
125
126    For Linux systems you need also provide the path in which your
127    kernel headers for your configured kernel can be found. This should
128    be the path of the directory containing a child directory named
129    "include". So if your version file was 
130    /usr/src/linux/include/linux/version.h you would invoke:
131    % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux
132
133    Currently you can build for only one Linux kernel at a time,
134    and the version is extracted from the kernel headers in the root
135    you specify.
136
137    To build for another Linux kernel version:
138    the system type defined in step A1.
139       % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
140       % make 
141
142    Your dest tree will now include an additional kernel module for your
143    additional kernel headers. Be aware that if the kernel version string
144    which UTS_RELEASE is defined to in include/linux/version.h matches the
145    last kernel you built for, the previous kernel module will be
146    overwritten.
147
148 E  HP-UX 11.0 Notes
149
150    HP-UX 11.0 requires a header called vfs_vm.h which HP has provided on their
151    web site: http://h21007.www2.hp.com/dspp/tech/tech_TechSoftwareDetailPage_IDX/1,1703,687,00.html
152    To navigate down from the top level of the portal, one would do
153
154         www.hp.com/dspp -> i want to... -> download software -> operating systems
155
156    to get to the same page. 
157
158 F  OpenBSD Notes
159
160    We recommend you build with the following options to configure:
161      --enable-namei-fileserver
162      --enable-largefile-fileserver
163      --enable-supergroups
164      --with-krb5
165
166    You need kernel source installed to build OpenAFS.  Use the
167    --with-bsd-kernel-headers= configure option if your kernel source is not
168    in /usr/src/sys.
169
170    There is a package builder in src/packaging/OpenBSD.  "sh buildpkg.sh"
171    should make a package for the client.  Use pkg_add to install.  The
172    package will install using transarc-paths, regardless of how you
173    configured.  The package builder does not work on OpenBSD 3.5 and later
174    due to the incompatible re-write of pkg_create.
175
176    There is no server package, but I am told that "make install" will put
177    server binaries in /usr/afs.
178
179    Your kernel may panic when you try to shutdown after running the OpenAFS
180    client.  To prevent this, change the "dangling vnode" panic in
181    sys/kern/vfs_syscalls.c to a printf and build a new kernel.
182
183    You can't run arla and OpenAFS at the same time.
184
185 G  FreeBSD Notes
186
187    The FreeBSD client is very new and untested.  Do not trust it for
188    production work.
189
190    We recommend you build with --enable-namei-fileserver and
191    --enable-largefile-fileserver options.
192
193    You need kernel source installed to build OpenAFS.  Use the
194    --with-bsd-kernel-headers= configure option if your kernel source is not
195    in /usr/src/sys.
196
197    You also need access to your kernel build directory for the opt_global.h
198    include file.  Use the --with-bsd-kernel-build= configure option if your
199    kernel build is not GENERIC in the standard place.
200
201    There is a package builder in src/packaging/OpenBSD.  "sh buildpkg.sh"
202    should make a package for the client.  Use pkg_add to install.  The
203    package will install using transarc-paths, regardless of how you
204    configured.  The builder uses an old version of the /usr/vice/etc/rc file
205    that probably won't work.  You might be able to replace it with something
206    like "kldload libafs.ko; /usr/vice/etc/afsd".
207
208    There is no server package, but I am told that "make install" will put
209    server binaries in /usr/afs.