{"id":41099158,"url":"https://github.com/nbigot/ministream","last_synced_at":"2026-01-22T15:03:17.270Z","repository":{"id":65001064,"uuid":"517352501","full_name":"nbigot/ministream","owner":"nbigot","description":"Ministream is a small, stand-alone, real-time event messaging streaming server","archived":false,"fork":false,"pushed_at":"2024-09-15T10:10:28.000Z","size":275,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-09-15T22:53:26.613Z","etag":null,"topics":["cloud-native","data-pipelines","event-streaming-database","eventing","go","golang","json","messaging","ministream","nosql","real-time-processing","server","streaming-data","webapi"],"latest_commit_sha":null,"homepage":"","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/nbigot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":"auditlog/auditlog.go","citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":"MAINTAINERS.md","copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-07-24T14:52:18.000Z","updated_at":"2024-09-15T09:58:46.000Z","dependencies_parsed_at":"2023-02-18T15:31:04.726Z","dependency_job_id":"8e2256ea-2914-4532-99e3-4858dd11edbf","html_url":"https://github.com/nbigot/ministream","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/nbigot/ministream","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbigot%2Fministream","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbigot%2Fministream/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbigot%2Fministream/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbigot%2Fministream/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nbigot","download_url":"https://codeload.github.com/nbigot/ministream/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nbigot%2Fministream/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28664839,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T14:01:31.714Z","status":"ssl_error","status_checked_at":"2026-01-22T13:59:23.143Z","response_time":144,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["cloud-native","data-pipelines","event-streaming-database","eventing","go","golang","json","messaging","ministream","nosql","real-time-processing","server","streaming-data","webapi"],"created_at":"2026-01-22T15:03:12.492Z","updated_at":"2026-01-22T15:03:17.255Z","avatar_url":"https://github.com/nbigot.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ministream\n\n[![Go Report Card](https://goreportcard.com/badge/github.com/nbigot/ministream)](https://goreportcard.com/report/github.com/nbigot/ministream)\n[![license](https://img.shields.io/github/license/nbigot/ministream)](https://github.com/nbigot/ministream/blob/main/LICENSE)\n\n\n\u003cp align=\"center\"\u003e\n    \u003cpicture\u003e\n      \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"docs/content/assets/img/ministream.logo-dark.small.png\"\u003e\n      \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"docs/content/assets/img/ministream.logo.small.png\"\u003e\n      \u003cimg alt=\"Ministream\" title=\"Ministream\" src=\"docs/content/assets/img/ministream.logo.png\"\u003e\n    \u003c/picture\u003e\n\u003c/p\u003e\n\n## Overview\n\nMinistream is an open-source real-time data stream service.\nMinistream is well suited for event driven architectures.\n\nMinistream is simple and straightforward, it runs on a single server and has no dependencies over third parties.\nEvents records are pushed and pulled by a simple HTTP request.\nIt it served by it's own HTTP(s) server and stores data on json files.\nMinistream can easily fit in a standalone docker container.\nMinistream also provides a complete web api to manage the server.\n\n\n## Quick install\n\n### Install the docker image\n\nUse the official docker image: `ghcr.io/nbigot/ministream:latest`\n\n[Packages and versions](https://github.com/nbigot/ministream/pkgs/container/ministream)\n\nInstall from the command line:\n\n```sh\n$ docker pull ghcr.io/nbigot/ministream:latest\n$ docker run --name ministream -it -p 8080:8080 ghcr.io/nbigot/ministream:latest\n```\n\n\n#### Docker quick tips\n\nThe docker image `ghcr.io/nbigot/ministream:latest` is a multi-arch image that contains images for:\n- linux amd64 v2\n- linux amd64 v3\n- linux arm64\n- linux arm v7\n\n\n```sh\n$ docker manifest inspect ghcr.io/nbigot/ministream:latest\n```\n\n\n### Install by building your own docker image\n\n#### Download source code\n\n```sh\n$ git clone https://github.com/nbigot/ministream.git\n```\n\n\n#### Build a docker image\n\n```sh\n$ cd ministream\n$ docker build -t nbigot/ministream .\n```\n\n\n#### Start a docker container\n\n```sh\n$ docker run --name ministream -it -p 8080:8080 nbigot/ministream\n```\n\n\n### Install by compiling source code\n\n#### Download source code\n\n```sh\n$ git clone https://github.com/nbigot/ministream.git\n```\n\n\n#### Compile\n\n```sh\n$ cd ministream\n$ go build cmd/ministream/ministream.go\n```\n\nOr to set the version variable at build time:\n\n```sh\n$ MINISTREAM_VERSION=\"${TAG_VERSION-$(git describe --tags --abbrev=0)}\"\n$ go build -ldflags=\"-X 'main.Version=${MINISTREAM_VERSION}'\" cmd/ministream/ministream.go\n```\n\n#### Linter\n\nTo run the linter, use:\n\n```sh\n$ golangci-lint run\n```\n\n#### Configure\n\nEdit the file *config-templates/docker/config/config.yaml*\n\nPay attention to the directory paths in the config file.\n\n\n#### Run ministream\n\n```sh\n$ ministream -config config-templates/docker/config/config.yaml\n```\n\nor run \n\n```sh\n$ go run cmd/ministream/ministream.go -config config-templates/minimal-inmemory/config.yaml\n```\n\n\n## Ministream quick tips\n\nLet's assume Ministream is running and listening on the tcp port 8080.\n\nRun simple commands:\n\n```sh\n$ curl http://localhost:8080\nWelcome to ministream!\n\n$ curl http://localhost:8080/api/v1/utils/ping\nok\n\n$ curl http://localhost:8080/livez\nok\n\n$ curl http://localhost:8080/readyz\nok\n```\n\n\n## Contribution guidelines\n\nIf you want to contribute to Ministream, be sure to review the [code of conduct](CODE_OF_CONDUCT.md).\n\n\n## License\n\nThis software is licensed under the [MIT](./LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnbigot%2Fministream","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnbigot%2Fministream","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnbigot%2Fministream/lists"}