{"id":28405934,"url":"https://github.com/txn2/txagent","last_synced_at":"2025-06-12T15:33:31.096Z","repository":{"id":57593326,"uuid":"120273752","full_name":"txn2/txagent","owner":"txn2","description":"Docker based iot container orchestration for arm based devices (Raspberry Pi / Orange Pi / Tinkerboard) or traditional servers.","archived":false,"fork":false,"pushed_at":"2018-04-26T03:49:27.000Z","size":33,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-05-21T20:59:48.534Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://txn2.com","language":"Go","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/txn2.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-02-05T08:07:01.000Z","updated_at":"2019-07-15T12:19:21.000Z","dependencies_parsed_at":"2022-09-06T12:20:38.999Z","dependency_job_id":null,"html_url":"https://github.com/txn2/txagent","commit_stats":null,"previous_names":["cjimti/iotagent"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/txn2%2Ftxagent","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/txn2%2Ftxagent/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/txn2%2Ftxagent/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/txn2%2Ftxagent/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/txn2","download_url":"https://codeload.github.com/txn2/txagent/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/txn2%2Ftxagent/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":257511924,"owners_count":22556735,"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":[],"created_at":"2025-06-01T22:09:34.991Z","updated_at":"2025-06-12T15:33:31.088Z","avatar_url":"https://github.com/txn2.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# txagent - Simplified Docker container provisioning.\n\n# Stable / Work in progress.\n\nThis code is used in production on a few hundred iot devices. It was developed for with a very specific, yet recurring use case. Professionally I develop software for a number of platforms, including iot. As a hobbyist, I have a dozen or so different devices that I provision with Docker. This project is in the early stages of becoming more general purpose. In the mean time, you may have a similar need. **txagent** is an uncomplicated way to provision iot devices running your Docker containers. Let me know if this project is useful to you and what features you would like to see.\n\n----\n\nThis project is intended to be a very simple docker container for iot devices, that are able to run docker. **txagent** has been tested on a few arm based devices, but is primarily used for the Raspberry Pi.\n\nPushing updates and configuration to devices is a complex and complicated problem, having to keep track of each device and it's state. **txagent** uses a **pull** model for basic provisioning.\n\nThe container runs a compiled Go application that can be configured to get a remote or local json configuration file, then uses the configuration to pull, run and monitor containers.\n\n\n\n## Supported Devices\n\nAnything that can run Docker. (Windows is untested)\n\n## Getting Started\n\nThe agent can be configured with environment variables, command line flags, or a combination on both. Command line argument will override environment variables.\n\n### Environment Variables\n\n| Prupose                    | Environment Variable | Flag  | Default Value |\n| -------                    | -------------------- | ----  | ------------- |\n| Container configuration.   | AGENT_CFG_URL        | -cfg  | file://conf/defs.json |\n| Repository authentication. | AGENT_AUTH_URL       | -auth | file://conf/auth.json |\n| Poll frequency.            | AGENT_CFG_POLL       | -poll | 30    |\n| Remove existing containers on start. |            | -rm   | false |\n\n\n## Testing (with source)\n\nGet a list of commands.\n\n```bash\ngo run ./agent.go --help\n```\n\n### Example #1: Run example configurations from source.\n\n```bash\ngo run ./agent.go\n```\n\n## Using as a lib\n\nsee GoDocs\nhttps://godoc.org/github.com/txn2/txagent/txagent\n\n### Development\n\nUses [goreleaser](https://goreleaser.com):\n\nInstall goreleaser with brew (mac):\n`brew install goreleaser/tap/goreleaser`\n\nBuild without releasing:\n`goreleaser --skip-publish --rm-dist --skip-validate`\n\n\n## TODO\n\n- Get \u0026 check configuration on interval (ensure state)\n- Configuration auth\n- Validate configs\n- Documentation, Use Case and Examples\n\n## DONE\n\n- Registry authentication\n- Command line flag `--rm` to remove running containers\n- Added command line flags `--cfg` and `--poll` (see `--help`)\n- Run containers\n- Pull containers\n- Create volumes\n- Create networks (if they do not exists)\n- Load and marshal configuration json\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftxn2%2Ftxagent","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftxn2%2Ftxagent","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftxn2%2Ftxagent/lists"}