appdefs.yml

---

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

app:
  id: 14
  name: firefox
  friendly_name: Firefox
  gui_type: x11
  base_os: alpine
  project:
    description: |-
      Mozilla Firefox is a free and open-source web browser developed by Mozilla
      Foundation and its subsidiary, Mozilla Corporation.
    url: https://www.mozilla.org/firefox/
  unraid:
    support_url: https://forums.unraid.net/topic/69440-support-firefox/
    category: "Tools:"
  documentation:
    sections:
      - title: Allowing the membarrier System Call
        level: 2
        content: |-
          To properly work, recent versions of {{ app.friendly_name }} need the
          `membarrier` system call.  Without it, tabs would frequently crash.

          Docker uses [seccomp profile] to restrict system calls available to the
          container.  Before Docker version `20.10.0`, the `membarrier` system call was
          not allowed in the default profile.  If you run a such version, you can use one
          of the following solutions, from the most to the least secure, to provide the
          container permission to use this sytem call:

            1. Run the container with a custom seccomp profile allowing the `membarrier`
               system call.  The [latest official seccomp profile] can be used.  Download
               the file and then add the following parameter when creating the container:
               `--security-opt seccomp=/path/to/seccomp_profile.json`.
            2. Run the container without the default seccomp profile (thus allowing all
               system calls). Use the following parameter when creating the container:
               `--security-opt seccomp=unconfined`.
            3. Run the container in privileged mode.  This effectively disables usage of
               seccomp.  Add the `--privileged` parameter when creating the container.

            [here]: https://bugzilla.mozilla.org/show_bug.cgi?id=1338771#c10
            [latest official seccomp profile]: https://github.com/moby/moby/blob/master/profiles/seccomp/default.json
            [seccomp profile]: https://docs.docker.com/engine/security/seccomp/
      - title: Sound Support
        level: 2
        content: |-
          For {{ app.friendly_name }} to be able to use the audio device available on
          the host, `/dev/snd` must be exposed to the container by adding the
          `--device /dev/snd` parameter to the `docker run` command.
      - title: Setting {{ app.friendly_name }} Preferences Via Environment Variables
        level: 2
        content: |-
          {{ app.friendly_name }} preferences can be set via environment variables
          passed to the container.  During the startup, a script process all these
          variables and modify the preference file accordingly.

          The name of the environment variable must start with `FF_PREF_`, followed by a
          string of your choice.  For example, `FF_PREF_MY_PREF` is a valid name.

          The content of the variable should be in the format `NAME=VAL`, where `NAME` is
          the name of the preference (as found in the `about:config` page) and `VAL` is
          its value.  A value can be one of the following types:
            - string
            - integer
            - boolean

          It is important to note that a value of type `string` should be surrounded by
          double quotes.  Other types don't need them.

          For example, to set the `network.proxy.http` preference, one would pass the
          environment variable to the container by adding the following argument to the
          `docker run` command:

          ```
          -e "FF_PREF_HTTP_PROXY=network.proxy.http=\"proxy.example.com\""
          ```

          If a preference needs to be *removed*, its value should be set to `UNSET`.  For
          example:

          ```
          -e "FF_PREF_HTTP_PROXY=network.proxy.http=UNSET"
          ```

          **NOTE**: This is an advanced usage and it is recommended to set preferences
          via {{ app.friendly_name }} directly.
      - title: Troubleshooting
        level: 2
      - title: Crashes
        level: 3
        content: |-
          If {{ app.friendly_name }} is crashing frequently, make sure that:
            - The `membarrier` system call is not blocked by Docker.  See the
              [Allowing the membarrier System Call](#allowing-the-membarrier-system-call)
              for more details.
            - Make sure the kernel of your Linux distribution is up-to-date.
  changelog:
    - version: 24.08.1
      date: 2024-08-05
      changes:
        - 'Updated Firefox to version 128.0.3-r0.'
    - version: 24.07.1
      date: 2024-07-02
      changes:
        - 'Updated Firefox to version 126.0.1-r0.'
        - '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.05.1
      date: 2024-05-02
      changes:
        - 'Updated Firefox to version 125.0.3-r0.'
    - version: 24.04.1
      date: 2024-04-12
      changes:
        - 'Updated Firefox to version 124.0.1-r0.'
    - version: 24.01.1
      date: 2024-01-20
      changes:
        - 'Updated Firefox to version 120.0.1-r0.'
        - 'Updated baseimage to version 4.5.3, based on Alpine Linux 3.19, 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-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.11.1
      date: 2023-11-09
      changes:
        - 'Updated Firefox to version 119.0-r0.'
    - version: 23.08.2
      date: 2023-08-20
      changes:
        - 'Updated Firefox to version 116.0.3-r0.'
    - version: 23.08.1
      date: 2023-08-04
      changes:
        - 'Updated Firefox to version 116.0-r0.'
    - version: 23.06.1
      date: 2023-06-24
      changes:
        - 'Updated Firefox to version 114.0.2-r0.'
        - 'Fixed issue caused by the presence slash or backslash characters in Firefox preference''s value set via environment variable.'
    - version: 23.05.2
      date: 2023-05-27
      changes:
        - 'Updated Firefox to version 113.0.2-r1.'
    - version: 23.05.1
      date: 2023-05-19
      changes:
        - 'Updated Firefox to version 113.0.1-r1.'
        - 'Updated baseimage to version 4.4.2, based on Alpine Linux 3.18, 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:
        - 'Fixed WebGL (software) support.'
        - 'Reverted to using a font with better UTF-8 characters support.'
        - 'Improved graceful shutdown of Firefox.'
        - '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`.'
    - version: 23.02.3
      date: 2023-02-13
      changes:
        - 'Updated baseimage to version 4.3.6, which brings the following changes:'
        - '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.'
        - 'Added default preference to prevent closing Firefox when closing the last tab.'
    - 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 Firefox to version 109.0.1-r0.'
        - 'Updated baseimage to version 4.3.3, which brings robustness related enhancements.'
    - version: 23.01.1
      date: 2023-01-04
      changes:
        - 'Updated Firefox to version 108.0.1-r1.'
        - '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.12.2
      date: 2022-12-11
      changes:
        - '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.'
    - version: 22.12.1
      date: 2022-12-09
      changes:
        - 'Updated Firefox to version 107.0.1-r1.'
        - 'Updated baseimage to version `4.2.1`, which brings multiple internal enhancements.'
    - version: 22.10.4
      date: 2022-10-24
      changes:
        - 'Update of the baseimage to version 4.1.1 brings the following changes:'
        - '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:Fixed logmonitor crash on arm64 platform.'
        - '2:A umask value of `0000` was not properly applied.'
        - '2:Fixed issue where the window manager configuration may fail to load.'
        - '2:Fixed errors from yad caused by usage of wrong fontconfig related files.'
    - version: 22.10.3
      date: 2022-10-14
      changes:
        - 'Fixed scenario where a reverse proxy with routing based un URL path is used.'
    - version: 22.10.2
      date: 2022-10-10
      changes:
        - 'Fixed an issue where taking ownership of `/config` would fail if a subfolder is mapped to a network share.'
        - 'Fixed handling of exposed sound device.'
        - 'Fixed handling of the VNC password.'
    - version: 22.10.1
      date: 2022-10-09
      changes:
        - 'Versioning scheme of the Docker image changed to `YY.MM.SEQUENCE`.'
        - 'Updated Firefox to version 101.0.1-r0.'
        - 'Added support for kiosk mode.'
        - 'Added support for URL opening at launch.'
        - 'Update of the baseimage to version 4.0.1 brings the following nbew 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.18.0
      date: 2021-12-30
      changes:
        - 'Updated Firefox to version 94.0-r0.'
        - 'Now using baseimage version 3.5.8, based on Alpine 3.15, which brings the following change:'
        - '2:Updated installed packages to get latest security fixes.'
    - version: 1.17.1
      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.17.0
      date: 2021-02-06
      changes:
        - 'Updated Firefox to version 84.0.2-r0.'
    - version: 1.16.0
      date: 2020-12-16
      changes:
        - 'Updated Firefox to version 83.0-r1.'
    - version: 1.15.0
      date: 2020-10-01
      changes:
        - 'Updated Firefox to version 81.0-r0'
    - version: 1.14.0
      date: 2020-08-05
      changes:
        - 'Upgraded Firefox to version 79.0-r0.'
        - 'Now using baseimage to version 3.5.6, which brings the following changes:'
        - '2:Other small adjustments for the YAD log monitor target.'
    - version: 1.13.0
      date: 2020-07-19
      changes:
        - 'Upgraded Firefox to version 78.0.2-r1.'
        - 'Added check for missing `membarrier` system call support.'
        - 'Now using baseimage v3.5.5, based on Alpine 3.12, which brings the following changes:'
        - '2:Upgraded glibc to version 2.31 on Alpine Linux images with glibc integrated.'
        - '2:Updated installed packages to get latest security fixes.'
        - '2:Adjusted the log monitor target for recent versions of YAD.'
    - version: 1.12.0
      date: 2020-06-24
      changes:
        - 'Upgraded Firefox to version 77.0.1-r2.'
    - version: 1.11.0
      date: 2020-04-25
      changes:
        - 'Upgraded Firefox to version 75.0-r2.'
    - version: 1.10.0
      date: 2020-03-15
      changes:
        - 'Upgraded Firefox to version 74.0-r0.'
    - version: 1.9.1
      date: 2020-02-10
      changes:
        - 'Upgraded Firefox to version 72.0.2-r0.'
    - version: 1.9.0
      date: 2020-01-14
      changes:
        - 'Upgraded Firefox to version 72.0.1-r0.'
    - version: 1.8.0
      date: 2019-12-25
      changes:
        - 'Upgraded Firefox to version 71.0-r0.'
        - 'Now using baseimage v3.5.3, which brings the following changes:'
        - '2:Updated installed packages to get latest security fixes.'
        - '2:Make sure the tzdata is installed.'
        - 'Use baseimage based on Alpine Linux 3.10.'
    - version: 1.7.1
      date: 2019-08-26
      changes:
        - 'Upgraded Firefox to version 68.0.2-r0.'
    - version: 1.7.0
      date: 2019-08-05
      changes:
        - 'Upgraded Firefox to version 68.0.r0.'
    - version: 1.6.0
      date: 2019-07-17
      changes:
        - 'Upgraded Firefox to version 67.0.4-r0.'
    - version: 1.5.1
      date: 2019-05-12
      changes:
        - 'Upgraded Firefox to version 66.0.5-r1.'
    - version: 1.5.0
      date: 2019-05-09
      changes:
        - 'Upgraded Firefox to version 66.0.4-r0.'
        - 'Print the Firefox version during the container startup.'
    - version: 1.4.1
      date: 2019-04-24
      changes:
        - 'Upgraded Firefox to version 62.0.3-r4.'
        - '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.4.0
      date: 2019-02-24
      changes:
        - 'Upgraded Firefox to version 62.0.3-r2.'
        - 'Preferences can now be set via environment variables.'
        - 'Use baseimage based on Alpine Linux 3.9.'
    - version: 1.3.1
      date: 2018-09-18
      changes:
        - 'Now using baseimage v3.5.1, which brings the following changes:'
        - '2:Updated installed packages to get latest security fixes.'
    - version: 1.3.0
      date: 2018-07-27
      changes:
        - 'Added support for more playable video formats.'
        - 'Added support for sound in Firefox.'
    - version: 1.2.0
      date: 2018-07-12
      changes:
        - 'Now using baseimage v3.4.0, which is based on Alpine Linux 3.8.'
        - 'Upgraded Firefox to version 61.0.1-r0.'
    - version: 1.1.0
      date: 2018-05-31
      changes:
        - 'Upgraded Firefox to version 60.0.1-r0.'
    - version: 1.0.2
      date: 2018-03-15
      changes:
        - 'Fixed issue where Firefox would not gracefully terminate.'
        - 'Fixed an issue where restoring session would resize window to the wrong dimensions.'
    - version: 1.0.1
      date: 2018-03-02
      changes:
        - 'Now using baseimage v3.3.4, which brings the following changes:'
        - '2:Fixed issue where log monitor states were not cleared during container startup.'
        - 'Updated Firefox to version 58.0.1-r2.'
    - version: 1.0.0
      date: 2018-02-16
      changes:
        - 'Initial release.'

container:
  unsupported_volume: /storage

  # Environment variables.
  environment_variables:
    - name: FF_OPEN_URL
      description: >-
        The URL to open when {{ app.friendly_name }} starts.
      type: public
      unraid_template:
        title: "Open URL"
        display: advanced
        required: false
        mask: false
    - name: FF_KIOSK
      description: >-
        Set to `1` to enable kiosk mode.  This mode launches Firefox in a very
        restricted and limited mode best suitable for public areas or
        customer-facing displays.
      type: public
      default: 0
      unraid_template:
        title: "Kiosk Mode"
        description: >-
          Set to 1 to enable kiosk mode.  This mode launches Firefox in a very
          restricted and limited mode best suitable for public areas or
          customer-facing displays.
        display: advanced
        required: false
        mask: false
    - name: FF_CUSTOM_ARGS
      description: >-
        Custom argument(s) to pass when launching {{ app.friendly_name }}.
      type: public
      default: 0
      unraid_template:
        title: "Custom Arguments"
        display: advanced
        required: false
        mask: false

  # Volumes
  volumes: []

  # Network ports
  ports: []

  # Devices
  devices:
    - path: /dev/snd
      description: Optional Linux device to expose to have sound.