summaryrefslogtreecommitdiff
path: root/man5
diff options
context:
space:
mode:
Diffstat (limited to 'man5')
-rwxr-xr-xman5/ezjail.540
-rwxr-xr-xman5/ezjail.conf.5288
2 files changed, 176 insertions, 152 deletions
diff --git a/man5/ezjail.5 b/man5/ezjail.5
deleted file mode 100755
index 62cbb42..0000000
--- a/man5/ezjail.5
+++ /dev/null
@@ -1,40 +0,0 @@
1.TH ezjail 5
2.SH NAME
3ezjail \- A simple jail setup framework
4.SH SYNOPSIS
5EZJAIL_PREFIX/etc/rc.d/ezjail.sh
6.SH DESCRIPTION
7The ezjail framework provides a simple way to create many virtual FreeBSD
8servers by using FreeBSD's jail system. It requires little administration
9effort and aims for minimum system resource usage.
10
11If you are not familiar with the FreeBSD jail concept, please refer to
12jail(8) before continuing.
13.SH OVERVIEW
14One \fIbase jail\fR is filled with most userland binaries and libraries and
15then mounted read only into a number of stripped down jails via
16.B mount_nullfs(8)\fR - thus saving lots of inodes and memory resources.
17.SH INVOCATION
18The ezjail script \fBEZJAIL_PREFIX/etc/rc.d/ezjail.sh\fR takes parameters \fIstart,
19startcrypto, restart\fR and \fIstop\fR. It may be passed an additional list of
20jails. If no jail name is specified (usually when the script is called by
21rc.local at boot and shutdown time), all jails in ezjail's scope, except crypto
22image jails (or jails marked as blocking), are started/stopped. To start
23all crytpo image jails (or those depending on them), use the \fIstartcrypto\fR parameter.
24
25The script examines its config, attaches and mounts images, and sets
26variables for each jail in the jail_list before passing its command on
27to the \fB/etc/rc.d/jail\fR script.
28.SH NOTES
29.B ezjail.sh\fR enforces the execution of \fB/etc/rc.d/jail\fR, by
30prepending \fI"one"\fR to the start, restart, and stop commands so it is
31.B NOT NECESSARY\fR to set \fIjail_enable\fR in the \fB/etc/rc.conf\fR
32config file.
33.SH FILES
34EZJAIL_PREFIX/etc/ezjail.conf
35.br
36EZJAIL_PREFIX/etc/rc.d/ezjail.sh
37.SH "SEE ALSO"
38ezjail-admin(1), ezjail.conf(5), jail(8), mount_nullfs(8)
39.SH AUTHOR
40Dirk Engling <erdgeist@erdgeist.org>
diff --git a/man5/ezjail.conf.5 b/man5/ezjail.conf.5
index 81ac1ba..27e6e2a 100755
--- a/man5/ezjail.conf.5
+++ b/man5/ezjail.conf.5
@@ -1,143 +1,207 @@
1.TH ezjail.conf 5 1.Dd January 15, 2011
2.SH NAME 2.Dt EZJAIL.CONF 5 USD
3ezjail.conf \- configuration file for ezjail script 3.Os FreeBSD
4.SH DESCRIPTION 4.Sh NAME
5.Pa ezjail.conf
6.Nd configuration file for ezjail script
7.Sh DESCRIPTION
5The file 8The file
6.B ezjail.conf 9.Pa ezjail.conf
7contains settings that control the operation of the ezjail rc script. It is 10contains settings that control the operation of the ezjail rc script. It is
8also read by the 11also read by the
9.B ezjail-admin 12.Cm ezjail-admin
10utility to figure out where it should perform its actions. 13utility to figure out where it should perform its actions. Its path is
11.SH PATH OPTIONS 14set at installation time to
12.TP 15.Pa EZJAIL_PREFIX/etc/ezjail.conf ,
13.B ezjail_jaildir (str) 16with an example file installed at
14Location of jail root directories 17.Pa EZJAIL_PREFIX/etc/ezjail.conf.sample .
15.br 18.Pp
16.I default: /usr/jails 19This file is really a shell script that is sourced by the
17.TP 20.Cm ezjail-admin
18.B ezjail_jailtemplate (str) 21command at run-time.
22.Dq (str)
23denotes a string; it should be enclosed in quotes if it contains space.
24.Dq (bool)
25notes a boolean, whose possible values are
26.Dq YES
27and
28.Dq NO .
29.Sh PATH OPTIONS
30.Bl -tag -width option
31.It ezjail_jaildir (str)
32Location of jail root directories.
33.br
34Default:
35.Em /usr/jails .
36.It ezjail_jailtemplate (str)
19Location of template jail used to create a new jail 37Location of template jail used to create a new jail
20.br 38.br
21.I default: /usr/jails/newjail 39Default:
22.TP 40.Em ${ezjail_jaildir}/newjail .
23.B ezjail_jailbase (str) 41.It ezjail_jailbase (str)
24Location of base jail, the one that is mounted to all jails 42Location of base jail, the one that is mounted to all jails
25.br 43.br
26.I default: /usr/jails/basejail 44Default:
27.TP 45.Em ${ezjail_jaildir}/basejail .
28.B ezjail_sourcetree (str) 46.It ezjail_sourcetree (str)
29Location of your copy of FreeBSD's source tree (refer to the 47Location of your copy of FreeBSD's source tree (refer to the
30.B ezjail-admin(1) 48.Xr ezjail-admin 1
31utility for more information) 49utility for more information).
32.br 50.br
33.I default: /usr/src 51Default:
34.TP 52.Em /usr/src .
35.B ezjail_portscvsroot (str) 53.It ezjail_flavours_dir (str)
36Cvs root to use when checking out or updating the ports tree in base jail 54Location of the flavours, where each directory is a different flavour.
37.br 55.br
38.I default: :pserver:anoncvs@anoncvs.at.FreeBSD.org:/home/ncvs 56Default:
39.TP 57.Em ${ezjail_jaildir}/flavours .
40.B ezjail_ftphost (str) 58.It ezjail_portscvsroot (str)
41This is where the install subcommand defaults to fetch its packages from 59CVS root to use when checking out or updating the ports tree in base jail.
42.br 60.br
43.I default: ftp.freebsd.org 61Default:
44.TP 62.Em :pserver:anoncvs@anoncvs.FreeBSD.org:/home/ncvs .
45.B ezjail_archivedir (str) 63.It ezjail_ftphost (str)
46This is the default archive location for the \fIezjail-admin archive\fR command. 64This is where the install subcommand defaults to fetch its packages from.
47.br 65.br
48.I default: `pwd -P` 66Default:
49.SH JAIL ADMIN OPTIONS 67.Em ftp.freebsd.org .
50.TP 68.It ezjail_archivedir (str)
51.B ezjail_default_execute (str) 69This is the default archive location for the
52This is the default command executed in a jail by ezjail-admin console. 70.Cm ezjail-admin archive
53.br 71command.
54.I default: YES 72.br
55.SH JAIL CREATION OPTIONS 73Default:
74.Em ${ezjail_jaildir}/ezjail_archives .
75.El
76.Sh JAIL ADMIN OPTIONS
77.Bl -tag -width option
78.It ezjail_default_execute (str)
79This is the default command executed in a jail by
80.Cm ezjail-admin console .
81.br
82Default:
83.Em /usr/bin/login -f root .
84.It ezjail_exec_start (str)
85The command to execute in a jail when starting it.
86.br
87Default:
88.Em /bin/sh /etc/rc .
89.El
90.Sh JAIL CREATION OPTIONS
56Default options for newly created jails. Used by the 91Default options for newly created jails. Used by the
57.B ezjail-admin(1) 92.Xr ezjail-admin 1
58utility. Be careful about disabling ezjail_mount_enable. (Refer to 93utility. Be careful about disabling
59.B ezjail-admin(1) 94.Em ezjail_mount_enable .
60for more information). 95.Bl -tag -width option
61.TP 96.It ezjail_mount_enable (bool)
62.B ezjail_mount_enable (bool) 97Controls whether
63Controls whether /etc/fstab.hostname should be executed at jail startup 98.Pa /etc/fstab. Ar hostname
64time. 99should be executed at jail startup time.
65.br 100.br
66.I default: "YES" 101Default:
67.TP 102.Em YES .
68.B ezjail_devfs_enable (bool) 103.It ezjail_devfs_enable (bool)
69Controls whether newly created jails are given a working 104Controls whether newly created jails are given a working
70.I /dev 105.Pa /dev
71directory. (Refer to 106directory. (Refer to
72.B devfs(5) 107.Xr devfs 5
73and 108and
74.B jail(8) 109.Xr jail 8
75for more information). 110for more information).
76.br 111.br
77.I default: "YES" 112Default:
78.TP 113.Em YES .
79.B ezjail_devfs_ruleset (str) 114.It ezjail_devfs_ruleset (str)
80Specifies which devfs ruleset should apply for newly created jails. 115Specifies which devfs ruleset should apply for newly created jails.
81(Refer to 116(Refer to
82.B devfs(5) 117.Xr devfs 5
83and 118and
84.N jail(8) 119.Xr jail 8
85for more information). 120for more information).
86.br 121.br
87.I default: "devfsrules_jail" 122Default:
88.TP 123.Em devfsrules_jail .
89.B ezjail_procfs_enable (bool) 124.It ezjail_procfs_enable (bool)
90Controls whether newly created jails are given a working 125Controls whether newly created jails are given a working
91.I /proc 126.Pa /proc
92directory. (Refer to 127directory. (Refer to
93.B procfs(5) 128.Xr procfs 5
94and 129and
95.B jail(8) 130.Xr jail (8)
96for more information). 131for more information).
97.br 132.br
98.I default: "YES" 133Default:
99.TP 134.Em YES .
100.B ezjail_fdescfs_enable (bool) 135.It ezjail_fdescfs_enable (bool)
101Controls whether newly created jails are given a working 136Controls whether newly created jails are given a working
102.I /dev/fd/ 137.Pa /dev/fd/
103directory. (Refer to 138directory. (Refer to
104.B fdescfs(5) 139.Xr fdescfs (5)
105and 140and
106.B jail(8) 141.Xr jail (8)
107for more information). 142for more information).
108.br 143.br
109.I default: "YES" 144Default:
110.TP 145.Em YES .
111.B ezjail_uglyperlhack (bool) 146.It ezjail_uglyperlhack (bool)
112Set to YES, if ezjail should provide a soft link from /usr/bin/perl to /usr/local/bin/perl in base jail. 147Set to YES, if ezjail should provide a soft link from
113.br 148.Pa /usr/bin/perl
114.I default: YES 149to
115.TP 150.Pa /usr/local/bin/perl
116.B ezjail_default_flavour (str) 151in base jail.
117Controls which flavours should be used for newly created jails if none are given on the command line. 152.br
118.br 153Default:
119.I default: none 154.Em YES .
120.SH ZFS OPTIONS 155.It ezjail_default_flavour (str)
121.TP 156Controls which flavours should be used for newly created jails if none
122.B ezjail_use_zfs (bool) 157are given on the command line.
123Set to YES, if ezjail should manage basejail and newjail in a seperate ZFS-datasets. 158.br
124.br 159Default:
125.I default: NO 160.Em none .
126.TP 161.It ezjail_imagetype (one of simple, bde, eli, zfs)
127.B ezjail_jailzfs (str) 162Type of jail to create when creating a jail with the
128The name of the parent ZFS-dataset which ezjail will use to create jails on. It will be mounted at the ezjail_jaildir. Setting this will automaticly enable ezjail managing jails in seperate ZFS-datasets. 163.Fl i
129.br 164flag without specifying the type explicitely.
130.I default: none 165.br
131.TP 166Default:
132.B ezjail_zfs_properties (str) 167.Em simple
133Default properties ZFS will use for creating datasets. See zfs(1m) for details. ADVANCED, be very careful! 168.El
134.br 169.Sh ZFS OPTIONS
135.I default: none 170.Bl -tag -width option
136.SH FILES 171.It ezjail_use_zfs (bool)
172Set to YES, if ezjail should manage basejail and newjail in a seperate
173ZFS-datasets.
174.br
175Default:
176.Em NO .
177.It ezjail_jailzfs (str)
178The name of the parent ZFS-dataset which ezjail will use to create
179jails on. It will be mounted in
180.Em ezjail_jaildir .
181Setting this will automaticly enable ezjail managing jails in seperate
182ZFS-datasets.
183.br
184Default:
185.Em none .
186.It ezjail_zfs_properties (str)
187Default properties ZFS will use for creating datasets. See
188.Xr zfs 1m
189for details. ADVANCED, be very careful!
190.br
191Default:
192.Em none .
193.El
194.Sh FILES
137EZJAIL_PREFIX/etc/ezjail.conf 195EZJAIL_PREFIX/etc/ezjail.conf
138.br 196.br
139EZJAIL_PREFIX/etc/rc.d/ezjail.sh 197EZJAIL_PREFIX/etc/rc.d/ezjail.sh
140.SH "SEE ALSO" 198.Sh SEE ALSO
141ezjail-admin(1), ezjail(5), jail(8), devfs(5), fdescfs(5), procfs(5) 199.Xr ezjail-admin 1 ,
142.SH AUTHOR 200.Xr ezjail 5 ,
143Dirk Engling <erdgeist@erdgeist.org> 201.Xr jail 8 ,
202.Xr devfs 5 ,
203.Xr fdescfs 5 ,
204.Xr procfs 5 .
205.Sh AUTHOR
206Dirk Engling
207.Aq erdgeist@erdgeist.org .