Skip to content

Launch

You are able to launch APIchamp by using the docker image from dockerhub.

Config files

You have to start the APIchamp docker image including two configuration files. - openapi specification - APIchamp configuration file

Both files must be mounted into the /app folder of the APIchamp docker image.

Launch with docker-compose

Start the APIchamp image by using docker-compose and mount the specs folder (having your configurations files) into the docker image /app folder.

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

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 -d -it
  -v "/specs/openapi.yaml:/app/openapi.yml"
  -v "/specs/config.yaml:/app/config.yml" # OPTIONAL
  -p 8080:8080
  apichamp-core:1.4.0