Skip to content

Latest commit

 

History

History
81 lines (61 loc) · 3.39 KB

README.md

File metadata and controls

81 lines (61 loc) · 3.39 KB

ShellHub Agent for Snap

Installation

ShellHub is available in the Snap Store. To install it, run the following command:

$ sudo snap install --classic shellhub

Note

By default, the ShellHub is configured to use the ShellHub Cloud, making it easy to get started without needing to set up a self-hosted instance. You just need to set the tenant-id to connect your device to your ShellHub Cloud namespace.

Configuration

Viewing Configuration

To view the current configuration of the ShellHub agent, use the snap get command:

$ snap get shellhub

This will display the current configuration settings for the ShellHub agent:

Key Value
private-key /etc/shellhub.key
server-address https://cloud.shellhub.io
tenant-id
preferred-hostname

Setting Configuration

To set or update the configuration of the ShellHub agent, use the snap set command followed by the desired configuration options:

$ sudo snap set shellhub <key>=<value>

Replace <key> and <value> with the configuration settings you wish to change.

  • private-key: The path to the private key used by the ShellHub agent.
  • server-address: The address of the ShellHub server the agent will connect to.
  • tenant-id: The tenant ID (if applicable) associated with the ShellHub namespace.

Building

$ git clone https://github.com/shellhub-io/snap.git
$ cd snap
$ snapcraft
$ sudo snap install --classic --dangerous shellhub_<version>_amd64.snap

Replace <version> with the appropriate version number of the generated snap file.

Make sure to replace the default values with your own configurations if needed.