From f5b5751546c64427143ee85ca55cab614fe4a29b Mon Sep 17 00:00:00 2001 From: deeplow Date: Wed, 9 Aug 2023 08:53:10 +0100 Subject: [PATCH] Adds minimal install advice on README.md Makes it clear that one needs to install Docker for Desktop to use Dangerzone on Mac or Windows and Podman on linux. The app itself will warn the user about this, but we should state the prerequisites more clearly upfront. Mentions mac and windows in INSTALL.md so that anyone reading this page does not wrongly assume that Dangerzone is a Linux-only app. Fixes #475 --- INSTALL.md | 11 ++++++++++- README.md | 19 +++++++++++++++++-- 2 files changed, 27 insertions(+), 3 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 454e82c..8e19b8e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -1,5 +1,14 @@ -Dangerzone is available for: +## MacOS +See instructions on [README.md](README.md). +## Windows +See instructions on [README.md](README.md). + +## 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. + +Dangerzone is available for: - Ubuntu 23.04 (lunar) - Ubuntu 22.04 (jammy) - Ubuntu 20.04 (focal) diff --git a/README.md b/README.md index fb8cfc0..c310291 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,28 @@ _Read more about Dangerzone in the [official site](https://dangerzone.rocks/abou ## Getting started +### MacOS - Download [Dangerzone 0.4.2 for Mac (Apple Silicon CPU)](https://github.com/freedomofpress/dangerzone/releases/download/v0.4.2/Dangerzone-0.4.2-arm64.dmg) - Download [Dangerzone 0.4.2 for Mac (Intel CPU)](https://github.com/freedomofpress/dangerzone/releases/download/v0.4.2/Dangerzone-0.4.2-i686.dmg) -- Download [Dangerzone 0.4.2 for Windows](https://github.com/freedomofpress/dangerzone/releases/download/v0.4.2/Dangerzone-0.4.2.msi) -- See [installing Dangerzone](INSTALL.md) for Linux repositories You can also install Dangerzone for Mac using [Homebrew](https://brew.sh/): `brew install --cask dangerzone` +> **Note**: you willl 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. + +### Windows + +- Download [Dangerzone 0.4.2 for Windows](https://github.com/freedomofpress/dangerzone/releases/download/v0.4.2/Dangerzone-0.4.2.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. + +### Linux + +See [installing Dangerzone](INSTALL.md) for adding the Linux repositories to your system. + ## Some features - Sandboxes don't have network access, so if a malicious document can compromise one, it can't phone home