Installation

Run the imgcompress Web App using Docker.
No local dependencies, no configuration clutter. Just a high-performance image optimization tool ready in seconds.

🚀 Quick Start (Recommended)

Fresh Install?

If you have used imgcompress before, ensure you have the newest version by running:

docker pull karimz1/imgcompress:latest

Docker Compose (Preferred) Single Container (docker run)

Best choice for long-running setups and easy upgrades.

Create a docker-compose.yml file:

services:
  imgcompress:
    image: karimz1/imgcompress:latest
    container_name: imgcompress
    restart: always
    ports:
      - "3001:5000"                     # HOST:CONTAINER — change 3001 if needed
    environment:
      - DISABLE_LOGO=true               # Optional: disable mascot
      - DISABLE_STORAGE_MANAGEMENT=true # Optional: disable the Storage Management

Launch the container:
```
docker compose up -d
```
👉 Access the UI

Standard Mode (Default — Mascot Enabled)

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

Minimal Mode (Hide Mascot)

To disable the mascot and use a cleaner, text-only interface, add -e DISABLE_LOGO=true to your command:

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

👉 Access the UI

🌐 Accessing the UI

Once the container is running, open your web browser and navigate to:

👉 http://localhost:3001

🔄 Maintenance & Updates

Keep your instance secure and up-to-date.

Method	Command
Docker Compose	`docker compose pull && docker compose up -d`
Docker Run	`docker pull karimz1/imgcompress:latest && docker rm -f imgcompress && docker run -d --name imgcompress -p 3001:5000 --restart unless-stopped karimz1/imgcompress:latest`

🔖 Choosing Your Version

Recommended

Use latest unless you have a specific reason not to.

Tag	Description	Best For
Stable (`latest`)	Fully tested release. Each version is manually QA-verified.	Most users.
Pinned (`X.Y.Z`)	An exact version that never changes (e.g., `0.3.1`).	Production & Reproducibility.
Nightly (`nightly`)	Latest changes & dependency bumps.	Beta testing new features.

Pinned Release (e.g., `0.3.1`)

A version that never changes. Ideal for production environments requiring strict reproducibility.

View all available Tags

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

Nightly (`nightly`)

Includes the newest features and dependency updates.
⚠️ May include breaking changes. Think of it as a public beta.

Architecture	Platform	Status
linux/amd64	x86-64 (Linux, Windows WSL 2)	✅ Supported
linux/arm64	ARM64 (Apple Silicon, RPi 4+, AWS Graviton)	✅ Supported

Windows Desktop: Runs via Docker Desktop + WSL 2 (no native Windows-container build needed).

Testing Note

All platforms above are built and run in CI with QEMU multi-arch emulation and a GitHub Actions matrix. That means the images pass automated tests, but not every architecture has been manually tried on physical hardware.

🛡️ Isolated & High-Security Deployment (Zero-Networking)

For enterprises, government agencies, or individuals requiring strict data isolation (e.g., air-gapped systems or HIPAA/GDPR compliance), imgcompress supports a Zero-Networking mode.

This specialized setup:

Disables all outbound traffic from the application container.
Protects against data exfiltration at the infrastructure level.
Maintains local accessibility via a secure internal bridge.

👉 View the Zero-Networking / Air-Gapped Setup guide.