Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 1.45 KB

README.md

File metadata and controls

21 lines (15 loc) · 1.45 KB
Raw

SecureDrop is an open-source whistleblower submission system that media organizations can use to securely accept documents from, and communicate with anonymous sources. It was originally created by the late Aaron Swartz and is currently managed by the Freedom of the Press Foundation.

This repository is used to build the public documentation for SecureDrop.

Quickstart

  1. This repository stores binaries such as screenshots via LFS. If not already present, install git-lfs by following the install guide. After installation, download the binaries with git-lfs fetch && git-lfs checkout.
  2. Create a virtual environment with python3 -m venv .venv or the tooling of your choice
  3. Activate your virtual environment (e.g., source .venv/bin/activate)
  4. Ensure you are using an up-to-date version of pip in the virtual environment (e.g., pip install --upgrade pip)
  5. Install the project requirements with pip install --require-hashes -r requirements/requirements.txt
  6. Run make docs to start a live build of the documentation at http://localhost:8000
  7. Edit RST files under the docs directory - your changes will be reflected in the live build

License

SecureDrop is open source and released under the GNU Affero General Public License v3.