README.md

Running ACA-Py with the Toolbox Plugin

Quickstart

To build the container:

$ docker build -t acapy-toolbox .

To start an agent using the default configuration:

$ docker run -it -p 3000:3000 -p 3001:3001 --rm acapy-toolbox

For development purposes, it is often useful to use local versions of the code rather than rebuilding a new container with the changes.

To start an agent using the default configuration and local versions of ACA-Py and/or the toolbox plugin (paths must be adapted to your environment):

$ docker run -it -p 3000:3000 -p 3001:3001 --rm \
	-v ../aries-cloudagent-python/aries_cloudagent:/home/indy/site-packages/aries_cloudagent:z \
	-v ./acapy_plugin_toolbox:/home/indy/acapy_plugin_toolbox:z \
	acapy-toolbox

Adjusting Parameters

For each of the commands listed below, ensure the image has been built:

$ docker build -t acapy-toolbox .

Listing configuration options

To see a list of configuration options, run:

$ docker run -it --rm acapy-toolbox start --help

Command line

The entry point for the container image allows adding configuration options on startup. When no command line options are given, the following command is run by default in the container:

$ aca-py start --arg-file default.yml

To add your own configuration (such as adjusting the Admin API to run on a different port), while keeping the defaults:

$ docker run -it -p 3000:3000 -p 3003:3003 --rm \
    acapy-toolbox start --arg-file default.yml --admin 0.0.0.0 3003

Configuration files

To use your own configuration files, consider loading them to a shared volume and specifying the file on startup:

$ docker run -it -p 3000:3000 -p 3001:3001 --rm \
    -v ./configs:/local/configs:z \
    acapy-toolbox start --arg-file /local/configs/my_config.yml

Environment

ACA-Py will also load options from the environment. This enables using Docker Compose env files to load configuration when appropriate. To see a list of configuration options and the mapping to environment variables map, run:

$ docker run -it --rm acapy-toolbox start --help