Edit online

Running WebHelp Responsive from a Docker image

This topic explains how to install the WebHelp Responsive plugin in a Docker image.

To install the Oxygen XML WebHelp Responsive plugin in a Docker image, follow these steps:

  1. Download and install Docker.
  2. Create a folder (for example, webhelp-docker).
  3. Move the licensekey.txt file for the WebHelp Responsive plugin to the newly created folder.
  4. Create a new file named Dockerfile with the following content and store it in the newly created folder:
    # Use the latest DITA-OT image as parent
    FROM ghcr.io/dita-ot/dita-ot:3.6.1
    
    # Build argument form the WebHelp download link
    ARG WEBHELP_DOWNLOAD_LINK
    
    # Download the WebHelp zip kit.
    RUN curl -o /tmp/oxygen-webhelp.zip ${WEBHELP_DOWNLOAD_LINK}
    
    # Unzip the WebHelp kit to the plugins directory of the DITA-OT distribution.
    RUN unzip /tmp/oxygen-webhelp.zip -d /opt/app/plugins
    
    # Remove the WebHelp zip.
    RUN rm /tmp/oxygen-webhelp.zip
    
    # Copy the license key.
    COPY licensekey.txt /opt/app/
    
    # Install the WebHelp plugins.
    RUN dita --install
  5. Build an image from the Dockerfile by running the following command:
    docker image build --build-arg WEBHELP_DOWNLOAD_LINK=https://www.oxygenxml.com/InstData/WebHelp/oxygen-webhelp-dot-3.x.zip -t webhelp-docker:23.1 ${PATH_TO_DOCKERFILE}
  6. Run a WebHelp Responsive transformation from docker:
    docker run -it \
    -v ${PATH_TO_DITAMAP}:/src webhelp-docker:23.1 \
    -i /src/map.ditamap \
    -o /src/out \
    -f webhelp-responsive -v
    Attention: Make sure that you do not violate the license model. More information can be found in the Oxygen XML WebHelp Responsive plugin End-User License Agreement.