/edgex-ui-go

Owner: Core/Support WG

Primary LanguageTypeScriptApache License 2.0Apache-2.0

edgex-ui-go

Build Status Code Coverage Go Report Card GitHub Latest Dev Tag) GitHub Latest Stable Tag) GitHub License GitHub go.mod Go version GitHub Pull Requests GitHub Contributors GitHub Committers GitHub Commit Activity

Use and Purpose

The EdgeX UI is for demonstration and developer use to manage and monitor a single instance of EdgeX Foundry (insecure or secure). Specifically, it can:

  • Manage (add, remove, update) the EdgeX objects (device, device services, profiles, rules, app services, etc.)
  • Monitor the EdgeX data flow (events and readings) and services
  • Monitor and manage from on-box with EdgeX (on the same host)

As is, the EdgeX UI is not meant for production use! Developers can use the UI as a base from which to create additional user interfaces. The EdgeX community is also exploring production level use cases and extending/expanding the UI for future releases that would include more production level needs such as the ability to use the UI from on or off box.

Go implementation of EdgeX Web UI.

Install and Deploy

  • Make sure you're using at least Go 1.12 (UI backend server currently uses Go 1.18.x)
  • If your code is in your GOPATH then make sure GO111MODULE=on is set
git clone http://github.com/edgexfoundry/edgex-ui-go.git
cd edgex-ui-go
make build

To start the application and the web-based UI:

export EDGEX_SECURITY_SECRET_STORE=false
make run

To rebuild after making changes to source:

make clean
make build

To test the web-based UI:

make test

Using the edgex-ui

With a modern browser, navigate to http://yourdomain:4000 (change yourdomain to your server's hostname or ip).

NOTE: the GUI is running in non-secure mode when the environment variable EDGEX_SECURITY_SECRET_STORE=false, if EDGEX_SECURITY_SECRET_STORE=true, the accesss token for edgex is required, see the edgex document how to get the token.

NOTE: make sure that EdgeXFoundry is already running, Please refer to Edgex Services Get Started.

User guide

Other installation and deployment options

Build your own Docker Containers

make docker

Snap

EdgeX UI is also available as a snap package. For more details on the snap, including how to install it, please refer to EdgeX UI Snap

Community

License

Apache-2.0

Feedback

  • If you want to learn how to use the UI, you can refer to the user guide user guide.

  • If you find a bug or want to request a new feature, please open a GitHub Issue.