1$Id: INSTALL,v 1.15 2004/11/15 00:26:30 hbo Exp $
2
3Installation Instructions for ${DIST}
4
5See the file SUDOCONFIG for directions on configuring sudo for use with sudoscript.
6
7Currently supported OSen are:
8
9	Fedora Core Tested on FC3
10	Red Hat Linux Tested on RHEL3 and RH 7.3
11	Solaris Tested on 9, Intel
12	FreeBSD Tested on 5.3,Intel
13
14If your OS isn't on the list and you'd like it to be, see the
15file PORTING in the distribution.
16
17For all architectures, the sudoshell script will offer to
18start sudoscriptd if it isn't running. To arrange for the
19daemon to be automatically started at system bootup, additional
20work needs to be done which differs by OS. These steps are included
21in the following sections, per OS.
22
23
24Tarball Installation on All Supported Architectures
25===================================================
26
27The source tarball should install on any of the OS architectures
28listed above. Instructions to do this follow. There are "binary"
29packages for all of the supported OS platforms except HP-UX.
30Installation instructions for those packages follows this section.
31
32As shipped, the archive contains prebuilt mans and html docs. The
33Makefile therefore does nothing with 'gmake' or 'gmake doc'.
34To run those targets, do a 'gmake clean' before running them.
35You will need perltidy to run the 'gmake doc' It is available at
36
37	http://prdownloads.sourceforge.net/perltidy/
38
39In the following instructions, I give commands that are the least
40common denominator between all the supported OS. For example, I use
41'gmake' for GNU Make. That's the native make on Linux, but 'gmake'
42works there too. The other OS all can use gmake one way or another,
43but it might not be installed by default. Also, I use the
44"gunzip -c <tarball> | tar xf -" method to unpack the archives. Platforms
45that se GNU tar by default (*BSD, Linux) can use the "tar xzf <tarball>"
46method instead.
47
48Without further ado, here are the instructions:
49
50	1. Unpack the distribution:
51
52	    gunzip -c ${TARBALL} | tar xf -
53	    cd ${DIST}
54
55	2. (Optional) run the 'doc' target to rebuild the mans
56	   and HTML (requires pod2[html|man] and perltidy):
57
58	    gmake doc
59
60	3. Install the package
61
62	    sudo gmake install
63
64
65	4.  Arrange for the daemon to be started and stopped
66	    at system startup and shutdown respectively. This
67	    varies per OS. Refer to the following sections for
68	    per OS.
69
70
71
72
73RPM Install on Red Hat Linux (tested on RHEL3 and 7.3)
74and Fedora (Tested on FC3)
75========================================================
76
77There is a Red Hat RPM at http://www.egbok.com/sudoscript/download.html
78If you are running on Red Hat you just need to grab that
79and do the following:
80
81	sudo rpm -i ${RPM}
82
83or
84
85	sudo rpm -U ${RPM}
86
87If you are upgrading from an earlier version. (Be sure to read RELEASENOTES.)
88
89After this finishes, you can run 'ss'. The script will offer to start
90the daemon for you. If you say yes, it will start the daemon, but warn
91you that you need to arrange for it to start itself at boot
92time. Here's how to do that.
93
94	sudo chkconfig sudoscriptd on
95
96If you prefer to start the daemon yourself rather than letting
97sudoshell do it, after you have done the previous command you can
98issue:
99
100	sudo service sudoscriptd start
101
102You can also do any of
103
104	sudo service sudoscriptd stop
105	sudo service sudoscriptd restart
106	sudo service sudoscriptd status
107
108Solaris (Tested on Solaris 9, Intel)
109====================================
110
111There is a Solaris package, tested on Solaris 9, Intel.
112at http://www.egbok.com/sudoscript/download.html
113Once you have the package, do the following as root:
114
115	gunzip -f ${SOLPKG}.gz
116	/usr/sbin/pkgadd -d ${SOLPKG} EGsdosc
117
118If you have an earlier version of sudoscript installed, you may have
119to do
120
121	/usr/sbin/pkgrm RGsdosc
122
123before installing the new package.
124
125Next you should arrange for the daemon to be started and stopped
126by init (runlevels and numbers are examples, but they should work fine.)
127
128	sudo ln -s /etc/init.d/sudoscriptd /etc/rc2.d/S97sudoscriptd
129	sudo ln -s /etc/init.d/sudoscriptd /etc/rc0.d/K04sudoscriptd
130
131Finally, you can start the daemon:
132
133	either
134	    sudo sh /etc/init.d/sudoscriptd start
135	or if you have root access through sudoshell
136	    ss
137
138HP-UX (Earlier version Tested on 11.0 by Donny Jekels
139and 11i by Kim Westerlund)
140======================================================
141
142There is no binary package for HP-UX yet. Follow the tarball
143installation instructions above, then arrange for the daemon to
144be started and stopped by init (runlevels and numbers are examples,
145but should work fine.)
146
147	sudo ln -s /sbin/init.d/sudoscriptd /sbin/rc2.d/S97sudoscriptd
148	sudo ln -s /sbin/init.d/sudoscriptd /sbin/rc0.d/K04sudoscriptd
149
150Finally, start the daemon:
151
152	either
153	    sudo sh /sbin/init.d/sudoscriptd start
154	or, if you have root access through sudoshell
155	    ss
156
157
158FreeBSD (Tested on FreeBSD 5.3)
159===============================
160
161There is a binary package and a source port at
162http://www.egbok.com/sudoscript/download.html
163Once you have the package, do the following as root:
164
165	/usr/sbin/pkg_add ${FBSDPKG}
166
167If you have an earlier version of sudoscript installed,
168you will need to do:
169
170	/usr/sbin/pkg_delete sudoscript\*
171
172before you do the pkg_add.
173
174Next, arrange for the daemon to be started at boot time
175
176
177	sudo cp /usr/local/etc/rc.d/sudoscriptd.sh.sample \
178		/usr/local/etc/rc.d/sudoscriptd.sh
179
180Finally, start the daemon:
181
182	either
183	    sudo sh /usr/local/etc/rc.d/sudoscriptd.sh
184	or
185	    ss
186
187
188