@@ -7,19 +7,19 @@ Although the images will be built by a CI pipeline in this repository, if
77necessary a maintainer can build them manually by following the instructions
88below.
99
10- ### Logging into the Docker registry
10+ ### Logging into the GitHub registry
1111
12- To be able to push to GitHub a personal access token is needed, see instructions
13- [ here] ( https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic ) .
12+ To be able to push a Docker image to the GitHub registry, a personal access
13+ token is needed, see instructions [ here] ( https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic ) .
1414In summary, if you do not have a suitable personal access token, generate one
1515[ here] ( https://github.com/settings/tokens/new?scopes=write:packages ) .
1616
1717``` shell
18- DOCKER_REGISTRY =ghcr.io
18+ GITHUB_REGISTRY =ghcr.io
1919GITHUB_USER=< your-github-username>
2020GITHUB_TOKEN=< your-github-personal-access-token>
2121echo ${GITHUB_TOKEN} | \
22- docker login ${DOCKER_REGISTRY } -u " ${GITHUB_USER} " --password-stdin
22+ docker login ${GITHUB_REGISTRY } -u " ${GITHUB_USER} " --password-stdin
2323```
2424
2525### Building and pushing the Docker image
@@ -48,10 +48,10 @@ DOCKER_BUILDKIT=1 docker build . \
4848 --build-arg DEBIAN_VERSION=${DEBIAN_VERSION} \
4949 --build-arg GCC_VERSION=${GCC_VERSION} \
5050 --build-arg CONAN_VERSION=${CONAN_VERSION} \
51- --tag ${DOCKER_REGISTRY } /${DOCKER_IMAGE} \
51+ --tag ${GITHUB_REGISTRY } /${DOCKER_IMAGE} \
5252 --platform linux/amd64
5353
54- docker push ${DOCKER_REGISTRY } /${DOCKER_IMAGE}
54+ docker push ${GITHUB_REGISTRY } /${DOCKER_IMAGE}
5555```
5656
5757#### Building the Docker image for Clang.
@@ -71,10 +71,10 @@ DOCKER_BUILDKIT=1 docker build . \
7171 --build-arg DEBIAN_VERSION=${DEBIAN_VERSION} \
7272 --build-arg CLANG_VERSION=${CLANG_VERSION} \
7373 --build-arg CONAN_VERSION=${CONAN_VERSION} \
74- --tag ${DOCKER_REGISTRY } /${DOCKER_IMAGE} \
74+ --tag ${GITHUB_REGISTRY } /${DOCKER_IMAGE} \
7575 --platform linux/amd64
7676
77- docker push ${DOCKER_REGISTRY } /${DOCKER_IMAGE}
77+ docker push ${GITHUB_REGISTRY } /${DOCKER_IMAGE}
7878```
7979
8080#### Running the Docker image
@@ -84,7 +84,7 @@ can do so with the following command:
8484
8585``` shell
8686CODEBASE=< path to the rippled repository>
87- docker run --rm -it -v ${CODEBASE} :/rippled ${DOCKER_REGISTRY } /${DOCKER_IMAGE}
87+ docker run --rm -it -v ${CODEBASE} :/rippled ${GITHUB_REGISTRY } /${DOCKER_IMAGE}
8888```
8989
9090Once inside the container you can run the following commands to build ` rippled ` :
@@ -103,7 +103,7 @@ cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake \
103103 -DCMAKE_BUILD_TYPE=${BUILD_TYPE} ..
104104# Build and test rippled. Setting the parallelism too high, e.g. to $(nproc),
105105# can result in an error like "gmake[2]: ...... Killed".
106- PARALLELISM=4
106+ PARALLELISM=2
107107cmake --build . -j ${PARALLELISM}
108108./rippled --unittest --unittest-jobs ${PARALLELISM}
109109```
0 commit comments