From ac7fa4905d571fc013b3e1ae149cec3dac2b3c7e Mon Sep 17 00:00:00 2001 From: benbierens Date: Fri, 29 Sep 2023 10:40:48 +0200 Subject: [PATCH] Adds dockertag description --- Tests/CodexTests/README.md | 11 ++++++----- Tools/CodexNetDeployer/README.MD | 11 ++++++----- 2 files changed, 12 insertions(+), 10 deletions(-) diff --git a/Tests/CodexTests/README.md b/Tests/CodexTests/README.md index 7c39829..d691d97 100644 --- a/Tests/CodexTests/README.md +++ b/Tests/CodexTests/README.md @@ -19,8 +19,9 @@ The following environment variables allow you to override specific aspects of th ## Using a local Codex repository If you have a clone of the Codex git repository, and you want to run the tests using your local modifications, the following environment variable options are for you. Please note that any changes made in Codex's 'vendor' directory will be discarded during the build process. -| Variable | Description | -|----------------|---------------------------------------------------------------------------------------------------------------------| -| CODEXREPOPATH | Path to the Codex repository. | -| DOCKERUSERNAME | Username of your Dockerhub account. | -| DOCKERPASSWORD | Password OR access-token for your Dockerhub account. You can omit this variable to use your system-default account. | +| Variable | Description | +|----------------|--------------------------------------------------------------------------------------------------------------------------| +| CODEXREPOPATH | Path to the Codex repository. | +| DOCKERUSERNAME | Username of your Dockerhub account. | +| DOCKERPASSWORD | Password OR access-token for your Dockerhub account. You can omit this variable to use your system-default account. | +| DOCKERTAG | Optional. Tag used for docker image that will be built and pushed to the Dockerhub account. Random ID used when not set. | diff --git a/Tools/CodexNetDeployer/README.MD b/Tools/CodexNetDeployer/README.MD index c60dd71..d85486a 100644 --- a/Tools/CodexNetDeployer/README.MD +++ b/Tools/CodexNetDeployer/README.MD @@ -18,8 +18,9 @@ The arguments allow you to configure quite a bit, but not everything. Here are s ## Using a local Codex repository If you have a clone of the Codex git repository, and you want to deploy a network using your local modifications, the following environment variable options are for you. Please note that any changes made in Codex's 'vendor' directory will be discarded during the build process. -| Variable | Description | -|----------------|---------------------------------------------------------------------------------------------------------------------| -| CODEXREPOPATH | Path to the Codex repository. | -| DOCKERUSERNAME | Username of your Dockerhub account. | -| DOCKERPASSWORD | Password OR access-token for your Dockerhub account. You can omit this variable to use your system-default account. | +| Variable | Description | +|----------------|--------------------------------------------------------------------------------------------------------------------------| +| CODEXREPOPATH | Path to the Codex repository. | +| DOCKERUSERNAME | Username of your Dockerhub account. | +| DOCKERPASSWORD | Password OR access-token for your Dockerhub account. You can omit this variable to use your system-default account. | +| DOCKERTAG | Optional. Tag used for docker image that will be built and pushed to the Dockerhub account. Random ID used when not set. |