another minor tweak to test git/ikiwiki integration
[openafs-wiki.git] / InstallOpenAFSClient.mdwn
1 ## <a name="How to Install the _OpenAFS Clie"></a> How to Install the [[OpenAFS]] Client
2
3 This documentation provides instructions for installing the [[OpenAFS]] client only. Documentation for installing a server belongs elsewhere.
4
5 This document is intended for users who are familiar enough with administrating their operating system of choice to not need hand holding, but unfamiliar enough with [[OpenAFS]] to need basic setup instructions.
6
7 ### <a name="Operation System specific instru"></a> Operation System specific instructions
8
9 #### <a name="Linux, Redhat 8"></a> Linux, Redhat 8
10
11 These are the steps I used to get [[OpenAFS]] working on a fairly standard Redhat 8 machine. These steps will also work for the other Redhat and Fedora releases since Redhat 8.
12
13 ##### <a name="Download RPMS"></a> Download RPMS
14
15 Download the most current versions of these RPMS from www.openafs.org:
16
17 - openafs (Utilities, Init scripts, and documentation)
18 - openafs-client (AFS daemon, PAM modules, client configuration files)
19 - openafs-kernel (AFS kernel module, for Redhat's kernel 2.4.18-14
20 - openafs-krb5 (Utilities for using Kerberos 5 tickets to get AFS tokens)
21
22 You may also want:
23
24 - openafs-compat (Populate /usr/afsws with symlinks for legacy applications/users)
25 - openafs-devel (AFS libraries and include files, for building AFS aware applications)
26 - openafs-kpasswd (Compatibility package for use with a KA server)
27 - openafs-kernel-source (AFS kernel module source, necessary if you aren't using Redhat's kernel)
28
29 You almost certainly don't want:
30
31 - openafs-server (AFS Server binaries)
32
33 If you don't already have Redhat's kerberos 5 RPMS installed, you may wish to download those as well. But they aren't strictly necessary, and only the openafs-krb5 package depends on them.
34
35 ##### <a name="Install RPMS"></a> Install RPMS
36
37 Install those RPMS. If you don't know how to do this, then this document isn't intended for you.
38
39 ##### <a name="Configure AFS"></a> Configure AFS
40
41 Follow the instructions that were output during the RPM install. In particular, edit /usr/vice/etc/ThisCell.
42
43 If you you will need to [[KerberosV]] on your system. If you have not done so, do so now. Instructions for doing that are outside of the scope of this document.
44
45 ##### <a name="Start AFS"></a> Start AFS
46
47 Start the AFS client, by running '/etc/rc.d/init.d/afs start'
48
49 Verify that /afs/&lt;your-cell-here&gt; is readable.
50
51 Get AFS tokens with klog, or translate existing kerberos tickets with aklog, and verify that you can modify files in AFS.
52
53 Once you've verified that AFS works correctly, you may want to configure AFS to start automatically, via whatever mechanism you prefer.
54
55 -- David Nolan - 29 Jul 2003
56
57 #### <a name="Raspberri Pi">Raspberry Pi</a>
58
59 You will need at least a 4GB card to download all the necessary software and linux kernel
60
61 Much of this is taken from <http://www.raspberrypi.org/phpBB3/viewtopic.php?f=71&t=17666>
62
63 A wiki that is kept more up to date at <https://samvinna.ru.is/projects/projects/devnet-documentation/wiki/AFS_Client_Installation>
64
65 Other guides:
66 rpi-update at <https://github.com/Hexxeh/rpi-update/>
67
68 To get started:
69 Install the latest dist and necessary tools
70
71     sudo bash
72     apt-get update
73     apt-get -y dist-upgrade
74     apt-get -y install gcc make git build-essential dkms
75
76 Install rpi-update and grab the latest firmware
77
78     cd rpi-update
79     apt-get install ca-certificates
80     sudo wget http://goo.gl/1BOfJ -O /usr/bin/rpi-update && sudo chmod +x /usr/bin/rpi-update
81
82 Grab latest kernel
83
84     cd /usr/src
85     wget  https://github.com/raspberrypi/linux/tarball/rpi-3.2.27 -O rpi-3.2.27.tgz
86     tar xzf rpi-3.2.27.tgz
87
88 Grab the configs from the kernel
89
90     cd raspberrypi-linux-*
91     zcat /proc/config.gz > .config
92     make oldconfig
93     make modules_prepare
94
95 Get the module symbol version 
96
97     wget https://github.com/raspberrypi/firmware/raw/master/extra/Module.symvers
98 Make symlinks for the build system
99
100     KSRC=`pwd`
101     pushd /lib/modules/`uname -r`
102     ln -s ${KSRC} source
103     ln -s ${KSRC} build
104     popd
105     pushd /usr/src
106     ln -s ${KSRC} linux-`uname -r`
107     ln -s ${KSRC} linux
108     popd
109
110 Install kerberos packages
111
112     apt-get install krb5-auth-dialog krb5-user krb5-clients libpam-ccreds libpam-krb5
113
114 Install the afs client and related modules
115
116     apt-get install  openafs-modules-dkms openafs-{client,krb5}
117
118 if it doesn't go successfuly, you can re-run it with:
119
120     dpkg-reconfigure openafs-modules-dkms
121
122 -- Joe Foley 22 Feb 2013 (Created from RU website)
123
124 #### <a name="Mac OS X 10.3"></a> Mac OS X 10.3
125
126 Some good guides into getting [[OpenAFS]] installed on Mac OS X 10.3 can be found at :
127
128 <http://www.ibiblio.org/macsupport/afs.html>
129
130 [http://www.ibiblio.org/macsupport/kerberos/kerberos10\_2.html](http://www.ibiblio.org/macsupport/kerberos/kerberos10_2.html)
131
132 -- Clark Hale - 20 Jan 2005 Removed Crap, and dead link.