From 3ed71e8ee00eda9eb8b3c934924fa192daa1600e 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] Document Operating System support The goal is to have rules rather than specific versions, and a table to summarize everything. --- CHANGELOG.md | 1 + INSTALL.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 ++ 3 files changed, 57 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5ab8ce1..d02a446 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,7 @@ since 0.4.1, and this project adheres to [Semantic Versioning](https://semver.or - Platform support: Drop support for Ubuntu Focal, since it's nearing end-of-life ([#1018](https://github.com/freedomofpress/dangerzone/issues/1018)) - Platform support: Add support for Fedora 42 ([#1091](https://github.com/freedomofpress/dangerzone/issues/1091)) - Platform support: Add support for Ubuntu 25.04 (Plucky Puffin)([#1090](https://github.com/freedomofpress/dangerzone/issues/1090)) +- Document Operating System support [#986](https://github.com/freedomofpress/dangerzone/issues/986) ## [0.8.1](https://github.com/freedomofpress/dangerzone/compare/v0.8.1...0.8.0) diff --git a/INSTALL.md b/INSTALL.md index ca87b4e..469081d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,8 +1,42 @@ +## Operating System support + +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. + +(Unless specified, the architecture of the OS is AMD64) + +| Distribution | Supported releases | Automated tests | Manual QA | +| ------------ | ------------------------- | ---------------------- | --------- | +| Windows | 2 last releases | 🗹 (`windows-latest`) ◎ | 🗹 | +| macOS intel | 3 last releases | 🗹 (`macos-13`) ◎ | 🗹 | +| macOS silicon | 3 last releases | 🗹 (`macos-latest`) ◎ | 🗹 | +| 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 last release | 🗷 | Last release only | + +Notes: + +✰ Support for Ubuntu Focal [was dropped](https://github.com/freedomofpress/dangerzone/issues/1018) + +✢ Qubes OS support assumes the use of a Fedora template. The supported releases 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 - 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 releases 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/). @@ -17,11 +51,30 @@ You can also install Dangerzone for Mac using [Homebrew](https://brew.sh/): `bre > 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 Windows releases 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 + 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 releases 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 25.04 (plucky) - Ubuntu 24.10 (oracular) - Ubuntu 24.04 (noble) @@ -29,6 +82,7 @@ Dangerzone is available for: - Debian 13 (trixie) - Debian 12 (bookworm) - Debian 11 (bullseye) +- Fedora 42 - Fedora 41 - Fedora 40 - Tails 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