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.
- 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 withgit-lfs fetch && git-lfs checkout
. - Create a virtual environment with
python3 -m venv .venv
or the tooling of your choice - Activate your virtual environment (e.g.,
source .venv/bin/activate
) - Ensure you are using an up-to-date version of
pip
in the virtual environment (e.g.,pip install --upgrade pip
) - Install the project requirements with
pip install --require-hashes -r requirements/requirements.txt
- Run
make docs
to start a live build of the documentation at http://localhost:8000 - Edit RST files under the docs directory - your changes will be reflected in the live build
SecureDrop is open source and released under the GNU Affero General Public License v3.