Skip to content

Commit

Permalink
Merge pull request #3028 from Executioner1939/feature/docs-env-vars-s…
Browse files Browse the repository at this point in the history
…igned

docs: added section on environment variables
  • Loading branch information
WadeBarnes authored Jun 11, 2024
2 parents d0f447f + 40d212d commit db54bf7
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/features/DevReadMe.md
Original file line number Diff line number Diff line change
@@ -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 <module> <host> <port>`, 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

0 comments on commit db54bf7

Please sign in to comment.