xref: /openbsd-src/share/man/man5/install.site.5 (revision a3154df39cef36d62ed08609a71ada5fbc5341cf)
1*a3154df3Skn.\"     $OpenBSD: install.site.5,v 1.1 2021/11/08 16:12:09 kn Exp $
2*a3154df3Skn.\"
3*a3154df3Skn.\" Copyright (c) 2021 Klemens Nanni <kn@openbsd.org>
4*a3154df3Skn.\"
5*a3154df3Skn.\" Permission to use, copy, modify, and distribute this software for any
6*a3154df3Skn.\" purpose with or without fee is hereby granted, provided that the above
7*a3154df3Skn.\" copyright notice and this permission notice appear in all copies.
8*a3154df3Skn.\"
9*a3154df3Skn.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10*a3154df3Skn.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11*a3154df3Skn.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12*a3154df3Skn.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13*a3154df3Skn.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14*a3154df3Skn.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15*a3154df3Skn.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16*a3154df3Skn.\"
17*a3154df3Skn.Dd $Mdocdate: November 8 2021 $
18*a3154df3Skn.Dt INSTALL.SITE 5
19*a3154df3Skn.Os
20*a3154df3Skn.Sh NAME
21*a3154df3Skn.Nm install.site ,
22*a3154df3Skn.Nm upgrade.site
23*a3154df3Skn.Nd OpenBSD installation and upgrade customization
24*a3154df3Skn.Sh DESCRIPTION
25*a3154df3SknThe
26*a3154df3Skn.Ox
27*a3154df3Skninstaller allows user-created sets and scripts to complement
28*a3154df3Sknand modify the files from a default install prior to rebooting.
29*a3154df3Skn.Pp
30*a3154df3SknLike the official file sets, generic
31*a3154df3Skn.Pa site${ Ns Va VERSION Ns }.tgz
32*a3154df3Sknand
33*a3154df3Sknhostname-specific
34*a3154df3Skn.Pa site${ Ns Va VERSION Ns }-$( Ns Ic hostname Fl s Ns ).tgz
35*a3154df3Sknsets are
36*a3154df3Skn.Xr gzip 1
37*a3154df3Skncompressed
38*a3154df3Skn.Xr tar 1
39*a3154df3Sknarchives rooted in
40*a3154df3Skn.Pa /
41*a3154df3Sknand untarred with the
42*a3154df3Skn.Fl xzphf
43*a3154df3Sknoptions.
44*a3154df3Skn.Pp
45*a3154df3Skn.Em siteXY
46*a3154df3Sknsets
47*a3154df3Sknmust be included in
48*a3154df3Skn.Pa index.txt
49*a3154df3Sknin order to be fetched via
50*a3154df3SknHTTP(S) and selectable in the installer.
51*a3154df3Skn.Pp
52*a3154df3SknIf they exist and are executable,
53*a3154df3Skn.Pa /install.site
54*a3154df3Sknand
55*a3154df3Skn.Pa /upgrade.site
56*a3154df3Sknare run at the end of the install and upgrade process, respectively, with
57*a3154df3Skn.Xr chroot 8
58*a3154df3Sknbased at the system's root.
59*a3154df3Skn.Sh FILES
60*a3154df3Skn.Bl -tag -width "site${VERSION}-$(hostname -s).tgz" -compact
61*a3154df3Skn.It Pa site${ Ns Va VERSION Ns }.tgz
62*a3154df3SknGeneric set.
63*a3154df3Skn.It Pa site${ Ns Va VERSION Ns }-$( Ns Ic hostname Fl s Ns ).tgz
64*a3154df3SknHost-specific set.
65*a3154df3Skn.It Pa /upgrade.site
66*a3154df3SknGeneric post-upgrade script.
67*a3154df3Skn.It Pa /install.site
68*a3154df3SknGeneric post-install script.
69*a3154df3Skn.El
70*a3154df3Skn.Sh EXAMPLES
71*a3154df3SknCreate
72*a3154df3Skn.Em site70
73*a3154df3Sknsets and update the index:
74*a3154df3Skn.Bd -literal -offset indent
75*a3154df3Skn# tar -czhf site70.tgz generic/
76*a3154df3Skn# tar -czhf site70-puffy.tgz puffy/
77*a3154df3Skn# ls -lT > index.txt
78*a3154df3Skn.Ed
79*a3154df3Skn.Pp
80*a3154df3SknUpgrade
81*a3154df3Skn.Xr packages 7
82*a3154df3Sknupon reboot after
83*a3154df3Skn.Xr sysupgrade 8
84*a3154df3Sknupgraded the system:
85*a3154df3Skn.Bd -literal -offset indent
86*a3154df3Skn# cat <<- EOF >> /upgrade.site
87*a3154df3Skn	echo 'pkg_add -Iu' >>/etc/rc.firsttime
88*a3154df3SknEOF
89*a3154df3Skn# chmod +x /upgrade.site
90*a3154df3Skn# sysupgrade
91*a3154df3Skn.Ed
92*a3154df3Skn.Sh SEE ALSO
93*a3154df3Skn.Xr autoinstall 8 ,
94*a3154df3Skn.Xr rc 8 ,
95*a3154df3Skn.Xr sysupgrade 8
96