{"id":15199895,"url":"https://github.com/oceanstreamio/iotedge-docker","last_synced_at":"2026-03-05T18:35:04.208Z","repository":{"id":196601480,"uuid":"306059056","full_name":"OceanStreamIO/iotedge-docker","owner":"OceanStreamIO","description":"Run Azure IoT Edge runtime in a Docker container; also you can use NPM to manage this.","archived":false,"fork":false,"pushed_at":"2024-07-31T14:10:30.000Z","size":10,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-01T19:40:50.916Z","etag":null,"topics":["azure-iot","azure-iot-edge","azure-iot-hub","docker","docker-image","iot-edge"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OceanStreamIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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,"publiccode":null,"codemeta":null}},"created_at":"2020-10-21T14:53:59.000Z","updated_at":"2024-07-31T14:10:33.000Z","dependencies_parsed_at":"2023-09-26T12:40:43.401Z","dependency_job_id":"6a20d8e4-9d7e-49ca-be91-2ab734fbafe9","html_url":"https://github.com/OceanStreamIO/iotedge-docker","commit_stats":{"total_commits":2,"total_committers":1,"mean_commits":2.0,"dds":0.0,"last_synced_commit":"b4721351c07f3fa845c0c7dabcfb9f47f8f78d15"},"previous_names":["oceanstreamio/iotedge-docker","pineviewlabs/iotedge-docker"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Fiotedge-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Fiotedge-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Fiotedge-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OceanStreamIO%2Fiotedge-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OceanStreamIO","download_url":"https://codeload.github.com/OceanStreamIO/iotedge-docker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241717684,"owners_count":20008428,"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":["azure-iot","azure-iot-edge","azure-iot-hub","docker","docker-image","iot-edge"],"created_at":"2024-09-28T02:20:34.204Z","updated_at":"2026-03-05T18:35:04.111Z","avatar_url":"https://github.com/OceanStreamIO.png","language":"Shell","readme":"# iotedge-runtime\n### Run the [Azure IoT Edge](https://azure.microsoft.com/en-us/services/iot-edge/) runtime in a Docker container\n\nThis project is based on the [Azure IoT Edge dev tool](https://github.com/Azure/iotedgedev), but it only contains the Docker image needed to run the Azure IoT Edge runtime in a container.\n\nIt is supposed to be used mostly in local development environments and it's wrapped in an NPM package.\n\n## Installation\nTo install via NPM, simply run:\n\n```sh\n$ npm install iotedge\n```\n\nOtherwise, clone the project from Github:\n```sh\n$ git clone git@github.com:pineviewlabs/iotedge-docker.git\n```\n\n## Usage\n\n### 1. Building the Docker image\n\nUsing NPM:\n\n```sh\n$ npx build-iotedge\n```\n\nor build the docker image manually with:\n\n```sh\n$ docker build . -t iotedge-runtime\n```\n\nThis will create a Docker image tagged `iotedge-runtime`.\n\n### 2. Set the Device Connection String\n\nGo to the [Azure Portal](https://portal.azure.com/), then go to your IoT Hub and click on IoT Edge from under the **Automatic Device Management** section.\n\nSelect an existing device that you would like to use or create a new one. Once on the device page, copy one of the two connection strings (either the _Primary Connection String_ or the _Secondary Connection String_).\nYou will need to set the connection string you have just grabbed as an environment variable, named `IOT_DEVICE_CONNSTR`.\n\n**Example**:\n```sh\n$ export IOT_DEVICE_CONNSTR='HostName=iothub0730.azure-devices.net;DeviceId=myEdgeDevice;SharedAccessKey=zfD73oX3agHTlT0rOvjPnYTkxRPw/k3U0exEGBDWQ5A='\n```                                                                                           \n                                                                                          \n### 3. Run the Docker image\n\nUsing NPM:\n```sh\n$ npx start-iotedge\n```\n\nOr run the container using the provided `run-container.sh` script in the `bin` folder:\n\n```sh\n$ ./bin/run-container.sh\n```\n\nA container named `iotedgec` will be created and inside the container the `iotedged` daemon will be started. If everything is working correctly you will see the daemon output log.\n\nThe IoT Edge runtime and its associated modules (which are running as independent containers) are using a Docker network called `azure-iot-edge`. The script also creates the network, if it doesn't already exist.\n\nThe daemon will use the default ip address assigned by Docker to the container (most probably will be 172.17.0.2). The discovery is automatically done in the `rund.sh` script located in the lib folder.\n\n## Using the `iotedge` CLI tool\n\nThis package also provides a cli utility which helps with development, debugging, and troubleshooting of issues. You can use it in two ways:\n\nVia NPM:\n```sh\n$ npx iotedge\n``` \n\nor running the provided `iotedge.sh` script directly:\n\n```sh\n$ ./bin/iotedge.sh\n```\n\nThis tool forwards the arguments to the `iotedge` CLI tool available in the main runtime container.  \n\nFor example:\n\n```sh\n$ ./bin/iotedge.sh list\n```\n\nis equivalent to:\n```sh\ndocker exec iotedgec iotedge -H http://172.17.0.2:15580 list\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanstreamio%2Fiotedge-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foceanstreamio%2Fiotedge-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foceanstreamio%2Fiotedge-docker/lists"}