Administration

ShellHub provides useful scripts for administering a self-hosted ShellHub instance. These scripts are located under the ./bin/cli executable, which can be found at the root of the ShellHub project directory.

TIP: If you are managing a self-hosted instance of ShellHub Enterprise, all administrative tasks can be performed through the Admin Console.

User management scripts

Create a user

Add user account to a local running instance of ShellHub.

Usage: ./bin/cli user create <username> <password> <email>

NOTE: The password can contain any characters, but the string length should be between 5 and 32 characters

Delete a user

Delete user account from a local running instance of ShellHub.

Usage: ./bin/cli user delete <username>

Reset a user's password

Reset user account password from a local running instance of ShellHub.

Usage: ./bin/cli user password <username> <password>

Namespace management scripts

Create a namespace

Add namespace to a local running instance of ShellHub.

Usage: bin/cli namespace create <namespace> <owner> [tenant]

NOTE: The namespace must adhere to a valid RFC1123 hostname format, but it should not contain dots.

NOTE: The [tenant] is an optional UUID value, automatically generated when not provided.

Delete a namespace

Delete namespace to a local running instance of ShellHub.

Usage: ./bin/cli namespace delete <namespace>

Add a member to the namespace

Add a user to a specific namespace in a locally running instance of ShellHub.

Usage: ./bin/cli namespace member add <username> <namespace> <role>

NOTE: The role must define the privileges the user has on this namespace and can be owner, operator, or observer.

Remove namespace member

Delete user from a specific namespace to a local running instance of ShellHub.

Usage: ./bin/cli namespace member remove <username> <namespace>