diff --git a/docs/img/yocto-tenant.gif b/docs/img/yocto-tenant.gif new file mode 100644 index 0000000..59e1b7f Binary files /dev/null and b/docs/img/yocto-tenant.gif differ diff --git a/docs/user-manual/yocto-project-integration.md b/docs/user-manual/yocto-project-integration.md new file mode 100644 index 0000000..1b6c61f --- /dev/null +++ b/docs/user-manual/yocto-project-integration.md @@ -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 git@github.com: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. diff --git a/mkdocs.yml b/mkdocs.yml index d84b4c6..e21a701 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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