diff options
| author | erdgeist <erdgeist@bauklotz.local> | 2015-08-16 16:38:25 +0200 |
|---|---|---|
| committer | erdgeist <erdgeist@bauklotz.local> | 2015-08-16 16:38:25 +0200 |
| commit | 23f0e1561767dd8a396188e317bae5920d171ea8 (patch) | |
| tree | a67f44e39ad8a45e42d60634488a65c37f3ad432 /stories/projects/ezjail.conf.5 | |
Initial import of my nikola website
Diffstat (limited to 'stories/projects/ezjail.conf.5')
| -rwxr-xr-x | stories/projects/ezjail.conf.5 | 229 |
1 files changed, 229 insertions, 0 deletions
diff --git a/stories/projects/ezjail.conf.5 b/stories/projects/ezjail.conf.5 new file mode 100755 index 0000000..f35d412 --- /dev/null +++ b/stories/projects/ezjail.conf.5 | |||
| @@ -0,0 +1,229 @@ | |||
| 1 | .Dd December 5, 2013 | ||
| 2 | .Dt EZJAIL.CONF 5 USD | ||
| 3 | .Os FreeBSD | ||
| 4 | .Sh NAME | ||
| 5 | .Pa ezjail.conf | ||
| 6 | .Nd configuration file for ezjail script | ||
| 7 | .Sh DESCRIPTION | ||
| 8 | The file | ||
| 9 | .Pa ezjail.conf | ||
| 10 | contains settings that control the operation of the ezjail | ||
| 11 | .Xr rc 8 | ||
| 12 | script. It is also read by the | ||
| 13 | .Cm ezjail-admin | ||
| 14 | utility to figure out where it should perform its actions. Its path is | ||
| 15 | set at installation time to | ||
| 16 | .Pa EZJAIL_PREFIX/etc/ezjail.conf , | ||
| 17 | with an example file installed at | ||
| 18 | .Pa EZJAIL_PREFIX/etc/ezjail.conf.sample . | ||
| 19 | .Pp | ||
| 20 | This file is really a shell script that is sourced by the | ||
| 21 | .Cm ezjail-admin | ||
| 22 | command at run-time. | ||
| 23 | .Dq (str) | ||
| 24 | denotes a string; it should be enclosed in quotes if it contains space. | ||
| 25 | .Dq (bool) | ||
| 26 | notes a boolean, whose possible values are | ||
| 27 | .Dq YES | ||
| 28 | and | ||
| 29 | .Dq NO . | ||
| 30 | .Sh PATH OPTIONS | ||
| 31 | .Bl -tag -width option | ||
| 32 | .It ezjail_jaildir (str) | ||
| 33 | Location of jail root directories. | ||
| 34 | .br | ||
| 35 | Default: | ||
| 36 | .Em /usr/jails . | ||
| 37 | .It ezjail_jailtemplate (str) | ||
| 38 | Location of template jail used to create a new jail | ||
| 39 | .br | ||
| 40 | Default: | ||
| 41 | .Em ${ezjail_jaildir}/newjail . | ||
| 42 | .It ezjail_jailbase (str) | ||
| 43 | Location of base jail, the one that is mounted to all jails | ||
| 44 | .br | ||
| 45 | Default: | ||
| 46 | .Em ${ezjail_jaildir}/basejail . | ||
| 47 | .It ezjail_sourcetree (str) | ||
| 48 | Location of your copy of FreeBSD's source tree (refer to the | ||
| 49 | .Xr ezjail-admin 8 | ||
| 50 | utility for more information). | ||
| 51 | .br | ||
| 52 | Default: | ||
| 53 | .Em /usr/src . | ||
| 54 | .It ezjail_flavours_dir (str) | ||
| 55 | Location of the flavours, where each directory is a different flavour. | ||
| 56 | .br | ||
| 57 | Default: | ||
| 58 | .Em ${ezjail_jaildir}/flavours . | ||
| 59 | .It ezjail_ftphost (str) | ||
| 60 | This is where the install subcommand defaults to fetch its packages from. | ||
| 61 | .br | ||
| 62 | Default: | ||
| 63 | .Em ftp.freebsd.org . | ||
| 64 | .It ezjail_archivedir (str) | ||
| 65 | This is the default archive location for the | ||
| 66 | .Cm ezjail-admin archive | ||
| 67 | command. | ||
| 68 | .br | ||
| 69 | Default: | ||
| 70 | .Em ${ezjail_jaildir}/ezjail_archives . | ||
| 71 | .El | ||
| 72 | .Sh JAIL ADMIN OPTIONS | ||
| 73 | .Bl -tag -width option | ||
| 74 | .It ezjail_default_execute (str) | ||
| 75 | This is the default command executed in a jail by | ||
| 76 | .Cm ezjail-admin console . | ||
| 77 | .br | ||
| 78 | Default: | ||
| 79 | .Em /usr/bin/login -f root . | ||
| 80 | .It ezjail_exec_start (str) | ||
| 81 | The command to execute in a jail when starting it. | ||
| 82 | .br | ||
| 83 | Default: | ||
| 84 | .Em /bin/sh /etc/rc . | ||
| 85 | .El | ||
| 86 | .Sh JAIL CREATION OPTIONS | ||
| 87 | Default options for newly created jails. Used by the | ||
| 88 | .Xr ezjail-admin 1 | ||
| 89 | utility. Be careful about disabling | ||
| 90 | .Em ezjail_mount_enable . | ||
| 91 | .Bl -tag -width option | ||
| 92 | .It ezjail_mount_enable (bool) | ||
| 93 | Controls whether | ||
| 94 | .Pa /etc/fstab. Ar hostname | ||
| 95 | should be executed at jail startup time. | ||
| 96 | .br | ||
| 97 | Default: | ||
| 98 | .Em YES . | ||
| 99 | .It ezjail_devfs_enable (bool) | ||
| 100 | Controls whether newly created jails are given a working | ||
| 101 | .Pa /dev | ||
| 102 | directory. (Refer to | ||
| 103 | .Xr devfs 5 | ||
| 104 | and | ||
| 105 | .Xr jail 8 | ||
| 106 | for more information). | ||
| 107 | .br | ||
| 108 | Default: | ||
| 109 | .Em YES . | ||
| 110 | .It ezjail_devfs_ruleset (str) | ||
| 111 | Specifies which devfs ruleset should apply for newly created jails. | ||
| 112 | (Refer to | ||
| 113 | .Xr devfs 5 | ||
| 114 | and | ||
| 115 | .Xr jail 8 | ||
| 116 | for more information). | ||
| 117 | .br | ||
| 118 | Default: | ||
| 119 | .Em devfsrules_jail . | ||
| 120 | .It ezjail_procfs_enable (bool) | ||
| 121 | Controls whether newly created jails are given a working | ||
| 122 | .Pa /proc | ||
| 123 | directory. (Refer to | ||
| 124 | .Xr procfs 5 | ||
| 125 | and | ||
| 126 | .Xr jail (8) | ||
| 127 | for more information). | ||
| 128 | .br | ||
| 129 | Default: | ||
| 130 | .Em YES . | ||
| 131 | .It ezjail_fdescfs_enable (bool) | ||
| 132 | Controls whether newly created jails are given a working | ||
| 133 | .Pa /dev/fd/ | ||
| 134 | directory. (Refer to | ||
| 135 | .Xr fdescfs (5) | ||
| 136 | and | ||
| 137 | .Xr jail (8) | ||
| 138 | for more information). | ||
| 139 | .br | ||
| 140 | Default: | ||
| 141 | .Em YES . | ||
| 142 | .It ezjail_uglyperlhack (bool) | ||
| 143 | Set to YES, if ezjail should provide a soft link from | ||
| 144 | .Pa /usr/bin/perl | ||
| 145 | to | ||
| 146 | .Pa /usr/local/bin/perl | ||
| 147 | in base jail. | ||
| 148 | .br | ||
| 149 | Default: | ||
| 150 | .Em YES . | ||
| 151 | .It ezjail_default_flavour (str) | ||
| 152 | Controls which flavours should be used for newly created jails if none | ||
| 153 | are given on the command line. | ||
| 154 | .br | ||
| 155 | Default: | ||
| 156 | .Em none . | ||
| 157 | .It ezjail_imagetype (one of simple, bde, eli, zfs) | ||
| 158 | Type of jail to create when creating a jail with the | ||
| 159 | .Fl i | ||
| 160 | flag without specifying the type explicitly. | ||
| 161 | .br | ||
| 162 | Default: | ||
| 163 | .Em simple | ||
| 164 | .El | ||
| 165 | .Sh ZFS OPTIONS | ||
| 166 | .Bl -tag -width option | ||
| 167 | .It ezjail_use_zfs (bool) | ||
| 168 | Set to YES, if ezjail should manage basejail and newjail in a separate | ||
| 169 | ZFS-datasets. | ||
| 170 | .br | ||
| 171 | Default: | ||
| 172 | .Em NO . | ||
| 173 | .It ezjail_use_zfs_for_jails (bool) | ||
| 174 | Set to YES, if ezjail should manage all new jails in their own | ||
| 175 | ZFS-datasets. To override that on the command line, use | ||
| 176 | .Cm ezjail-admin create -c simple | ||
| 177 | for image based jails or | ||
| 178 | .Cm ezjail-admin create -c '' | ||
| 179 | for non-image jails. | ||
| 180 | .br | ||
| 181 | Default: | ||
| 182 | .Em NO . | ||
| 183 | .It ezjail_jailzfs (str) | ||
| 184 | The name of the parent ZFS-dataset which ezjail will use to create | ||
| 185 | jails on. It will be mounted in | ||
| 186 | .Em ezjail_jaildir . | ||
| 187 | Setting this will automatically enable ezjail managing jails in separate | ||
| 188 | ZFS-datasets. | ||
| 189 | .br | ||
| 190 | Default: | ||
| 191 | .Em none . | ||
| 192 | .It ezjail_zfs_properties (str) | ||
| 193 | Default properties ZFS will use for creating datasets. See | ||
| 194 | .Xr zfs 1m | ||
| 195 | for details. ADVANCED, be very careful! | ||
| 196 | .br | ||
| 197 | Default: | ||
| 198 | .Em none . | ||
| 199 | .It ezjail_default_retention_policy (str) | ||
| 200 | Policy for the | ||
| 201 | .Cm ezjail-admin snapshot | ||
| 202 | subcommand to keep older snapshots. See | ||
| 203 | .Xr ezjail-admin 1 | ||
| 204 | for details. | ||
| 205 | .br | ||
| 206 | Default: | ||
| 207 | .Em none . | ||
| 208 | .El | ||
| 209 | .Sh FILES | ||
| 210 | EZJAIL_PREFIX/etc/ezjail.conf | ||
| 211 | .br | ||
| 212 | EZJAIL_PREFIX/etc/rc.d/ezjail.sh | ||
| 213 | .Sh SEE ALSO | ||
| 214 | .Xr ezjail-admin 1 , | ||
| 215 | .Xr ezjail 5 , | ||
| 216 | .Xr jail 8 , | ||
| 217 | .Xr devfs 5 , | ||
| 218 | .Xr fdescfs 5 , | ||
| 219 | .Xr procfs 5 . | ||
| 220 | .Sh AUTHOR | ||
| 221 | Dirk Engling | ||
| 222 | .Aq erdgeist@erdgeist.org . | ||
| 223 | .Pp | ||
| 224 | The man page is based on a draft by | ||
| 225 | .An JoeB | ||
| 226 | .Aq joeb1@a1poweruser.com | ||
| 227 | and was rewritten by | ||
| 228 | .An Frederic Perrin | ||
| 229 | .Aq frederic.perrin@resel.fr . | ||
