Skip to content

Commit

Permalink
docs(readme): update list of env vars
Browse files Browse the repository at this point in the history
  • Loading branch information
egasimus committed Oct 19, 2023
1 parent 1b77abe commit 76bddf9
Showing 1 changed file with 24 additions and 27 deletions.
51 changes: 24 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,36 +236,33 @@ support for Podman.
# Configuration
|Env var|Default path|Description|
|-|-|-|
|`FADROMA_ROOT` |current working directory |Root directory of project|
|`FADROMA_PROJECT` |`@/ops.ts` |Project command entrypoint|
|`FADROMA_BUILD_STATE` |`@/wasm` |Checksums of compiled contracts by version|
|`FADROMA_UPLOAD_STATE`|`@/state/uploads.csv` |Receipts of uploaded contracts|
|`FADROMA_DEPLOY_STATE`|`@/state/deployments.csv` |Receipts of instantiated (deployed) contracts|
|Env var|Description|
|-|-|
|**`FADROMA_ARTIFACTS`** |(path to directory) project artifact cache|
|**`FADROMA_BUILD_DOCKERFILE`**|(path to dockerfile)dockerfile to build image if missing|
|**`FADROMA_BUILD_IMAGE`** |(docker image tag) image to run|
|**`FADROMA_BUILD_PODMAN`** |(boolean) whether to use podman instead of docker|
|**`FADROMA_BUILD_QUIET`** |(boolean) less log output|
|**`FADROMA_BUILD_RAW`** |(boolean) run the build script in the current environment instead of container|
|**`FADROMA_BUILD_SCRIPT`** |(path to script) build implementation|
|**`FADROMA_BUILD_STATE`** |Checksums of compiled contracts by version (default: `wasm`)|
|**`FADROMA_BUILD_VERBOSE`** |(boolean)more log output|
|**`FADROMA_DEPLOY_STATE`** |Receipts of instantiated (deployed) contracts (default: `state/deployments.csv`)|
|**`FADROMA_DOCKER`** |("host:port" or /path/to/socket) non-default docker socket address|
|**`FADROMA_PROJECT`** |Project command entrypoint (default: `ops.ts`)|
|**`FADROMA_PROJECT`** |(path) root of project|
|**`FADROMA_REBUILD`** |(boolean) builds always run, artifact cache is ignored|
|**`FADROMA_ROOT`** |Root directory of project (default: current working directory)|
|**`FADROMA_UPLOAD_STATE`** |Receipts of uploaded contracts (default: `state/uploads.csv`)|
|name|env var|description|
|-|-|-|
|**chainId**|`FADROMA_DEVNET_CHAIN_ID`|**string**: chain ID (set to reconnect to existing devnet)|
|**platform**|`FADROMA_DEVNET_PLATFORM`|**string**: what kind of devnet to instantiate (e.g. `scrt_1.9`)|
|**deleteOnExit**|`FADROMA_DEVNET_REMOVE_ON_EXIT`|**boolean**: automatically remove the container and state when your script exits|
|**keepRunning**|`FADROMA_DEVNET_KEEP_RUNNING`|**boolean**: don't pause the container when your script exits|
|**host**|`FADROMA_DEVNET_HOST`|**string**: hostname where the devnet is running|
|**port**|`FADROMA_DEVNET_PORT`|**string**: port on which to connect to the devnet|
|env var|type|description|
|-|-|-|
|**`FADROMA_ARTIFACTS`**|path|project artifact cache
|**`FADROMA_BUILD_DOCKERFILE`**|path to dockerfile|dockerfile to build image if missing
|**`FADROMA_BUILD_IMAGE`**|docker image tag|image to run
|**`FADROMA_BUILD_PODMAN`**|flag|whether to use podman instead of docker
|**`FADROMA_BUILD_QUIET`**|flag|less log output
|**`FADROMA_BUILD_RAW`**|flag|run the build script in the current environment instead of container
|**`FADROMA_BUILD_SCRIPT`**|path to script|build implementation
|**`FADROMA_BUILD_VERBOSE`**|flag|more log output
|**`FADROMA_DOCKER`**|host:port or socket|non-default docker socket address
|**`FADROMA_PROJECT`**|path|root of project
|**`FADROMA_REBUILD`**|flag|builds always run, artifact cache is ignored
|`FADROMA_DEVNET_CHAIN_ID`|**chainId**|**string**: chain ID (set to reconnect to existing devnet)|
|`FADROMA_DEVNET_PLATFORM`|**platform**|**string**: what kind of devnet to instantiate (e.g. `scrt_1.9`)|
|`FADROMA_DEVNET_REMOVE_ON_EXIT`|**deleteOnExit**|**boolean**: automatically remove the container and state when your script exits|
|`FADROMA_DEVNET_KEEP_RUNNING`|**keepRunning**|**boolean**: don't pause the container when your script exits|
|`FADROMA_DEVNET_HOST`|**host**|**string**: hostname where the devnet is running|
|`FADROMA_DEVNET_PORT`|**port**|**string**: port on which to connect to the devnet|
# State
Expand Down

0 comments on commit 76bddf9

Please sign in to comment.