Skip to content

Latest commit

 

History

History
119 lines (75 loc) · 2.03 KB

admin_cli.md.md

File metadata and controls

119 lines (75 loc) · 2.03 KB
Raw

chiSSL Admin CLI

The chissl admin CLI allows you to manage users in the chiSSL server. This includes adding, deleting, retrieving, and listing users. The commands are secured using Basic Authentication.

Known limitations and TODOs

  • Add support of using proxy config
  • Add support for using custom TLS configs
  • Use client side hashed passwords

Usage

chissl admin [subcommand] [options]

Subcommands

  • adduser - Adds a new user
  • deluser - Deletes an existing user
  • getuser - Retrieves info about an existing user
  • listusers - Lists all users

Global Options

  • --profile - Path to profile YAML file containing configuration

Examples

Add User

chissl admin adduser --username johndoe --password secret --admin --addresses ".*"

Delete User

chissl admin deluser --username johndoe

Get User

chissl admin getuser --username johndoe

To get the raw JSON response:

chissl admin getuser --username johndoe --raw

List Users

chissl admin listusers

To get the raw JSON response:

chissl admin listusers --raw

Detailed Subcommands Usage

adduser

Adds a new user to the chiSSL server.

chissl admin adduser [options]

Options

  • --username, -u - Username for the new user
  • --password, -p - Password for the new user
  • --addresses, -a - Comma-separated list of regex expressions for allowed addresses
  • --admin - Flag to grant admin permissions to the user

deluser

Deletes an existing user from the chiSSL server.

chissl admin deluser [options]

Options

  • --username, -u - Username of the user to delete

getuser

Retrieves details of an existing user from the chiSSL server.

chissl admin getuser [options]

Options

  • --username, -u - Username of the user to get
  • --raw - Flag to output the raw JSON response

listusers

Lists all users in the chiSSL server.

chissl admin listusers

Flags

  • --raw - Flag to output the raw JSON response