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