Skip to content

Files

Latest commit

 

History

History

docker

Running ACA-Py with the acapy-plugin-pickup Plugin

Quickstart

To build the container, from the docker folder run:

$ docker build -f ./Dockerfile --tag acapy-plugin-pickup ..

To start an agent using the default configuration:

$ docker run -it -p 3000:3000 -p 3001:3001 --rm acapy-plugin-pickup

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 acapy-plugin-pickup 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-pickup/acapy_plugin_pickup:/home/indy/acapy-plugin-pickup/acapy_plugin_pickup:z \
	acapy-plugin-pickup

Adjusting Parameters

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

$ docker build -t acapy-plugin-pickup .

Listing configuration options

To see a list of configuration options, run:

$ docker run -it --rm acapy-plugin-pickup 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-plugin-pickup 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-plugin-pickup 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-plugin-pickup start --help

Trouble shooting

Apple silicon using ARM may need platform flag(DOCKER_DEFAULT_PLATFORM=linux/amd64) for docker. example

DOCKER_DEFAULT_PLATFORM=linux/amd64 docker build -f ./Dockerfile --tag acapy-plugin-pickup ..