diff --git a/docs/chapters/subcommands/console.rst b/docs/chapters/subcommands/console.rst index b1a218eb..966e066c 100644 --- a/docs/chapters/subcommands/console.rst +++ b/docs/chapters/subcommands/console.rst @@ -2,8 +2,7 @@ console ======= -This sub-command launches a login shell into the container. Default is password-less -root login. +This sub-command launches a login shell into the container. Default is password-less root login. .. code-block:: shell @@ -11,6 +10,23 @@ root login. [folsom]: root@folsom:~ # +TARGET can also be a running jails JID value. + + ishmael ~ # bastille list + JID IP Address Hostname Path + 1 10.1.2.3 ishmael /usr/local/bastille/jails/ishmael/root + ishmael ~ # bastille console 1 + [ishmael]: + root@ishmael:~ # + At this point you are logged in to the container and have full shell access. The system is yours to use and/or abuse as you like. Any changes made inside the container are limited to the container. + +.. code-block:: shell + + "Usage: bastille console [option(s)] TARGET [user]" + Options: + + -a | --auto Auto mode. Start/stop jail(s) if required. + -x | --debug Enable debug mode.