Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added section on environment variables #3028

Merged
merged 2 commits into from
Jun 11, 2024
Merged

docs: added section on environment variables #3028

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3c2f06e
docs: added section on environment variables
Executioner1939 Jun 11, 2024
40d212d
Merge branch 'main' into feature/docs-env-vars-signed
ianco Jun 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions docs/features/DevReadMe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down
Loading