appdefs.yml

---

#
# Definitions for dupeGuru docker container.
#
# This file is used as data source to generate README.md and unRAID template files
# from Jinja2 templates.
#

app:
  id: 1
  name: dupeguru
  friendly_name: dupeGuru
  gui_type: x11
  base_os: alpine
  project:
    description: |-
      dupeGuru is a tool to find duplicate files on your computer. It can scan either
      filenames or contents. The filename scan features a fuzzy matching algorithm
      that can find duplicate filenames even when they are not exactly the same.
    url: https://dupeguru.voltaicideas.net
  unraid:
    support_url: https://forums.unraid.net/topic/56392-support-dupeguru/
    category: "Tools:"
  documentation:
    sections:
      - title: dupeGuru Deletion Options
        level: 2
        content: |-
          When deleting duplicated files, dupeGuru offer two choices:
            * Send files to trash
            * Delete files directly

          The first option moves files to the `/trash` directory inside the container.
          This operation can be slow for large files since it may imply a copy of the
          data before the actual deletion.

          There is also an option to link deleted files.  It is not recommended to enable
          this option, since there is a good chance that created links won't make sense
          outside the container.
  changelog:
    - version: 24.12.1
      date: 2024-12-07
      changes:
        - 'Updated baseimage to version 4.6.7, which brings the following changes:'
        - '2:Fixed web audio feature with URL path-based reverse proxy.'
        - '2:Fixed TLS secure connection method for VNC that was preventing web access.'
        - '2:Fixed CJK font installation.'
        - '2:Rebuild against latest distro images to get security fixes.'
    - version: 24.09.1
      date: 2024-09-29
      changes:
        - 'Updated baseimage to version 4.6.4, which brings the following changes:'
        - '2:Fixed web authentication feature with URL path-based reverse proxy.'
        - '2:Rebuild against latest distro images to get security fixes.'
    - version: 24.07.1
      date: 2024-07-03
      changes:
        - 'Updated baseimage to version 4.6.3, which brings the following changes:'
        - '2:Audio support through web browser.'
        - '2:Web authentication support.'
        - '2:Better support of GTK4 applications.'
        - '2:Updated noVNC to version 1.5.0.'
        - '2:Updated web UI components (Bootstrap, Font Awesome).'
        - '2:When connecting, the control bar is now temporarily shown only once.'
        - '2:During package mirror setup, make sure to keep permissions of copied files.'
    - version: 24.01.1
      date: 2024-01-23
      changes:
        - 'Updated baseimage to version 4.5.3, which brings the following changes:'
        - '2:Disabled fullscreen support when page is loaded into an iFrame.'
        - '2:Rebuilt against latest distro images to get security fixes.'
    - version: 23.11.3
      date: 2023-11-19
      changes:
        - 'Updated baseimage to version 4.5.2, which brings the following changes:'
        - '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.'
    - version: 23.11.2
      date: 2023-11-13
      changes:
        - 'Fixed exception during startup that might occur in some environments.'
    - version: 23.11.1
      date: 2023-11-10
      changes:
        - 'Updated baseimage to version 4.5.1, which brings the following changes:'
        - '2:Mirror for packages installation can be set via the `PACKAGES_MIRROR` environment variable.'
        - '2:Improved the way the `take-ownership` script is working.'
        - '2:Readiness and minimum running time checks should not be done for a service defined with an interval.'
        - '2:Raise an error when a synched service fails to start.'
        - '2:Minimum running time check of a service was using an incorrect way to verify if process is still alive.'
        - '2:Fixed installation of CJK font.'
    - version: 23.06.1
      date: 2023-06-07
      changes:
        - 'Updated baseimage to version 4.4.2, which brings the following changes:'
        - '2:Rebuilt against latest distro images to get security fixes.'
        - '2:Updated X server to version 1.20.14.'
    - version: 23.04.1
      date: 2023-04-29
      changes:
        - 'Updated baseimage to version 4.4.1, which brings the following changes:'
        - '2:Updated TigerVNC to version 1.13.1.'
    - version: 23.03.1
      date: 2023-03-05
      changes:
        - 'Updated baseimage to version 4.4.0, which brings the following changes:'
        - '2:Updated components providing access to application''s UI over web.'
        - '2:Improved web UI usage with touch devices.'
        - '2:Fixed issue with initialization of Linux users and groups when the `GROUP_ID` is also part of `SUP_GROUP_IDS`.'
        - '2:Limit the maximum number of opened files on system having a very large, unlimited value. This prevents unnecessary waste of CPU resources and time for applications trying to close all possible file descriptors.'
    - version: 23.02.2
      date: 2023-02-08
      changes:
        - 'Updated baseimage to version 4.3.4, which brings the following changes:'
        - '2:Fixed error message from openbox about missing Fontconfig cache directory.'
        - 'Do not use the OCI Docker image format yet to keep better compatibility (e.g with older docker clients).'
    - version: 23.02.1
      date: 2023-02-04
      changes:
        - 'Updated baseimage to version 4.3.3, which brings robustness related enhancements.'
    - version: 23.01.1
      date: 2023-01-04
      changes:
        - 'Update of the baseimage to version 4.3.1 brings the following changes:'
        - '2:Control menu can be moved to the right side of the screen.'
        - '2:Automatic focus of the clipboard text box when opening the control menu.'
        - '2:Automatic close of the control menu when clicking into the application.'
        - '2:Rotation of the internal web server log files.'
    - version: 22.10.2
      date: 2022-10-24
      changes:
        - 'Update of the baseimage to version 4.1.1 brings the following changes:'
        - '2:Fixed Websockify and favicons paths for compatibility with scenario where a reverse proxy with routing based un URL path is used.'
        - '2:Collapse the setting section of the control panel by default on touch devices to accommodate the size taken by the on-screen keyboard.'
        - '2:Include the Docker image platform in informational box printed during container startup.'
        - '2:A umask value of `0000` was not properly applied.'
        - '2:Fixed issue where the window manager configuration may fail to load.'
    - version: 22.10.1
      date: 2022-10-12
      changes:
        - 'Versioning scheme of the Docker image changed to `YY.MM.SEQUENCE`.'
        - 'Update of the baseimage to version 4.0.2 brings the following new features:'
        - '2:Multi-arch image support.'
        - '2:Support for dark mode.'
        - '2:Support for remote window resize.'
        - '2:Updated the web UI with a new, simplified and less intrusive look.'
    - version: 1.13.0
      date: 2022-07-15
      changes:
        - 'Updated dupeGuru to version 4.3.1.'
    - version: 1.12.1
      date: 2022-03-27
      changes:
        - 'Updated dupeGuru to version 4.2.1.'
    - version: 1.12.0
      date: 2022-03-10
      changes:
        - 'Updated dupeGuru to version 4.2.0.'
        - 'Updated baseimage to version 3.5.8, based on Alpine 3.15, which brings to following changes:'
        - '2:Updated installed packages to get latest security fixes.'
    - version: 1.11.3
      date: 2021-09-14
      changes:
        - 'Fixed issue where the container would fail to start under certain environments.'
    - version: 1.11.2
      date: 2021-04-13
      changes:
        - 'Now using baseimage version 3.5.7, which brings the following change:'
        - '2:Updated installed packages to get latest security fixes.'
    - version: 1.11.1
      date: 2021-03-22
      changes:
        - 'Updated dupeGuru to version 4.1.1.'
    - version: 1.11.0
      date: 2021-01-11
      changes:
        - 'Updated dupeGuru to version 4.1.0.'
        - 'Now using baseimage version 3.5.6, based on Alpine 3.12, which bring the following changes (since last used version):'
        - '2:Updated installed packages to get latest security fixes.'
        - '2:Make sure the tzdata is installed.'
        - '2:Upgraded glibc to version 2.31 on Alpine Linux images with glibc integrated.'
        - '2:Adjusted the log monitor target for recent versions of YAD.'
    - version: 1.10.2
      date: 2019-05-15
      changes:
        - 'Upgraded dupeGuru to version 4.0.4.'
    - version: 1.10.1
      date: 2019-04-24
      changes:
        - 'Now using baseimage v3.5.2, which brings the following changes:'
        - '2:Updated installed packages to get latest security fixes.'
        - '2:Fixed issue where the container could have a zombie process.'
        - '2:Fixed issue where the password would not be submitted when pressing the enter key in the password modal.'
        - '2:Use relative path for favicon ressources to be more friendly with reverse proxy senarios.'
    - version: 1.10.0
      date: 2018-09-19
      changes:
        - 'Now using baseimage v3.5.1, which brings the following changes (since last used version):'
        - '2:Image based on Alpine Linux 3.8.'
        - '2:Upgraded s6-overlay to version 1.21.4.0.'
        - '2:Wait for a limited time when terminating a service.'
        - '2:Set and create the XDG_RUNTIME_DIR directory.'
        - '2:Updated installed packages to get latest security fixes.'
    - version: 1.9.3
      date: 2018-03-02
      changes:
        - 'Now using baseimage v3.3.4, which brings the following changes (since last used version):'
        - '2:Make sure the log monitor is started after the X server.'
        - '2:Fixed an issue where the log monitor `yad` target would use XDG folders of the application.'
        - '2:Fixed issue where log monitor states were not cleared during container startup.'
    - version: 1.9.2
      date: 2018-02-03
      changes:
        - 'Now using baseimage v3.3.2, which brings the following changes:'
        - '2:Restored timezone support in Alpine Linux images with glibc.'
        - '2:Fixed issue in `add-pkg` helper where a package could be incorrectly detected as installed.'
    - version: 1.9.1
      date: 2018-01-30
      changes:
        - 'Now using baseimage v3.3.1, which brings the following changes:'
        - '2:Adjusted the way some ressources are accessed to better support reverse proxy to the container.'
    - version: 1.9.0
      date: 2018-01-22
      changes:
        - 'Now using baseimage v3.3.0, which brings the following changes (since last used version):'
        - '2:For Alpine Linux images with glibc, automatically update dynamic linker''s cache after new libraries are installed.'
        - '2:Fixed the LANG environment variable not being set properly.'
        - '2:Added the ability to automatically install a CJK (Chinese/Japanese/Korean) font.'
    - version: 1.8.4
      date: 2018-01-11
      changes:
        - 'Now using baseimage v3.2.2, which brings the following changes (since last used version):'
        - '2:Upgraded S6 overlay to version 1.21.2.2.'
        - '2:Upgraded glibc to version 2.26 (Alpine Linux glibc images).'
        - '2:Adjusted the way ownership of /config is taken to better support cases where the folder is mapped to a network share.'
        - 'Small adjustment to the way ownership of files are taken.'
    - version: 1.8.3
      date: 2017-12-12
      changes:
        - 'Now using baseimage v3.1.4, which brings the following changes:'
        - '2:Set 2 worker processes for nginx.'
    - version: 1.8.2
      date: 2017-11-20
      changes:
        - 'Now using baseimage v3.1.3, which brings the following changes:'
        - '2:Upgraded S6 overlay to version 1.21.2.1.'
    - version: 1.8.1
      date: 2017-11-07
      changes:
        - 'Now using baseimage v3.1.2, which brings the following changes (from last used version):'
        - '2:Fixed an issue where a self-disabled service could be restarted.'
        - '2:Upgraded S6 overlay to version 1.21.2.0.'
        - '2:Use a more efficient way to monitor status files.'
    - version: 1.8.0
      date: 2017-10-29
      changes:
        - 'Now using baseimage v3.1.0, which brings the following changes:'
        - '2:Upgraded S6 overlay to version 1.21.1.1.'
        - '2:Enhanced integration of service dependencies functionality.'
        - '2:Added a simple log monitor.'
        - '2:Fixed race condition where container''s exit code would not be the expected one.'
        - '2:Fixed issue where application''s GUI fails to displayed when accessing it through the web interface via standard ports 80/443.'
    - version: 1.7.2
      date: 2017-10-09
      changes:
        - 'Now using baseimage v3.0.2, which brings the following changes:'
        - '2:Fixed issue where nginx config change was not applied correctly on systems without IPV6 support and secure connection disabled.'
    - version: 1.7.1
      date: 2017-10-08
      changes:
        - 'Now using baseimage v3.0.1, which brings the following changes:'
        - '2:Fixed nginx config for systems without IPV6 support.'
    - version: 1.7.0
      date: 2017-10-07
      changes:
        - 'Now using baseimage v3.0.0, which brings the following changes:'
        - '2:Better support for service dependencies.'
        - '2:Added support for secure access to the application''s GUI.'
    - version: 1.6.7
      date: 2017-09-21
      changes:
        - 'Compile dupeGuru from source instead of installing from the debian package.'
        - 'Now using baseimage v2.0.9, which brings the following changes:'
        - '2:Restore default `/etc/shadow` during container startup.'
    - version: 1.6.6
      date: 2017-09-08
      changes:
        - 'Now using baseimage v2.0.8, which brings the following changes (from last used version):'
        - '2:Fixed timezone support on alpine-glibc images.'
        - '2:Fixed duplicated entries in /etc/passwd and /etc/group that were created after a restart of the container.'
    - version: 1.6.5
      date: 2017-08-14
      changes:
        - 'Now using baseimage v2.0.6, which brings the following changes:'
        - '2:Upgraded S6 overlay to version 1.20.0.0.'
    - version: 1.6.4
      date: 2017-07-31
      changes:
        - 'Now using baseimage v2.0.5, which brings the following changes (from last used version):'
        - '2:Clear the environment of the container during startup.'
        - '2:Clear the /tmp folder during startup.'
        - '2:Cleanly terminate the X server when container is restarted/stopped.'
        - '2:Improved robustness of X server starting process.'
        - '2:Removed unneeded files from the image.'
    - version: 1.6.3
      date: 2017-07-27
      changes:
        - 'Now using baseimage v2.0.3, which brings the following changes:'
        - '2:Improved robustness of the X server starting process.'
    - version: 1.6.2
      date: 2017-07-23
      changes:
        - 'Now using baseimage v2.0.2, which brings the following changes:'
        - '2:Proper VNC port is exposed.'
    - version: 1.6.1
      date: 2017-07-18
      changes:
        - 'Now using baseimage v2.0.1, which brings the following changes:'
        - '2:Internal enhancements.'
        - '2:Clean temporary files left by npm.'
    - version: 1.6.0
      date: 2017-07-17
      changes:
        - 'Now using baseimage v2.0.0, which brings the following changes:'
        - '2:Various internal enhancements.'
        - '2:Fixed the way a service waits for another one.'
        - 'Added a default QtProject.conf configuration file.'
    - version: 1.5.0
      date: 2017-07-04
      changes:
        - 'Fixed dialog windows not appearing on top of other ones.'
        - 'Now using baseimage v1.5.0, which brings the following changes:'
        - '2:Added the UMASK environment variable to control how file permissions are set for newly created files.'
        - '2:Added the X11VNC_EXTRA_OPTS environment variable used to pass additional arguments to the x11vnc server.'
        - '2:By default, activate auto-scaling of application''s window.'
        - '2:Applied latest Alpine Linux security updates.'
    - version: 1.4.0
      date: 2017-06-22
      changes:
        - 'Switched to Alpine Linux 3.6 baseimage.'
        - 'Now using baseimage v1.4.3, which brings the following changes:'
        - '2:Updated Alpine Linux to version 3.6.2.'
        - 'Make sure the main window is always below other ones.'
    - version: 1.3.1
      date: 2017-06-21
      changes:
        - 'Now using baseimage v1.4.2, which brings the following changes (from last used version):'
        - '2:Associate the application''s icon to a unique version to avoid browser cache issues.'
        - '2:Fixed prefix of some service related messages.'
        - '2:Added support for supplying supplementary groups of the application.'
    - version: 1.3.0
      date: 2017-06-06
      changes:
        - 'Now using baseimage v1.4.0, which brings the following changes:'
        - '2:Improved process startup and shutdown.'
        - '2:When container is stopped or restarted, processes are now terminated gracefully and in proper order. This allow the GUI application to execute its termination routine.'
        - '2:No more error messages when container is stopped or restarted.'
        - 'Added OS signals handling to dupeGuru. This allows the application to properly close when the container is stopped or restarted.'
        - 'Now that dupeGuru closes gracefully, all settings are properly saved.'
    - version: 1.2.2
      date: 2017-06-01
      changes:
        - 'Now using baseimage v1.3.2, which brings the following changes:'
        - '2:Fixed password modal window not showing up when required.'
    - version: 1.2.1
      date: 2017-05-17
      changes:
        - 'Now using baseimage v1.3.1, which brings the following changes:'
        - '2:Better font is used.'
    - version: 1.2.0
      date: 2017-05-15
      changes:
        - 'Now using baseimage v1.3.0, which brings the following changes:'
        - '2:Added support for application''s niceness configuration.'
    - version: 1.1.3
      date: 2017-05-12
      changes:
        - 'Now using baseimage v1.2.3, which brings the following changes:'
        - '2:Adjusted the default display width to 1280 pixels, as documented.'
    - version: 1.1.2
      date: 2017-05-11
      changes:
        - 'Now using baseimage v1.2.2, which brings the following changes:'
        - '2:Fixed issue with the web UI, where the remote application''s window was not taking the available height after activating/deactivating the hideable navigation bar.'
    - version: 1.1.1
      date: 2017-05-10
      changes:
        - 'Now using baseimage v1.2.1, which brings the following changes:'
        - '2:Fixed issue where clipboard content was lost on modal window closure.'
    - version: 1.1.0
      date: 2017-05-10
      changes:
        - 'Now using baseimage v1.2.0, which brings a new UI for web access to the container:'
        - '2:Based on Bootstrap and JQuery.'
        - '2:Mobile friendly.'
        - '2:Hideable navigation bar.'
        - '2:Downscaling support.'
        - '2:Clipboard support.'
        - '2:Fullscreen toggle.'
        - '2:Draggable remote screen when it doesn''t fix the client''s window.'
        - '2:Virtual keyboard support on mobile.'
        - '2:Right-click via long touch on mobile.'
    - version: 1.0.2
      date: 2017-05-05
      changes:
        - 'Now using baseimage v1.0.1, which brings the following fixes:'
        - '2:Fixed issue where VNC password was still applied after removal of the VNC password file from /config.'
        - '2:Fixed mouse handling when accessing the container''s GUI via Microsoft Internet Explorer/Edge.'
        - '2:Fixed a crash of the build-in VNC server.'
    - version: 1.0.1
      date: 2017-05-05
      changes:
        - 'Some configuration files used by dupeGuru were not saved outside the container.'
    - version: 1.0.0
      date: 2017-04-07
      changes:
        - 'Initial release.'

container:
  storage_permissions: rw

  # Environment variables.
  environment_variables: []

  # Volumes
  volumes:
    - container_path: /trash
      host_path_example:
      description: >-
        This is where duplicated files are moved when they are sent to trash.
      permissions: rw
      unraid_template:
        title: Trash
        description: >-
          This is where dupeGuru moves files when they are sent to trash.  Usage
          of the trash is optional.  The default value of /dev/null can be kept
          if the trash is not wanted.
        default: /dev/null
        display: advanced-hide
        required: false
        mask: false

  # Network ports
  ports: []

  # Devices
  devices: []