Skip to content

Commit

Permalink
yocto project integration: add section
Browse files Browse the repository at this point in the history
Fix shellhub-io#15

Signed-off-by: domarys <[email protected]>
  • Loading branch information
Domarys committed Aug 27, 2020
1 parent ea8cd9d commit 1b543d6
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/getting-started/yocto-project-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Before beginning, you need to have the ShellHub account because the TENANT_ID only is generated and will stay available with an account. You will need this information in settings before generating the image. In case you don't have an account yet, access [ShellHub platform](https://cloud.shellhub.io/login) and register yourself.

To use ShellHub in a Yocto Project image is necessary to add [meta-shellhub](https://github.com/shellhub-io/meta-shellhub) layer in your project.

```
git clone [email protected]:shellhub-io/meta-shellhub.git
```

!!! info ""
ShellHub have support to Dunfell(master), [Zeus](https://github.com/shellhub-io/meta-shellhub/tree/zeus), [Sumo](https://github.com/shellhub-io/meta-shellhub/tree/sumo) and [Rocko](https://github.com/shellhub-io/meta-shellhub/tree/rocko) branches.

Besides that, add the settings below in your local.conf file:

```
CORE_IMAGE_EXTRA_INSTALL += "packagegroup-shellhub-runtime"
SHELLHUB_TENANT_ID = ""
```

CORE_IMAGE_EXTRA_INSTALL: this variable will install the ShellHub agent in your device.

SHELLHUB_TENANT_ID: needs to be filled with your tenant code available in your account such as shown below:

![](/img/yocto-tenant.gif)

Remember to add the other configurations according to your needs. After this, just generate the desired image.

!!! attention ""
Stay tuned to the fact that ShellHub demands the use of a password in the device will use ShellHub.

With the device working now you can test like shown in [Connecting to a device](connecting-device.md).
Binary file added docs/img/yocto-tenant.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ nav:
- Creating account: getting-started/creating-account.md
- Registering a device: getting-started/registering-device.md
- Connecting to a device: getting-started/connecting-device.md
- Yocto Project Integration: getting-started/yocto-project-integration.md
- ShellHub Cloud:
- Introduction: cloud/index.md
- Security: cloud/security.md
Expand Down

0 comments on commit 1b543d6

Please sign in to comment.