Skip to content

Ministream is a small, stand-alone, real-time event messaging streaming server

License

Notifications You must be signed in to change notification settings

nbigot/ministream

Repository files navigation

Ministream

Go Report Card license

Overview

Ministream is an open-source real-time data stream service. Ministream is well suited for event driven architectures.

Ministream is simple and straightforward, it runs on a single server and has no dependencies over third parties. Events records are pushed and pulled by a simple HTTP request. It it served by it's own HTTP(s) server and stores data on json files. Ministream can easily fit in a standalone docker container. Ministream also provides a complete web api to manage the server.

Quick install

Download source code

$ git clone https://github.com/nbigot/ministream.git

Compile

$ cd ministream
$ go build cmd/ministream/ministream.go

Configure

Edit the file config-templates/docker-minimal/config/config.yaml

Pay attention to the directory paths in the config file.

Run ministream

$ ministream -config config-templates/docker-minimal/config/config.yaml

Docker quick tips

Download source code

$ git clone https://github.com/nbigot/ministream.git

Build a docker image

$ cd ministream
$ docker build -t nbigot/ministream .

Start a docker container

$ docker run --name ministream -it -p 8080:8080 nbigot/ministream

Contribution guidelines

If you want to contribute to Ministream, be sure to review the code of conduct.

License

This software is licensed under the MIT.