almet/dangerzone
1
0
Fork 0
mirror of https://github.com/freedomofpress/dangerzone.git synced 2025-04-28 18:02:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Update readme

Browse source
This commit is contained in:
Micah Lee 2020-02-28 18:06:55 -08:00
parent b99748620b
commit aa74aab4a2
No known key found for this signature in database
GPG key ID: 403C2657CD994F73
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -6,9 +6,13 @@ Take potentially dangerous PDFs, office documents, or images and convert them to
Dangerzone works like this: You give it a document that you don't know if you can trust (for example, an email attachment). Inside of a sandbox, dangerzone converts the document to a PDF (if it isn't already one), and then converts the PDF into raw pixel data: a huge list of of RGB color values for each page. Then, in a separate sandbox, dangerzone takes this pixel data and converts it back into a PDF.
**See [Installing Dangerzone](https://github.com/firstlookmedia/dangerzone/wiki/Installing-Dangerzone) to get started.**
## Getting started
Some features:
- Download [dangerzone 0.1 for Mac](https://github.com/firstlookmedia/dangerzone/releases/download/v0.1/Dangerzone.0.1.dmg)
- Download [dangerzone 0.1 for Windows](https://github.com/firstlookmedia/dangerzone/releases/download/v0.1/Dangerzone.0.1.msi)
- See [installing dangerzone](https://github.com/firstlookmedia/dangerzone/wiki/Installing-Dangerzone) on the wiki for Linux repositories
## Some features
- Sandboxes don't have network access, so if a malicious document can compromise one, it can't phone home
- Dangerzone can optionally OCR the safe PDFs it creates, so it will have a text layer again
@ -30,6 +34,6 @@ Dangerzone can convert these types of document into safe PDFs:
- PNG (`.png`)
- TIFF (`.tif`, `.tiff`)
Dangerzone was inspired by [Qubes trusted PDF](https://blog.invisiblethings.org/2013/02/21/converting-untrusted-pdfs-into-trusted.html), but it works in non-Qubes operating systems and sandboxes the document conversion in containers instead of virtual machines (using Docker for macOS, Windows, and Debian/Ubuntu, and [podman](https://podman.io/) for Fedora).
Dangerzone was inspired by [Qubes trusted PDF](https://blog.invisiblethings.org/2013/02/21/converting-untrusted-pdfs-into-trusted.html), but it works in non-Qubes operating systems. It uses containers as sandboxes instead of virtual machines (using Docker for macOS, Windows, and Debian/Ubuntu, and [podman](https://podman.io/) for Fedora).
Set up a development environment by following [these instructions](/BUILD.md).