From 3c2f06e9f071a62041f12b8ba77f05a1af7bf287 Mon Sep 17 00:00:00 2001 From: Richard Date: Tue, 11 Jun 2024 10:10:58 +0200 Subject: [PATCH] docs: added section on environment variables Signed-off-by: Richard --- docs/features/DevReadMe.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/features/DevReadMe.md b/docs/features/DevReadMe.md index bfcfb013fd..0490d4e4aa 100644 --- a/docs/features/DevReadMe.md +++ b/docs/features/DevReadMe.md @@ -7,6 +7,7 @@ See the [README](../../README.md) for details about this repository and informat - [Introduction](#introduction) - [Developer Demos](#developer-demos) - [Running](#running) + - [Configuring ACA-PY: Environment Variables](#configuring-aca-py-environment-variables) - [Configuring ACA-PY: Command Line Parameters](#configuring-aca-py-command-line-parameters) - [Docker](#docker) - [Locally Installed](#locally-installed) @@ -42,6 +43,26 @@ To put ACA-Py through its paces at the command line, checkout our [demos](../dem ## Running +### Configuring ACA-PY: Environment Variables + +All CLI parameters in ACA-PY have equivalent environment variables. To convert a CLI argument to an environment +variable: + +1. **Basic Conversion**: Convert the CLI argument to uppercase and prefix it with `ACAPY_`. For example, `--admin` + becomes `ACAPY_ADMIN`. + +2. **Multiple Parameters**: Arguments that take multiple parameters, such as `--admin 0.0.0.0 11000`, should be wrapped + in an array. For example, `ACAPY_ADMIN="[0.0.0.0, 11000]"` +3. **Repeat Parameters**: Arguments like `-it `, which can be repeated, must be wrapped inside + another array and string escaped. For example, instead of: `-it http 0.0.0.0 11000 ws 0.0.0.0 8023` + use: `ACAPY_INBOUND_TRANSPORT=[[\"http\",\"0.0.0.0\",\"11000\"],[\"ws\",\"0.0.0.0\",\"8023\"]]` + +For a comprehensive list of all arguments, argument groups, CLI args, and their environment variable equivalents, please +see +the [argparse.py](https://github.com/hyperledger/aries-cloudagent-python/blob/main/aries_cloudagent/config/argparse.py) +file. + + ### Configuring ACA-PY: Command Line Parameters ACA-Py agent instances are configured through the use of command line