Appearance

Docker Image Configuration ​

WARNING

The Docker image is not suitable for production use. It is meant for running locally to replicate your production stack locally for development purposes.

The Icefiery Docker image is pre-configured for local development and testing purposes. No additional configuration is required to get started.

License ​

Our Docker container is release under the Icefiery Docker Image – End User License Agreement.

By using the Docker image you agree to its terms.

Quick Start ​

Run the container:

bash
docker run -d \
  --name icefiery \
  -p 5100:5100 \
  ghcr.io/icefiery-com/icefiery:latest

Docker Compose ​

Alternatively add Icefiery to your docker-compose.yml file:

yaml
version: "3.9"
services:
  icefiery:
    image: ghcr.io/icefiery-com/icefiery:latest
    ports:
      - 5100:5100

Docker Compose won't pull new versions of the image automatically. Run docker-compose pull icefiery periodically in the project directory to pull the latest version.

Changing the port ​

If you map the port from 5100 to another value, make sure to add it as an env variable ICEFIERY_PORT:

bash
docker run -d \
  --name icefiery \
  -p 8080:5100 \
  -e ICEFIERY_PORT=8080 \
  ghcr.io/icefiery-com/icefiery:latest

Or in docker-compose.yml:

yaml
version: "3.9"
services:
  icefiery:
    image: ghcr.io/icefiery-com/icefiery:latest
    ports:
      - 8080:5100
    environment:
      ICEFIERY_PORT: 8080

This will help the API return correct URLs.

Image Version ​

Supported: latest

Incremental or historical versions are not provided. We update the image continuously as Icefiery evolves. Keep pulling the latest version regularly to keep up with the production version at icefiery.com.

Service URLs ​

Pre-configured Environment ​

The container comes with a pre-seeded environment for immediate testing:

  • Project ID: prj_000000000000000000000000
  • Private API Key: local
  • Upload Key: local

Example requests ​

bash
curl -X POST \
  -H "X-Original-Filename: example.jpg" \
  --data-binary @example.jpg \
  http://localhost:5100/api/v1/upload-temporary-image/local

curl -X POST \
  -H "X-API-KEY: local" \
  -H "Content-Type: application/json" \
  -d '{"temporaryImageUrl": "http://localhost:5100/res/temporary/tmp_xyz.jpg"}' \
  http://localhost:5100/api/v1/save-temporary-image

Example CDN URL ​

html
<img src="http://localhost:5100/res/img_abc123.png" />
<img src="http://localhost:5100/res/img_abc123.png?width=300" />
<img src="http://localhost:5100/res/img_abc123.png?width=300&height=200" />