summaryrefslogtreecommitdiff
path: root/man1/ezjail-admin.1
blob: 68aadb44148bf5af0a3cacad64c2bf518031f13f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
.TH ezjail\-admin 1
.SH NAME
ezjail-admin \- Administrate ezjail
.SH SYNOPSIS
.T
.B ezjail-admin create
[-r jailroot] [-x]
.I hostname jailip

.T
.B ezjail-admin delete
[-w]
.I hostname

.T
.B ezjail-admin list

.T
.B ezjail-admin update
[-s sourcetree] [-i]
.SH DESCRIPTION
The
.B ezjail-admin
tool is used to manage jails inside the ezjail scope. It is not used 
to start or stop ezjails jails. Refer to ezjail(5) for more details. 
.SH ezjail-admin create
makes a copy of the ezjail template jail to the standard jail directory,
using either the name specified with the -r option or a name derived from 
the given hostname.

If the jailroot does not start with a /, it is 
interpreted relative to ezjails root dir. If the given jailroot lies 
outside ezjails root dir, a soft link is created inside ezjails root dir 
pointing to the newly created jails location.

The first step is skipped, if the -x (jail exists) option is given, useful 
in situations where you just want to alter some of a jail properties and 
called ezjail-admin delete without the -w option before. However, sanity 
checks are being performed.

It then creates an entry in its /etc/ezjail directory allowing the 
jail to be brought up after next reboot.

If the ezjail_mount_enable option is set, a /etc/fstab.hostname is 
generated, allowing the basejail to be auto-mounted when the jail starts 
up.

Options for newly created jails are read from ezjail.conf, refer to 
ezjail.conf(5) for more information.
.SH ezjail-admin delete
removes a jail from ezjails /etc/ezjail resource directory thus preventing 
it from being brought up on next reboot.

It then removes the /etc/fstab.hostname entry, if it exists.

If the -w (wipe) option is given, the directory pointed to by the jail 
root entry is removed as well as the soft link, if necessary.
.SH ezjail-admin list
lists all jails inside ezjails scope, together with some information on 
them.
.SH ezjail-admin update
installs a FreeBSD system from the source tree to a location either
provided in the
.B ezjail.conf
config file or via the -s option.

Install destination is a temporary directory inside ezjails jail root. If 
the -i (install only) option is given,
.B ezjail-admin update
only performes a
.I make installworld,
otherwise
.I make world
is invoked.

It then fills the basejail from that temporary directory (leaving intact 
all installed libraries, if the base jail already existed). All
directories copied are removed and replaced by soft links into the 
base jail tree that later will be mounted into the jail.

Finally it removes the old template jail and renames the 
temporary directory as the new template jail.
.SH NOTES
When using the
.B ezjail-admin update
option, be careful to use the same FreeBSD source tree used to build the 
host systems world, or at least its kernel. Combining a make world in the 
host system with
.B ezjail-admin update
is considered a good idea.
.SH FILES
.T4
/usr/local/etc/ezjail.conf
.br
/usr/local/etc/rc.d/ezjail
.SH "SEE ALSO"
ezjail(5), ezjail.conf(5), jail(8), devfs(5), fdescfs(5), procfs(5)
.SH AUTHOR
Dirk Engling <erdgeist@erdgeist.org>