Skip to content

Commit 5988299

Browse files
committed
yocto project integration: add section
Fix shellhub-io#15 Signed-off-by: domarys <[email protected]>
1 parent c22f2bd commit 5988299

File tree

3 files changed

+29
-0
lines changed

3 files changed

+29
-0
lines changed

docs/img/yocto-tenant.gif

6.76 MB
Loading
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
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.
2+
3+
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.
4+
5+
```
6+
git clone [email protected]:shellhub-io/meta-shellhub.git
7+
```
8+
9+
!!! info ""
10+
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.
11+
12+
Besides that, add the settings below in your local.conf file:
13+
14+
```
15+
CORE_IMAGE_EXTRA_INSTALL += "packagegroup-shellhub-runtime"
16+
SHELLHUB_TENANT_ID = ""
17+
```
18+
19+
CORE_IMAGE_EXTRA_INSTALL: this variable will install the ShellHub agent in your device.
20+
21+
SHELLHUB_TENANT_ID: needs to be filled with your tenant code available in your account such as shown below:
22+
23+
![](/img/yocto-tenant.gif)
24+
25+
Remember to add the other configurations according to your needs. After this, just generate the desired image.
26+
27+
!!! attention ""
28+
Stay tuned to the fact that ShellHub demands the use of a password in the device will use ShellHub.

mkdocs.yml

+1
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ nav:
101101
- User Manual:
102102
- Introduction: user-manual/index.md
103103
- Installing: user-manual/installing.md
104+
- Yocto Project Integration: user-manual/yocto-project-integration.md
104105
- Troubleshooting:
105106
Frequently Encountered Issues: troubleshooting.md
106107
# Extra data

0 commit comments

Comments
 (0)