You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

55 lines
2.7 KiB

9 years ago
9 years ago
  1. # Supported tags and respective `Dockerfile` links
  2. - `0.8.0`, `0.8`, `latest` [(Dockerfile)](https://github.com/tendermint/tendermint/blob/bf64dd21fdb193e54d8addaaaa2ecf7ac371de8c/DOCKER/Dockerfile)
  3. - `develop` [(Dockerfile)]()
  4. `develop` tag points to the [develop](https://github.com/tendermint/tendermint/tree/develop) branch.
  5. # Tendermint
  6. Tendermint Core is Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine, written in any programming language, and securely replicates it on many machines.
  7. For more background, see the [introduction](https://tendermint.com/intro).
  8. To get started developing applications, see the [application developers guide](https://tendermint.com/docs/guides/app-development).
  9. # How to use this image
  10. ## Start one instance of the Tendermint core with the `dummy` app
  11. A very simple example of a built-in app and Tendermint core in one container.
  12. ```
  13. docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init
  14. docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint
  15. ```
  16. ## mintnet-kubernetes
  17. If you want to see many containers talking to each other, consider using [mintnet-kubernetes](https://github.com/tendermint/mintnet-kubernetes), which is a tool for running Tendermint-based applications on a Kubernetes cluster.
  18. # Supported Docker versions
  19. This image is officially supported on Docker version 1.13.1.
  20. Support for older versions (down to 1.6) is provided on a best-effort basis.
  21. Please see [the Docker installation documentation](https://docs.docker.com/installation/) for details on how to upgrade your Docker daemon.
  22. # License
  23. View [license information](https://raw.githubusercontent.com/tendermint/tendermint/master/LICENSE) for the software contained in this image.
  24. # User Feedback
  25. ## Issues
  26. If you have any problems with or questions about this image, please contact us through a [GitHub](https://github.com/tendermint/tendermint/issues) issue. If the issue is related to a CVE, please check for [a `cve-tracker` issue on the `official-images` repository](https://github.com/docker-library/official-images/issues?q=label%3Acve-tracker) first.
  27. You can also reach the image maintainers via [Slack](http://forum.tendermint.com:3000/).
  28. ## Contributing
  29. You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
  30. Before you start to code, we recommend discussing your plans through a [GitHub](https://github.com/tendermint/tendermint/issues) issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.