├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── bug-report.yml │ ├── config.yml │ └── feature-request.yml └── workflows │ └── build-image.yml ├── DOCKERHUB.md ├── Dockerfile ├── LICENSE ├── README.md ├── appdefs.yml ├── rootfs ├── defaults │ └── recently-used.xbel ├── etc │ ├── cont-env.d │ │ └── RUST_LOG │ ├── cont-init.d │ │ └── 55-czkawka.sh │ ├── machine-id │ └── openbox │ │ └── main-window-selection.xml ├── startapp.sh └── usr │ └── local │ └── bin │ └── gio └── src └── czkawka ├── build.sh ├── disable_trash.patch ├── hide-title-buttons.patch ├── main-window-maximized.patch ├── results_location.patch └── video_hash_fix.patch /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: jlesage 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | custom: ["https://paypal.me/JocelynLeSage", "https://www.tesla.com/referral/jocelyn4590"] 13 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug-report.yml: -------------------------------------------------------------------------------- 1 | name: Bug report 2 | description: File a bug report. 3 | title: "[Bug] Provide a short description of the bug here" 4 | labels: ["bug"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thanks for taking the time to fill out this bug report! 10 | - type: textarea 11 | attributes: 12 | label: Current Behavior 13 | description: A concise description of what you're experiencing. 14 | validations: 15 | required: true 16 | - type: textarea 17 | attributes: 18 | label: Expected Behavior 19 | description: A concise description of what you expected to happen. 20 | validations: 21 | required: false 22 | - type: textarea 23 | attributes: 24 | label: Steps To Reproduce 25 | description: Steps to reproduce the behavior. 26 | validations: 27 | required: false 28 | - type: textarea 29 | attributes: 30 | label: Environment 31 | description: | 32 | Provide details about the host running the container. 33 | Examples: 34 | - Operating system (e.g. Ubuntu, Windows, TrueNAS, openmediavault, unRAID, etc). 35 | - Version of the operating system. 36 | - CPU architecture (x86-64, arm, arm64, etc). 37 | - Model of the device, if applicable (e.g. Raspberry Pi 4B, Synology DS418, QNAP TS-364, etc). 38 | - The Docker version (output of `docker version`). 39 | - Anything else specific to your environment. Examples: 40 | - Network share (NFS, CIFS) mapped to the container. 41 | - Docker running in LXC container. 42 | - etc. 43 | - If applicable, how the UI provided by the container is access: 44 | - Browser (Chrome, Firefox, Edge, etc). 45 | - Version of the browser. 46 | - OS of the browser. 47 | - Is the container accessed through a reverse proxy. 48 | - etc. 49 | value: | 50 | - OS: 51 | - OS version: 52 | - CPU: 53 | - Docker version: 54 | - Device model: 55 | - Browser/OS: 56 | validations: 57 | required: false 58 | - type: textarea 59 | attributes: 60 | label: Container creation 61 | description: | 62 | How did you create the container ? 63 | Examples: 64 | - The `docker run` command used. 65 | - The compose file used. 66 | - Screenshots of the management tool UI (e.g. Portainer, unRAID, etc) showing container settings. 67 | validations: 68 | required: true 69 | - type: textarea 70 | attributes: 71 | label: Container log 72 | description: Please copy/paste the output of `docker logs `. 73 | render: text 74 | validations: 75 | required: true 76 | - type: textarea 77 | attributes: 78 | label: Container inspect 79 | description: | 80 | If the container is running, please provide the output of `docker inspect `. 81 | **Attention**: If you defined passwords, secrets or any sensitive information via environment variables, make sure to remove them from the output. 82 | render: text 83 | validations: 84 | required: false 85 | - type: textarea 86 | attributes: 87 | label: Anything else? 88 | description: | 89 | Anything that will give more context about the issue you are encountering. 90 | 91 | Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. 92 | validations: 93 | required: false 94 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: Ask a question, discuss 4 | url: https://github.com/jlesage/docker-czkawka/discussions 5 | about: Get help using this Docker container. 6 | - name: Documentation 7 | url: https://github.com/jlesage/docker-czkawka#readme 8 | about: Documentation about this Docker container. 9 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature-request.yml: -------------------------------------------------------------------------------- 1 | name: Feature request 2 | description: Suggest an idea for this project. 3 | title: "[Feature request] Provide a short description of the feature here" 4 | labels: ["enhancement"] 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | Thank you for suggesting an idea to make this project better. 10 | - type: textarea 11 | attributes: 12 | label: Idea 13 | description: | 14 | Please describe the desired behavior, pitch your idea, or suggest improvements. 15 | validations: 16 | required: true 17 | -------------------------------------------------------------------------------- /.github/workflows/build-image.yml: -------------------------------------------------------------------------------- 1 | name: Docker image CI/CD 2 | 3 | concurrency: 4 | group: ${{ github.workflow }}-${{ github.ref }} 5 | cancel-in-progress: true 6 | 7 | env: 8 | DOCKER_IMAGE_NAME: jlesage/czkawka 9 | PLATFORMS: linux/amd64,linux/386,linux/arm/v6,linux/arm/v7,linux/arm64/v8 10 | 11 | on: 12 | push: 13 | branches: '*' 14 | tags: 15 | - v[0-9][0-9].[0-9][0-9].[0-9]+ 16 | - v[0-9][0-9].[0-9][0-9].[0-9]+-pre.[0-9]+ 17 | pull_request: 18 | 19 | jobs: 20 | build: 21 | name: Build image 22 | runs-on: ubuntu-22.04 23 | 24 | steps: 25 | - name: Free disk space 26 | uses: jlumbroso/free-disk-space@main 27 | with: 28 | tool-cache: true 29 | android: true 30 | dotnet: true 31 | haskell: true 32 | large-packages: true 33 | docker-images: true 34 | swap-storage: false 35 | 36 | - name: Prepare 37 | id: prep 38 | run: | 39 | # Determine the Docker container version. 40 | VERSION=unknown 41 | if [[ $GITHUB_REF =~ refs/tags/* ]]; then 42 | # Git tag pushed: use tag as the version. 43 | VERSION=${GITHUB_REF#refs/tags/} 44 | elif [[ $GITHUB_REF =~ refs/heads/* ]]; then 45 | # Git commit pushed: use the commit SHA as the version. 46 | VERSION=${GITHUB_SHA::8} 47 | elif [[ $GITHUB_REF =~ refs/pull/* ]]; then 48 | # Pull request: use PR number as the version. 49 | VERSION=pr-${{ github.event.number }} 50 | else 51 | echo "::error::Unexpected GITHUB_REF: $GITHUB_REF" 52 | exit 1 53 | fi 54 | # Determine the version to put in container label. 55 | LABEL_VERSION=${VERSION} 56 | if [[ $GITHUB_REF =~ refs/tags/* ]]; then 57 | # Do not include the starting 'v' of the version. 58 | LABEL_VERSION=${VERSION:1} 59 | fi 60 | # Determine the Docker container tags. 61 | TAGS="${{ env.DOCKER_IMAGE_NAME }}:${VERSION}" 62 | if [[ $GITHUB_REF =~ refs/tags/* ]]; then 63 | TAGS="$TAGS,${{ env.DOCKER_IMAGE_NAME }}:latest" 64 | fi 65 | TAGS="$TAGS,$(echo $TAGS | tr ',' '\n' | sed 's|^|ghcr.io/|' | tr '\n' ',')" 66 | # Determine the release type. 67 | if [[ $GITHUB_REF =~ refs/tags/* ]]; then 68 | IS_RELEASE=yes 69 | if [[ $GITHUB_REF =~ -pre\.[0-9]+ ]]; then 70 | RELEASE_TYPE="pre" 71 | else 72 | RELEASE_TYPE="standard" 73 | fi 74 | else 75 | IS_RELEASE=no 76 | RELEASE_TYPE="n/a" 77 | fi 78 | # Print results. 79 | echo "::group::Results" 80 | echo "Github reference: $GITHUB_REF" 81 | echo "Release: $IS_RELEASE" 82 | echo "Release type: $RELEASE_TYPE" 83 | echo "Docker container version: $VERSION" 84 | echo "Docker container version label: $LABEL_VERSION" 85 | echo "Docker container tag(s): $TAGS" 86 | echo "::endgroup::" 87 | # Export outputs. 88 | echo "is_release=${IS_RELEASE}" >> $GITHUB_OUTPUT 89 | echo "release_type=${RELEASE_TYPE}" >> $GITHUB_OUTPUT 90 | echo "version=${VERSION}" >> $GITHUB_OUTPUT 91 | echo "label_version=${LABEL_VERSION}" >> $GITHUB_OUTPUT 92 | echo "tags=${TAGS}" >> $GITHUB_OUTPUT 93 | #echo "build_date=$(date -u +'%Y-%m-%dT%H:%M:%SZ')" >> $GITHUB_OUTPUT 94 | 95 | - name: Setup QEMU 96 | uses: docker/setup-qemu-action@v3 97 | with: 98 | platforms: arm,arm64,ppc64le,mips64,s390x 99 | 100 | - name: Setup Docker Buildx 101 | uses: docker/setup-buildx-action@v3 102 | with: 103 | # Limit the number of parallel build steps that can run at the same 104 | # time. Compiling Rust is very CPU intensive and without this the 105 | # build fails with the following error: 106 | # The hosted runner: Hosted Agent lost communication with the 107 | # server. Anything in your workflow that terminates the runner 108 | # process, starves it for CPU/Memory, or blocks its network access 109 | # can cause this error. 110 | config-inline: | 111 | [worker.oci] 112 | max-parallelism = 2 113 | 114 | - name: Login to DockerHub 115 | if: ${{ steps.prep.outputs.is_release == 'yes' }} 116 | uses: docker/login-action@v3 117 | with: 118 | username: ${{ secrets.DOCKERHUB_USERNAME }} 119 | password: ${{ secrets.DOCKERHUB_PASSWORD }} 120 | 121 | - name: Login to GitHub Container Registry 122 | if: ${{ steps.prep.outputs.is_release == 'yes' }} 123 | uses: docker/login-action@v3 124 | with: 125 | registry: ghcr.io 126 | username: ${{ github.repository_owner }} 127 | password: ${{ secrets.GITHUB_TOKEN }} 128 | 129 | - name: Build and push 130 | uses: docker/build-push-action@v6 131 | with: 132 | push: ${{ steps.prep.outputs.is_release == 'yes' }} 133 | provenance: false 134 | platforms: ${{ env.PLATFORMS }} 135 | tags: ${{ steps.prep.outputs.tags }} 136 | build-args: | 137 | DOCKER_IMAGE_VERSION=${{ steps.prep.outputs.label_version }} 138 | cache-from: type=gha,scope=${{ env.DOCKER_IMAGE_NAME }} 139 | cache-to: type=gha,mode=max,scope=${{ env.DOCKER_IMAGE_NAME }} 140 | 141 | - name: Inspect 142 | if: ${{ steps.prep.outputs.is_release == 'yes' }} 143 | run: | 144 | docker buildx imagetools inspect ${{ env.DOCKER_IMAGE_NAME }}:${{ steps.prep.outputs.version }} 145 | 146 | - name: Checkout 147 | uses: actions/checkout@v4 148 | if: ${{ steps.prep.outputs.release_type == 'standard' }} 149 | 150 | - name: Dockerhub description 151 | if: ${{ steps.prep.outputs.release_type == 'standard' }} 152 | uses: peter-evans/dockerhub-description@v4 153 | with: 154 | username: ${{ secrets.DOCKERHUB_USERNAME }} 155 | password: ${{ secrets.DOCKERHUB_PASSWORD }} 156 | repository: ${{ env.DOCKER_IMAGE_NAME }} 157 | readme-filepath: DOCKERHUB.md 158 | 159 | notification: 160 | name: Notification 161 | needs: [ build ] 162 | runs-on: ubuntu-22.04 163 | if: ${{ always() && github.event_name != 'pull_request' }} 164 | 165 | steps: 166 | - name: Pushover notification 167 | uses: desiderati/github-action-pushover@v1 168 | with: 169 | job-status: ${{ needs.build.result }} 170 | pushover-api-token: ${{ secrets.PUSHOVER_API_TOKEN }} 171 | pushover-user-key: ${{ secrets.PUSHOVER_USER_KEY }} 172 | -------------------------------------------------------------------------------- /DOCKERHUB.md: -------------------------------------------------------------------------------- 1 | # Docker container for Czkawka 2 | [![Release](https://img.shields.io/github/release/jlesage/docker-czkawka.svg?logo=github&style=for-the-badge)](https://github.com/jlesage/docker-czkawka/releases/latest) 3 | [![Docker Image Size](https://img.shields.io/docker/image-size/jlesage/czkawka/latest?logo=docker&style=for-the-badge)](https://hub.docker.com/r/jlesage/czkawka/tags) 4 | [![Docker Pulls](https://img.shields.io/docker/pulls/jlesage/czkawka?label=Pulls&logo=docker&style=for-the-badge)](https://hub.docker.com/r/jlesage/czkawka) 5 | [![Docker Stars](https://img.shields.io/docker/stars/jlesage/czkawka?label=Stars&logo=docker&style=for-the-badge)](https://hub.docker.com/r/jlesage/czkawka) 6 | [![Build Status](https://img.shields.io/github/actions/workflow/status/jlesage/docker-czkawka/build-image.yml?logo=github&branch=master&style=for-the-badge)](https://github.com/jlesage/docker-czkawka/actions/workflows/build-image.yml) 7 | [![Source](https://img.shields.io/badge/Source-GitHub-blue?logo=github&style=for-the-badge)](https://github.com/jlesage/docker-czkawka) 8 | [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg?style=for-the-badge)](https://paypal.me/JocelynLeSage) 9 | 10 | This is a Docker container for [Czkawka](https://github.com/qarmin/czkawka). 11 | 12 | The GUI of the application is accessed through a modern web browser (no 13 | installation or configuration needed on the client side) or via any VNC client. 14 | 15 | --- 16 | 17 | [![Czkawka logo](https://images.weserv.nl/?url=raw.githubusercontent.com/jlesage/docker-templates/master/jlesage/images/czkawka-icon.png&w=110)](https://github.com/qarmin/czkawka)[![Czkawka](https://images.placeholders.dev/?width=224&height=110&fontFamily=monospace&fontWeight=400&fontSize=52&text=Czkawka&bgColor=rgba(0,0,0,0.0)&textColor=rgba(121,121,121,1))](https://github.com/qarmin/czkawka) 18 | 19 | Czkawka is written in Rust, simple, fast and easy to use app to remove 20 | unnecessary files from your computer. 21 | 22 | --- 23 | 24 | ## Quick Start 25 | 26 | **NOTE**: 27 | The Docker command provided in this quick start is given as an example 28 | and parameters should be adjusted to your need. 29 | 30 | Launch the Czkawka docker container with the following command: 31 | ```shell 32 | docker run -d \ 33 | --name=czkawka \ 34 | -p 5800:5800 \ 35 | -v /docker/appdata/czkawka:/config:rw \ 36 | -v /home/user:/storage:rw \ 37 | jlesage/czkawka 38 | ``` 39 | 40 | Where: 41 | 42 | - `/docker/appdata/czkawka`: This is where the application stores its configuration, states, log and any files needing persistency. 43 | - `/home/user`: This location contains files from your host that need to be accessible to the application. 44 | 45 | Browse to `http://your-host-ip:5800` to access the Czkawka GUI. 46 | Files from the host appear under the `/storage` folder in the container. 47 | 48 | ## Documentation 49 | 50 | Full documentation is available at https://github.com/jlesage/docker-czkawka. 51 | 52 | ## Support or Contact 53 | 54 | Having troubles with the container or have questions? Please 55 | [create a new issue]. 56 | 57 | For other great Dockerized applications, see https://jlesage.github.io/docker-apps. 58 | 59 | [create a new issue]: https://github.com/jlesage/docker-czkawka/issues 60 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # 2 | # czkawka Dockerfile 3 | # 4 | # https://github.com/jlesage/docker-czkawka 5 | # 6 | 7 | # Docker image version is provided via build arg. 8 | ARG DOCKER_IMAGE_VERSION= 9 | 10 | # Define software versions. 11 | ARG CZKAWKA_VERSION=9.0.0 12 | 13 | # Define software download URLs. 14 | ARG CZKAWKA_URL=https://github.com/qarmin/czkawka/archive/${CZKAWKA_VERSION}.tar.gz 15 | 16 | # Get Dockerfile cross-compilation helpers. 17 | FROM --platform=$BUILDPLATFORM tonistiigi/xx AS xx 18 | 19 | # Build Czkawka. 20 | FROM --platform=$BUILDPLATFORM alpine:3.20 AS czkawka 21 | ARG TARGETPLATFORM 22 | ARG CZKAWKA_URL 23 | COPY --from=xx / / 24 | COPY src/czkawka /build 25 | RUN /build/build.sh "$CZKAWKA_URL" 26 | RUN xx-verify \ 27 | /tmp/czkawka-install/czkawka_cli \ 28 | /tmp/czkawka-install/czkawka_gui 29 | 30 | # Pull base image. 31 | FROM jlesage/baseimage-gui:alpine-3.20-v4.7.1 32 | 33 | # Define working directory. 34 | WORKDIR /tmp 35 | 36 | ARG CZKAWKA_VERSION 37 | ARG DOCKER_IMAGE_VERSION 38 | 39 | # Install dependencies. 40 | RUN add-pkg \ 41 | gtk4.0 \ 42 | font-cantarell \ 43 | alsa-lib \ 44 | dbus-x11 \ 45 | ffmpeg \ 46 | ffplay \ 47 | && \ 48 | add-pkg --repository http://dl-cdn.alpinelinux.org/alpine/v3.21/community \ 49 | libheif 50 | 51 | # Generate and install favicons. 52 | RUN \ 53 | APP_ICON_URL=https://github.com/jlesage/docker-templates/raw/master/jlesage/images/czkawka-icon.png && \ 54 | install_app_icon.sh "$APP_ICON_URL" 55 | 56 | # Add files. 57 | COPY rootfs/ / 58 | COPY --from=czkawka /tmp/czkawka-install/czkawka_cli /usr/bin/ 59 | COPY --from=czkawka /tmp/czkawka-install/czkawka_gui /usr/bin/ 60 | 61 | # Set internal environment variables. 62 | RUN \ 63 | set-cont-env APP_NAME "Czkawka" && \ 64 | set-cont-env APP_VERSION "$CZKAWKA_VERSION" && \ 65 | set-cont-env DOCKER_IMAGE_VERSION "$DOCKER_IMAGE_VERSION" && \ 66 | true 67 | 68 | # Define mountable directories. 69 | VOLUME ["/storage"] 70 | 71 | # Metadata. 72 | LABEL \ 73 | org.label-schema.name="czkawka" \ 74 | org.label-schema.description="Docker container for Czkawka" \ 75 | org.label-schema.version="${DOCKER_IMAGE_VERSION:-unknown}" \ 76 | org.label-schema.vcs-url="https://github.com/jlesage/docker-czkawka" \ 77 | org.label-schema.schema-version="1.0" 78 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2025 Jocelyn Le Sage 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | 23 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Docker container for Czkawka 2 | [![Release](https://img.shields.io/github/release/jlesage/docker-czkawka.svg?logo=github&style=for-the-badge)](https://github.com/jlesage/docker-czkawka/releases/latest) 3 | [![Docker Image Size](https://img.shields.io/docker/image-size/jlesage/czkawka/latest?logo=docker&style=for-the-badge)](https://hub.docker.com/r/jlesage/czkawka/tags) 4 | [![Docker Pulls](https://img.shields.io/docker/pulls/jlesage/czkawka?label=Pulls&logo=docker&style=for-the-badge)](https://hub.docker.com/r/jlesage/czkawka) 5 | [![Docker Stars](https://img.shields.io/docker/stars/jlesage/czkawka?label=Stars&logo=docker&style=for-the-badge)](https://hub.docker.com/r/jlesage/czkawka) 6 | [![Build Status](https://img.shields.io/github/actions/workflow/status/jlesage/docker-czkawka/build-image.yml?logo=github&branch=master&style=for-the-badge)](https://github.com/jlesage/docker-czkawka/actions/workflows/build-image.yml) 7 | [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg?style=for-the-badge)](https://paypal.me/JocelynLeSage) 8 | 9 | This project implements a Docker container for [Czkawka](https://github.com/qarmin/czkawka). 10 | 11 | The GUI of the application is accessed through a modern web browser (no 12 | installation or configuration needed on the client side) or via any VNC client. 13 | 14 | --- 15 | 16 | [![Czkawka logo](https://images.weserv.nl/?url=raw.githubusercontent.com/jlesage/docker-templates/master/jlesage/images/czkawka-icon.png&w=110)](https://github.com/qarmin/czkawka)[![Czkawka](https://images.placeholders.dev/?width=224&height=110&fontFamily=monospace&fontWeight=400&fontSize=52&text=Czkawka&bgColor=rgba(0,0,0,0.0)&textColor=rgba(121,121,121,1))](https://github.com/qarmin/czkawka) 17 | 18 | Czkawka is written in Rust, simple, fast and easy to use app to remove 19 | unnecessary files from your computer. 20 | 21 | --- 22 | 23 | ## Table of Content 24 | 25 | * [Quick Start](#quick-start) 26 | * [Usage](#usage) 27 | * [Environment Variables](#environment-variables) 28 | * [Deployment Considerations](#deployment-considerations) 29 | * [Data Volumes](#data-volumes) 30 | * [Ports](#ports) 31 | * [Changing Parameters of a Running Container](#changing-parameters-of-a-running-container) 32 | * [Docker Compose File](#docker-compose-file) 33 | * [Docker Image Versioning](#docker-image-versioning) 34 | * [Docker Image Update](#docker-image-update) 35 | * [Synology](#synology) 36 | * [unRAID](#unraid) 37 | * [User/Group IDs](#usergroup-ids) 38 | * [Accessing the GUI](#accessing-the-gui) 39 | * [Security](#security) 40 | * [SSVNC](#ssvnc) 41 | * [Certificates](#certificates) 42 | * [VNC Password](#vnc-password) 43 | * [Web Authentication](#web-authentication) 44 | * [Configuring Users Credentials](#configuring-users-credentials) 45 | * [Reverse Proxy](#reverse-proxy) 46 | * [Routing Based on Hostname](#routing-based-on-hostname) 47 | * [Routing Based on URL Path](#routing-based-on-url-path) 48 | * [Shell Access](#shell-access) 49 | * [Support or Contact](#support-or-contact) 50 | 51 | ## Quick Start 52 | 53 | > [!IMPORTANT] 54 | > The Docker command provided in this quick start is given as an example and 55 | > parameters should be adjusted to your need. 56 | 57 | Launch the Czkawka docker container with the following command: 58 | ```shell 59 | docker run -d \ 60 | --name=czkawka \ 61 | -p 5800:5800 \ 62 | -v /docker/appdata/czkawka:/config:rw \ 63 | -v /home/user:/storage:rw \ 64 | jlesage/czkawka 65 | ``` 66 | 67 | Where: 68 | 69 | - `/docker/appdata/czkawka`: This is where the application stores its configuration, states, log and any files needing persistency. 70 | - `/home/user`: This location contains files from your host that need to be accessible to the application. 71 | 72 | Browse to `http://your-host-ip:5800` to access the Czkawka GUI. 73 | Files from the host appear under the `/storage` folder in the container. 74 | 75 | ## Usage 76 | 77 | ```shell 78 | docker run [-d] \ 79 | --name=czkawka \ 80 | [-e =]... \ 81 | [-v :[:PERMISSIONS]]... \ 82 | [-p :]... \ 83 | jlesage/czkawka 84 | ``` 85 | 86 | | Parameter | Description | 87 | |-----------|-------------| 88 | | -d | Run the container in the background. If not set, the container runs in the foreground. | 89 | | -e | Pass an environment variable to the container. See the [Environment Variables](#environment-variables) section for more details. | 90 | | -v | Set a volume mapping (allows to share a folder/file between the host and the container). See the [Data Volumes](#data-volumes) section for more details. | 91 | | -p | Set a network port mapping (exposes an internal container port to the host). See the [Ports](#ports) section for more details. | 92 | 93 | ### Environment Variables 94 | 95 | To customize some properties of the container, the following environment 96 | variables can be passed via the `-e` parameter (one for each variable). Value 97 | of this parameter has the format `=`. 98 | 99 | | Variable | Description | Default | 100 | |----------------|----------------------------------------------|---------| 101 | |`USER_ID`| ID of the user the application runs as. See [User/Group IDs](#usergroup-ids) to better understand when this should be set. | `1000` | 102 | |`GROUP_ID`| ID of the group the application runs as. See [User/Group IDs](#usergroup-ids) to better understand when this should be set. | `1000` | 103 | |`SUP_GROUP_IDS`| Comma-separated list of supplementary group IDs of the application. | (no value) | 104 | |`UMASK`| Mask that controls how permissions are set for newly created files and folders. The value of the mask is in octal notation. By default, the default umask value is `0022`, meaning that newly created files and folders are readable by everyone, but only writable by the owner. See the online umask calculator at http://wintelguy.com/umask-calc.pl. | `0022` | 105 | |`LANG`| Set the [locale](https://en.wikipedia.org/wiki/Locale_(computer_software)), which defines the application's language, **if supported**. Format of the locale is `language[_territory][.codeset]`, where language is an [ISO 639 language code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes), territory is an [ISO 3166 country code](https://en.wikipedia.org/wiki/ISO_3166-1#Current_codes) and codeset is a character set, like `UTF-8`. For example, Australian English using the UTF-8 encoding is `en_AU.UTF-8`. | `en_US.UTF-8` | 106 | |`TZ`| [TimeZone](http://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used by the container. Timezone can also be set by mapping `/etc/localtime` between the host and the container. | `Etc/UTC` | 107 | |`KEEP_APP_RUNNING`| When set to `1`, the application will be automatically restarted when it crashes or terminates. | `0` | 108 | |`APP_NICENESS`| Priority at which the application should run. A niceness value of -20 is the highest priority and 19 is the lowest priority. The default niceness value is 0. **NOTE**: A negative niceness (priority increase) requires additional permissions. In this case, the container should be run with the docker option `--cap-add=SYS_NICE`. | `0` | 109 | |`INSTALL_PACKAGES`| Space-separated list of packages to install during the startup of the container. List of available packages can be found at https://pkgs.alpinelinux.org. **ATTENTION**: Container functionality can be affected when installing a package that overrides existing container files (e.g. binaries). | (no value) | 110 | |`PACKAGES_MIRROR`| Mirror of the repository to use when installing packages. List of mirrors is available at https://mirrors.alpinelinux.org. | (no value) | 111 | |`CONTAINER_DEBUG`| Set to `1` to enable debug logging. | `0` | 112 | |`DISPLAY_WIDTH`| Width (in pixels) of the application's window. | `1920` | 113 | |`DISPLAY_HEIGHT`| Height (in pixels) of the application's window. | `1080` | 114 | |`DARK_MODE`| When set to `1`, dark mode is enabled for the application. | `0` | 115 | |`WEB_AUDIO`| When set to `1`, audio support is enabled, meaning that any audio produced by the application is played through the browser. Note that audio is not supported for VNC clients. | `0` | 116 | |`WEB_AUTHENTICATION`| When set to `1`, the application's GUI is protected via a login page when accessed via a web browser. Access is allowed only when providing valid credentials. **NOTE**: This feature requires secure connection (`SECURE_CONNECTION` environment variable) to be enabled. | `0` | 117 | |`WEB_AUTHENTICATION_TOKEN_VALIDITY_TIME`| The lifetime of a token, in hours. A token is attributed to the user after a successful login. As long as the token is valid, user can access the application's GUI without having to log in again. Once the token expires, the login page is prompted again. | `24` | 118 | |`WEB_AUTHENTICATION_USERNAME`| Optional username to configure for the web authentication. This is a quick and easy way to configure credentials for a single user. To configure credentials in a more secure way, or to add more users, see the [Web Authentication](#web-authentication) section. | (no value) | 119 | |`WEB_AUTHENTICATION_PASSWORD`| Optional password to configure for the web authentication. This is a quick and easy way to configure credentials for a single user. To configure credentials in a more secure way, or to add more users, see the [Web Authentication](#web-authentication) section. | (no value) | 120 | |`SECURE_CONNECTION`| When set to `1`, an encrypted connection is used to access the application's GUI (either via a web browser or VNC client). See the [Security](#security) section for more details. | `0` | 121 | |`SECURE_CONNECTION_VNC_METHOD`| Method used to perform the secure VNC connection. Possible values are `SSL` or `TLS`. See the [Security](#security) section for more details. | `SSL` | 122 | |`SECURE_CONNECTION_CERTS_CHECK_INTERVAL`| Interval, in seconds, at which the system verifies if web or VNC certificates have changed. When a change is detected, the affected services are automatically restarted. A value of `0` disables the check. | `60` | 123 | |`WEB_LISTENING_PORT`| Port used by the web server to serve the UI of the application. This port is used internally by the container and it is usually not required to be changed. By default, a container is created with the default bridge network, meaning that, to be accessible, each internal container port must be mapped to an external port (using the `-p` or `--publish` argument). However, if the container is created with another network type, changing the port used by the container might be useful to prevent conflict with other services/containers. **NOTE**: a value of `-1` disables listening, meaning that the application's UI won't be accessible over HTTP/HTTPs. | `5800` | 124 | |`VNC_LISTENING_PORT`| Port used by the VNC server to serve the UI of the application. This port is used internally by the container and it is usually not required to be changed. By default, a container is created with the default bridge network, meaning that, to be accessible, each internal container port must be mapped to an external port (using the `-p` or `--publish` argument). However, if the container is created with another network type, changing the port used by the container might be useful to prevent conflict with other services/containers. **NOTE**: a value of `-1` disables listening, meaning that the application's UI won't be accessible over VNC. | `5900` | 125 | |`VNC_PASSWORD`| Password needed to connect to the application's GUI. See the [VNC Password](#vnc-password) section for more details. | (no value) | 126 | |`ENABLE_CJK_FONT`| When set to `1`, open-source computer font `WenQuanYi Zen Hei` is installed. This font contains a large range of Chinese/Japanese/Korean characters. | `0` | 127 | 128 | #### Deployment Considerations 129 | 130 | Many tools used to manage Docker containers extract environment variables 131 | defined by the Docker image and use them to create/deploy the container. For 132 | example, this is done by: 133 | - The Docker application on Synology NAS 134 | - The Container Station on QNAP NAS 135 | - Portainer 136 | - etc. 137 | 138 | While this can be useful for the user to adjust the value of environment 139 | variables to fit its needs, it can also be confusing and dangerous to keep all 140 | of them. 141 | 142 | A good practice is to set/keep only the variables that are needed for the 143 | container to behave as desired in a specific setup. If the value of variable is 144 | kept to its default value, it means that it can be removed. Keep in mind that 145 | all variables are optional, meaning that none of them is required for the 146 | container to start. 147 | 148 | Removing environment variables that are not needed provides some advantages: 149 | 150 | - Prevents keeping variables that are no longer used by the container. Over 151 | time, with image updates, some variables might be removed. 152 | - Allows the Docker image to change/fix a default value. Again, with image 153 | updates, the default value of a variable might be changed to fix an issue, 154 | or to better support a new feature. 155 | - Prevents changes to a variable that might affect the correct function of 156 | the container. Some undocumented variables, like `PATH` or `ENV`, are 157 | required to be exposed, but are not meant to be changed by users. However, 158 | container management tools still show these variables to users. 159 | - There is a bug with the Container Station on QNAP and the Docker application 160 | on Synology, where an environment variable without value might not be 161 | allowed. This behavior is wrong: it's absolutely fine to have a variable 162 | without value. In fact, this container does have variables without value by 163 | default. Thus, removing unneeded variables is a good way to prevent 164 | deployment issue on these devices. 165 | 166 | ### Data Volumes 167 | 168 | The following table describes data volumes used by the container. The mappings 169 | are set via the `-v` parameter. Each mapping is specified with the following 170 | format: `:[:PERMISSIONS]`. 171 | 172 | | Container path | Permissions | Description | 173 | |-----------------|-------------|-------------| 174 | |`/config`| rw | This is where the application stores its configuration, states, log and any files needing persistency. | 175 | |`/storage`| rw | This location contains files from your host that need to be accessible to the application. | 176 | 177 | ### Ports 178 | 179 | Here is the list of ports used by the container. 180 | 181 | When using the default bridge network, ports can be mapped to the host via the 182 | `-p` parameter (one per port mapping). Each mapping is defined with the 183 | following format: `:`. The port number used inside 184 | the container might not be changeable, but you are free to use any port on the 185 | host side. 186 | 187 | See the [Docker Container Networking](https://docs.docker.com/config/containers/container-networking) 188 | documentation for more details. 189 | 190 | | Port | Protocol | Mapping to host | Description | 191 | |------|----------|-----------------|-------------| 192 | | 5800 | TCP | Optional | Port to access the application's GUI via the web interface. Mapping to the host is optional if access through the web interface is not wanted. For a container not using the default bridge network, the port can be changed with the `WEB_LISTENING_PORT` environment variable. | 193 | | 5900 | TCP | Optional | Port to access the application's GUI via the VNC protocol. Mapping to the host is optional if access through the VNC protocol is not wanted. For a container not using the default bridge network, the port can be changed with the `VNC_LISTENING_PORT` environment variable. | 194 | 195 | ### Changing Parameters of a Running Container 196 | 197 | As can be seen, environment variables, volume and port mappings are all specified 198 | while creating the container. 199 | 200 | The following steps describe the method used to add, remove or update 201 | parameter(s) of an existing container. The general idea is to destroy and 202 | re-create the container: 203 | 204 | 1. Stop the container (if it is running): 205 | ```shell 206 | docker stop czkawka 207 | ``` 208 | 209 | 2. Remove the container: 210 | ```shell 211 | docker rm czkawka 212 | ``` 213 | 214 | 3. Create/start the container using the `docker run` command, by adjusting 215 | parameters as needed. 216 | 217 | > [!NOTE] 218 | > Since all application's data is saved under the `/config` container folder, 219 | > destroying and re-creating a container is not a problem: nothing is lost and 220 | > the application comes back with the same state (as long as the mapping of the 221 | > `/config` folder remains the same). 222 | 223 | ## Docker Compose File 224 | 225 | Here is an example of a `docker-compose.yml` file that can be used with 226 | [Docker Compose](https://docs.docker.com/compose/overview/). 227 | 228 | Make sure to adjust according to your needs. Note that only mandatory network 229 | ports are part of the example. 230 | 231 | ```yaml 232 | version: '3' 233 | services: 234 | czkawka: 235 | image: jlesage/czkawka 236 | ports: 237 | - "5800:5800" 238 | volumes: 239 | - "/docker/appdata/czkawka:/config:rw" 240 | - "/home/user:/storage:rw" 241 | ``` 242 | 243 | ## Docker Image Versioning 244 | 245 | Each release of a Docker image is versioned. Prior to october 2022, the 246 | [semantic versioning](https://semver.org) was used as the versioning scheme. 247 | 248 | Since then, versioning scheme changed to 249 | [calendar versioning](https://calver.org). The format used is `YY.MM.SEQUENCE`, 250 | where: 251 | - `YY` is the zero-padded year (relative to year 2000). 252 | - `MM` is the zero-padded month. 253 | - `SEQUENCE` is the incremental release number within the month (first release 254 | is 1, second is 2, etc). 255 | 256 | ## Docker Image Update 257 | 258 | Because features are added, issues are fixed, or simply because a new version 259 | of the containerized application is integrated, the Docker image is regularly 260 | updated. Different methods can be used to update the Docker image. 261 | 262 | The system used to run the container may have a built-in way to update 263 | containers. If so, this could be your primary way to update Docker images. 264 | 265 | An other way is to have the image be automatically updated with [Watchtower]. 266 | Watchtower is a container-based solution for automating Docker image updates. 267 | This is a "set and forget" type of solution: once a new image is available, 268 | Watchtower will seamlessly perform the necessary steps to update the container. 269 | 270 | Finally, the Docker image can be manually updated with these steps: 271 | 272 | 1. Fetch the latest image: 273 | ```shell 274 | docker pull jlesage/czkawka 275 | ``` 276 | 277 | 2. Stop the container: 278 | ```shell 279 | docker stop czkawka 280 | ``` 281 | 282 | 3. Remove the container: 283 | ```shell 284 | docker rm czkawka 285 | ``` 286 | 287 | 4. Create and start the container using the `docker run` command, with the 288 | the same parameters that were used when it was deployed initially. 289 | 290 | [Watchtower]: https://github.com/containrrr/watchtower 291 | 292 | ### Synology 293 | 294 | For owners of a Synology NAS, the following steps can be used to update a 295 | container image. 296 | 297 | 1. Open the *Docker* application. 298 | 2. Click on *Registry* in the left pane. 299 | 3. In the search bar, type the name of the container (`jlesage/czkawka`). 300 | 4. Select the image, click *Download* and then choose the `latest` tag. 301 | 5. Wait for the download to complete. A notification will appear once done. 302 | 6. Click on *Container* in the left pane. 303 | 7. Select your Czkawka container. 304 | 8. Stop it by clicking *Action*->*Stop*. 305 | 9. Clear the container by clicking *Action*->*Reset* (or *Action*->*Clear* if 306 | you don't have the latest *Docker* application). This removes the 307 | container while keeping its configuration. 308 | 10. Start the container again by clicking *Action*->*Start*. **NOTE**: The 309 | container may temporarily disappear from the list while it is re-created. 310 | 311 | ### unRAID 312 | 313 | For unRAID, a container image can be updated by following these steps: 314 | 315 | 1. Select the *Docker* tab. 316 | 2. Click the *Check for Updates* button at the bottom of the page. 317 | 3. Click the *update ready* link of the container to be updated. 318 | 319 | ## User/Group IDs 320 | 321 | When using data volumes (`-v` flags), permissions issues can occur between the 322 | host and the container. For example, the user within the container may not 323 | exist on the host. This could prevent the host from properly accessing files 324 | and folders on the shared volume. 325 | 326 | To avoid any problem, you can specify the user the application should run as. 327 | 328 | This is done by passing the user ID and group ID to the container via the 329 | `USER_ID` and `GROUP_ID` environment variables. 330 | 331 | To find the right IDs to use, issue the following command on the host, with the 332 | user owning the data volume on the host: 333 | 334 | id 335 | 336 | Which gives an output like this one: 337 | ```text 338 | uid=1000(myuser) gid=1000(myuser) groups=1000(myuser),4(adm),24(cdrom),27(sudo),46(plugdev),113(lpadmin) 339 | ``` 340 | 341 | The value of `uid` (user ID) and `gid` (group ID) are the ones that you should 342 | be given the container. 343 | 344 | ## Accessing the GUI 345 | 346 | Assuming that container's ports are mapped to the same host's ports, the 347 | graphical interface of the application can be accessed via: 348 | 349 | * A web browser: 350 | 351 | ```text 352 | http://:5800 353 | ``` 354 | 355 | * Any VNC client: 356 | 357 | ```text 358 | :5900 359 | ``` 360 | 361 | ## Security 362 | 363 | By default, access to the application's GUI is done over an unencrypted 364 | connection (HTTP or VNC). 365 | 366 | Secure connection can be enabled via the `SECURE_CONNECTION` environment 367 | variable. See the [Environment Variables](#environment-variables) section for 368 | more details on how to set an environment variable. 369 | 370 | When enabled, application's GUI is performed over an HTTPs connection when 371 | accessed with a browser. All HTTP accesses are automatically redirected to 372 | HTTPs. 373 | 374 | When using a VNC client, the VNC connection is performed over SSL. Note that 375 | few VNC clients support this method. [SSVNC] is one of them. 376 | 377 | [SSVNC]: http://www.karlrunge.com/x11vnc/ssvnc.html 378 | 379 | ### SSVNC 380 | 381 | [SSVNC] is a VNC viewer that adds encryption security to VNC connections. 382 | 383 | While the Linux version of [SSVNC] works well, the Windows version has some 384 | issues. At the time of writing, the latest version `1.0.30` is not functional, 385 | as a connection fails with the following error: 386 | ```text 387 | ReadExact: Socket error while reading 388 | ``` 389 | However, for your convenience, an unofficial and working version is provided 390 | here: 391 | 392 | https://github.com/jlesage/docker-baseimage-gui/raw/master/tools/ssvnc_windows_only-1.0.30-r1.zip 393 | 394 | The only difference with the official package is that the bundled version of 395 | `stunnel` has been upgraded to version `5.49`, which fixes the connection 396 | problems. 397 | 398 | ### Certificates 399 | 400 | Here are the certificate files needed by the container. By default, when they 401 | are missing, self-signed certificates are generated and used. All files have 402 | PEM encoded, x509 certificates. 403 | 404 | | Container Path | Purpose | Content | 405 | |---------------------------------|----------------------------|---------| 406 | |`/config/certs/vnc-server.pem` |VNC connection encryption. |VNC server's private key and certificate, bundled with any root and intermediate certificates.| 407 | |`/config/certs/web-privkey.pem` |HTTPs connection encryption.|Web server's private key.| 408 | |`/config/certs/web-fullchain.pem`|HTTPs connection encryption.|Web server's certificate, bundled with any root and intermediate certificates.| 409 | 410 | > [!TIP] 411 | > To prevent any certificate validity warnings/errors from the browser or VNC 412 | > client, make sure to supply your own valid certificates. 413 | 414 | > [!NOTE] 415 | > Certificate files are monitored and relevant daemons are automatically 416 | > restarted when changes are detected. 417 | 418 | ### VNC Password 419 | 420 | To restrict access to your application, a password can be specified. This can 421 | be done via two methods: 422 | * By using the `VNC_PASSWORD` environment variable. 423 | * By creating a `.vncpass_clear` file at the root of the `/config` volume. 424 | This file should contain the password in clear-text. During the container 425 | startup, content of the file is obfuscated and moved to `.vncpass`. 426 | 427 | The level of security provided by the VNC password depends on two things: 428 | * The type of communication channel (encrypted/unencrypted). 429 | * How secure the access to the host is. 430 | 431 | When using a VNC password, it is highly desirable to enable the secure 432 | connection to prevent sending the password in clear over an unencrypted channel. 433 | 434 | > [!CAUTION] 435 | > Password is limited to 8 characters. This limitation comes from the Remote 436 | > Framebuffer Protocol [RFC](https://tools.ietf.org/html/rfc6143) (see section 437 | > [7.2.2](https://tools.ietf.org/html/rfc6143#section-7.2.2)). Any characters 438 | > beyond the limit are ignored. 439 | 440 | ### Web Authentication 441 | 442 | Access to the application's GUI via a web browser can be protected with a login 443 | page. When web authentication is enabled, users have to provide valid 444 | credentials, otherwise access is denied. 445 | 446 | Web authentication can be enabled by setting the `WEB_AUTHENTICATION` 447 | environment variable to `1`. 448 | 449 | See the [Environment Variables](#environment-variables) section for more details 450 | on how to set an environment variable. 451 | 452 | > [!IMPORTANT] 453 | > Secure connection must also be enabled to use web authentication. 454 | > See the [Security](#security) section for more details. 455 | 456 | #### Configuring Users Credentials 457 | 458 | Two methods can be used to configure users credentials: 459 | 460 | 1. Via container environment variables. 461 | 2. Via password database. 462 | 463 | Containers environment variables can be used to quickly and easily configure 464 | a single user. Username and pasword are defined via the following environment 465 | variables: 466 | - `WEB_AUTHENTICATION_USERNAME` 467 | - `WEB_AUTHENTICATION_PASSWORD` 468 | 469 | See the [Environment Variables](#environment-variables) section for more details 470 | on how to set an environment variable. 471 | 472 | The second method is more secure and allows multiple users to be configured. 473 | The usernames and password hashes are saved into a password database, located at 474 | `/config/webauth-htpasswd` inside the container. This database file has the 475 | same format as htpasswd files of the Apache HTTP server. Note that password 476 | themselves are not saved into the database, but only their hash. The bcrypt 477 | password hashing function is used to generate hashes. 478 | 479 | Users are managed via the `webauth-user` tool included in the container: 480 | - To add a user password: `docker exec -ti webauth-user add `. 481 | - To update a user password: `docker exec -ti webauth-user update `. 482 | - To remove a user: `docker exec webauth-user del `. 483 | - To list users: `docker exec webauth-user user`. 484 | 485 | ## Reverse Proxy 486 | 487 | The following sections contain NGINX configurations that need to be added in 488 | order to reverse proxy to this container. 489 | 490 | A reverse proxy server can route HTTP requests based on the hostname or the URL 491 | path. 492 | 493 | ### Routing Based on Hostname 494 | 495 | In this scenario, each hostname is routed to a different application/container. 496 | 497 | For example, let's say the reverse proxy server is running on the same machine 498 | as this container. The server would proxy all HTTP requests sent to 499 | `czkawka.domain.tld` to the container at `127.0.0.1:5800`. 500 | 501 | Here are the relevant configuration elements that would be added to the NGINX 502 | configuration: 503 | 504 | ```nginx 505 | map $http_upgrade $connection_upgrade { 506 | default upgrade; 507 | '' close; 508 | } 509 | 510 | upstream docker-czkawka { 511 | # If the reverse proxy server is not running on the same machine as the 512 | # Docker container, use the IP of the Docker host here. 513 | # Make sure to adjust the port according to how port 5800 of the 514 | # container has been mapped on the host. 515 | server 127.0.0.1:5800; 516 | } 517 | 518 | server { 519 | [...] 520 | 521 | server_name czkawka.domain.tld; 522 | 523 | location / { 524 | proxy_pass http://docker-czkawka; 525 | } 526 | 527 | location /websockify { 528 | proxy_pass http://docker-czkawka; 529 | proxy_http_version 1.1; 530 | proxy_set_header Upgrade $http_upgrade; 531 | proxy_set_header Connection $connection_upgrade; 532 | proxy_read_timeout 86400; 533 | } 534 | 535 | # Needed when audio support is enabled. 536 | location /websockify-audio { 537 | proxy_pass http://docker-czkawka; 538 | proxy_http_version 1.1; 539 | proxy_set_header Upgrade $http_upgrade; 540 | proxy_set_header Connection $connection_upgrade; 541 | proxy_read_timeout 86400; 542 | } 543 | } 544 | 545 | ``` 546 | 547 | ### Routing Based on URL Path 548 | 549 | In this scenario, the hostname is the same, but different URL paths are used to 550 | route to different applications/containers. 551 | 552 | For example, let's say the reverse proxy server is running on the same machine 553 | as this container. The server would proxy all HTTP requests for 554 | `server.domain.tld/czkawka` to the container at `127.0.0.1:5800`. 555 | 556 | Here are the relevant configuration elements that would be added to the NGINX 557 | configuration: 558 | 559 | ```nginx 560 | map $http_upgrade $connection_upgrade { 561 | default upgrade; 562 | '' close; 563 | } 564 | 565 | upstream docker-czkawka { 566 | # If the reverse proxy server is not running on the same machine as the 567 | # Docker container, use the IP of the Docker host here. 568 | # Make sure to adjust the port according to how port 5800 of the 569 | # container has been mapped on the host. 570 | server 127.0.0.1:5800; 571 | } 572 | 573 | server { 574 | [...] 575 | 576 | location = /czkawka {return 301 $scheme://$http_host/czkawka/;} 577 | location /czkawka/ { 578 | proxy_pass http://docker-czkawka/; 579 | # Uncomment the following line if your Nginx server runs on a port that 580 | # differs from the one seen by external clients. 581 | #port_in_redirect off; 582 | location /czkawka/websockify { 583 | proxy_pass http://docker-czkawka/websockify/; 584 | proxy_http_version 1.1; 585 | proxy_set_header Upgrade $http_upgrade; 586 | proxy_set_header Connection $connection_upgrade; 587 | proxy_read_timeout 86400; 588 | } 589 | } 590 | } 591 | 592 | ``` 593 | ## Shell Access 594 | 595 | To get shell access to the running container, execute the following command: 596 | 597 | ```shell 598 | docker exec -ti CONTAINER sh 599 | ``` 600 | 601 | Where `CONTAINER` is the ID or the name of the container used during its 602 | creation. 603 | 604 | ## Support or Contact 605 | 606 | Having troubles with the container or have questions? Please 607 | [create a new issue]. 608 | 609 | For other great Dockerized applications, see https://jlesage.github.io/docker-apps. 610 | 611 | [create a new issue]: https://github.com/jlesage/docker-czkawka/issues 612 | -------------------------------------------------------------------------------- /appdefs.yml: -------------------------------------------------------------------------------- 1 | --- 2 | 3 | # 4 | # Definitions for Czkawka docker container. 5 | # 6 | # This file is used as data source to generate README.md and unRAID template files 7 | # from Jinja2 templates. 8 | # 9 | 10 | app: 11 | id: 21 12 | name: czkawka 13 | friendly_name: Czkawka 14 | gui_type: x11 15 | base_os: alpine 16 | project: 17 | description: |- 18 | Czkawka is written in Rust, simple, fast and easy to use app to remove 19 | unnecessary files from your computer. 20 | url: https://github.com/qarmin/czkawka 21 | unraid: 22 | support_url: https://forums.unraid.net/topic/101459-support-czkawka/ 23 | category: "Tools:" 24 | documentation: 25 | changelog: 26 | - version: 25.04.1 27 | date: 2025-04-18 28 | changes: 29 | - 'Updated Czkawka to version 9.0.0.' 30 | - 'Fixed potential issues with handling of HEIC files.' 31 | - version: 25.03.1 32 | date: 2025-03-11 33 | changes: 34 | - 'Improved handling of file parsing problems.' 35 | - version: 25.02.1 36 | date: 2025-02-09 37 | changes: 38 | - 'Updated baseimage to version 4.7.1, which brings the following changes (since last used version):' 39 | - '2:Added environment variable that allows configuring the web authentication token lifetime.' 40 | - '2:Fixed compatibility issues that were introduced with support of GTK4 applications.' 41 | - '2:Increased the default service ready timeout from 5 seconds to 10 seconds and allow runtime adjustment via environment variable.' 42 | - '2:Rebuild against latest distro images to get security fixes.' 43 | - version: 24.12.1 44 | date: 2024-12-07 45 | changes: 46 | - 'Updated baseimage to version 4.6.7, which brings the following changes:' 47 | - '2:Fixed web audio feature with URL path-based reverse proxy.' 48 | - '2:Fixed TLS secure connection method for VNC that was preventing web access.' 49 | - '2:Fixed CJK font installation.' 50 | - '2:Rebuild against latest distro images to get security fixes.' 51 | - version: 24.10.1 52 | date: 2024-10-18 53 | changes: 54 | - 'Updated Czkawka to version 8.0.0.' 55 | - version: 24.09.1 56 | date: 2024-09-29 57 | changes: 58 | - 'Updated baseimage to version 4.6.4, which brings the following changes:' 59 | - '2:Fixed web authentication feature with URL path-based reverse proxy.' 60 | - '2:Rebuild against latest distro images to get security fixes.' 61 | - version: 24.07.1 62 | date: 2024-07-03 63 | changes: 64 | - 'Updated baseimage to version 4.6.3, which brings the following changes:' 65 | - '2:Audio support through web browser.' 66 | - '2:Web authentication support.' 67 | - '2:Better support of GTK4 applications.' 68 | - '2:Updated noVNC to version 1.5.0.' 69 | - '2:Updated web UI components (Bootstrap, Font Awesome).' 70 | - '2:When connecting, the control bar is now temporarily shown only once.' 71 | - '2:During package mirror setup, make sure to keep permissions of copied files.' 72 | - version: 24.05.1 73 | date: 2024-05-02 74 | changes: 75 | - 'Fixed issue where videos were not playing.' 76 | - version: 24.04.1 77 | date: 2024-04-04 78 | changes: 79 | - 'Updated Czkawka to version 7.0.0.' 80 | - version: 24.02.1 81 | date: 2024-02-18 82 | changes: 83 | - 'Updated baseimage to version 4.5.3, which brings the following changes:' 84 | - '2:Disabled fullscreen support when page is loaded into an iFrame.' 85 | - '2:Rebuilt against latest distro images to get security fixes.' 86 | - version: 23.11.2 87 | date: 2023-11-19 88 | changes: 89 | - 'Updated baseimage to version 4.5.2, which brings the following changes:' 90 | - '2:Fixed issue that would cause the helper that takes ownership of a directory to fail when using a very high user or group ID.' 91 | - version: 23.11.1 92 | date: 2023-11-10 93 | changes: 94 | - 'Updated baseimage to version 4.5.1, which brings the following changes:' 95 | - '2:Mirror for packages installation can be set via the `PACKAGES_MIRROR` environment variable.' 96 | - '2:Improved the way the `take-ownership` script is working.' 97 | - '2:Readiness and minimum running time checks should not be done for a service defined with an interval.' 98 | - '2:Raise an error when a synched service fails to start.' 99 | - '2:Minimum running time check of a service was using an incorrect way to verify if process is still alive.' 100 | - '2:Fixed installation of CJK font.' 101 | - version: 23.10.1 102 | date: 2023-10-16 103 | changes: 104 | - 'Updated Czkawka to version 6.1.0.' 105 | - version: 23.09.1 106 | date: 2023-09-07 107 | changes: 108 | - 'Added support to open video files.' 109 | - version: 23.06.2 110 | date: 2023-06-12 111 | changes: 112 | - 'Updated Czkawka to version 6.0.0.' 113 | - version: 23.06.1 114 | date: 2023-06-07 115 | changes: 116 | - 'Updated baseimage to version 4.4.2, which brings the following changes:' 117 | - '2:Rebuilt against latest distro images to get security fixes.' 118 | - '2:Updated X server to version 1.20.14.' 119 | - version: 23.04.1 120 | date: 2023-04-29 121 | changes: 122 | - 'Removed warning log message from GTK.' 123 | - 'Updated baseimage to version 4.4.1, which brings the following changes:' 124 | - '2:Updated TigerVNC to version 1.13.1.' 125 | - version: 23.03.1 126 | date: 2023-03-05 127 | changes: 128 | - 'Updated baseimage to version 4.4.0, which brings the following changes:' 129 | - '2:Updated components providing access to application''s UI over web.' 130 | - '2:Improved web UI usage with touch devices.' 131 | - '2:Fixed issue with initialization of Linux users and groups when the `GROUP_ID` is also part of `SUP_GROUP_IDS`.' 132 | - version: 23.02.3 133 | date: 2023-02-20 134 | changes: 135 | - 'Updated Czkawka to version 5.1.0.' 136 | - 'Updated baseimage to version 4.3.6, which brings robustness related enhancements.' 137 | - version: 23.02.2 138 | date: 2023-02-08 139 | changes: 140 | - 'Updated baseimage to version 4.3.4, which brings the following changes:' 141 | - '2:Fixed error message from openbox about missing Fontconfig cache directory.' 142 | - 'Do not use the OCI Docker image format yet to keep better compatibility (e.g with older docker clients).' 143 | - version: 23.02.1 144 | date: 2023-02-04 145 | changes: 146 | - 'Updated baseimage to version 4.3.3, which brings robustness related enhancements.' 147 | - version: 23.01.1 148 | date: 2023-01-04 149 | changes: 150 | - 'Update of the baseimage to version 4.3.1 brings the following changes:' 151 | - '2:Control menu can be moved to the right side of the screen.' 152 | - '2:Automatic focus of the clipboard text box when opening the control menu.' 153 | - '2:Automatic close of the control menu when clicking into the application.' 154 | - '2:Rotation of the internal web server log files.' 155 | - version: 22.12.2 156 | date: 2022-12-11 157 | changes: 158 | - 'Implemented workaround for issue seen with Synology devices where container would not start after an image update. The problem is caused by Synology explicitly setting all environment variables and keeping values from the old version.' 159 | - version: 22.12.1 160 | date: 2022-12-01 161 | changes: 162 | - 'Restored FFmpeg that was inadvertently removed.' 163 | - version: 22.11.2 164 | date: 2022-11-30 165 | changes: 166 | - 'Fixed saving of results to file.' 167 | - 'Disabled trash functionality: current implementation is not adapted for container environment.' 168 | - 'Fixed issue where permissions of `/tmp` were incorrect on some systems.' 169 | - 'Updated baseimage to version `4.2.0`, which brings multiple internal enhancements.' 170 | - version: 22.11.1 171 | date: 2022-11-19 172 | changes: 173 | - 'Updated Czkawka to version 5.0.2.' 174 | - 'Versioning scheme of the Docker image changed to `YY.MM.SEQUENCE`.' 175 | - 'Update of the baseimage to version 4.1.5 brings the following new features:' 176 | - '2:Multi-arch image support.' 177 | - '2:Support for dark mode.' 178 | - '2:Support for remote window resize.' 179 | - '2:Updated the web UI with a new, simplified and less intrusive look.' 180 | - version: 1.7.0 181 | date: 2022-04-24 182 | changes: 183 | - 'Updated Czkawka to version 4.1.0.' 184 | - 'Now using baseimage version 3.5.8, based on Alpine 3.15, which brings the following change:' 185 | - '2:Updated installed packages to get latest security fixes.' 186 | - version: 1.6.1 187 | date: 2022-01-22 188 | changes: 189 | - 'Added FFmpeg, needed to find similar videos.' 190 | - 'Fixed some icons not being displayed correctly.' 191 | - version: 1.6.0 192 | date: 2022-01-21 193 | changes: 194 | - 'Updated Czkawka to version 4.0.0.' 195 | - version: 1.5.0 196 | date: 2021-11-23 197 | changes: 198 | - 'Updated Czkawka to version 3.3.1.' 199 | - version: 1.4.0 200 | date: 2021-05-10 201 | changes: 202 | - 'Updated Czkawka to version 3.1.0.' 203 | - version: 1.3.1 204 | date: 2021-04-13 205 | changes: 206 | - 'Now using baseimage version 3.5.7, which brings the following change:' 207 | - '2:Updated installed packages to get latest security fixes.' 208 | - version: 1.3.0 209 | date: 2021-03-13 210 | changes: 211 | - 'Updated Czkawka to version 3.0.0.' 212 | - version: 1.2.0 213 | date: 2021-02-22 214 | changes: 215 | - 'Updated Czkawka to version 2.4.0.' 216 | - version: 1.1.0 217 | date: 2021-01-26 218 | changes: 219 | - 'Updated Czkawka to version 2.3.2.' 220 | - 'Added Czkawka CLI to the image.' 221 | - version: 1.0.0 222 | date: 2021-01-15 223 | changes: 224 | - 'Initial release.' 225 | 226 | container: 227 | storage_permissions: rw 228 | 229 | # Environment variables. 230 | environment_variables: [] 231 | 232 | # Volumes 233 | volumes: [] 234 | 235 | # Network ports 236 | ports: [] 237 | 238 | # Devices 239 | devices: [] 240 | -------------------------------------------------------------------------------- /rootfs/defaults/recently-used.xbel: -------------------------------------------------------------------------------- 1 | 2 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | -------------------------------------------------------------------------------- /rootfs/etc/cont-env.d/RUST_LOG: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e # Exit immediately if a command exits with a non-zero status. 4 | set -u # Treat unset variables as an error. 5 | 6 | if is-bool-val-true "${CONTAINER_DEBUG:-0}"; then 7 | echo "debug" 8 | else 9 | # Do not set the variable. 10 | exit 100 11 | fi 12 | 13 | # vim:ft=sh:ts=4:sw=4:et:sts=4 14 | -------------------------------------------------------------------------------- /rootfs/etc/cont-init.d/55-czkawka.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e # Exit immediately if a command exits with a non-zero status. 4 | set -u # Treat unset variables as an error. 5 | 6 | # Generate machine id. 7 | if [ ! -f /config/machine-id ]; then 8 | echo "generating machine-id..." 9 | cat /proc/sys/kernel/random/uuid | tr -d '-' > /config/machine-id 10 | fi 11 | 12 | # Clear the fstab file to make sure its content is not displayed when selecting 13 | # folder to add. 14 | echo > /etc/fstab 15 | 16 | if [ ! -f /config/xdg/data/recently-used.xbel ]; then 17 | mkdir -p /config/xdg/data 18 | cp /defaults/recently-used.xbel /config/xdg/data/recently-used.xbel 19 | fi 20 | 21 | # vim: set ft=sh : 22 | -------------------------------------------------------------------------------- /rootfs/etc/machine-id: -------------------------------------------------------------------------------- 1 | /config/machine-id -------------------------------------------------------------------------------- /rootfs/etc/openbox/main-window-selection.xml: -------------------------------------------------------------------------------- 1 | normal 2 | czkawka_gui 3 | -------------------------------------------------------------------------------- /rootfs/startapp.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | export HOME=/config 3 | 4 | export LIBGL_ALWAYS_SOFTWARE=true 5 | 6 | # This is to avoid the following warning: 7 | # (czkawka_gui:613): Gtk-WARNING **: 17:45:24.876: Unable to acquire the address of the accessibility bus: GDBus.Error:org.freedesktop.DBus.Error.ServiceUnknown: The name org.a11y.Bus was not provided by any .service files. If you are attempting to run GT 8 | export GTK_A11Y=none 9 | 10 | cd /storage 11 | exec /usr/bin/czkawka_gui 12 | 13 | # vim:ft=sh:ts=4:sw=4:et:sts=4 14 | -------------------------------------------------------------------------------- /rootfs/usr/local/bin/gio: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # 3 | # The gio binary is used for sending files to trash. This script intercept the 4 | # trash functionality so it can work in a Docker environment. 5 | # 6 | # Note that this script must be located under /usr/local/bin, a path with a 7 | # higher priority than /usr/bin (the original location of gio). 8 | # 9 | 10 | if [ "${1:-}" = "trash" ]; then 11 | # Intercept the trash functionality. 12 | shift 13 | mv "$@" /trash/ 14 | else 15 | if [ "${1:-}" = "open" ] && [ -f "$2" ]; then 16 | if [ "$(ffprobe -v error -select_streams v:0 -show_entries stream=codec_type -of csv=p=0 "$2" 2>/dev/null)" = "video" ]; then 17 | # This is a video file. Start playing with with ffplay. 18 | # Use the current screen size to determine the size of the ffplay window. 19 | DISPLAY_SIZE="$(obxprop --root | grep "^_NET_DESKTOP_GEOMETRY" | cut -d'=' -f2 | tr -d ',' | awk '{print $1; print $2}')" 20 | X="$(echo "$DISPLAY_SIZE" | head -n1)" 21 | Y="$(echo "$DISPLAY_SIZE" | tail -n1)" 22 | exec ffplay -loglevel quiet -x "$(expr "$X" / 2)" -y "$(expr "$Y" / 2)" "$2" 2>/dev/null 23 | fi 24 | fi 25 | exec /usr/bin/gio "$@" 26 | fi 27 | -------------------------------------------------------------------------------- /src/czkawka/build.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | set -e # Exit immediately if a command exits with a non-zero status. 4 | set -u # Treat unset variables as an error. 5 | 6 | SCRIPT_DIR="$(cd "$(dirname "$0")" && pwd)" 7 | 8 | function log { 9 | echo ">>> $*" 10 | } 11 | 12 | CZKAWKA_URL="$1" 13 | 14 | if [ -z "$CZKAWKA_URL" ]; then 15 | log "ERROR: Czkawka URL missing." 16 | exit 1 17 | fi 18 | 19 | # 20 | # Install required packages. 21 | # 22 | apk --no-cache add \ 23 | bash \ 24 | curl \ 25 | git \ 26 | clang \ 27 | g++ \ 28 | lld \ 29 | patch \ 30 | pkgconf \ 31 | 32 | xx-apk --no-cache --no-scripts add \ 33 | musl-dev \ 34 | gcc \ 35 | libstdc++-dev \ 36 | gtk4.0-dev \ 37 | libheif-dev \ 38 | 39 | CZKAWKA_FEATURES="heif" 40 | if ! xx-info is-cross; then 41 | CZKAWKA_FEATURES="$CZKAWKA_FEATURES,libraw" 42 | fi 43 | 44 | # Install Rust. 45 | # NOTE: Czkawka often requires a recent version of Rust that is not available 46 | # yet in Alpine repository. 47 | USE_RUST_FROM_ALPINE_REPO=false 48 | if $USE_RUST_FROM_ALPINE_REPO; then 49 | apk --no-cache add \ 50 | rust \ 51 | cargo 52 | else 53 | apk --no-cache add \ 54 | gcc \ 55 | musl-dev 56 | curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | bash -s -- -y 57 | source /root/.cargo/env 58 | 59 | # NOTE: When not installing Rust from the Alpine repository, we must compile 60 | # with `RUSTFLAGS="-C target-feature=-crt-static"` to avoid crash 61 | # during GTK initialization. 62 | # See https://github.com/qarmin/czkawka/issues/416. 63 | export RUSTFLAGS="-C target-feature=-crt-static" 64 | fi 65 | 66 | # Fix the xx-cargo setup. See https://github.com/tonistiigi/xx/issues/104. 67 | if xx-info is-cross; then 68 | xx-cargo --setup-target-triple 69 | if [ ! -e "/$(xx-cargo --print-target-triple)" ]; then 70 | ln -s "$(xx-info)" "/$(xx-cargo --print-target-triple)" 71 | fi 72 | if [ ! -e "$(xx-info sysroot)/usr/lib/gcc/$(xx-cargo --print-target-triple)" ]; then 73 | ln -s "$(xx-info)" "$(xx-info sysroot)/usr/lib/gcc/$(xx-cargo --print-target-triple)" 74 | fi 75 | fi 76 | 77 | # 78 | # Download sources. 79 | # 80 | 81 | log "Downloading Czkawka..." 82 | mkdir /tmp/czkawka 83 | curl -# -L -f ${CZKAWKA_URL} | tar xz --strip 1 -C /tmp/czkawka 84 | 85 | # 86 | # Compile Czkawka. 87 | # 88 | 89 | # Create cargo profile. 90 | # https://github.com/johnthagen/min-sized-rust 91 | mkdir /tmp/czkawka/.cargo 92 | echo "[profile.release]" >> /tmp/czkawka/.cargo/config.toml 93 | echo "strip = true" >> /tmp/czkawka/.cargo/config.toml 94 | echo "opt-level = 's'" >> /tmp/czkawka/.cargo/config.toml 95 | echo "lto = 'thin'" >> /tmp/czkawka/.cargo/config.toml 96 | echo "panic = 'unwind'" >> /tmp/czkawka/.cargo/config.toml 97 | echo "codegen-units = 1" >> /tmp/czkawka/.cargo/config.toml 98 | 99 | log "Patching Czkawka..." 100 | PATCHES=" 101 | main-window-maximized.patch 102 | hide-title-buttons.patch 103 | results_location.patch 104 | disable_trash.patch 105 | video_hash_fix.patch 106 | " 107 | for PATCH in $PATCHES; do 108 | log "Applying $PATCH..." 109 | patch -p1 -d /tmp/czkawka < "$SCRIPT_DIR"/"$PATCH" 110 | done 111 | 112 | # Fix for Czkawka failing to compile, due to vid_dup_finder_lib, for 32-bit 113 | # targets. See: 114 | # - https://github.com/qarmin/czkawka/issues/1477 115 | # - https://github.com/Farmadupe/vid_dup_finder_lib/issues/12 116 | ( 117 | echo "[patch.crates-io]" >> /tmp/czkawka/.cargo/config.toml 118 | echo "vid_dup_finder_lib = { path = '/tmp/vid_dup_finder_lib/vid_dup_finder_lib' }" >> /tmp/czkawka/.cargo/config.toml 119 | git clone https://github.com/Farmadupe/vid_dup_finder_lib.git /tmp/vid_dup_finder_lib 120 | git -C /tmp/vid_dup_finder_lib reset --hard 23ef0f09273f3719b2a16a37639bf789e00ed3be 121 | ) 122 | 123 | log "Compiling Czkawka CLI..." 124 | ( 125 | cd /tmp/czkawka 126 | # shared-mime-info.pc is under /usr/share/pkgconfig. 127 | PKG_CONFIG_PATH=/$(xx-info)/usr/share/pkgconfig \ 128 | xx-cargo build --release --bin czkawka_cli --features "$CZKAWKA_FEATURES" 129 | ) 130 | 131 | log "Compiling Czkawka GUI..." 132 | # NOTE: When not installing Rust from the Alpine repository, we must compile 133 | # with `RUSTFLAGS="-C target-feature=-crt-static"` to avoid crash during 134 | # GTK initialization. See https://github.com/qarmin/czkawka/issues/416. 135 | ( 136 | cd /tmp/czkawka 137 | # shared-mime-info.pc is under /usr/share/pkgconfig. 138 | PKG_CONFIG_PATH=/$(xx-info)/usr/share/pkgconfig \ 139 | xx-cargo build --release --bin czkawka_gui --features "$CZKAWKA_FEATURES" 140 | ) 141 | 142 | log "Installing Czkawka..." 143 | mkdir /tmp/czkawka-install 144 | cp -v /tmp/czkawka/target/*/release/czkawka_cli /tmp/czkawka-install/ 145 | cp -v /tmp/czkawka/target/*/release/czkawka_gui /tmp/czkawka-install/ 146 | -------------------------------------------------------------------------------- /src/czkawka/disable_trash.patch: -------------------------------------------------------------------------------- 1 | --- a/czkawka_gui/ui/settings.ui 2022-11-30 18:47:44.710807848 -0500 2 | +++ b/czkawka_gui/ui/settings.ui 2022-11-30 18:48:07.539874398 -0500 3 | @@ -105,6 +105,7 @@ 4 | 1 5 | 1 6 | Move deleted files to trash 7 | + false 8 | 9 | 10 | 11 | --- a/czkawka_gui/src/connect_things/connect_button_delete.rs 2022-11-30 18:48:59.933206460 -0500 12 | +++ b/czkawka_gui/src/connect_things/connect_button_delete.rs 2022-11-30 18:49:56.590937189 -0500 13 | @@ -273,7 +273,7 @@ 14 | check_button_settings_use_trash: &CheckButton, 15 | text_view_errors: &TextView, 16 | ) { 17 | - let use_trash = check_button_settings_use_trash.is_active(); 18 | + let use_trash = false && check_button_settings_use_trash.is_active(); 19 | 20 | let model = get_list_store(tree_view); 21 | 22 | @@ -388,7 +388,7 @@ 23 | check_button_settings_use_trash: &CheckButton, 24 | text_view_errors: &TextView, 25 | ) { 26 | - let use_trash = check_button_settings_use_trash.is_active(); 27 | + let use_trash = false && check_button_settings_use_trash.is_active(); 28 | 29 | let model = get_list_store(tree_view); 30 | 31 | @@ -464,7 +464,7 @@ 32 | check_button_settings_use_trash: &CheckButton, 33 | text_view_errors: &TextView, 34 | ) { 35 | - let use_trash = check_button_settings_use_trash.is_active(); 36 | + let use_trash = false && check_button_settings_use_trash.is_active(); 37 | 38 | let model = get_list_store(tree_view); 39 | 40 | --- a/czkawka_gui/src/saving_loading.rs 2022-11-30 19:05:16.727908825 -0500 41 | +++ b/czkawka_gui/src/saving_loading.rs 2022-11-30 19:18:20.654609426 -0500 42 | @@ -738,7 +738,7 @@ 43 | let hide_hard_links: bool = loaded_entries.get_bool(hashmap_ls[&LoadText::HideHardLinks].clone(), DEFAULT_HIDE_HARD_LINKS); 44 | let use_cache: bool = loaded_entries.get_bool(hashmap_ls[&LoadText::UseCache].clone(), DEFAULT_USE_CACHE); 45 | let use_json_cache: bool = loaded_entries.get_bool(hashmap_ls[&LoadText::UseJsonCacheFile].clone(), DEFAULT_SAVE_ALSO_AS_JSON); 46 | - let use_trash: bool = loaded_entries.get_bool(hashmap_ls[&LoadText::DeleteToTrash].clone(), DEFAULT_USE_TRASH); 47 | + let use_trash: bool = false; //loaded_entries.get_bool(hashmap_ls[&LoadText::DeleteToTrash].clone(), DEFAULT_USE_TRASH); 48 | let ignore_other_fs: bool = loaded_entries.get_bool(hashmap_ls[&LoadText::GeneralIgnoreOtherFilesystems].clone(), DEFAULT_GENERAL_IGNORE_OTHER_FILESYSTEMS); 49 | let delete_outdated_cache_duplicates: bool = loaded_entries.get_bool( 50 | hashmap_ls[&LoadText::DuplicateDeleteOutdatedCacheEntries].clone(), 51 | -------------------------------------------------------------------------------- /src/czkawka/hide-title-buttons.patch: -------------------------------------------------------------------------------- 1 | --- a/czkawka_gui/ui/main_window.ui 2022-11-17 21:54:35.435266384 -0500 2 | +++ b/czkawka_gui/ui/main_window.ui 2022-11-17 21:55:08.492041642 -0500 3 | @@ -1106,6 +1106,7 @@ 4 | 1100 5 | 6 | 7 | + false 8 | 9 | 10 | 5 11 | -------------------------------------------------------------------------------- /src/czkawka/main-window-maximized.patch: -------------------------------------------------------------------------------- 1 | This is a workaround for JWM not maximizing the window when the UI is accessed 2 | before the app is started. 3 | --- a/czkawka_gui/ui/main_window.ui 2022-11-17 21:54:35.435266384 -0500 4 | +++ b/czkawka_gui/ui/main_window.ui 2022-11-17 22:45:14.925713529 -0500 5 | @@ -9,6 +9,7 @@ 6 | 100 7 | 8 | 9 | + true 10 | 11 | 12 | vertical 13 | -------------------------------------------------------------------------------- /src/czkawka/results_location.patch: -------------------------------------------------------------------------------- 1 | --- a/czkawka_gui/src/connect_things/connect_button_save.rs 2024-10-14 20:32:26.095130157 -0400 2 | +++ b/czkawka_gui/src/connect_things/connect_button_save.rs 2024-10-14 20:38:29.880494004 -0400 3 | @@ -1,6 +1,5 @@ 4 | use std::cell::RefCell; 5 | use std::collections::HashMap; 6 | -use std::env; 7 | use std::rc::Rc; 8 | 9 | use czkawka_core::common_traits::PrintResults; 10 | @@ -31,10 +30,7 @@ 11 | let notebook_main = gui_data.main_notebook.notebook_main.clone(); 12 | 13 | buttons_save.connect_clicked(move |_| { 14 | - let current_path = match env::current_dir() { 15 | - Ok(t) => t.to_string_lossy().to_string(), 16 | - Err(_) => "__unknown__".to_string(), 17 | - }; 18 | + let current_path = "/config".to_string(); 19 | let result = match to_notebook_main_enum(notebook_main.current_page().expect("Current page not set")) { 20 | NotebookMainEnum::Duplicate => shared_duplication_state.borrow().as_ref().map(|x| x.save_all_in_one(¤t_path, "results_duplicates")), 21 | NotebookMainEnum::EmptyDirectories => shared_empty_folders_state 22 | -------------------------------------------------------------------------------- /src/czkawka/video_hash_fix.patch: -------------------------------------------------------------------------------- 1 | --- a/czkawka_core/src/tools/similar_videos.rs 2025-04-10 07:30:01.084138929 -0400 2 | +++ b/czkawka_core/src/tools/similar_videos.rs 2025-04-10 07:30:46.795147026 -0400 3 | @@ -11,7 +11,7 @@ 4 | use log::debug; 5 | use rayon::prelude::*; 6 | use serde::{Deserialize, Serialize}; 7 | -use vid_dup_finder_lib::{VideoHash, ffmpeg_builder}; 8 | +use vid_dup_finder_lib::{VideoHash}; 9 | 10 | use crate::common::{ 11 | VIDEO_FILES_EXTENSIONS, WorkContinueStatus, check_if_stop_received, delete_files_custom, prepare_thread_handler_common, send_info_and_wait_for_ending_all_threads, 12 | @@ -198,7 +198,7 @@ 13 | } 14 | 15 | fn check_video_file_entry(&self, mut file_entry: VideosEntry) -> VideosEntry { 16 | - let vhash = match ffmpeg_builder::VideoHashBuilder::default().hash(file_entry.path.clone()) { 17 | + let vhash = match vid_dup_finder_lib::VideoHashBuilder::default().hash(file_entry.path.clone()) { 18 | Ok(t) => t, 19 | Err(e) => { 20 | file_entry.error = format!("Failed to hash file, reason {e}"); 21 | --------------------------------------------------------------------------------