User Guide Cancel

Docker images for ColdFusion API Manager

  1. ColdFusion Tools User Guide
  2. Performance Monitoring Toolset
    1. Overview of ColdFusion Performance Monitoring Toolset
    2. Auto-discovery of ColdFusion nodes and clusters
    3. Code profiler in ColdFusion Performance Monitoring Toolset
    4. Configure ColdFusion Performance Monitoring Toolset settings
    5. Install ColdFusion Performance Monitoring Toolset
    6. View cloud metrics
    7. Monitor GraphQL in Performance Monitoring Toolset
    8. Configure TLS/SSL and Authentication for Elasticsearch 8.x  in Performance Monitoring Toolset
    9. View cluster and node metrics
    10. View data source metrics
    11. View external services
    12. View incoming services
    13. View list of sites and busy connections
    14. View topology of sites
    15. Datastore Health Monitoring
    16. Performance Monitoring Toolset Update 1
    17. Secure Performance Monitoring Toolset with HTTPS/SSL
    18. Performance Monitoring Toolset deployment guide
  3. Use ColdFusion Builder
    1. About ColdFusion Builder
    2. System requirements | ColdFusion Builder
    3. Install ColdFusion Builder
    4. Edit code in ColdFusion Builder
    5. Manage servers in ColdFusion Builder
    6. Manage projects in ColdFusion Builder
    7. What's new in Adobe ColdFusion Builder (2018 release)
    8. Frequently Asked Questions (FAQ) | Adobe ColdFusion Builder (2018 release)
    9. Debug applications in ColdFusion Builder
    10. ColdFusion Builder workbench
    11. ColdFusion Builder extensions
    12. Debugging Perspective in ColdFusion Builder
    13. Build mobile applications using ColdFusion Builder
    14. Bundled ColdFusion Server
    15. Debug mobile applications in ColdFusion Builder
    16. Use extensions in ColdFusion Builder
  4. Coldfusion API Manager
    1. Overview of Adobe ColdFusion API Manager
    2. Features in ColdFusion API Manager
    3. Get started with ColdFusion API Manager
    4. Install ColdFusion API Manager
    5. Authentication types
    6. Create and publish APIs
    7. Administrator
    8. Subscriber
    9. Throttling and rate limiting
    10. Notifications
    11. Connectors
    12. Set up cluster support
    13. Integrate ColdFusion and API Manager
    14. Metrics and Logging in API Manager
    15. Generate Swagger documents
    16. Configure SSL
    17. Known issues in this release
    18. Policies in ColdFusion API Manager
    19. Create a Redis cluster
    20. Multitenancy in API Manager
    21. 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>

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

Add-ons

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

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

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: 

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>

API Manager add-ons

Note:

Required ENV variable: acceptEULA=YES

analytics.env

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

datastore.env

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

Run Docker compose. Enter the command:

docker-compose up -d

 Adobe

Get help faster and easier

New user?