Skip to content

Commit

Permalink
Docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
juliarobles committed May 21, 2024
1 parent fcf2a76 commit b619905
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/docs/installation/using-helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,19 @@ helm repo add ertis https://ertis-research.github.io/Helm-charts/
Once done, the next step is installing the chart by executing this line on your terminal (in our case, we will use `opentwins` as release name and `opentwins` as namespace, but you can choose the one that you prefeer). To customize the installation, please refer to [Helm's values](https://github.com/ertis-research/Helm-charts/blob/main/OpenTwins/values.yaml) file.

```bash
helm upgrade --install opentwins ertis/OpenTwins -n opentwins --wait --dependency-update
helm upgrade --install opentwins ertis/OpenTwins -n opentwins --wait --dependency-update --debug
```

After waiting some time, the installation will be ready for use.


## Lightweight installation
As described in the main page, OpenTwins has it's own lightweight version that aims to run on IoT devices such as Raspberry Pi devices.

OpenTwins has it's own lightweight version that aims to run on IoT devices such as Raspberry Pi devices.
To install this versión, you have to follow the first step in order to add ERTIS repository to your repository list and then install the platform using the command bellow:

```bash
helm install ot ertis/OpenTwins-Lightweight -n opentwins
```

In this case connections still need to be made for the platform to work properly.
5 changes: 5 additions & 0 deletions docs/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,11 @@ helm upgrade --install opentwins ertis/OpenTwins -n opentwins --wait --dependenc

To modify the components to be deployed and connected during the installation, you can check the [installation via Helm](./installation/using-helm.md).

### Configuration
If you've correctly installed OpenTwins Helm using the default settings, all connections should be established.
The final step involves **configuring the platform interface plugin** by adding the addresses of the Eclipse Ditto nginx service and the Ditto Extended API component into the plugin's configuration section.
Check the [installation documentation](./installation/using-helm.md) for more details.


## Create your first digital twin

Expand Down

0 comments on commit b619905

Please sign in to comment.