User Guide Cancel

Docker images for ColdFusion API Manager

Note:

To see a list of all Docker images for ColdFusion, API Manager, and Performance Monitoring Toolset, see ColdFusion Bintray.

Tag Conventions

  • latest - Latest available version of API Manager.
  • latest-2018 - Latest available version of ColdFusion 2018 API Manager.
  • 2016.0.1 - ColdFusion API Manager (2016 release) Update 1.

ColdFusion EULA

Before proceeding, it is mandatory that you read the EULA.

EULA needs to be accepted, via an environment variable, while running the container.

Frequently Asked Questions

Pull the image

Enter the command:

docker pull eaps-docker-coldfusion.bintray.io/apim/<product>:<version>
docker pull eaps-docker-coldfusion.bintray.io/apim/<product>:<version>
docker pull eaps-docker-coldfusion.bintray.io/apim/<product>:<version>

For example,

  • Standalone - docker pull eaps-docker-coldfusion.bintray.io/apim/apimanager:latest
  • Add-ons - docker pull eaps-docker-coldfusion.bintray.io/apim/addons:latest

API Manager

You can run API Manager and its add-ons as separate containers. The environment variables file contains all settings to startup Datastore and Analytics services.

To run docker:

Stand-alone

docker run --rm -it eaps-docker-coldfusion.bintray.io/apim/apimanager help
// Stand-alone: Lists supported commands and environment variables
docker run --rm -it eaps-docker-coldfusion.bintray.io/apim/apimanager help // Stand-alone: Lists supported commands and environment variables
docker run --rm -it eaps-docker-coldfusion.bintray.io/apim/apimanager help 

// Stand-alone: Lists supported commands and environment variables

Add-ons

docker run --rm -it eaps-docker-coldfusion.bintray.io/apim/addons help
// Add-ons: Lists supported commands and environment variables
docker run --rm -it eaps-docker-coldfusion.bintray.io/apim/addons help // Add-ons: Lists supported commands and environment variables
docker run --rm -it eaps-docker-coldfusion.bintray.io/apim/addons help 

// Add-ons: Lists supported commands and environment variables

To view a list of containers that are started, enter the command:

docker ps -a
docker ps -a
docker ps -a

To check the status of the containers, enter the command:

docker logs <containerID / containerName>
docker logs <containerID / containerName>
docker logs <containerID / containerName>

docker-compose.yml

version: "3"
services:
apimanager:
container_name: apimanager
image: eaps-docker-coldfusion.bintray.io/apim/apimanager:2016.0.1
depends_on:
- datastore
- analytics
ports:
- "9000:9000"
- "9100:9100"
env_file:
- apimanager.env
networks:
- webnet
datastore:
container_name: datastore_service
image: eaps-docker-coldfusion.bintray.io/apim/addons:2016.0.1
ports:
- "6379:6379"
volumes:
- "apim_datastore:/data/datastore"
env_file:
- datastore.env
networks:
- webnet
analytics:
container_name: analytics_service
image: eaps-docker-coldfusion.bintray.io/apim/addons:2016.0.1
ports:
- "9200:9200"
- "9300:9300"
env_file:
- analytics.env
networks:
- webnet
volumes:
apim_datastore:
networks:
webnet:
version: "3" services: apimanager: container_name: apimanager image: eaps-docker-coldfusion.bintray.io/apim/apimanager:2016.0.1 depends_on: - datastore - analytics ports: - "9000:9000" - "9100:9100" env_file: - apimanager.env networks: - webnet datastore: container_name: datastore_service image: eaps-docker-coldfusion.bintray.io/apim/addons:2016.0.1 ports: - "6379:6379" volumes: - "apim_datastore:/data/datastore" env_file: - datastore.env networks: - webnet analytics: container_name: analytics_service image: eaps-docker-coldfusion.bintray.io/apim/addons:2016.0.1 ports: - "9200:9200" - "9300:9300" env_file: - analytics.env networks: - webnet volumes: apim_datastore: networks: webnet:
version: "3"
services:

    apimanager: 
        container_name: apimanager
        image: eaps-docker-coldfusion.bintray.io/apim/apimanager:2016.0.1
        depends_on:
        - datastore
        - analytics
        ports:
        - "9000:9000"
        - "9100:9100"
        env_file:
        - apimanager.env 
        networks: 
        - webnet

    datastore:
        container_name: datastore_service 
        image: eaps-docker-coldfusion.bintray.io/apim/addons:2016.0.1
        ports:
        - "6379:6379"
        volumes:
        - "apim_datastore:/data/datastore"
        env_file:
        - datastore.env
        networks:
        - webnet

    analytics:
        container_name: analytics_service
        image: eaps-docker-coldfusion.bintray.io/apim/addons:2016.0.1
        ports:
        - "9200:9200"
        - "9300:9300"
        env_file:
        - analytics.env
        networks:
        - webnet

