# xmidt-agent

**Repository Path**: mirrors_xmidt-org/xmidt-agent

## Basic Information

- **Project Name**: xmidt-agent
- **Description**: The client agent for the Xmidt service.
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-06-13
- **Last Updated**: 2025-12-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xmidt-agent
The client agent for the Xmidt service.

[![Build Status](https://github.com/xmidt-org/xmidt-agent/actions/workflows/ci.yml/badge.svg)](https://github.com/xmidt-org/xmidt-agent/actions/workflows/ci.yml)
[![codecov.io](http://codecov.io/github/xmidt-org/xmidt-agent/coverage.svg?branch=main)](http://codecov.io/github/xmidt-org/xmidt-agent?branch=main)
[![Go Report Card](https://goreportcard.com/badge/github.com/xmidt-org/xmidt-agent)](https://goreportcard.com/report/github.com/xmidt-org/xmidt-agent)
[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/xmidt-org/xmidt-agent/blob/main/LICENSE)
[![GitHub Release](https://img.shields.io/github/release/xmidt-org/xmidt-agent.svg)](CHANGELOG.md)


## Code of Conduct

This project and everyone participating in it are governed by the [XMiDT Code Of Conduct](https://xmidt.io/code_of_conduct/). 
By participating, you agree to this Code.


## Contributing

Refer to [CONTRIBUTING.md](CONTRIBUTING.md).

## What is Xmidt-Agent?

This is the go replacement for the c client (parodus) running on the RDK-B (internet gateway).  It connects the gateway to the xmidt cloud. 

## Run xmidt-agent simulator as a docker container
1. build xmidt-agent for alpine
    ```cd cmd/xmidt-agent```
    ```env GOOS=linux GOARCH=arm64 go build .```
2. mv cmd/xmidt-agent/xmdidt-agent binary to the root directory 
3. from the root directory, build the docker container
    ```docker build -t xmdit-agent .```
4. run the container 
    ```docker run xmdit-agent --dev```
5. Note that you will see a connection error unless a websocket server is running at the default url specified by websocket -> back_up_url in cmd/xmidt-agent/default-config.yaml.
6. To override the default configuration, update the below config file OR bind a config file to target "/etc/xmidt-agent/xmidt-agent.yaml" at runtime:
```.release/docker/config/config.yml```
7. If using TLS, the Dockerfile expects the certificate and key files to be ".release/docker/certs" at build time.  Otherwise bind the directory at runtime.