github.com/status-im/status-go@v1.1.0/_assets/compose/bootnode/README.md (about)

     1  # Status Bootnode
     2  
     3  This folder contains setup for running your own Bootnode.
     4  It uses:
     5  
     6  * [Docker Compose](https://docs.docker.com/compose/) for managing the bootnode container.
     7  * [Makefile](https://www.gnu.org/software/make/) to simplify the process for the user.
     8  
     9  # Requirements
    10  
    11  This Makefile uses two tools: `jq` and `docker-compose`.
    12  
    13  # Usage
    14  
    15  To simply start a container run `make`, other commands include:
    16  
    17  * `make start` - Starts the `status-go-bootnode` container.
    18  * `make stop` - Stops the container.
    19  * `make show` - Shows you current status of the container.
    20  * `make logs` - Shows you logs of the container.
    21  * `make enode` - Shows `enode` address of bootnode.
    22  * `make keys/nodekey` - Creates unique identity for bootnode.
    23  
    24  # Settings
    25  
    26  All settings are passed through environment variables:
    27  
    28  * `LISTEN_PORT` - Bootnode UDP port, by default it's `30301` but you might want to use `443`.
    29  * `RPC_PORT` - Control port making it possible to use the [JSON-RPC API](https://github.com/ethereum/wiki/wiki/JSON-RPC).
    30  * `API_MODULES` - API modules to be made available via the `RPC_PORT`.
    31  * `CONTAINER_IMG` - Name of the container image. (default: `statusteam/status-go`)
    32  * `CONTAINER_TAG` - Tag of container image to use. (default: `v0.64.3`)
    33  * `CONTAINER_NAME` - Name of the container that will be created. (default: `status-go-bootnode`)
    34  * `LOG_LEVEL` - Set level of log messages to show. (valid: `1=ERROR`, `2=WARN`, `3=INFO`, `4=DEBUG`, `5=TRACE`)
    35  * `COMPOSE_UP_FLAGS` - Allows passing flags to `docker-compose up`