Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shellhub-io/snap
https://github.com/shellhub-io/snap
Last synced: 3 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/shellhub-io/snap
- Owner: shellhub-io
- Created: 2024-04-17T16:37:10.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-10-29T22:36:14.000Z (14 days ago)
- Last Synced: 2024-10-30T00:45:33.788Z (14 days ago)
- Language: Shell
- Size: 16.6 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
ShellHub Agent for Snap
## Installation
ShellHub is available in the [Snap Store](https://snapcraft.io/shellhub). To install it, run the following command:
```
$ sudo snap install --classic shellhub
```
> [!NOTE]
> By default, the ShellHub is configured to use the [ShellHub Cloud](https://cloud.shellhub.io),
> 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` | |
### 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 =
```
Replace `` and `` 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__amd64.snap
```
Replace `` with the appropriate version number of the generated snap file.
Make sure to replace the default values with your own configurations if needed.