Getting Started: Let's set it up!¶

If you want imgcompress to stay on your server or NAS, use a Docker Compose file.

1. Create a file named docker-compose.yml and paste this inside:

   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
   

   Customizing your UI

   You can customize your experience by editing the environment section:

   • DISABLE_LOGO=true: Switches to the clean, mascot-free UI seen on the homepage.
   • DISABLE_STORAGE_MANAGEMENT=true: Hides management features if you don't want users to see all processed files.

   Visual Preview:

   

   

   Standard UI Clean UI (DISABLE_LOGO=true)

   Slide to compare the two UI styles. Toggle DISABLE_LOGO=true in your docker-compose.yml to switch.

2. Run this command in the same folder:

   docker compose up -d
   

3. Open your browser and go to http://localhost:3001.

If you just want to try it out quickly, run this command in your terminal:

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

Now open your browser and go to http://localhost:3001.

1. Get the new version

   docker compose pull
   

2. Restart

   docker compose up -d
   

1. Get the new version

   docker pull karimz1/imgcompress:latest
   

2. Swap for the new one

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