Skip to content
This repository was archived by the owner on Aug 24, 2022. It is now read-only.

yocto project integration: add section #19

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.
28 changes: 28 additions & 0 deletions docs/user-manual/yocto-project-integration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
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.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,7 @@ nav:
- User Manual:
- Introduction: user-manual/index.md
- Installing: user-manual/installing.md
- Yocto Project Integration: user-manual/yocto-project-integration.md
- Troubleshooting:
Frequently Encountered Issues: troubleshooting.md
# Extra data
Expand Down