{"id":24811140,"url":"https://github.com/thin-edge/tedge-management-ui","last_synced_at":"2025-03-25T13:24:13.364Z","repository":{"id":216297464,"uuid":"740953020","full_name":"thin-edge/tedge-management-ui","owner":"thin-edge","description":"thin-edge.io community project to provide a local UI for management of thin-edge.io","archived":false,"fork":false,"pushed_at":"2024-05-25T08:11:56.000Z","size":15152,"stargazers_count":2,"open_issues_count":4,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-30T12:19:41.063Z","etag":null,"topics":["thin-edge"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thin-edge.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2024-01-09T12:10:33.000Z","updated_at":"2024-05-16T06:53:49.000Z","dependencies_parsed_at":"2024-02-12T00:28:21.307Z","dependency_job_id":"becb4375-7c7e-41c5-a0f7-780eeb12e57b","html_url":"https://github.com/thin-edge/tedge-management-ui","commit_stats":null,"previous_names":["thin-edge/tedge-management-ui"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thin-edge%2Ftedge-management-ui","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thin-edge%2Ftedge-management-ui/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thin-edge%2Ftedge-management-ui/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thin-edge%2Ftedge-management-ui/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thin-edge","download_url":"https://codeload.github.com/thin-edge/tedge-management-ui/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245468745,"owners_count":20620443,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["thin-edge"],"created_at":"2025-01-30T12:19:29.863Z","updated_at":"2025-03-25T13:24:13.336Z","avatar_url":"https://github.com/thin-edge.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Cumulocity thin-edge.io Management UI\n\nThis 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:\n* web-ui, for easy setup of the Thin Edge \n* simple line chart to view streamed data and to view historical data\n* component to store measurements locally in a mongo db\n\n# Content\n- [Cumulocity thin-edge.io Management UI](#cumulocity-thin-edgeio-management-ui)\n- [Content](#content)\n- [Solution components](#solution-components)\n- [Build Thin Edge binaries and run solution](#build-thin-edge-binaries-and-run-solution)\n- [Configure Thin Edge in the web-ui](#configure-thin-edge-in-the-web-ui)\n- [Contributing](#contributing)\n- [License](#license)\n\n\n# Solution components\n\nThis solution consists of 3 services:\n* `tedge`: contain the Thin Edge core services: `tedge-agent`, `tedge-mapper`, ... and `tedge-mgmt-server` app\n* `mqtt-collector`: listens to measurements on all topics of the mosquitto broker and sends them to the mongo db\n* `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\n\nWhen 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.\nIn this case no historic measurements can be viewed, only realtime measurements can be viewed.\n\n![Docker Container](resource/02-Architecture.svg)\n\nThe following diagram show how the components (`tedge-mgmt-server`, `node` backend, `tedge` processes) in the tedge service communicate:\n\n![Components of Docker Container tedge-mgmt-server](resource/01-Architecture.svg)\n\n\n# Build Thin Edge binaries and run solution\n\nTo build the docker image the docker memory config must be set greater than 2GB, e.g. 4GB.\nTo build the docker solution run:\n```\ndocker-compose up\n```\n\n# Configure Thin Edge in the web-ui\n\nTo access the web-ui open a web browser at: http://localhost:9080/#/setup.\nHere you start the setup of the edge and enter external device id and your cumulocity tenant url.\n![Setup](resource/01-Setup.png)\nThen 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.\nThis will generate a certificate. This has to be uploaded through the web-ui. As mentioned before, the certificate is uploaded to the cloud tenant.\n\n![Setup](resource/03-Setup.png)\nAlternatively, you can download the certificate locally and upload it manually to your cloud tenant.\n\n![Setup](resource/05-Setup.png)\nA 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.\nDownload the certificate.\nWhen the certificate is uploaded you can start the edge. If everything went well the completion of the startup is acknowledged\n\n![Setup](resource/01-Control.png)\n\nThe edge processes are started and the Thin Edge is registered in the cloud tenant\n\n![Setup](resource/01-Cloud.png)\n\nThe registration to the cloud can be verified here as well:\n\n![Setup](resource/04-Setup.png)\n\nThen you can access the analytics dashboard : http://localhost:9080/#/analytics\n\n![Setup](resource/01-Analytics.png)\n\nand change the settings of the chart:\n\n![Analytics Measurement Series](resource/02-Analytics.png)\n\nIn case the solution is used without the storage component you can only view measurement in realtime mode. The historic view is not available.\n\n![Analytics without Storage](resource/03-Analytics.png)\n\n# Contributing\n\nContributions 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\n\nAny contributions you make are greatly appreciated. \n\n\n# License\n\nDistributed under the Apache 2.0 License. See LICENSE for more information. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthin-edge%2Ftedge-management-ui","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthin-edge%2Ftedge-management-ui","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthin-edge%2Ftedge-management-ui/lists"}