LXDUI's CLI

lxdui - the cli

In version 2.0 of LXDUI a new CLI was introduced to aid in the configuration and management of the application. The CLI was abbreviated to lui (because we hate typing long commands :)) form the original lui to keep it more in line with the lxc, and lxd command set, but this created an issue when creating executable binary for snapcraft so in version 2.1 the CLI was renamed to lxdui (how original!).

The CLI has five (5) primary functions.

1. Application initialization - init
2. Application lifecycle management - start, stop, restart, status
3. Configuration Management - config
4. Certificate Management (SSL) - cert
5. User Management - user

CLI Commands

lxdui init -- configures lxdui upon first use - admin password, generate certs

lxdui start -- start the app and display the endpoint URL http://hostname:port

lxdui stop -- stop the app

lxdui restart -- restart the app

lxdui status -- show the pid and the http endpoint for the UI http://hostname:port

lxdui config show -- print out running config to console

lxdui config set -c <path_to_conf_file> -- use external conf file

lxdui config set <key> <value> -- set the value for a configuration key

lxdui cert add -- add existing certs from file path

lxdui cert create -- generate new SSL certs (overwrite old files)

lxdui cert list -- list SSL certs

lxdui cert delete -- remove SSL certs

lxdui user add -u <username> -p <password> -- create a new user that can access the UI

lxdui user update -u <username> -p <password> -- the user specified in lxdui.admin.user can't be deleted

lxdui user delete -u <username> -- remove a user from the auth file

lxdui user list -- list the users in the auth file