📂 API Providers > Docker Images

# Airnode Client Image

Table of Contents

Usually the Airnode is deployed on a serverless platform using the deployer. However, there is another option which is to run the Airnode in a docker container on your machine locally, on premise or cloud hosted.

A docker client image has been published on Docker Hub (opens new window). If you want to build the container from the source yourself, you can find the image and built instructions in the Airnode repository (opens new window).

# Configuration

The Airnode needs two configuration files for its run: config.json and secrets.env. These files need to be passed to the Docker container via volumes.

The Docker container looks for configuration files mounted internally in the /app/config directory.

Your current working directory should contain the configuration files above and you bind it to the /app/config directory for the docker using the --volume parameter.

# Usage

Example directory structure and commands for running the Airnode Docker container. The below commands are run from the depicted directory.

# Running Airnode

It is recommended to run the Airnode in a detached mode using the --detach parameter, but you may run the it without it as well.

If you want to connect Airnode to a blockchain running on localhost, you need to make the blockchain accessible from within the docker itself. If you use docker for linux you can use --network="host" parameter. If you are using Docker Desktop (on any platform), connect to http://host.docker.internal:8545 instead of http://127.0.0.1:8545. See https://stackoverflow.com/a/24326540 (opens new window).

# Checking Airnode logs

If you run the Airnode in a detached mode, you need to use the logs command to access the logs. You can also use --follow parameter to stream the Airnode log output.

docker logs airnode
1

or

docker logs --follow airnode
1

# Stopping Airnode

docker stop airnode
1
Last Updated: 12/13/2022, 11:41:09 AM