Zum Hauptinhalt springen

Command-Line Usage of opentalk-controller

When started without a subcommand, the opentalk-controller command loads the configuration and starts as a service, serving incoming connections using the included HTTP server.

In addition, some subcommands are available for management tasks.

Subcommands​

These subcommands are available:

  • fix-acl for recreating all ACL entries of the database.
  • acl for modification of ACL settings.
  • migrate-db for explicit migration of database without starting the controller service
  • tenants for managing tenants.
  • tariffs for managing tariffs.
  • jobs for configuring and running maintenance jobs.
  • modules for managing modules.
  • openapi for exporting the OpenAPI specification.
  • help for showing the help output.

Raw help output​

Help output looks like this:

Usage: opentalk-controller [OPTIONS] [COMMAND]

Commands:
  fix-acl     Recreate all ACL entries from the current database content. Existing entries will not be touched unless the command is told to delete them all beforehand
  acl         Modify the ACLs
  migrate-db  Migrate the db. This is done automatically during start of the controller, but can be done without starting the controller using this command
  tenants     Manage existing tenants
  tariffs     Manage tariffs
  jobs        Manage and execute maintenance jobs
  modules     Manage modules
  openapi     Get information on the OpenAPI specification
  help        Print this message or the help of the given subcommand(s)

Options:
  -c, --config <CONFIG>
          Path of the configuration file.

          If present, exactly this config file will be used.

          If absent, `controller` looks for a config file in these locations and uses the first one that is found:

          - `config.toml` in the current directory (deprecated, for backwards compatiblity only)
          - `controller.toml` in the current directory
          - `<XDG_CONFIG_HOME>/opentalk/controller.toml` (where `XDG_CONFIG_HOME` is usually `~/.config`)
          - `/etc/opentalk/controller.toml`

      --reload
          Triggers a reload of reloadable configuration options

  -V, --version
          Print version information

  -l, --license
          Print license information

  -h, --help
          Print help (see a summary with '-h')