mirror of
https://github.com/BastilleBSD/bastille.git
synced 2025-12-11 01:19:52 +01:00
add mor man pages
bastille bootstrap clone config cmd
This commit is contained in:
@@ -1,6 +1,8 @@
|
||||
bootstrap
|
||||
=========
|
||||
|
||||
Bootstrap a release or template(s).
|
||||
|
||||
The bootstrap sub-command is used to download and extract releases and templates
|
||||
for use with Bastille containers. A valid release is needed before containers
|
||||
can be created. Templates are optional but are managed in the same manner.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
clone
|
||||
=====
|
||||
|
||||
Clone/duplicate an existing jail to a new jail.
|
||||
Clone an existing jail.
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
@@ -19,6 +19,6 @@ Limitations
|
||||
|
||||
Options:
|
||||
|
||||
-a | --auto Auto mode. Start/stop jail(s) if required. Cannot be used with [-l|--live].
|
||||
-l | --live Clone a running jail (ZFS only). Cannot be used with [-a|--auto].
|
||||
-x | --debug Enable debug mode.
|
||||
-a | --auto Auto mode. Start/stop jail(s) if required. Cannot be used with [-l|--live].
|
||||
-l | --live Clone a running jail (ZFS only). Cannot be used with [-a|--auto].
|
||||
-x | --debug Enable debug mode.
|
||||
@@ -1,7 +1,7 @@
|
||||
cmd
|
||||
===
|
||||
|
||||
Execute commands inside targeted jail(s).
|
||||
Execute command inside targeted jail(s).
|
||||
|
||||
.. code-block:: shell
|
||||
|
||||
@@ -19,5 +19,5 @@ Execute commands inside targeted jail(s).
|
||||
|
||||
Options:
|
||||
|
||||
-a | --auto Auto mode. Start/stop jail(s) if required.
|
||||
-x | --debug Enable debug mode.
|
||||
-a | --auto Auto mode. Start/stop jail(s) if required.
|
||||
-x | --debug Enable debug mode.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
config
|
||||
======
|
||||
|
||||
Get, set or remove properties from targeted jail(s).
|
||||
Get, set, add or remove properties from targeted jail(s).
|
||||
|
||||
Getting a property that *is* defined in jail.conf:
|
||||
|
||||
@@ -38,7 +38,8 @@ The restart message will appear every time a property is removed.
|
||||
.. code-block:: shell
|
||||
|
||||
ishmael ~ # bastille config help
|
||||
Usage: bastille config [option(s)] TARGET [get|(set|add)|remove] PROPERTY [VALUE]
|
||||
Usage: bastille config [option(s)] TARGET set|add PROPERTY [VALUE]
|
||||
get|remove PROPERTY
|
||||
|
||||
Options:
|
||||
|
||||
|
||||
@@ -11,10 +11,10 @@ Usage
|
||||
bastille [option(s)] command [option(s)] TARGET ARGS
|
||||
|
||||
Available Commands:
|
||||
bootstrap Bootstrap a release for jail base.
|
||||
bootstrap Bootstrap a release or template(s).
|
||||
clone Clone an existing jail.
|
||||
cmd Execute arbitrary command on targeted jail(s).
|
||||
config Get, set or remove a config value for the targeted jail(s).
|
||||
cmd Execute command inside targeted jail(s).
|
||||
config Get, set, add or remove properties from targeted jail(s).
|
||||
console Console into a jail.
|
||||
convert Convert thin jail to thick jail, or convert a jail to a custom release.
|
||||
cp cp(1) files from host to targeted jail(s).
|
||||
|
||||
@@ -76,10 +76,10 @@ Usage:
|
||||
bastille [option(s)] command [option(s)] TARGET ARGS
|
||||
|
||||
Available Commands:
|
||||
bootstrap Bootstrap a release for jail base.
|
||||
bootstrap Bootstrap a release or template(s).
|
||||
clone Clone an existing jail.
|
||||
cmd Execute arbitrary command on targeted jail(s).
|
||||
config Get, set or remove a config value for the targeted jail(s).
|
||||
cmd Execute command inside targeted jail(s).
|
||||
config Get, set, add or remove properties from targeted jail(s).
|
||||
console Console into a jail.
|
||||
convert Convert thin jail to thick jail, or convert a jail to a custom release.
|
||||
cp cp(1) files from host to targeted jail(s).
|
||||
|
||||
@@ -38,9 +38,9 @@ usage() {
|
||||
|
||||
Options:
|
||||
|
||||
-a | --auto Auto mode. Start/stop jail(s) if required. Cannot be used with [-l|--live].
|
||||
-l | --live Clone a running jail (ZFS only). Cannot be used with [-a|--auto].
|
||||
-x | --debug Enable debug mode.
|
||||
-a | --auto Auto mode. Start/stop jail(s) if required. Cannot be used with [-l|--live].
|
||||
-l | --live Clone a running jail (ZFS only). Cannot be used with [-a|--auto].
|
||||
-x | --debug Enable debug mode.
|
||||
|
||||
EOF
|
||||
exit 1
|
||||
|
||||
@@ -38,8 +38,8 @@ usage() {
|
||||
|
||||
Options:
|
||||
|
||||
-a | --auto Auto mode. Start/stop jail(s) if required.
|
||||
-x | --debug Enable debug mode.
|
||||
-a | --auto Auto mode. Start/stop jail(s) if required.
|
||||
-x | --debug Enable debug mode.
|
||||
|
||||
EOF
|
||||
exit 1
|
||||
|
||||
@@ -34,7 +34,8 @@
|
||||
|
||||
|
||||
usage() {
|
||||
error_notify "Usage: bastille config [option(s)] TARGET [get|(set|add)|remove] PROPERTY [VALUE]"
|
||||
error_notify "Usage: bastille config [option(s)] TARGET set|add PROPERTY [VALUE]"
|
||||
error_notify " get|remove PROPERTY"
|
||||
cat << EOF
|
||||
|
||||
Options:
|
||||
|
||||
@@ -5,19 +5,19 @@
|
||||
.Nm bastille bootstrap
|
||||
.Nd bootstrap a release or template(s)
|
||||
.Sh SYNOPSIS
|
||||
.Nm bastille bootstrap -h
|
||||
.Nm bastille bootstrap
|
||||
.Nm
|
||||
.Op Fl px
|
||||
.Ar RELEASE Op update|arch
|
||||
.Nm bastille bootstrap
|
||||
.Ar RELEASE
|
||||
.Op Cm update|arch
|
||||
.Nm
|
||||
.Op Fl x
|
||||
.Ar TEMPLATE
|
||||
.Sh DESCRIPTION
|
||||
.Nm bastille bootstrap
|
||||
will bootstrap a release for to use when creating jails. It will
|
||||
.Nm
|
||||
will bootstrap a release to use when creating jails. It will
|
||||
also fetch and verify templates if a url is given as an arguement.
|
||||
.Bl -tag -width Ds
|
||||
.It bootstrap Oo Fl px Oc Ar RELEASE Op update|ARCH
|
||||
.It bootstrap Oo Fl px Oc Ar RELEASE Op Cm update|ARCH
|
||||
.Bl -tag -width Ds
|
||||
.It Fl p , Fl -pkgbase
|
||||
Bootstrap a release using PkgBase package sets. By default Bastille
|
||||
@@ -38,13 +38,6 @@ use cases.
|
||||
.Bl -tag -width Ds
|
||||
.It Fl x , Fl -debug
|
||||
Enable debug mode.
|
||||
.El
|
||||
.El
|
||||
.Sh OPTIONS
|
||||
.Bl -tag -width Ds
|
||||
.It Fl h , Fl -help
|
||||
Print usage information.
|
||||
.El
|
||||
.Sh EXAMPLES
|
||||
.Bl -tag -width Ds
|
||||
.It Bootstrap 15.0-RELEASE:
|
||||
@@ -53,43 +46,41 @@ Print usage information.
|
||||
.Nm bastille bootstrap https://github.com/BastilleBSD/templates
|
||||
.It Bootstrap 15.0-RELEASE using PkgBase:
|
||||
.Nm bastille bootstrap -p 15.0-RELEASE
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr bastille.conf 1
|
||||
.Xr bastille-bootstrap 1
|
||||
.Xr bastille-clone 1
|
||||
.Xr bastille-cmd 1
|
||||
.Xr bastille-config 1
|
||||
.Xr bastille-console 1
|
||||
.Xr bastille-convert 1
|
||||
.Xr bastille-cp 1
|
||||
.Xr bastille-create 1
|
||||
.Xr bastille-destroy 1
|
||||
.Xr bastille-edit 1
|
||||
.Xr bastille-etcupdate 1
|
||||
.Xr bastille-export 1
|
||||
.Xr bastille-htop 1
|
||||
.Xr bastille-import 1
|
||||
.Xr bastille-jcp 1
|
||||
.Xr bastille-limits 1
|
||||
.Xr bastille-list 1
|
||||
.Xr bastille-migrate 1
|
||||
.Xr bastille-mount 1
|
||||
.Xr bastille-network 1
|
||||
.Xr bastille-pkg 1
|
||||
.Xr bastille-rcp 1
|
||||
.Xr bastille-rdr 1
|
||||
.Xr bastille-rename 1
|
||||
.Xr bastille-restart 1
|
||||
.Xr bastille-service 1
|
||||
.Xr bastille-setup 1
|
||||
.Xr bastille-start 1
|
||||
.Xr bastille-stop 1
|
||||
.Xr bastille-sysrc 1
|
||||
.Xr bastille-tags 1
|
||||
.Xr bastille-top 1
|
||||
.Xr bastille-umount 1
|
||||
.Xr bastille-update 1
|
||||
.Xr bastille-upgrade
|
||||
.Xr bastille-verify 1
|
||||
.Xr bastille-zfs 1
|
||||
.Xr bastille.conf 5 ,
|
||||
.Xr bastille-clone 1 ,
|
||||
.Xr bastille-cmd 1 ,
|
||||
.Xr bastille-config 1 ,
|
||||
.Xr bastille-console 1 ,
|
||||
.Xr bastille-convert 1 ,
|
||||
.Xr bastille-cp 1 ,
|
||||
.Xr bastille-create 1 ,
|
||||
.Xr bastille-destroy 1 ,
|
||||
.Xr bastille-edit 1 ,
|
||||
.Xr bastille-etcupdate 1 ,
|
||||
.Xr bastille-export 1 ,
|
||||
.Xr bastille-htop 1 ,
|
||||
.Xr bastille-import 1 ,
|
||||
.Xr bastille-jcp 1 ,
|
||||
.Xr bastille-limits 1 ,
|
||||
.Xr bastille-list 1 ,
|
||||
.Xr bastille-migrate 1 ,
|
||||
.Xr bastille-mount 1 ,
|
||||
.Xr bastille-network 1 ,
|
||||
.Xr bastille-pkg 1 ,
|
||||
.Xr bastille-rcp 1 ,
|
||||
.Xr bastille-rdr 1 ,
|
||||
.Xr bastille-rename 1 ,
|
||||
.Xr bastille-restart 1 ,
|
||||
.Xr bastille-service 1 ,
|
||||
.Xr bastille-setup 1 ,
|
||||
.Xr bastille-start 1 ,
|
||||
.Xr bastille-stop 1 ,
|
||||
.Xr bastille-sysrc 1 ,
|
||||
.Xr bastille-tags 1 ,
|
||||
.Xr bastille-top 1 ,
|
||||
.Xr bastille-umount 1 ,
|
||||
.Xr bastille-update 1 ,
|
||||
.Xr bastille-upgrade 1 ,
|
||||
.Xr bastille-verify 1 ,
|
||||
.Xr bastille-zfs 1 ,
|
||||
75
usr/local/share/man/man1/bastille-clone.1
Normal file
75
usr/local/share/man/man1/bastille-clone.1
Normal file
@@ -0,0 +1,75 @@
|
||||
.Dd 2025/12/04
|
||||
.Dt bastille-clone 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm bastille clone
|
||||
.Nd clone an existing jail
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl alx
|
||||
.Ar TARGET NEW_NAME IP
|
||||
.Sh DESCRIPTION
|
||||
.Nm
|
||||
will create an exact duplicate of the targeted jail, giving it
|
||||
the specified
|
||||
.Ar NEW_NAME
|
||||
and
|
||||
.Ar IP address .
|
||||
.Ss OPTIONS
|
||||
.Bl -tag -width Ds
|
||||
.It Fl a , Fl -auto
|
||||
Instead of printing an error stating that the jail needs to be
|
||||
stopped, this option will simply stop the jail (if running) before
|
||||
proceeding to clone it. Cannot be used with
|
||||
.Sy -l|--live .
|
||||
.It Fl l , Fl -live
|
||||
Attempt to clone a running jail (ZFS only). Cannot be used with
|
||||
.Sy -a|--auto .
|
||||
.It Fl x , Fl -debug
|
||||
Enable debug mode.
|
||||
.Sh EXAMPLES
|
||||
.Bl -tag -width Ds
|
||||
.It Clone myjail to newjail:
|
||||
.Sy bastille clone myjail newjail 10.23.3.4/24
|
||||
.It Clone myjail to newjail with DHCP (VNET only):
|
||||
.Sy bastille clone myjail newjail DHCP
|
||||
.It Clone myjail to newjail while running, with debug mode:
|
||||
.Sy bastille clone -xl myjail newjail 10.23.3.4/24
|
||||
.Sh SEE ALSO
|
||||
.Xr bastille.conf 5 ,
|
||||
.Xr bastille-bootstrap 1 ,
|
||||
.Xr bastille-cmd 1 ,
|
||||
.Xr bastille-config 1 ,
|
||||
.Xr bastille-console 1 ,
|
||||
.Xr bastille-convert 1 ,
|
||||
.Xr bastille-cp 1 ,
|
||||
.Xr bastille-create 1 ,
|
||||
.Xr bastille-destroy 1 ,
|
||||
.Xr bastille-edit 1 ,
|
||||
.Xr bastille-etcupdate 1 ,
|
||||
.Xr bastille-export 1 ,
|
||||
.Xr bastille-htop 1 ,
|
||||
.Xr bastille-import 1 ,
|
||||
.Xr bastille-jcp 1 ,
|
||||
.Xr bastille-limits 1 ,
|
||||
.Xr bastille-list 1 ,
|
||||
.Xr bastille-migrate 1 ,
|
||||
.Xr bastille-mount 1 ,
|
||||
.Xr bastille-network 1 ,
|
||||
.Xr bastille-pkg 1 ,
|
||||
.Xr bastille-rcp 1 ,
|
||||
.Xr bastille-rdr 1 ,
|
||||
.Xr bastille-rename 1 ,
|
||||
.Xr bastille-restart 1 ,
|
||||
.Xr bastille-service 1 ,
|
||||
.Xr bastille-setup 1 ,
|
||||
.Xr bastille-start 1 ,
|
||||
.Xr bastille-stop 1 ,
|
||||
.Xr bastille-sysrc 1 ,
|
||||
.Xr bastille-tags 1 ,
|
||||
.Xr bastille-top 1 ,
|
||||
.Xr bastille-umount 1 ,
|
||||
.Xr bastille-update 1 ,
|
||||
.Xr bastille-upgrade 1 ,
|
||||
.Xr bastille-verify 1 ,
|
||||
.Xr bastille-zfs 1 ,
|
||||
64
usr/local/share/man/man1/bastille-cmd.1
Normal file
64
usr/local/share/man/man1/bastille-cmd.1
Normal file
@@ -0,0 +1,64 @@
|
||||
.Dd 2025/12/04
|
||||
.Dt bastille-cmd 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm bastille cmd
|
||||
.Nd execute commands inside targeted jail(s)
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl ax
|
||||
.Ar TARGET COMMAND
|
||||
.Sh DESCRIPTION
|
||||
.Nm
|
||||
will run the specified command inside targeted jail(s)
|
||||
.Ss OPTIONS
|
||||
.Bl -tag -width Ds
|
||||
.It Fl a , Fl -auto
|
||||
Instead of printing an error stating that the jail needs to be
|
||||
running, this option will simply start the jail (if stopped) before
|
||||
proceeding to run the command inside it.
|
||||
.It Fl x , Fl -debug
|
||||
Enable debug mode.
|
||||
.Sh EXAMPLES
|
||||
.Bl -tag -width Ds
|
||||
.It List contents of /etc:
|
||||
.Sy bastille cmd TARGET ls /etc
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr bastille.conf 5 ,
|
||||
.Xr bastille-bootstrap 1 ,
|
||||
.Xr bastille-clone 1 ,
|
||||
.Xr bastille-config 1 ,
|
||||
.Xr bastille-console 1 ,
|
||||
.Xr bastille-convert 1 ,
|
||||
.Xr bastille-cp 1 ,
|
||||
.Xr bastille-create 1 ,
|
||||
.Xr bastille-destroy 1 ,
|
||||
.Xr bastille-edit 1 ,
|
||||
.Xr bastille-etcupdate 1 ,
|
||||
.Xr bastille-export 1 ,
|
||||
.Xr bastille-htop 1 ,
|
||||
.Xr bastille-import 1 ,
|
||||
.Xr bastille-jcp 1 ,
|
||||
.Xr bastille-limits 1 ,
|
||||
.Xr bastille-list 1 ,
|
||||
.Xr bastille-migrate 1 ,
|
||||
.Xr bastille-mount 1 ,
|
||||
.Xr bastille-network 1 ,
|
||||
.Xr bastille-pkg 1 ,
|
||||
.Xr bastille-rcp 1 ,
|
||||
.Xr bastille-rdr 1 ,
|
||||
.Xr bastille-rename 1 ,
|
||||
.Xr bastille-restart 1 ,
|
||||
.Xr bastille-service 1 ,
|
||||
.Xr bastille-setup 1 ,
|
||||
.Xr bastille-start 1 ,
|
||||
.Xr bastille-stop 1 ,
|
||||
.Xr bastille-sysrc 1 ,
|
||||
.Xr bastille-tags 1 ,
|
||||
.Xr bastille-top 1 ,
|
||||
.Xr bastille-umount 1 ,
|
||||
.Xr bastille-update 1 ,
|
||||
.Xr bastille-upgrade 1 ,
|
||||
.Xr bastille-verify 1 ,
|
||||
.Xr bastille-zfs 1 ,
|
||||
84
usr/local/share/man/man1/bastille-config.1
Normal file
84
usr/local/share/man/man1/bastille-config.1
Normal file
@@ -0,0 +1,84 @@
|
||||
.Dd 2025/12/04
|
||||
.Dt bastille-config 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm bastille config
|
||||
.Nd get, set, add or remove properties from targeted jail(s)
|
||||
.Sh SYNOPSIS
|
||||
.Nm
|
||||
.Op Fl x
|
||||
.Cm set|add
|
||||
.Ar PROPERTY
|
||||
.Op VALUE
|
||||
.Nm
|
||||
.Op Fl x
|
||||
.Cm get|remove
|
||||
.Ar PROPERTY
|
||||
.Sh DESCRIPTION
|
||||
.Nm
|
||||
can modify targeted jail(s) configuration and
|
||||
get, set, add or remove properties.
|
||||
.Ss ACTIONS
|
||||
.Bl -tag -width Ds
|
||||
.It Sy set
|
||||
Set the value of the specified property from the jail configuration.
|
||||
If the property is not set, it will be added and set. The VALUE part
|
||||
is optional for some values. For example, allow.mlock does not need
|
||||
a VALUE, but it won't do any harm to set it as 1 (enable).
|
||||
.It Sy add
|
||||
Same as
|
||||
.Sy set .
|
||||
.It Sy get
|
||||
Get the value of the specified property from the jail configuration.
|
||||
.It Sy remove
|
||||
Remove the specified property from the jail configuration.
|
||||
.Ss OPTIONS
|
||||
.Bl -tag -width Ds
|
||||
.It Fl x , -debug
|
||||
Enable debug mode.
|
||||
.Sh EXAMPLES
|
||||
.Bl -tag -width Ds
|
||||
.It Set allow.mlock inside myjail:
|
||||
.Sy bastille config myjail set allow.mlock 1
|
||||
.It Set to priority value of myjail:
|
||||
.Sy bastille config myjail set priority 10
|
||||
.It Set the boot value:
|
||||
.Sy bastille config myjail set boot off
|
||||
.Sh SEE ALSO
|
||||
.Xr bastille.conf 5 ,
|
||||
.Xr bastille-bootstrap 1 ,
|
||||
.Xr bastille-clone 1 ,
|
||||
.Xr bastille-cmd 1 ,
|
||||
.Xr bastille-console 1 ,
|
||||
.Xr bastille-convert 1 ,
|
||||
.Xr bastille-cp 1 ,
|
||||
.Xr bastille-create 1 ,
|
||||
.Xr bastille-destroy 1 ,
|
||||
.Xr bastille-edit 1 ,
|
||||
.Xr bastille-etcupdate 1 ,
|
||||
.Xr bastille-export 1 ,
|
||||
.Xr bastille-htop 1 ,
|
||||
.Xr bastille-import 1 ,
|
||||
.Xr bastille-jcp 1 ,
|
||||
.Xr bastille-limits 1 ,
|
||||
.Xr bastille-list 1 ,
|
||||
.Xr bastille-migrate 1 ,
|
||||
.Xr bastille-mount 1 ,
|
||||
.Xr bastille-network 1 ,
|
||||
.Xr bastille-pkg 1 ,
|
||||
.Xr bastille-rcp 1 ,
|
||||
.Xr bastille-rdr 1 ,
|
||||
.Xr bastille-rename 1 ,
|
||||
.Xr bastille-restart 1 ,
|
||||
.Xr bastille-service 1 ,
|
||||
.Xr bastille-setup 1 ,
|
||||
.Xr bastille-start 1 ,
|
||||
.Xr bastille-stop 1 ,
|
||||
.Xr bastille-sysrc 1 ,
|
||||
.Xr bastille-tags 1 ,
|
||||
.Xr bastille-top 1 ,
|
||||
.Xr bastille-umount 1 ,
|
||||
.Xr bastille-update 1 ,
|
||||
.Xr bastille-upgrade 1 ,
|
||||
.Xr bastille-verify 1 ,
|
||||
.Xr bastille-zfs 1 ,
|
||||
@@ -1,14 +1,14 @@
|
||||
.Dd 2025/08/27
|
||||
.Dd 2025/12/04
|
||||
.Dt bastille 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm bastille
|
||||
.Nd Open-source jail automation and management tool
|
||||
.Nd open-source jail automation and management tool
|
||||
.Sh SYNOPSIS
|
||||
.Nm bastille
|
||||
.Nm
|
||||
.Op Fl vh
|
||||
.Op Fl c Ar file
|
||||
.Ar command
|
||||
.Ar COMMAND
|
||||
.Op option(s)
|
||||
.Ar TARGET
|
||||
.Ar ARGS
|
||||
@@ -17,100 +17,95 @@ Bastille is an open-source system for automating deployment
|
||||
and management of containerized applications on FreeBSD
|
||||
using the jail framework.
|
||||
.Sh OPTIONS
|
||||
The following options are supported by
|
||||
.Nm :
|
||||
.Bl -tag -width Ds
|
||||
.It Fl c Ar file , Fl -config Ar file
|
||||
Specify a non-default config file to use. Must be placed
|
||||
inside the Bastille config directory.
|
||||
.It Fl h , Fl -help
|
||||
Display usage information.
|
||||
Display usage information. This option is also available for each
|
||||
sub-command, though they are not listed in the man pages.
|
||||
.It Fl v , Fl -version
|
||||
Print version information.
|
||||
.El
|
||||
.Sh SUBCOMMANDS
|
||||
The following commands are supported by
|
||||
.Nm :
|
||||
.Bl -tag -width Ds
|
||||
.It Nm bootstrap
|
||||
Bootstrap a FreeBSD release for jail base.
|
||||
.It Nm clone
|
||||
.It Sy bootstrap
|
||||
Bootstrap a release or template(s).
|
||||
.It Sy clone
|
||||
Clone an existing jail.
|
||||
.It Nm cmd
|
||||
.It Sy cmd
|
||||
Execute arbitrary command on targeted jail(s).
|
||||
.It Nm config
|
||||
Get, set or remove a config value for the targeted jail(s).
|
||||
.It Nm console
|
||||
.It Sy config
|
||||
Get, set, add or remove properties from targeted jail(s).
|
||||
.It Sy console
|
||||
Console into a jail.
|
||||
.It Nm convert
|
||||
.It Sy convert
|
||||
Convert thin jail to thick jail, or convert a jail to a custom release.
|
||||
.It Nm cp
|
||||
.It Sy cp
|
||||
cp(1) files from host to targeted jail(s).
|
||||
.It Nm create
|
||||
.It Sy create
|
||||
Create a jail.
|
||||
.It Nm destroy
|
||||
.It Sy destroy
|
||||
Destroy a jail or release
|
||||
.It Nm edit
|
||||
.It Sy edit
|
||||
Edit jail configuration files (advanced).
|
||||
.It Nm export
|
||||
.It Sy export
|
||||
Exports a jail.
|
||||
.It Nm help
|
||||
.It Sy help
|
||||
Help about any command.
|
||||
.It Nm htop
|
||||
.It Sy htop
|
||||
Interactive process viewer (requires htop).
|
||||
.It Nm import
|
||||
.It Sy import
|
||||
Import a jail.
|
||||
.It Nm jcp
|
||||
.It Sy jcp
|
||||
cp(1) files from a jail to jail(s).
|
||||
.It Nm limits
|
||||
.It Sy limits
|
||||
Apply resources limits to targeted container(s). See rctl(8).
|
||||
.It Nm list
|
||||
.It Sy list
|
||||
List jails, releases, templates and more...
|
||||
.It Nm migrate
|
||||
.It Sy migrate
|
||||
Migrate targeted jail(s) to a remote system.
|
||||
.It Nm mount
|
||||
.It Sy mount
|
||||
Mount a volume inside targeted jail(s).
|
||||
.It Nm network
|
||||
.It Sy network
|
||||
Add or remove interfaces from targeted jail(s).
|
||||
.It Nm pkg
|
||||
.It Sy pkg
|
||||
Manipulate binary packages within targeted container(s). See pkg(8).
|
||||
.It Nm rcp
|
||||
.It Sy rcp
|
||||
cp(1) files from a jail to host.
|
||||
.It Nm rdr
|
||||
.It Sy rdr
|
||||
Redirect host port to container port.
|
||||
.It Nm rename
|
||||
.It Sy rename
|
||||
Rename a jail.
|
||||
.It Nm restart
|
||||
.It Sy restart
|
||||
Restart a running container.
|
||||
.It Nm service
|
||||
.It Sy service
|
||||
Manage services within targeted jail(s).
|
||||
.It Nm setup
|
||||
.It Sy setup
|
||||
Attempt to auto-configure network, firewall and storage and more...
|
||||
.It Nm start
|
||||
.It Sy start
|
||||
Start stopped jail(s).
|
||||
.It Nm stop
|
||||
.It Sy stop
|
||||
Stop running jail(s).
|
||||
.It Nm sysrc
|
||||
.It Sy sysrc
|
||||
Safely edit rc files within targeted jail(s).
|
||||
.It Nm tags
|
||||
.It Sy tags
|
||||
Add or remove tags to targeted jail(s).
|
||||
.It Nm template
|
||||
.It Sy template
|
||||
Apply file templates to targeted jail(s).
|
||||
.It Nm top
|
||||
.It Sy top
|
||||
Display and update information about the top(1) cpu processes.
|
||||
.It Nm umount
|
||||
.It Sy umount
|
||||
Unmount a volume from targeted jail(s).
|
||||
.It Nm update
|
||||
.It Sy update
|
||||
Update a jail or release.
|
||||
.It Nm upgrade
|
||||
.It Sy upgrade
|
||||
Upgrade a jail to new X.Y-RELEASE.
|
||||
.It Nm verify
|
||||
.It Sy verify
|
||||
Compare release against a "known good" index.
|
||||
.It Nm zfs
|
||||
.It Sy zfs
|
||||
Manage (get|set) zfs attributes on targeted jail(s).
|
||||
.El
|
||||
.Sh SEE ALSO
|
||||
.Xr bastille.conf 1
|
||||
.Xr bastille.conf 5
|
||||
.Xr bastille-bootstrap 1
|
||||
.Xr bastille-clone 1
|
||||
.Xr bastille-cmd 1
|
||||
|
||||
@@ -1,133 +0,0 @@
|
||||
.Dd 2025/12/04
|
||||
.Dt bastille.conf 1
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm bastille.conf
|
||||
.Nd configuration file for Bastille
|
||||
.SH SYNOPSIS
|
||||
.Nm /usr/local/etc/bastille/bastille.conf
|
||||
.Sh DESCRIPTION
|
||||
Bastille has most options preconfigured with sane defaults. These
|
||||
can be adjusted to fit your environment.
|
||||
.Sh DEFAULT PATH CONFIGURATION
|
||||
.Bl -tag -width Ds
|
||||
.It Nm bastille_prefix
|
||||
This is the main Bastille prefix. All Bastille directories, excluding
|
||||
.Nm bastille_logsdir
|
||||
will start with this prefix.
|
||||
.Pp
|
||||
If zfs is enabled, this will become the mount point of the zfs dataset.
|
||||
.Pp
|
||||
The following directories, excluding
|
||||
.Nm bastille_logsdir
|
||||
will be prefixed by
|
||||
.Nm basatille_prefix .
|
||||
If zfs is enabled, they will inherit the mount point of
|
||||
.Nm bastille_prefix .
|
||||
.It Nm bastille_backupsdir
|
||||
Bastille will store backups and exports here.
|
||||
.It Nm bastille_cachedir
|
||||
Bastille will store cache here.
|
||||
.It Nm bastille_jailsdir
|
||||
Bastille will store jails here.
|
||||
.It Nm bastille_releasesdir
|
||||
Bastille will store releases here.
|
||||
.It Nm bastille_templatesdir
|
||||
Bastille will store templates here.
|
||||
.It Nm bastille_logsdir
|
||||
Bastille will store jail console logs here.
|
||||
.El
|
||||
.Sh FIREWALL CONFIGURATION
|
||||
.Bl -tag -width Ds
|
||||
.It Nm bastille_pf_conf
|
||||
Path to the pf firewall configuration file.
|
||||
.El
|
||||
.Sh SHARE DIRECTORY CONFIGURATION
|
||||
.Bl -tag -width Ds
|
||||
.It Nm bastille_sharedir
|
||||
This is the path where Bastille expects sub-commands to live at.
|
||||
.El
|
||||
.Sh BOOTSTRAP CONFIGURATION
|
||||
.Bl -tag -width Ds
|
||||
.It Nm bastille_bootstrap_archives
|
||||
This is a whitespace-separated list of distribution sets to fetch
|
||||
when bootstrapping a legacy (non-pkgbase) release.
|
||||
.It Nm bastille_pkgbase_packages
|
||||
This is a whitespace-separated list of package sets to install
|
||||
when bootstrapping a release using PkgBase.
|
||||
.It Nm bastille_url_freebsd
|
||||
Url from which to fetch legacy distributions sets when bootstrapping
|
||||
a FreeBSD release.
|
||||
.It Nm bastille_url_hardenedbsd
|
||||
Url from which to fetch legacy distributions sets when bootstrapping
|
||||
a HardenedBSD release.
|
||||
.It Nm bastille_url_midnightbsd
|
||||
Url from which to fetch legacy distributions sets when bootstrapping
|
||||
a MidnightBSD release.
|
||||
.El
|
||||
.Sh TIMEZONE CONFIGURATION
|
||||
.Bl -tag -width Ds
|
||||
.It Nm bastille_tzdata
|
||||
Set the timezone to apply to newly created jails.
|
||||
.El
|
||||
.Sh RESOLV.CONF CONFIGURATION
|
||||
.Bl -tag -width Ds
|
||||
.It Nm bastille_resolv_conf
|
||||
This file is copied into newly created jails to allow them
|
||||
to reach DNS.
|
||||
.El
|
||||
.Sh ZFS CONFIGURATION
|
||||
.Bl -tag -width Ds
|
||||
.It Nm bastille_zfs_enable
|
||||
Whether to enable or disable zfs support.
|
||||
.It Nm bastille_zfs_zpool
|
||||
Which zpool to use when zfs is enabled.
|
||||
.It Nm bastille_zfs_prefix
|
||||
Which dataset to use when zfs is enabled. Do not include the zpool
|
||||
here.
|
||||
.It Nm bastille_zfs_options
|
||||
Zfs options to use when creating any and all datasets for any and all
|
||||
supported actions.
|
||||
|
||||
|
||||
|
||||
|
||||
.Sh SEE ALSO
|
||||
.Xr bastille.conf 1
|
||||
.Xr bastille-bootstrap 1
|
||||
.Xr bastille-clone 1
|
||||
.Xr bastille-cmd 1
|
||||
.Xr bastille-config 1
|
||||
.Xr bastille-console 1
|
||||
.Xr bastille-convert 1
|
||||
.Xr bastille-cp 1
|
||||
.Xr bastille-create 1
|
||||
.Xr bastille-destroy 1
|
||||
.Xr bastille-edit 1
|
||||
.Xr bastille-etcupdate 1
|
||||
.Xr bastille-export 1
|
||||
.Xr bastille-htop 1
|
||||
.Xr bastille-import 1
|
||||
.Xr bastille-jcp 1
|
||||
.Xr bastille-limits 1
|
||||
.Xr bastille-list 1
|
||||
.Xr bastille-migrate 1
|
||||
.Xr bastille-mount 1
|
||||
.Xr bastille-network 1
|
||||
.Xr bastille-pkg 1
|
||||
.Xr bastille-rcp 1
|
||||
.Xr bastille-rdr 1
|
||||
.Xr bastille-rename 1
|
||||
.Xr bastille-restart 1
|
||||
.Xr bastille-service 1
|
||||
.Xr bastille-setup 1
|
||||
.Xr bastille-start 1
|
||||
.Xr bastille-stop 1
|
||||
.Xr bastille-sysrc 1
|
||||
.Xr bastille-tags 1
|
||||
.Xr bastille-top 1
|
||||
.Xr bastille-umount 1
|
||||
.Xr bastille-update 1
|
||||
.Xr bastille-upgrade
|
||||
.Xr bastille-verify 1
|
||||
.Xr bastille-zfs 1
|
||||
Reference in New Issue
Block a user