1 Copyright 2000, International Business Machines Corporation and others.
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
8 Short instructions for sites upgrading from a previous version of AFS:
9 % ./configure --enable-transarc-paths
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
18 Otherwise, please read on.
20 Building OpenAFS on UNIX and LINUX
21 ----------------------------------
23 A. Creating the proper directory structure.
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.
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.
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, i386_fbsd_61
38 (client does not work)
39 i386_linux22, i386_linux24, i386_linux26
40 i386_umlinux22, i386_umlinux24
41 i386_obsd31, i386_obsd32, i386_obsd33, i386_obsd34, i386_obsd35,
42 i386_obsd36, i386_obsd37, i386_obsd38, i386_obsd39
44 sgi_65 (file server not tested)
45 sun4_413 (No client support, no fileserver support, db servers only)
46 sun4x_56, sun4x_57, sun4x_58, sun4x_59, sun4x_510,
47 sunx86_57, sunx86_58, sunx86_59, sunx86_510 (logging UFS not supported
48 for mixed-use partitions containing client cache)
50 ppc_linux22, ppc_linux24
51 alpha_linux22, alpha_linux24
52 ia64_linux24, ia64_linux26
53 sparc_linux22, sparc_linux24
54 sparc64_linux22, sparc64_linux24
55 hp_ux11i, hp_ux110 (See notes below for information on getting
57 hp_ux102 (Client port possible, but db servers and utilities work)
59 2. Using configure in the top level directory, configure for your
60 AFS system type, providing the necessary flags:
61 % ./configure --with-afs-sysname=sun4x_58 --enable-transarc-paths
63 If you do not have the "configure" script you can re-create it by
64 running regen.sh. You will need autoconf to do this.
66 For some systems you need also provide the path in which your kernel
67 headers for your configured kernel can be found. See the
68 system-specific Notes sections below for details.
70 There are two modes for directory path handling: "Transarc mode" and "default mode":
71 - In Transarc mode, we retain compatibility with Transarc/IBM AFS tools
72 by putting client configuaration files in /usr/vice/etc, and server
73 files in /usr/afs under the traditional directory layout.
74 - In default mode, files are located in standardized locations, usually
76 - Client programs, libraries, and related files always go in standard
77 directories under $(prefix). This rule covers things that would go
78 into $(bindir), $(includedir), $(libdir), $(mandir), and $(sbindir).
79 - Other files get located in the following places:
81 Directory Transarc Mode Default Mode
82 ============ ========================= ==============================
83 viceetcdir /usr/vice/etc $(sysconfdir)/openafs
84 afssrvdir /usr/afs/bin (servers) $(libexecdir)/openafs
85 afsconfdir /usr/afs/etc $(sysconfdir)/openafs/server
86 afslocaldir /usr/afs/local $(localstatedir)/openafs
87 afsdbdir /usr/afs/db $(localstatedir)/openafs/db
88 afslogdir /usr/afs/logs $(localstatedir)/openafs/logs
89 afsbosconfig $(afslocaldir)/BosConfig $(afsconfdir)/BosConfig
90 afsbosserver $(afsbindir)/bosserver $(sbindir)/bosserver
95 1. Now, you can build OpenAFS.
99 2. Install your build using either "make install" to install
100 into the current system (you will need to be root, and files
101 will be placed as appropriate for Transarc or standard paths),
102 "make install DESTDIR=/some/path" to install into an alternate
103 directory tree, or if you configured with --enable-transarc-paths
104 make dest to create a complete binary tree in the dest directory
105 under the directory named for the sys_name you built for,
106 e.g. sun4x_57/dest or i386_linux22/dest
108 2. As appropriate you can clean up or, if you're using Linux, build for
109 another kernel version.
115 If you have a problem building this source, you may want to visit
116 http://www.openafs.org/ to see if any problems have been reported
117 or to find out how to get more help.
119 Mailing lists have been set up to help; More details can be found
120 on the openafs.org site.
124 For Linux systems you need also provide the path in which your
125 kernel headers for your configured kernel can be found. This should
126 be the path of the directory containing a child directory named
127 "include". So if your version file was
128 /usr/src/linux/include/linux/version.h you would invoke:
129 % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux
131 Currently you can build for only one Linux kernel at a time,
132 and the version is extracted from the kernel headers in the root
135 To build for another Linux kernel version:
136 the system type defined in step A1.
137 % ./configure --with-afs-sysname=i386_linux24 --with-linux-kernel-headers=/usr/src/linux-2.2.19-i686
140 Your dest tree will now include an additional kernel module for your
141 additional kernel headers. Be aware that if the kernel version string
142 which UTS_RELEASE is defined to in include/linux/version.h matches the
143 last kernel you built for, the previous kernel module will be
148 HP-UX 11.0 requires a header called vfs_vm.h which HP has provided on their
149 web site: http://h21007.www2.hp.com/dspp/tech/tech_TechSoftwareDetailPage_IDX/1,1703,687,00.html
150 To navigate down from the top level of the portal, one would do
152 www.hp.com/dspp -> i want to... -> download software -> operating systems
154 to get to the same page.
158 We recommend you build with the following options to configure:
159 --enable-namei-fileserver
160 --enable-largefile-fileserver
163 If you need to run regen.sh to make the configure script, you should
164 first install autoconf-2.59, then setenv AUTOCONF_VERSION 2.59.
166 You need kernel source installed to build OpenAFS. Use the
167 --with-bsd-kernel-headers= configure option if your kernel source is not
170 If you want to build src/aklog, add the following options to your
171 configure. Note that you shouldn't need aklog because heimdal afslog
172 does (almost) the same thing.
173 --with-krb5 KRB5CFLAGS=-I/usr/include/kerberosV KRB5LIBS=-lcrypto
175 src/packaging/OpenBSD/buildpkg.sh will make a tar file for installing the
176 client. There is no server package, but I am told that "make install"
177 will put server binaries in /usr/afs.
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.
183 You can't run arla and OpenAFS at the same time.
187 The FreeBSD client does not currently work. The remaining problems
188 mostly have to do with locking, vnode refcounting, and packaging. The
191 We recommend you build with --enable-namei-fileserver and
192 --enable-largefile-fileserver options.
194 You need kernel source installed to build OpenAFS. Use the
195 --with-bsd-kernel-headers= configure option if your kernel source is not
198 You also need access to your kernel build directory for the opt_global.h
199 include file. Use the --with-bsd-kernel-build= configure option if your
200 kernel build is not GENERIC in the standard place.
202 There is a package builder in src/packaging/OpenBSD. "sh buildpkg.sh"
203 should make a package for the client. Use pkg_add to install. The
204 package will install using transarc-paths, regardless of how you
205 configured. The builder uses an old version of the /usr/vice/etc/rc file
206 that probably won't work. You might be able to replace it with something
207 like "kldload libafs.ko; /usr/vice/etc/afsd".
209 There is no server package, but I am told that "make install" will put
210 server binaries in /usr/afs.