Skip to main content

Freebsd/appjail

@josephholsten/freebsd/appjailv2026.06.12.1· 1d agoMODELS
01README

AppJail jail lifecycle and inventory via SSH on FreeBSD — sync, makejail, ociRun, start, stop, destroy, jexec, logs

02Models1
@josephholsten/freebsd/appjail/jailv2026.06.12.1jail.ts
fn sync()
List all jails and write one resource per jail name
fn makejail(name: string, makejail: string, vars?: record, buildArgs?: record, options?: array, runtimeArgs?: array)
Create a jail from a Makejail source (appjail makejail). No timeout — image pulls can take time.
ArgumentTypeDescription
namestringJail name
makejailstringMakejail source — local path or fetch specifier (e.g. gh+owner/repo)
vars?recordVariables passed as -V key=val
buildArgs?recordBuild arguments passed as -b key=val
options?arrayOptions passed as -o option
runtimeArgs?arrayArguments forwarded to the jail at runtime after --
fn start(name: string)
Start a stopped jail (appjail start)
ArgumentTypeDescription
namestringJail name
fn stop(name: string, force: boolean)
Stop a running jail (appjail stop)
ArgumentTypeDescription
namestringJail name
forcebooleanForce-stop without running stop scripts
fn destroy(name: string, force: boolean)
Destroy a jail and remove its configuration (appjail jail destroy). Refuses if the jail is running unless force is set.
ArgumentTypeDescription
namestringJail name
forcebooleanDestroy even if running (passes -f to appjail jail destroy)
fn ociRun(name: string, image: string, detach: boolean, user?: string, options?: array, env?: record)
Deploy an OCI container as a jail (appjail oci run). No timeout — image pulls can take time.
ArgumentTypeDescription
namestringJail name
imagestringOCI image reference (e.g. ghcr.io/owner/app:latest)
detachbooleanRun in background (-d)
user?stringUser to run as (-u)
options?arrayOptions passed as -o option (e.g. 'overwrite=force', 'virtualnet=:<random> default', 'nat', 'expose=80:80' — expose format is host_port:container_port)
env?recordEnvironment variables passed as -e KEY=VALUE
fn logs(name: string, lines?: number)
Capture recent log output from a jail (appjail logs tail). Note: OCI jails using s6-log (e.g. daemonless.io images) write logs to /config/logs/... inside the jail — use jexec to read those instead.
ArgumentTypeDescription
namestringJail name
lines?numberNumber of lines to show (-n)
fn jexec(name: string, command: array)
Run a command inside a jail via cmd jexec and capture the result
ArgumentTypeDescription
namestringJail name
commandarrayCommand and arguments to run inside the jail

Resources

jail(infinite)— AppJail jail state — status, type, ports, and network addresses
execResult(7d)— Output captured from a command run inside a jail via cmd jexec
03Stats
A
100 / 100
Downloads
0
Archive size
13.0 KB
  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types (deprecated)1/1earned
  • Dependencies pass trust audit2/2earned
  • Has description1/1earned
  • Platform support declared (or universal)2/2earned
  • License declared1/1earned
  • Verified public repository2/2earned
04Platforms
05Labels