github.com/badrootd/nibiru-cometbft@v0.37.5-0.20240307173500-2a75559eee9b/DOCKER/README.md (about)

     1  # Docker
     2  
     3  ## Supported tags and respective `Dockerfile` links
     4  
     5  DockerHub tags for official releases are [here](https://hub.docker.com/r/cometbft/cometbft/tags/). The "latest" tag will always point to the highest version number.
     6  
     7  Official releases can be found [here](https://github.com/cometbft/cometbft/releases).
     8  
     9  The Dockerfile for CometBFT is not expected to change in the near future. The main file used for all builds can be found [here](https://raw.githubusercontent.com/cometbft/cometbft/v0.37.x/DOCKER/Dockerfile).
    10  
    11  Respective versioned files can be found <https://raw.githubusercontent.com/cometbft/cometbft/vX.XX.XX/DOCKER/Dockerfile> (replace the Xs with the version number).
    12  
    13  ## Quick reference
    14  
    15  - **Where to get help:** <https://cometbft.com/>
    16  - **Where to file issues:** <https://github.com/cometbft/cometbft/issues>
    17  - **Supported Docker versions:** [the latest release](https://github.com/moby/moby/releases) (down to 1.6 on a best-effort basis)
    18  
    19  ## CometBFT
    20  
    21  CometBFT is Byzantine Fault Tolerant (BFT) middleware that takes a state transition machine, written in any programming language, and securely replicates it on many machines.
    22  
    23  For more background, see the [the docs](https://docs.cometbft.com/v0.37/introduction/#quick-start).
    24  
    25  To get started developing applications, see the [application developers guide](https://docs.cometbft.com/v0.37/introduction/quick-start.html).
    26  
    27  ## How to use this image
    28  
    29  ### Start one instance of the CometBFT with the `kvstore` app
    30  
    31  A quick example of a built-in app and CometBFT in one container.
    32  
    33  ```sh
    34  docker run -it --rm -v "/tmp:/cometbft" cometbft/cometbft init
    35  docker run -it --rm -v "/tmp:/cometbft" cometbft/cometbft node --proxy_app=kvstore
    36  ```
    37  
    38  ## Local cluster
    39  
    40  To run a 4-node network, see the `Makefile` in the root of [the repo](https://github.com/cometbft/cometbft/blob/v0.37.x/Makefile) and run:
    41  
    42  ```sh
    43  make build-linux
    44  make build-docker-localnode
    45  make localnet-start
    46  ```
    47  
    48  Note that this will build and use a different image than the ones provided here.
    49  
    50  ## License
    51  
    52  - CometBFT's license is [Apache 2.0](https://github.com/cometbft/cometbft/blob/v0.37.x/LICENSE).
    53  
    54  ## Contributing
    55  
    56  Contributions are most welcome! See the [contributing file](https://github.com/cometbft/cometbft/blob/v0.37.x/CONTRIBUTING.md) for more information.