clearblade/edge repository overview

⁠Supported Tags

• develop- under development and subject to change without notice
• latest- the current production release
• stable- the release is stable and released bi-weekly. It contains both new features and bug fixes.
• lts- (Long Term Support) the release is stable and supports bug fixes for a year from the release date.

⁠Quick reference

⁠Release Notes:

Release Notes can be found here⁠.

⁠Where to get help:

ClearBlade Service Desk⁠

⁠Where to file issues:

ClearBlade Service Desk⁠

⁠Supported architectures:

amd64

Other architectures to be added soon, bare-metal binaries for other architectures can be found on github⁠

⁠References

• ClearBlade Edge Documentation⁠

• Edge Configuration File⁠

• ClearBlade Edge Tutorial⁠

  (Make sure you are enrolled in the ClearBlade Academy)

⁠What is ClearBlade Edge?

ClearBlade Edge is an application to synchronize, configure, manage, and deploy distributed IoT systems. It contains all the same features of the Platform, and is designed to be deployed in remote networks to interact with sensors, controllers, and industrial systems.

⁠How to use this image

A user can choose any of the following options to use this image

⁠Start Edge Using Config File (Recommended)

docker run --name edge -d -v /path/to/your/cb/dir:/etc/clearblade clearblade/edge --config /etc/clearblade/config.toml

This method of starting Edge uses a config file and uses Docker volume to make database persistent. Scroll down for an example Config File⁠.

⁠Start Edge using flags

docker run --name edge -d -v /path/to/your/cb/dir:/etc/clearblade clearblade/edge -platform-ip=<PLATFORM_URL> -parent-system=<SYSTEM_KEY> -edge-id=<EDGE_ID> -edge-cookie=<EDGE_COOKIE>

This method of starting Edge uses edge flags and uses Docker volume to make database persistent.

⁠Starting edge with non-persistent database (Not Recommended)

docker run --name edge -d clearblade/edge -platform-ip=<PLATFORM_URL> -parent-system=<SYSTEM_KEY> -edge-id=<EDGE_ID> -edge-cookie=<EDGE_COOKIE>

This method of starting Edge uses edge flags with non-persistent database.

⁠Configuration File

[Debug]
DisablePprof = true
[Database]
SqliteAdmin = "/etc/clearblade/clearblade.db"
SqliteUserData = "/etc/clearblade/clearblade_users.db"
[Edge]
PlatformIP = "<PLATFORM_IP>"
PlatformPort = "<PLATFORM_PORT>"
EdgeID = "<EDGE_ID>"
EdgeIP = "<EDGE_IP>"
EdgeCookie = "<EDGE_TOKEN>"
ParentSystemKey = "<PARENT_SYSTEM_KEY>"

⁠Example Configuration File

[Debug]
DisablePprof = true
[Database]
SqliteAdmin = "/etc/clearblade/clearblade.db"
SqliteUserData = "/etc/clearblade/clearblade_users.db"
[Edge]
PlatformIP = "staging.clearblade.com"
PlatformPort = "8950"
EdgeID = "testEdge"
EdgeIP = "localhost"
EdgeCookie = "h8416xwH3848sTemP626t3"
ParentSystemKey = "b8978fd40bbefb89a3edacd4c98601"