NAME

appjail-quick — Create a pre-configured jail

SYNOPSIS

appjail quick name [options ...]

DESCRIPTION

The appjail quick utility creates and configures a jail. Basically, it configure the template that the jail uses with options that you specify after its name. Each option has its own responsibility, but in a nutshell, it writes the template with other AppJail subcommands. Due to this flexibility, appjail quick provides a simple and fast approach to creating and recreating jails. The appjail-makejail(1)'s -o parameter and the appjail-makejail(5)'s OPTION instruction are essentially a wrapper for this command.

Each parameter has a data type, can conflict with other options, can be specified multiple times, and can even have dependencies, that is, it needs another parameter to work correctly or even to take effect.

DATA TYPES

String: Any character that is valid according to the option itself is valid.
Integer: Positive number, or in other words, [0-9]+.
Boolean: An option with no arguments is considered to be of type boolean.
Options: A parameter that contains subparameters.

OPTIONS

alias | alias="interface"

Interface assigned to the jail. interface is used as the default interface for other options specified in Requires; If not defined, each option must define the interface to use, but is not a requirement. It is recommended to configure an interface using this option or at least one for each option listed in Requires, as the jail(8) framework may not perform any action.

Type: String
Multiple: No
Conflicts (any):

bridge
jng
vnet

Requires (any):

ip4
ip4_inherit
ip4_disable
ip6
ip6_inherit
ip6_disable
virtualnet

Examples:

alias
alias="appjail0"

boot

Set the boot flag to the jail, so that appjail-startup(1) can start it, typically at startup.

See also appjail-enable(1).

Type: String
Multiple: Yes
Examples:

create_args="nginx_conf=/app/nginx.conf"

defaultrouter="router"

Create a static default route to this jail.

Type: String
Multiple: No
Examples:

defaultrouter="192.168.0.1"

defaultrouter6="router"

The IPv6 equivalent of defaultrouter.

device="rulespec"

Add a DEVFS rule.

See also appjail-enable(1).

Type: String
Multiple: Yes

run_env="name=value"

Set default environment variables for the cmd stage.

See also appjail-enable(1).

Type: String
Multiple: Yes

slaac="interface"

Configure interface using SLAAC.
Type: String
Multiple: Yes
Requires (any):

bridge
jng
vnet

Examples:

slaac="sb_mariadb"
slaac="ng1_httpd"

start

Start the jail after its creation.

Type: Boolean
Multiple: No

start_args="parameter=value"

Set default parameters for the start stage.

See also appjail-enable(1).

Type: String
Multiple: Yes

start_env="name=value"

Set default environment variables for the start stage.

See also appjail-enable(1).

Type: String
Multiple: Yes

stop_args="parameter=value"

Set default parameters for the stop stage.

See also appjail-enable(1).

Type: String
Multiple: Yes

stop_env="name=value"

Set default environment variables for the stop stage.

See also appjail-enable(1).

Type: String
Multiple: Yes

template="template"

Template file. If not specified, the template file specified by the DEFAULT_TEMPLATE parameter is used.

Type: String
Multiple: No

tiny+import="file"

Create a new jail by importing a TinyJail.

Type: String
Multiple: No
Conflicts (any):

clone+jail
clone+release
copy
empty
import+jail
import+root
zfs+import+jail
zfs+import+root

tmpdir

Create a directory and an appjail-fstab(5)'s entry to mount /tmp within the jail. The directory is created with permissions ‘1777’.

Type: Boolean
Multiple: No
Conflicts (any):

x11

type

Type on which the jail is based. The default is thin.

DIRTY JAIL

If you create a jail with appjail quick, the jail is marked as dirty until you finish creating it. Creation implies that all options used implicitly or explicitly are done. Keep this in mind when using options like login, as the jail is dirty until the session ends. See appjail-jail(1) for more details, but basically this means that appjail quick considers that this jail failed in some way and can proceed to remove it without the user's permission.

EXAMPLES

The following examples show how to use appjail quick and assume that you have some things like the loopback interface used by LinuxJails or that you already have the components downloaded by appjail-fetch(1) to create jails. See appjail-tutorial(7) if you want more information on how to configure these things.

Example 1: Basic Usage

# appjail quick jtest start overwrite=force

Example 2: Virtual Networks

# appjail quick jtest overwrite=force start virtualnet=":<random> default" nat

Example 3: LinuxJails

# appjail quick ubuntu \
     start \
     overwrite=force \
     osversion=jammy \
     type=linux+debootstrap \
     linuxfs \
     device='include $devfsrules_hide_all' \
     device='include $devfsrules_unhide_basic' \
     device='include $devfsrules_unhide_login' \
     device='path shm unhide' \
     device="path 'shm/*' unhide" \
     template=/usr/local/share/examples/appjail/templates/linux.conf

Example 4: LinuxJails & Virtual Networks

# appjail quick ubuntu \
     start \
     overwrite=force \
     osversion=jammy \
     type=linux+debootstrap \
     linuxfs \
     device='include $devfsrules_hide_all' \
     device='include $devfsrules_unhide_basic' \
     device='include $devfsrules_unhide_login' \
     device='path shm unhide' \
     device="path 'shm/*' unhide" \
     template=/usr/local/share/examples/appjail/templates/linux.conf \
     virtualnet=":appjail0 default" \
     nat \
     alias

EXIT STATUS

The appjail quick utility exits 0 on success, and >0 if an error occurs.

AUTHORS

Jesús Daniel Colmenares Oviedo <DtxdF@disroot.org>

CAVEATS

Most of the options described in this document are executed after the jail performs some specific operation, e.g. start or stop it.