Skip to content
Pages in Reference

noust console

Publish the console on a name of its own, over TLS, or take it off again.

Reference Updated View as Markdown
Shell
noust console [OPTIONS] COMMAND [ARGS]...

Subcommands: expose, status, unexpose

noust console expose

Open the console at https://DOMAIN, with a certificate, instead of an SSH tunnel.

Shell
noust console expose [OPTIONS]
Option What it does Default
--domain The public name, already pointing at this server (console.example.com).
--allow-ip Only these addresses or networks may reach the console. Repeatable. Without it anyone can open the sign-in page; the second factor is then all that stops them.
--force-ens Publish although the ENS profile is on (it keeps the console on loopback). Asks for confirmation, needs --allow-ip, and is audited.
--skip-dns-check Do not require the name to resolve to this server's addresses (a server behind NAT).
-y, --yes Do not ask for confirmation.
--json Print the outcome as JSON.
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust console status

Show whether the console is published, where, and whether it is still in place.

Shell
noust console status [OPTIONS]
Option What it does Default
--json Print the state as JSON.
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

noust console unexpose

Take the console off its public name, back to an SSH tunnel only.

Shell
noust console unexpose [OPTIONS]
Option What it does Default
-y, --yes Do not ask for confirmation.
--json Print the outcome as JSON.
--reason Why this change is made (a change reference, a ticket). Recorded with the command in the audit log; required only where a compliance framework asks for it (ENS) or security.change_reasons is on.

Something on this page is wrong or unclear? Report it on GitHub.

Help, contributing and the project’s policies are under Project.

Search the documentation

Type to search every page.

↑ ↓ to move, Enter to open, Esc to close