Getting Started Development Help & Support

Installation & Setup

Install imgcompress on your own server in minutes with Docker. Self-hosted image compression, WebP/AVIF conversion, and AI background removal — no cloud, no data sharing, full control over your files.

Get StartedDocker

Prerequisites#

You only need Docker installed. No other dependencies required.

Install#

Choose the method that works best for you.

Use Docker Compose if you want imgcompress to stay running on your server or NAS.

Create a docker-compose.yml file and paste the following:

yaml
services:
    imgcompress:
        image: karimz1/imgcompress:latest
        container_name: imgcompress
        restart: always
        ports:
        - "3001:5000"
        environment:
        # Set to true to remove the mascot and enable a minimal, mascot-free UI
        - DISABLE_LOGO=false
        # Set to true to disable the storage management features (e.g., for your users to not see all the files)
        - DISABLE_STORAGE_MANAGEMENT=false

Start the container:

bash
docker compose up -d

Open your browser at http://localhost:3001.

Default UI (with mascot)

The standard interface includes Captain Compress, the product mascot.

ImgCompress default web UI with Captain Compress mascot ImgCompress default web UI with Captain Compress mascot

Minimal UI (uncomment DISABLE_LOGO=true)

A clean, mascot-free interface ideal for professional, shared, or corporate environments.

ImgCompress minimal web UI without mascot, DISABLE_LOGO=true ImgCompress minimal web UI without mascot, DISABLE_LOGO=true

Try imgcompress instantly with a single command.

Default UI (with mascot)

bash
docker run -d --name imgcompress -p 3001:5000 karimz1/imgcompress:latest

ImgCompress default web UI with Captain Compress mascot ImgCompress default web UI with Captain Compress mascot

Minimal UI (DISABLE_LOGO=true)

A clean, mascot-free interface great for professional or corporate environments:

bash
docker run -d --name imgcompress -p 3001:5000 -e DISABLE_LOGO=true karimz1/imgcompress:latest

ImgCompress minimal web UI without mascot, DISABLE_LOGO=true ImgCompress minimal web UI without mascot, DISABLE_LOGO=true

Open your browser at http://localhost:3001.

Update#

Keeping imgcompress up to date takes two commands.

bash
docker compose pull
docker compose up -d

bash
docker pull karimz1/imgcompress:latest
docker rm -f imgcompress
docker run -d --name imgcompress -p 3001:5000 karimz1/imgcompress:latest

Versions#

Most users should stick with latest.

Tag	Type	Who is it for?
`latest`	Stable release	Recommended for everyone.
`nightly`	Daily build	For testing new features before they ship.

⚠️Nightly builds

The nightly tag rebuilds every few days, for hot patches from the main branch. It may contain experimental features or bugs. Not recommended for production.

Platform Support#

imgcompress runs on any platform that supports Docker:

Platform	Status
Standard PCs & Macs	✅ Supported
Windows (Docker Desktop)	✅ Supported
Linux (any distro)	✅ Supported
Apple Silicon (M1/M2/M3/M4)	✅ Supported
Raspberry Pi 4+	✅ Supported

Web UI Guide