diff options
-rwxr-xr-x | man1/ezjail-admin.1 | 81 | ||||
-rwxr-xr-x | man5/ezjail.conf.5 | 96 |
2 files changed, 177 insertions, 0 deletions
diff --git a/man1/ezjail-admin.1 b/man1/ezjail-admin.1 new file mode 100755 index 0000000..9030d53 --- /dev/null +++ b/man1/ezjail-admin.1 | |||
@@ -0,0 +1,81 @@ | |||
1 | .TH ezjail\-admin 1 | ||
2 | .SH NAME | ||
3 | ezjail-admin \- Administrate ezjail | ||
4 | .SH SYNOPSIS | ||
5 | .T | ||
6 | .B ezjail-admin create | ||
7 | [-r jailroot] [-x] | ||
8 | .I hostname jailip | ||
9 | |||
10 | .T | ||
11 | .B ezjail-admin delete | ||
12 | [-w] | ||
13 | .I hostname | ||
14 | |||
15 | .T | ||
16 | .B ezjail-admin list | ||
17 | |||
18 | .T | ||
19 | .B ezjail-admin update | ||
20 | [-s sourcetree] | ||
21 | .SH DESCRIPTION | ||
22 | The | ||
23 | .B ezjail-admin | ||
24 | tool is used to manage jails inside the ezjail scope. It is not used | ||
25 | to start or stop ezjails jails. Refer to ezjail(5) for more details. | ||
26 | .SH ezjail-admin create | ||
27 | makes a copy of the ezjail template jail to the standard jail directory, | ||
28 | using either the name specified with the -r option or a name derived from | ||
29 | the given hostname. | ||
30 | |||
31 | If the jailroot does not start with a /, it is | ||
32 | interpreted relative to ezjails root dir. If the given jailroot lies | ||
33 | outside ezjails root dir, a soft link is created inside ezjails root dir | ||
34 | pointing to the newly created jails location. | ||
35 | |||
36 | The first step is skipped, if the -x (jail exists) option is given, useful | ||
37 | in situations where you just want to alter some of a jail properties and | ||
38 | called ezjail-admin delete without the -w option before. However, sanity | ||
39 | checks are being performed. | ||
40 | |||
41 | It then creates an entry in its /etc/ezjail directory allowing the | ||
42 | jail to be brought up after next reboot. | ||
43 | |||
44 | If the ezjail_mount_enable option is set, a /etc/fstab.hostname is | ||
45 | generated, allowing the basejail to be auto-mounted when the jail starts | ||
46 | up. | ||
47 | |||
48 | Options for newly created jails are read from ezjail.conf, refer to | ||
49 | ezjail.conf(5) for more information. | ||
50 | .SH ezjail-admin delete | ||
51 | removes a jail from ezjails /etc/ezjail resource directory thus preventing | ||
52 | it from being brought up on next reboot. | ||
53 | |||
54 | It then removes the /etc/fstab.hostname entry, if it exists. | ||
55 | |||
56 | If the -w (wipe) option is given, the directory pointed to by the jail | ||
57 | root entry is removed as well as the soft link, if necessary. | ||
58 | .SH ezjail-admin list | ||
59 | lists all jails inside ezjails scope, together with some information on | ||
60 | them. | ||
61 | .SH ezjail-admin update | ||
62 | tries to build and install a FreeBSD system from the source tree either | ||
63 | specified in the ezjail.conf config file or via the -s option. Build | ||
64 | destination is a temporary directory inside ezjails jail root. | ||
65 | |||
66 | It then fills the basejail from that temporary directory (leaving all | ||
67 | older version installed libraries intact, if it already existed). All | ||
68 | copied directories are removed and replaced by soft links to what later is | ||
69 | mounted into the jail. | ||
70 | |||
71 | Finally it removes the old template jail and renames the | ||
72 | temporary directory as the new template jail. | ||
73 | .SH FILES | ||
74 | .T4 | ||
75 | /usr/local/etc/ezjail.conf | ||
76 | .br | ||
77 | /usr/local/etc/rc.d/ezjail | ||
78 | .SH "SEE ALSO" | ||
79 | ezjail(5), ezjail.conf(5), jail(8), devfs(5), fdescfs(5), procfs(5) | ||
80 | .SH AUTHOR | ||
81 | Dirk Engling <erdgeist@erdgeist.org> | ||
diff --git a/man5/ezjail.conf.5 b/man5/ezjail.conf.5 new file mode 100755 index 0000000..8f6cf39 --- /dev/null +++ b/man5/ezjail.conf.5 | |||
@@ -0,0 +1,96 @@ | |||
1 | .TH ezjail.conf 5 | ||
2 | .SH NAME | ||
3 | ezjail.conf \- configuration file for ezjail script | ||
4 | .SH DESCRIPTION | ||
5 | The file | ||
6 | .B ezjail.conf | ||
7 | contains setting that control the operation of the ezjail rc script. It is | ||
8 | also read by the | ||
9 | .B ezjail-admin | ||
10 | utility to figure out where it should perform its actions. | ||
11 | .SH PATH OPTIONS | ||
12 | .TP | ||
13 | .B ezjail_jaildir (str) | ||
14 | Location of jail root directories | ||
15 | .br | ||
16 | .I default: /usr/jails | ||
17 | .TP | ||
18 | .B ezjail_jailtemplate (str) | ||
19 | Location of template jail used to create a new jail | ||
20 | .br | ||
21 | .I default: /usr/jails/newjail | ||
22 | .TP | ||
23 | .B ezjail_jailbase (str) | ||
24 | Location of base jail, the one that is mounted to all jails | ||
25 | .br | ||
26 | .I default: /usr/jails/basejail | ||
27 | .TP | ||
28 | .B ezjail_sourcetree (str) | ||
29 | Location of your copy of FreeBSD's source tree (refer to the | ||
30 | .B ezjail-admin(1) | ||
31 | utility for more information) | ||
32 | .br | ||
33 | .I default: /usr/src | ||
34 | .SH JAIL CREATION OPTIONS | ||
35 | Default options for newly created jails. Used by the | ||
36 | .B ezjail-admin(1) | ||
37 | utility. Be careful about disabling ezjail_mount_enable. (Refer to | ||
38 | .B ezjail-admin(1) | ||
39 | for more information). | ||
40 | .TP | ||
41 | .B ezjail_mount_enable (bool) | ||
42 | Controls, wheter /etc/fstab.JAILNAME should be executed at jail startup | ||
43 | time. | ||
44 | .br | ||
45 | .I default: "YES" | ||
46 | .TP | ||
47 | .B ezjail_devfs_enable (bool) | ||
48 | Controls, wheter newly created jails will be given a working | ||
49 | .I /dev | ||
50 | directory. (Refer to | ||
51 | .B devfs(5) | ||
52 | and | ||
53 | .B jail(8) | ||
54 | for more information). | ||
55 | .br | ||
56 | .I default: "YES" | ||
57 | .TP | ||
58 | .B ezjail_devfs_ruleset (str) | ||
59 | Specifies, which devfs ruleset should apply for newly created jails. | ||
60 | (Refer to | ||
61 | .B devfs(5) | ||
62 | and | ||
63 | .N jail(8) | ||
64 | for more information). | ||
65 | .br | ||
66 | .I default: "devfsrules_jail" | ||
67 | .TP | ||
68 | .B ezjail_procfs_enable (bool) | ||
69 | Controls, wheter newly created jails will be given a working | ||
70 | .I /proc | ||
71 | directory. (Refer to | ||
72 | .B procfs(5) | ||
73 | and | ||
74 | .B jail(8) | ||
75 | for more information). | ||
76 | .br | ||
77 | .I default: "YES" | ||
78 | .TP | ||
79 | .B ezjail_fdescfs_enable (bool) | ||
80 | Controls, wheter newly created jails will be given a working | ||
81 | .I /dev/fd/ | ||
82 | directory. (Refer to | ||
83 | .B fdescfs(5) | ||
84 | and | ||
85 | .B jail(8) | ||
86 | for more information). | ||
87 | .br | ||
88 | .I default: "YES" | ||
89 | .SH FILES | ||
90 | .TP | ||
91 | /usr/local/etc/ezjail.conf | ||
92 | /usr/local/etc/rc.d/ezjail | ||
93 | .SH "SEE ALSO" | ||
94 | ezjail-admin(1), ezjail(5), jail(8), devfs(5), fdescfs(5), procfs(5) | ||
95 | .SH AUTHOR | ||
96 | Dirk Engling <erdgeist@erdgeist.org> | ||