Fix links in ansible-openafs page
[openafs-wiki.git] / admin / 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 You will need to install [[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 aklog, 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 Other guides:
64 rpi-update at <https://github.com/Hexxeh/rpi-update/>
65
66 To get started:
67 Install the latest dist and necessary tools
68
69     sudo bash
70     apt-get update
71     apt-get -y dist-upgrade
72     apt-get -y install gcc make git build-essential dkms
73
74 Install rpi-update and grab the latest firmware
75
76     cd rpi-update
77     apt-get install ca-certificates
78     sudo wget http://goo.gl/1BOfJ -O /usr/bin/rpi-update && sudo chmod +x /usr/bin/rpi-update
79
80 Grab latest kernel
81
82     cd /usr/src
83     wget  https://github.com/raspberrypi/linux/tarball/rpi-3.2.27 -O rpi-3.2.27.tgz
84     tar xzf rpi-3.2.27.tgz
85
86 Grab the configs from the kernel
87
88     cd raspberrypi-linux-*
89     zcat /proc/config.gz > .config
90     make oldconfig
91     make modules_prepare
92
93 Get the module symbol version 
94
95     wget https://github.com/raspberrypi/firmware/raw/master/extra/Module.symvers
96 Make symlinks for the build system
97
98     KSRC=`pwd`
99     pushd /lib/modules/`uname -r`
100     ln -s ${KSRC} source
101     ln -s ${KSRC} build
102     popd
103     pushd /usr/src
104     ln -s ${KSRC} linux-`uname -r`
105     ln -s ${KSRC} linux
106     popd
107
108 Install kerberos packages
109
110     apt-get install krb5-auth-dialog krb5-user krb5-clients libpam-ccreds libpam-krb5
111
112 Install the afs client and related modules
113
114     apt-get install  openafs-modules-dkms openafs-{client,krb5}
115
116 if it doesn't go successfuly, you can re-run it with:
117
118     dpkg-reconfigure openafs-modules-dkms
119
120 -- Joe Foley 22 Feb 2013 (Created from RU website)
121
122 #### <a name="Mac OS X 10.3"></a> Mac OS X 10.3
123
124 Some good guides into getting [[OpenAFS]] installed on Mac OS X 10.3 can be found at :
125
126 <http://www.ibiblio.org/macsupport/afs.html>
127
128 [http://www.ibiblio.org/macsupport/kerberos/kerberos10\_2.html](http://www.ibiblio.org/macsupport/kerberos/kerberos10_2.html)
129
130 -- Clark Hale - 20 Jan 2005 Removed Crap, and dead link.
131 -- Caitlyn Marko - 24 Aug 2017 Removed broken link.