From 1dbb35d701a0ad66b806870ef14f818a0ffda735 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexis=20M=C3=A9taireau?= Date: Thu, 13 Mar 2025 17:26:01 +0100 Subject: [PATCH 1/3] Document Operating System support The goal is to have rules rather than specific versions, and a table to summarize everything. --- INSTALL.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 2 files changed, 46 insertions(+) diff --git a/INSTALL.md b/INSTALL.md index 32621f9..f9a1d39 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,5 +1,35 @@ +## Operating system support + +Dangerzone can run on a varieties of Operating systems, and have automated tests for a subset of them. +This section explains what is the support you should expect from us. + +You can find general support information in this table, and more details in the following sections. + +(Unless specified, the architecture is AMD64) + +| Distribution | Supported versions | Automated tests | Manual QA | +| ------------ | ------------------------- | ---------------------- | ----------------- | +| Windows | 3 last releases | Last release only | Last version only | +| macOS intel | 3 last releases | Last release only | Last release only | +| macOS ARM | 3 last releases | Last release only | Last release only | +| Ubuntu | Follow upstream support ✰ | 🗹 | 🗹 | +| Debian | Current stable, Oldstable and LTS releases | 🗹 | 🗹 | +| Fedora | Follow upstream support | 🗹 | 🗹 | +| Qubes OS | [Beta support](https://github.com/freedomofpress/dangerzone/issues/413) ✢ | 🗷 | Latest Fedora template | +| Tails | Only the latest version | 🗷 | Last release only | + +Notes: + +✰ Support for Ubuntu Focal [was dropped](https://github.com/freedomofpress/dangerzone/issues/1018) + +✢ Qubes OS support is done via the use of other OSes (e.g. Fedora or Debian) for the VMs, so the versions we support are tied to them. + ## MacOS +We support the versions of macOS that are still within Apple's servicing timeline. Apple usually provides security updates for the latest 3 releases, but this isn’t consistently applied and security fixes aren’t guaranteed for the non-latest releases. + +We have automated tests for the latest version of macOS only. + - Download [Dangerzone 0.8.1 for Mac (Apple Silicon CPU)](https://github.com/freedomofpress/dangerzone/releases/download/v0.8.1/Dangerzone-0.8.1-arm64.dmg) - Download [Dangerzone 0.8.1 for Mac (Intel CPU)](https://github.com/freedomofpress/dangerzone/releases/download/v0.8.1/Dangerzone-0.8.1-i686.dmg) @@ -11,6 +41,12 @@ You can also install Dangerzone for Mac using [Homebrew](https://brew.sh/): `bre ## Windows +We generally support the versions of Windows that are still within [Microsoft’s servicing timeline](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). + +For Windows, Docker sets the bottom line: + +> Docker only supports Docker Desktop on Windows for those versions of Windows that are still within [Microsoft’s servicing timeline](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). Docker Desktop is not supported on server versions of Windows, such as Windows Server 2019 or Windows Server 2022. + - Download [Dangerzone 0.8.1 for Windows](https://github.com/freedomofpress/dangerzone/releases/download/v0.8.1/Dangerzone-0.8.1.msi) > **Note**: you will also need to install [Docker Desktop](https://www.docker.com/products/docker-desktop/). @@ -18,10 +54,18 @@ You can also install Dangerzone for Mac using [Homebrew](https://brew.sh/): `bre > create the secure environment. ## Linux + +We support Ubuntu, Debian, and Fedora versions that are still within their respective servicing timelines, with a few twists: + +- Ubuntu: We follow upstream support with an extra cutoff date. No support for versions prior to the second oldest LTS release. +- Fedora: We follow upstream support +- Debian: current stable, oldstable and LTS releases. + On Linux, Dangerzone uses [Podman](https://podman.io/) instead of Docker Desktop for creating an isolated environment. It will be installed automatically when installing Dangerzone. Dangerzone is available for: + - Ubuntu 24.10 (oracular) - Ubuntu 24.04 (noble) - Ubuntu 22.04 (jammy) diff --git a/README.md b/README.md index 9ae10af..5ea76db 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,8 @@ Follow the instructions for each platform: * [Qubes OS (beta)](https://github.com/freedomofpress/dangerzone/blob/v0.8.0/INSTALL.md#qubes-os) * [Tails](https://github.com/freedomofpress/dangerzone/blob/v0.8.1/INSTALL.md#tails) +You can read more about our operating system support [here](https://github.com/freedomofpress/dangerzone/blob/v0.8.1/INSTALL.md#operating-system-support). + ## Some features - Sandboxes don't have network access, so if a malicious document can compromise one, it can't phone home From c0a4f388b36669d0fdbe3726b2f2cc47e7cdca28 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexis=20M=C3=A9taireau?= Date: Thu, 20 Mar 2025 15:46:30 +0100 Subject: [PATCH 2/3] FIXUP: Update the Operating System support overview and table --- INSTALL.md | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index f9a1d39..12cd699 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,28 +1,33 @@ -## Operating system support +## Operating System support -Dangerzone can run on a varieties of Operating systems, and have automated tests for a subset of them. -This section explains what is the support you should expect from us. +Dangerzone can run on various Operating Systems (OS), and has automated tests +for most of them. +This section explains which OS we support, how long we support each version, and +how do we test Dangerzone against these. -You can find general support information in this table, and more details in the following sections. +You can find general support information in this table, and more details in the +following sections. -(Unless specified, the architecture is AMD64) +(Unless specified, the architecture of the OS is AMD64) -| Distribution | Supported versions | Automated tests | Manual QA | -| ------------ | ------------------------- | ---------------------- | ----------------- | -| Windows | 3 last releases | Last release only | Last version only | -| macOS intel | 3 last releases | Last release only | Last release only | -| macOS ARM | 3 last releases | Last release only | Last release only | -| Ubuntu | Follow upstream support ✰ | 🗹 | 🗹 | -| Debian | Current stable, Oldstable and LTS releases | 🗹 | 🗹 | -| Fedora | Follow upstream support | 🗹 | 🗹 | -| Qubes OS | [Beta support](https://github.com/freedomofpress/dangerzone/issues/413) ✢ | 🗷 | Latest Fedora template | -| Tails | Only the latest version | 🗷 | Last release only | +| Distribution | Supported versions | Automated tests | Manual QA | +| ------------ | ------------------------- | ---------------------- | ----------------- | +| Windows | 2 last versions | 🗹 (`windows-latest`) ◎ | Last version only | +| macOS intel | 3 last versions | 🗹 (`macos-13`) ◎ | Last version only | +| macOS silicon | 3 last versions | 🗹 (`macos-latest`) ◎ | Last version only | +| Ubuntu | Follow upstream support ✰ | 🗹 | 🗹 | +| Debian | Current stable, Oldstable and LTS releases | 🗹 | 🗹 | +| Fedora | Follow upstream support | 🗹 | 🗹 | +| Qubes OS | [Beta support](https://github.com/freedomofpress/dangerzone/issues/413) ✢ | 🗷 | Latest Fedora template | +| Tails | Only the latest version | 🗷 | Last release only | Notes: ✰ Support for Ubuntu Focal [was dropped](https://github.com/freedomofpress/dangerzone/issues/1018) -✢ Qubes OS support is done via the use of other OSes (e.g. Fedora or Debian) for the VMs, so the versions we support are tied to them. +✢ Qubes OS support assumes the use of a Fedora template. The supported versions follow our general support for Fedora. + +◎ More information about where that points [in the runner-images repository](https://github.com/actions/runner-images/tree/main) ## MacOS From 87ec9b73c1f198e278276b60edff11712ecf9d91 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexis=20M=C3=A9taireau?= Date: Thu, 20 Mar 2025 15:56:58 +0100 Subject: [PATCH 3/3] FIXUP: Put OS support info under a tooltip --- INSTALL.md | 34 ++++++++++++++++++---------------- 1 file changed, 18 insertions(+), 16 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 12cd699..345a5de 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -31,13 +31,11 @@ Notes: ## MacOS -We support the versions of macOS that are still within Apple's servicing timeline. Apple usually provides security updates for the latest 3 releases, but this isn’t consistently applied and security fixes aren’t guaranteed for the non-latest releases. - -We have automated tests for the latest version of macOS only. - - Download [Dangerzone 0.8.1 for Mac (Apple Silicon CPU)](https://github.com/freedomofpress/dangerzone/releases/download/v0.8.1/Dangerzone-0.8.1-arm64.dmg) - Download [Dangerzone 0.8.1 for Mac (Intel CPU)](https://github.com/freedomofpress/dangerzone/releases/download/v0.8.1/Dangerzone-0.8.1-i686.dmg) +> [!TIP] We support the versions of macOS that are still within Apple's servicing timeline. Apple usually provides security updates for the latest 3 releases, but this isn’t consistently applied and security fixes aren’t guaranteed for the non-latest releases. We are also dependent on [Docker Desktop windows support](https://docs.docker.com/desktop/setup/install/mac-install/) + You can also install Dangerzone for Mac using [Homebrew](https://brew.sh/): `brew install --cask dangerzone` > **Note**: you will also need to install [Docker Desktop](https://www.docker.com/products/docker-desktop/). @@ -46,29 +44,33 @@ You can also install Dangerzone for Mac using [Homebrew](https://brew.sh/): `bre ## Windows -We generally support the versions of Windows that are still within [Microsoft’s servicing timeline](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). - -For Windows, Docker sets the bottom line: - -> Docker only supports Docker Desktop on Windows for those versions of Windows that are still within [Microsoft’s servicing timeline](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). Docker Desktop is not supported on server versions of Windows, such as Windows Server 2019 or Windows Server 2022. - - Download [Dangerzone 0.8.1 for Windows](https://github.com/freedomofpress/dangerzone/releases/download/v0.8.1/Dangerzone-0.8.1.msi) > **Note**: you will also need to install [Docker Desktop](https://www.docker.com/products/docker-desktop/). > This program needs to run alongside Dangerzone at all times, since it is what allows Dangerzone to > create the secure environment. +> [!TIP] We generally support the versions of Windows that are still within [Microsoft’s servicing timeline](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). +> +> Docker sets the bottom line: +> +> > Docker only supports Docker Desktop on Windows for those versions of Windows that are still within [Microsoft’s servicing timeline](https://support.microsoft.com/en-us/help/13853/windows-lifecycle-fact-sheet). Docker Desktop is not supported on server versions of Windows, such as Windows Server 2019 or Windows Server 2022. + + ## Linux -We support Ubuntu, Debian, and Fedora versions that are still within their respective servicing timelines, with a few twists: - -- Ubuntu: We follow upstream support with an extra cutoff date. No support for versions prior to the second oldest LTS release. -- Fedora: We follow upstream support -- Debian: current stable, oldstable and LTS releases. - On Linux, Dangerzone uses [Podman](https://podman.io/) instead of Docker Desktop for creating an isolated environment. It will be installed automatically when installing Dangerzone. +> [!TIP] We support Ubuntu, Debian, and Fedora versions that are still within +> their respective servicing timelines, with a few twists: + +> - Ubuntu: We follow upstream support with an extra cutoff date. No support for +> versions prior to the second oldest LTS release. +> - Fedora: We follow upstream support +> - Debian: current stable, oldstable and LTS releases. + + Dangerzone is available for: - Ubuntu 24.10 (oracular)