Skip to content

Commit

Permalink
Cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
bisgardo committed Dec 6, 2023
1 parent b049f77 commit 925f3f6
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 9 deletions.
4 changes: 1 addition & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -128,9 +128,7 @@ RUN apt-get update && \
EXPOSE 8888
# Prometheus port ('concordium-node').
EXPOSE 9090
# GRPC port ('concordium-node').
EXPOSE 10000
# GRPC APIv2 port.
# GRPC API (v2) port.
EXPOSE 11000

COPY --from=build /target/bin/concordium-node /concordium-node
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,15 +105,15 @@ The project includes a full Docker Compose deployment for running a node and col
optionally along with a set of related services (each of which is enabled individually).

The main setup is configured in [`docker-compose.yaml`](./docker-compose.yaml)
and is thoroughly parameterized to work with any Concordium blockchain network (including custom ones).
and is thoroughly parameterized to work with any Concordium blockchain network (including unofficial ones).

It relies on features that are available only in relatively recent versions of Compose.
The `requirements.txt` file pins a compatible version (the latest v1 release at the time of this writing)
which may be installed (preferably in a [virtualenv](https://docs.python.org/3/library/venv.html))
using `pip install -r requirements.txt`.
The setup has not yet been tested with [Compose v2](https://docs.docker.com/compose/cli-command/).

To build and run a node/collector and Prometheus instance on the network Mainnet, adjust and run the following command:
To build and run a node/collector instance on Mainnet with Prometheus enabled, adjust and run the following command:

```shell
NODE_NAME=my_node \
Expand All @@ -127,7 +127,7 @@ docker-compose --project-name=mainnet up

where `<tag>` is as described above.

The variable `NODE_NAME` sets the name to be displayed on [CCDScan](https://ccdscan.io).
The variable `NODE_NAME` sets the name to be displayed on [CCDScan](https://ccdscan.io/nodes).

The variable `DOMAIN` determines which concrete network to join.
The publicly available official options are:
Expand Down Expand Up @@ -303,7 +303,7 @@ A GitHub Actions CI job for building and pushing the images to
[a public registry](https://hub.docker.com/r/bisgardo/concordium-node) is defined in
[`./.github/workflows/build-push.yaml`](.github/workflows/build-push.yaml).

A Mainnet node setup that includes a Prometheus instance may for example be run using the Docker Compose script like so:
For example, a Mainnet node setup that includes a Prometheus instance may be run using the Docker Compose script like so:

```shell
export NODE_NAME=my_node
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ services:
ports:
- "8888:8888" # P2P
- "9090:9090" # Prometheus (metrics)
- "11000:11000" # gRPC APIv2
- "11000:11000" # gRPC API (v2)
volumes:
- ${GENESIS_DATA_FILE}:/mnt/genesis.dat
- data:/mnt/data
Expand Down
2 changes: 1 addition & 1 deletion run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# NODE_NAME=<node-name> ./run.sh <network>
#
# where <network> is the network on which the node is intended to join
# and <node-name> is the name of the node to appear on the CCDScan instance of that network.
# and <node-name> is the name of the node to appear on CCDScan for that network.
#
# The parameters of the deployment are loaded from an environment file <network>.env in the current working directory.
# All images referenced in this file are expected to be pullable from the appropriate image registry.
Expand Down

0 comments on commit 925f3f6

Please sign in to comment.