3266526ac7b608e5a843f57bf3eb0a439316b7d3
[buildd-tools/sbuild.git] / man / sbuild-setup.7.in
1 .\" t
2 .\"
3 .\" Copyright © 2005-2008  Roger Leigh <rleigh@debian.org>
4 .\"
5 .\" This program is free software: you can redistribute it and/or modify
6 .\" it under the terms of the GNU General Public License as published by
7 .\" the Free Software Foundation, either version 2 of the License, or
8 .\" (at your option) any later version.
9 .\"
10 .\" This program is distributed in the hope that it will be useful, but
11 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13 .\" General Public License for more details.
14 .\"
15 .\" You should have received a copy of the GNU General Public License
16 .\" along with this program.  If not, see
17 .\" <http://www.gnu.org/licenses/>.
18 .so defs.man
19 .TH SBUILD-SETUP 7 "\*[RELEASE_DATE]" "Version \*[VERSION]" "Debian sbuild"
20 .SH NAME
21 sbuild-setup \- sbuild setup procedure
22 .SH DESCRIPTION
23 \fBsbuild\fP uses chroots to build packages within, to provide a minimal and
24 consistent build environment.  This man page describes the procedure to create
25 a chroot by hand using debootstrap.  These are only guidelines; depending upon
26 the setup required, several of the steps may be omitted entirely.
27 .SH QUICK START
28 Simply running
29 .B sbuild-createchroot
30 will perform all the setup steps described in detail below.  See the section
31 \[lq]\fIsbuild-createchroot\fP\[rq] below, as well as
32 .BR sbuild\-createchroot (1).
33 .SH CHROOT SETUP
34 This guide sets up a lenny chroot on a powerpc machine.  Adjust the
35 names for other suites and architectures.
36 .SS 1. Run debootstrap to create the chroot
37 \f[CR]# \f[CB]mkdir \-p /srv/chroot/lenny\fP\fP
38 .br
39 .PP
40 The author has each chroot as a separate LVM logical volume (LV).  Create and
41 mount an LV here if required:
42 .PP
43 \f[CR]# \f[CB]lvcreate \-L 4G \-n lenny_chroot \-Z y volume-group\fP\fP
44 .br
45 .PP
46 Add to /etc/fstab and mount (see next section for full fstab example).
47 Finally, run debootstrap to create the chroot:
48 .PP
49 \f[CR]# \f[CB]debootstrap \-\-variant=buildd lenny /srv/chroot/lenny http://ftp.uk.debian.org/debian/\fP\fP
50 .br
51 .SS 2. Set up additional mounts
52 An example \fI/etc/fstab\fP:
53 .PP
54 .TS
55 lfCR s s s s s.
56 /dev/volume-group/lenny_chroot \[rs]
57 .T&
58 lfCR lfCR lfCR lfCR lfCR lfCR.
59         /srv/chroot/lenny       ext3    defaults        0       2
60 /dev/pts        /srv/chroot/lenny/dev/pts       none    rw,bind 0       0
61 tmpfs   /srv/chroot/lenny/dev/shm       tmpfs   defaults        0       0
62 proc    /srv/chroot/lenny/proc  proc    defaults        0       0
63 .T&
64 lfCR s s s s s.
65 /dev/volume-group/home \[rs]
66 .T&
67 lfCR lfCR lfCR lfCR lfCR lfCR.
68         /srv/chroot/lenny/home  ext3    quota   0       0
69 /tmp    /srv/chroot/lenny/tmp   none    rw,bind 0       0
70 /etc/passwd     /srv/chroot/lenny/etc/passwd    none    ro,bind 0       0
71 /etc/shadow     /srv/chroot/lenny/etc/shadow    none    ro,bind 0       0
72 /etc/group      /srv/chroot/lenny/etc/group     none    ro,bind 0       0
73 /etc/gshadow    /srv/chroot/lenny/etc/gshadow   none    ro,bind 0       0
74 .T&
75 lfCR s s s s s.
76 /etc/resolv.conf \[rs]
77 .T&
78 lfCR lfCR s s s s.
79         /srv/chroot/lenny/etc/resolv.conf \[rs]
80 .T&
81 lfCR lfCR lfCR lfCR lfCR lfCR.
82                 none    ro,bind 0       0
83 .TE
84 .PP
85 If the bind mountpoints don't exist in the chroot, touch them:
86 .PP
87 \f[CR]# \f[CB]touch /srv/chroot/lenny/etc/resolv.conf\fP\fP
88 .PP
89 Next, mount them all.
90 .PP
91 Depending on your kernel version and security considerations, you may wish to
92 do this part slightly differently.  With a Linux kernel, at least version 2.6
93 is required for bind mounts, and devpts (CONFIG_UNIX98_PTYS) for
94 \fI/dev/pts\fP.  Other guides recommend copying the files, but this method
95 keeps them up-to-date at no cost.
96 .PP
97 If using sbuild with schroot, \fIpasswd\fP, \fIshadow\fP, \fIgroup\fP,
98 \fIgshadow\fP and \fIresolv.conf\fP can be updated automatically at the start
99 of each build, so no action is required here.  schroot can also automatically
100 mount all of the extra filesystems, so all the other mounts may be omitted.
101 .PP
102 To disable networking, don't bind mount \fI/etc/resolv.conf\fP.  This will
103 prevent APT from working inside the chroot, but prevents package building from
104 having working network access (no nameservers).
105 .SS 3. Edit \f[BI]sources.list\fP
106 Create or edit \fI/srv/chroot/lenny/etc/apt/sources.list\fP, and add all the
107 APT sources required to obtain binary and source packages for your chosen
108 distribution:
109 .PP
110 \f[CR]deb http://security.debian.org/ lenny/updates main\fP
111 .br
112 \f[CR]deb\-src http://security.debian.org/ lenny/updates main\fP
113 .br
114 \f[CR]\fP
115 .br
116 \f[CR]deb http://ftp.uk.debian.org/debian/ lenny main\fP
117 .br
118 \f[CR]deb\-src http://ftp.uk.debian.org/debian/ lenny main\fP
119 .br
120 .SS 4. Configure dchroot or schroot
121 This is entirely optional, but will make the chroot environment easier to
122 access and administer.
123 .PP
124 For dchroot, add the following line to \fI/etc/dchroot.conf\fP:
125 .PP
126 \f[CR]lenny /srv/chroot/lenny\fP
127 .br
128 .PP
129 For schroot, add a group to \fI/etc/schroot/schroot.conf\fP (or a new file
130 \fI/etc/schroot/chroot.d/lenny\fP), for example:
131 .PP
132 \f[CR][lenny]\fP
133 .br
134 \f[CR]type=directory\fP
135 .br
136 \f[CR]description=Debian lenny (stable)\fP
137 .br
138 \f[CR]location=/srv/chroot/lenny\fP
139 .br
140 \f[CR]priority=2\fP
141 .br
142 \f[CR]groups=root,sbuild\fP
143 .br
144 \f[CR]root\-groups=sbuild\fP
145 .br
146 \f[CR]aliases=stable\fP
147 .br
148 \f[CR]run\-setup\-scripts=true\fP
149 .br
150 \f[CR]run\-session\-scripts=true\fP
151 .br
152 .PP
153 For sudo, add a symbolic link to the directory \fI/etc/sbuild/chroot\fP, for
154 example:
155 .PP
156 \f[CR]# \f[CB]mkdir \-p /etc/sbuild/chroot\fP\fP
157 .br
158 \f[CR]# \f[CB]ln \-s /srv/chroot/lenny /etc/sbuild/chroot/lenny\fP\fP
159 .br
160 .SS 5. Log into chroot
161 \f[CR]# \f[CB]dchroot \-c lenny\fP\fP
162 .br
163 .PP
164 or
165 .PP
166 \f[CR]$ \f[CB]schroot \-c lenny \-u root\fP\fP
167 .br
168 .SS 6. Set up packages for sbuild
169 While running as root inside the chroot:
170 .PP
171 \f[CR]# \f[CB]apt-get update\fP\fP
172 .br
173 \f[CR]# \f[CB]apt-get dist-upgrade\fP\fP
174 .br
175 \f[CR]# \f[CB]apt-get install debconf\fP\fP
176 .br
177 \f[CR]# \f[CB]dpkg-reconfigure -plow debconf\fP\fP
178 .br
179 .PP
180 Answer the debconf questions as follows:
181 .IP \fBinterface\fP
182 choose \fI6/Noninteractive\fP
183 .IP \fBpriority\fP
184 choose \fI1/Critical\fP
185 .PP
186 You only need to run dpkg-reconfigure if you weren't asked the questions during
187 the debconf install.  Next, install the packages required for building
188 packages:
189 .PP
190 \f[CR]# \f[CB]apt\-get install debfoster fakeroot build\-essential\fP\fP
191 .br
192 \f[CR]# \f[CB]apt\-get install makedev\fP\fP
193 .br
194 \f[CR]# \f[CB]cd /dev/\fP\fP
195 .br
196 \f[CR]# \f[CB]/sbin/MAKEDEV generic\fP\fP
197 .br
198 \f[CR]# \f[CB]touch /etc/mtab\fP\fP
199 .br
200 .PP
201 For some security, we don't bind mount /dev, so it can't access e.g. USB
202 devices
203 .SS 7. sbuild setup
204 While running as root inside the chroot:
205 .PP
206 \f[CR]# \f[CB]mkdir /build\fP\fP
207 .br
208 \f[CR]# \f[CB]chown root:sbuild /build\fP\fP
209 .br
210 \f[CR]# \f[CB]chmod 02775 /build\fP\fP
211 .br
212 \f[CR]# \f[CB]mkdir \-p /var/lib/sbuild/srcdep\-lock\fP\fP
213 .br
214 \f[CR]# \f[CB]chown \-R root:sbuild /var/lib/sbuild\fP\fP
215 .br
216 \f[CR]# \f[CB]chmod \-R 02775 /var/lib/sbuild\fP\fP
217 .br
218 .PP
219 Note that when using sbuild with schroot, this setup is done at the start of
220 each build, so is not required here.
221 .SS 8. Finished
222 Congratulations!  You should now have a fully configured and operational
223 chroot.
224 .SH SBUILD-CREATECHROOT
225 This script will automatically perform a number of the steps described above,
226 including:
227 .IP \[bu]
228 Running debootstrap.
229 .IP \[bu]
230 Setting up APT sources in \fI/etc/apt/sources.list\fP.
231 .IP \[bu]
232 Setting up a minimal \fI/etc/passwd\fP
233 .IP \[bu]
234 Setting up /build and /var/lib/sbuild with appropriate ownership and
235 permissions.
236 .PP
237 After it has done this, you do still need to do some manual setup, completing
238 the steps it missed out above, for example.
239 .SH USER SETUP
240 .SS 1. Group membership
241 As root, run:
242 .PP
243 \f[CR]# \f[CB]sbuild-adduser \f[CBI]user\fP\fP\fP
244 .br
245 .PP
246 Alternatively, add the user to the \fIsbuild\fP group by hand:
247 .PP
248 \f[CR]# \f[CB]adduser \f[CBI]user\fP sbuild\fP\fP
249 .SS 2. \f[BI]~/.sbuildrc\fP
250 .br
251 Configure the user's \fI~/.sbuildrc\fP:
252 .PP
253 \f[CR]$ \f[CB]cp /usr/share/doc/sbuild/examples/example.sbuildrc ~\f[CBI]user\fP/.sbuildrc\fP\fP
254 .br
255 .PP
256 Edit to set the correct mail address to send log files to, and the correct
257 maintainer name and/or uploader name.
258 .PP
259 .SS 3. Build directories
260 Create directories to contain packages and log files.  (.sbuildrc may have
261 configured different locations; the default build directory is the current
262 directory, and the default $log_dir is ~/logs):
263 .PP
264 \f[CR]$ \f[CB]mkdir ~/logs\fP\fP
265 .br
266 .SS 4. sudo setup
267 This step not required if schroot is used (which is the default, set in
268 \fIsbuild.conf\fP).  If using sbuild with sudo (chroot_mode \[lq]split\[rq]),
269 sudo needs configuring to give the user permission to install and remove
270 packages in the chroot, which requires root priveleges.  Add the following
271 lines to \fI/etc/sudoers\fP:
272 .PP
273 \f[CR]\f[CI]username\fP  ALL=NOPASSWD: ALL\fP
274 .br
275 \f[CR]Defaults:\f[CI]username\fP env_keep+="APT_CONFIG DEBIAN_FRONTEND SHELL"\fP
276 .br
277 .PP
278 where \fIusername\fP is the name of the user who will run sbuild.
279 .SS 5. Finished
280 The user should now be able to run sbuild.
281 .PP
282 \f[CR]$ \f[CB]sbuild ...\fP\fP
283 .br
284 .SH AUTHORS
285 Roger Leigh.
286 .SH COPYRIGHT
287 Copyright \(co 2005-2008  Roger Leigh <rleigh@debian.org>
288 .PP
289 This program is free software; you can redistribute it and/or modify it
290 under the terms of the GNU General Public License as published by the Free
291 Software Foundation; either version 2 of the License, or (at your option)
292 any later version.
293 .SH SEE ALSO
294 .BR debootstrap (1),
295 .BR sbuild (1),
296 .BR sbuild\-adduser (1),
297 .BR sbuild\-createchroot (1).
298 .\"#
299 .\"# The following sets edit modes for GNU EMACS
300 .\"# Local Variables:
301 .\"# mode:nroff
302 .\"# fill-column:79
303 .\"# End: