FreeBSD Manual Pages
APPJAIL(1) General Commands Manual APPJAIL(1) NAME appjail -- Simple and easy-to-use tool for creating portable jails SYNOPSIS appjail command [args ...] DESCRIPTION AppJail is an open-source BSD-3 licensed framework entirely written in POSIX shell and C to create isolated, portable and easy to deploy envi- ronments using FreeBSD jails that behaves like an application. See appjail-tutorial(7) to get started and Getting Started: https://appjail.readthedocs.io/en/latest/getting-started/ if you prefer an online guide. appjail-tutorial(7) provides a quick guide to config- uring AppJail, RC scripts, the packet filter, and some recommendations. This tutorial is not suitable for all kind of users, but for beginners or users who do not need all the features of AppJail. SUBCOMMANDS Tutorial appjail-tutorial(7) A tutorial introduction to AppJail. Configuration appjail.conf(5) Configuration parameters for AppJail. Image appjail-ajspec(5) AJSPEC file specification. appjail-image(1) Create, list, remove, update images and much more. Automation appjail-initscript(5) Jail automation script. appjail-makejail(5) Build a jail using a Makejail file. appjail-label(1) Add metadata to jails. Templates appjail-config(1) Configuration utiliy for templates. appjail-template(5) Template file specification. Makejails appjail-apply(1) Apply a Makejail to an existing jail. appjail-makejail(1) Build a jail using a Makejail file. Networking appjail-network Create, remove or manage virtual networks for jails. appjail-nat(1) Mapping local IPv4 address to an external IPv4 address. appjail-expose(1) Port forwarding from host port to jail port. Help appjail-help(1) Display help information about AppJail. appjail-usage(1) Display the syntax of a given command. appjail-version(1) Display version information about AppJail. DNS appjail-dns(8) DNS information for AppJail users. ZFS appjail-zfs(1) Common ZFS commands for jails. Source appjail-deleteOld(1) Run delete-old and delete-old-libs targets on a given release or jail. appjail-checkOld(1) Run check-old target on a given release or jail appjail-etcupdate(1) Manage updates to system files not updated by installworld. Startup Management appjail-restart(1) Restart a running jail. appjail-rstop(1) Stop a jail and the jails it depends on. appjail-stop(1) Stop a running jail. appjail-startup(1) Unattended command to start jails and other related things. appjail-start(1) Start a stopped jail. appjail-status(1) Show the status of a jail. Volume Management appjail-fstab(1) Static information about the file systems of a jail. appjail-volume(1) Volume management for jails. Resource Management appjail-limits(1) Display and update resource limits database for jails. appjail-cpuset(1) Configure processor sets for jails. Update / Upgrade appjail-update(1) Update a thick jail or a release. appjail-upgrade(1) Upgrade a jail or a release. Argument Persistence appjail-disable(1) Remove default parameters for stages. appjail-enable(1) Set default parameters for stages. appjail-enabled(1) Get the value for a given enabled parameter. Supervisor appjail-healthcheck(1) Keep your jails healthy and running. Logs Management appjail-logs(1) Log management for jails. rc(8) Management appjail-service(1) Control (start/stop/etc.) or list system services within a jail. appjail-sysrc(1) Safely edit system rc files within a jail. Trusted Users appjail-user(8) Hints and parameters for trusted users. Jail Creation appjail-jail(1) Creates, removes, lists and configures jails. appjail-quick(1) Create a pre-configured jail. Command Execution appjail-cmd(1) Execute commands in a jail. Dynamic Device Management appjail-devfs(1) Dynamic DEVFS ruleset management. Package Management appjail-pkg(1) Manipulate packages within a jail. Release Creation appjail-fetch(1) Fetch and extract components to create jails. Ephemeral Concept appjail-ephemeral(7) cattle, pets and jails. Login appjail-login(1) Log into the jail. User-defined Stages appjail-run(1) Run user-defined stages. SIGNALS AppJail returns 70 when a signal is captured or other depending on the last command executed and interrupted. The following signals are cap- tured: SIGHUP SIGINT SIGQUIT SIGTERM SIGXCPU SIGXFSZ The following signals are ignored: SIGALRM SIGVTALRM SIGPROF SIGUSR1 SIGUSR2 If a signal is captured or simply terminates execution, AppJail per- forms several operations that depend entirely on the subcommand, but some are general: send a SIGTERM (or SIGKILL if SIGTERM has no effect after a while) to all child processes created by the main process and delete temporary files. EXIT STATUS The appjail utility exits 0 on success, and >0 if an error occurs. It may fail for one of the following reasons: - EX_USAGE: The command was not specified. - EX_NOINPUT: The command does not exist. - EX_SOFTWARE: The function responsible for the implementation of the command does not exist. - EX_IOERR: Error creating a ZFS dataset or a directory. - EX_DATAERR: The log name used to record the AppJail session is in- valid. SEE ALSO appjail-tutorial(7) appjail-help(1) appjail-usage(1) sysexits(3) AUTHORS Jess Daniel Colmenares Oviedo <DtxdF@disroot.org> FreeBSD 14.3 March 12, 2024 APPJAIL(1)
NAME | SYNOPSIS | DESCRIPTION | SUBCOMMANDS | SIGNALS | EXIT STATUS | SEE ALSO | AUTHORS
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=appjail&sektion=1&manpath=FreeBSD+14.3-RELEASE+and+Ports>