volumes:
    apim_datastore:

networks:
    webnet: 

You can access the Admin portal by using the url http://<host>:<port>/admin and the Subscriber portal using the url http://<host>:<port>/portal.

Environment variables

Note:

Required ENV variable: apim_acceptEULA=YES

Supported commands: help, start <.cfm>

apimanager.env

apim_acceptEULA=YES
apim_serial=<Serial Key>
apim_previousSerial=<Previous Serial Key (Upgrade)>
apim_password=<API Manager Admin Password>
apim_datastoreHost=<Datastore Hostname>
apim_datastorePort=<Datastore Port>
apim_datastorePassword=<Redis (Datastore) Password>
apim_datastoreSeed=<Datastore Encryption Seed>
apim_analyticsHost=<Analytics Server Hostname>
apim_analyticsPort=<Analytics Server Port>
apim_analyticsClusterPort=<Analytics Server Cluster Port>
apim_analyticsClusterName=<ElasticSearch Cluster Name>
apim_acceptEULA=YES apim_serial=<Serial Key> apim_previousSerial=<Previous Serial Key (Upgrade)> apim_password=<API Manager Admin Password> apim_datastoreHost=<Datastore Hostname> apim_datastorePort=<Datastore Port> apim_datastorePassword=<Redis (Datastore) Password> apim_datastoreSeed=<Datastore Encryption Seed> apim_analyticsHost=<Analytics Server Hostname> apim_analyticsPort=<Analytics Server Port> apim_analyticsClusterPort=<Analytics Server Cluster Port> apim_analyticsClusterName=<ElasticSearch Cluster Name>
apim_acceptEULA=YES 
apim_serial=<Serial Key> 
apim_previousSerial=<Previous Serial Key (Upgrade)> 
apim_password=<API Manager Admin Password> 
apim_datastoreHost=<Datastore Hostname> 
apim_datastorePort=<Datastore Port> 
apim_datastorePassword=<Redis (Datastore) Password> 
apim_datastoreSeed=<Datastore Encryption Seed> 
apim_analyticsHost=<Analytics Server Hostname> 
apim_analyticsPort=<Analytics Server Port> 
apim_analyticsClusterPort=<Analytics Server Cluster Port> 
apim_analyticsClusterName=<ElasticSearch Cluster Name>

API Manager add-ons

Note:

Required ENV variable: acceptEULA=YES

analytics.env

acceptEULA=YES
startAnalyticsService=<true/false>
analyticsClusterName=<Elasticsearch cluster name>
acceptEULA=YES startAnalyticsService=<true/false> analyticsClusterName=<Elasticsearch cluster name>
acceptEULA=YES 
startAnalyticsService=<true/false> 
analyticsClusterName=<Elasticsearch cluster name>

datastore.env

acceptEULA=YES
startDatastoreService=<true/false>
datastorePassword=<Redis password>
acceptEULA=YES startDatastoreService=<true/false> datastorePassword=<Redis password>
acceptEULA=YES 
startDatastoreService=<true/false> 
datastorePassword=<Redis password>

Run Docker compose. Enter the command:

docker-compose up -d
docker-compose up -d
docker-compose up -d

Get help faster and easier

New user?