https://github.com/thin-edge/tedge-management-ui
thin-edge.io community project to provide a local UI for management of thin-edge.io
https://github.com/thin-edge/tedge-management-ui
thin-edge
Last synced: about 1 year ago
JSON representation
thin-edge.io community project to provide a local UI for management of thin-edge.io
- Host: GitHub
- URL: https://github.com/thin-edge/tedge-management-ui
- Owner: thin-edge
- Created: 2024-01-09T12:10:33.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-25T08:11:56.000Z (about 2 years ago)
- Last Synced: 2025-01-30T12:19:41.063Z (over 1 year ago)
- Topics: thin-edge
- Language: TypeScript
- Homepage:
- Size: 14.5 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Cumulocity thin-edge.io Management UI
This project adds an configuration ui to thin-edge.io. It enables you to use thin-edge.io with an easy-to-use docker based deployment and no code commissioning process. This helps to setup and monitor the edge using a web-ui:
* web-ui, for easy setup of the Thin Edge
* simple line chart to view streamed data and to view historical data
* component to store measurements locally in a mongo db
# Content
- [Cumulocity thin-edge.io Management UI](#cumulocity-thin-edgeio-management-ui)
- [Content](#content)
- [Solution components](#solution-components)
- [Build Thin Edge binaries and run solution](#build-thin-edge-binaries-and-run-solution)
- [Configure Thin Edge in the web-ui](#configure-thin-edge-in-the-web-ui)
- [Contributing](#contributing)
- [License](#license)
# Solution components
This solution consists of 3 services:
* `tedge`: contain the Thin Edge core services: `tedge-agent`, `tedge-mapper`, ... and `tedge-mgmt-server` app
* `mqtt-collector`: listens to measurements on all topics of the mosquitto broker and sends them to the mongo db
* `mongodb`: stores the measurements in a collection, to be retrieved by the web-ui. All measurements have time-to-live (TTL) of 300. This can be changed
When memory and storage usage should be minimized the solution can be confiured to run without storage. In this case the two container `mqtt-collector` and `mongodb` are not used.
In this case no historic measurements can be viewed, only realtime measurements can be viewed.
The following diagram show how the components (`tedge-mgmt-server`, `node` backend, `tedge` processes) in the tedge service communicate:
# Build Thin Edge binaries and run solution
To build the docker image the docker memory config must be set greater than 2GB, e.g. 4GB.
To build the docker solution run:
```
docker-compose up
```
# Configure Thin Edge in the web-ui
To access the web-ui open a web browser at: http://localhost:9080/#/setup.
Here you start the setup of the edge and enter external device id and your cumulocity tenant url.
Then press `Configure Edge` to create a device certificate. This Will late be uploaded to you cloud tenant. The Thin Edge uses the certificate for authentication.
This will generate a certificate. This has to be uploaded through the web-ui. As mentioned before, the certificate is uploaded to the cloud tenant.
Alternatively, you can download the certificate locally and upload it manually to your cloud tenant.
A detailed description how to import your certificate can de found is [Cumulocity Administration Documentation](https://cumulocity.com/guides/users-guide/device-management/#managing-trusted-certificates) to your cumulocity cloud tenant.
Download the certificate.
When the certificate is uploaded you can start the edge. If everything went well the completion of the startup is acknowledged
The edge processes are started and the Thin Edge is registered in the cloud tenant
The registration to the cloud can be verified here as well:
Then you can access the analytics dashboard : http://localhost:9080/#/analytics
and change the settings of the chart:
In case the solution is used without the storage component you can only view measurement in realtime mode. The historic view is not available.
# Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. How you can contribute to thin-edge.io you can find in the Contribution Guideline
Any contributions you make are greatly appreciated.
# License
Distributed under the Apache 2.0 License. See LICENSE for more information.