Skip to content

Launch with Docker

Launch APICHAMP on your environment by using the docker image from dockerhub.

Config files

Precondition: APICHAMP will only start if you provide valid configuration files.

Both files must be either copied or mounted into the /app folder of your apichamp-core container.

Both examples below show how to start APICHAMP with mounted configuration files. For your usecase and security reasons it might be recommended to copy the files into the image´s /app path on container creation.

Launch with docker run

Start the APICHAMP core image using docker run and mount the configuration files into the docker image /app folder.

docker run -it
  -v /opt/demo/specs/openapi.yaml:/app/openapi.yaml
  -v /opt/demo/specs/config.yaml:/app/config.yaml
  -p 8080:8080
  apichamp/apichamp-core:latest

USE ABSOLUTE PATH TO YOUR FILES

Launch with docker-compose

Start the APICHAMP image by using docker-compose and mount the specs folder (with your configuration files) into the docker image /app folder. 

version: "3.9"
  services:
    apichamp:
      image: apichamp/apichamp-core:latest
      ports:
        - "8080:8080"
      volumes:
        - ./specs:/app