diff --git a/README.md b/README.md index 056b33da0..73653d123 100644 --- a/README.md +++ b/README.md @@ -49,6 +49,58 @@ FireZone requires a valid SSL certificate and a matching DNS record to run in pr 6. Finally, create an admin user with `sudo firezone-ctl create_admin`. Check the console for the login credentials. 7. Now you should be able to log into the web UI at `https://` +## Usage + +FireZone can be managed via the `firezone-ctl` command, as shown below. Most subcommands require prefixing with `sudo`. + +```shell +I don't know that command. +omnibus-ctl: command (subcommand) +create_admin + Create an Admin user +General Commands: + cleanse + Delete *all* firezone data, and start from scratch. + help + Print this help message. + reconfigure + Reconfigure the application. + show-config + Show the configuration that would be generated by reconfigure. + uninstall + Kill all processes and uninstall the process supervisor (data will be preserved). + version + Display current version of Firezone +Service Management Commands: + graceful-kill + Attempt a graceful stop, then SIGKILL the entire process group. + hup + Send the services a HUP. + int + Send the services an INT. + kill + Send the services a KILL. + once + Start the services if they are down. Do not restart them if they stop. + restart + Stop the services if they are running, then start them again. + service-list + List all the services (enabled services appear with a *.) + start + Start services if they are down, and restart them if they stop. + status + Show the status of all the services. + stop + Stop the services, and do not restart them. + tail + Watch the service logs of all enabled services. + term + Send the services a TERM. + usr1 + Send the services a USR1. + usr2 + Send the services a USR2. +``` ## Architecture