Export to Word On-Premises installation

# Setting up the application using a Docker container

1. Use instructions from the CKEditor Ecosystem customer dashboard to log into the Export to Word On-Premises (DOCX converter) Docker registry and pull the Docker image.

2. Containerize the application using docker or docker-compose.

3. Use a demo page to verify if the application works properly.

# Containerize example using docker

Launch the Docker container:

docker run --init -p 8080:8080 -e LICENSE_KEY=[your_license_key] docker.cke-cs.com/docx-converter:[version]

If you want use authorization you should provide SECRET_KEY:

docker run --init -p 8080:8080 -e LICENSE_KEY=[your_license_key] -e SECRET_KEY=[your_secret_key] docker.cke-cs.com/docx-converter:[version]

You can read more about using authorization in the authorization section.

# Containerize example using docker-compose

1. Create the docker-compose.yml file:

version: "3.8"
  services:
    image: docker.cke-cs.com/docx-converter:[version]
      ports:
        - "8080:8080"
      restart: always
      init: true
      environment:
        LICENSE_KEY: your_license_key
        # Secret Key is optional
        SECRET_KEY: secret_key

For details on SECRET_KEY usage check the authorization section.

2. Run:

docker-compose up

# Notes

• Without a correct LICENSE_KEY the application will not start. If the license is invalid, you’ll get a Wrong license key error in the logs and the application will not run.
• You should override the SECRET_KEY variable using a unique and hard to guess string for security reasons.

# Next steps

Use the http://localhost:8080/v1/convert endpoint to export DOCX files. Check out the authorization section to learn more about tokens and token endpoints.

You can also use the demo page available on http://localhost:8080/demo to generate an example DOCX file.

Refer to the Export to Word REST API documentation on http://localhost:8080/docs for more details.