tendermint/DOCKER/README.md

57 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2018-06-06 11:04:42 -04:00
# Docker
## Supported tags and respective `Dockerfile` links
DockerHub tags for official releases are [here](https://hub.docker.com/r/tendermint/tendermint/tags/). The "latest" tag will always point to the highest version number.
Official releases can be found [here](https://github.com/tendermint/tendermint/releases).
The Dockerfile for tendermint is not expected to change in the near future. The master file used for all builds can be found [here](https://raw.githubusercontent.com/tendermint/tendermint/master/DOCKER/Dockerfile).
2017-09-25 20:06:49 +03:00
Respective versioned files can be found https://raw.githubusercontent.com/tendermint/tendermint/vX.XX.XX/DOCKER/Dockerfile (replace the Xs with the version number).
2017-09-25 20:06:49 +03:00
## Quick reference
2017-09-25 20:06:49 +03:00
- **Where to get help:** https://tendermint.com/
- **Where to file issues:** https://github.com/tendermint/tendermint/issues
- **Supported Docker versions:** [the latest release](https://github.com/moby/moby/releases) (down to 1.6 on a best-effort basis)
2017-09-25 20:06:49 +03:00
2018-06-06 11:04:42 -04:00
## Tendermint
2015-06-10 12:06:28 -04:00
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.
For more background, see the [the docs](https://tendermint.com/docs/introduction/#quick-start).
To get started developing applications, see the [application developers guide](https://tendermint.com/docs/introduction/quick-start.html).
2018-06-06 11:04:42 -04:00
## How to use this image
2016-02-04 21:21:13 -08:00
2018-06-06 11:04:42 -04:00
### Start one instance of the Tendermint core with the `kvstore` app
2015-06-10 12:06:28 -04:00
2018-05-22 15:09:47 -04:00
A quick example of a built-in app and Tendermint core in one container.
```
docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint init
docker run -it --rm -v "/tmp:/tendermint" tendermint/tendermint node --proxy_app=kvstore
2016-02-04 21:21:13 -08:00
```
2018-06-06 11:04:42 -04:00
## Local cluster
To run a 4-node network, see the `Makefile` in the root of [the repo](https://github.com/tendermint/tendermint/blob/master/Makefile) and run:
2018-05-22 15:09:47 -04:00
```
make build-linux
make build-docker-localnode
make localnet-start
```
2018-05-22 15:09:47 -04:00
Note that this will build and use a different image than the ones provided here.
2018-06-06 11:04:42 -04:00
## License
- Tendermint's license is [Apache 2.0](https://github.com/tendermint/tendermint/blob/master/LICENSE).
2018-06-06 11:04:42 -04:00
## Contributing
2018-05-22 15:09:47 -04:00
Contributions are most welcome! See the [contributing file](https://github.com/tendermint/tendermint/blob/master/CONTRIBUTING.md) for more information.