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