prokop/thgtoa
1
0
Fork 0
mirror of https://github.com/Anon-Planet/thgtoa.git synced 2026-08-07 11:35:06 +02:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: prokop/thgtoa:v1.2.6-pre1
Branches Tags
prokop/thgtoa:main prokop/thgtoa:gh-pages prokop/thgtoa:343-whonix-route-update
prokop/thgtoa:v1.2.6 prokop/thgtoa:v1.2.6-pre1 prokop/thgtoa:v1.2.5 prokop/thgtoa:v1.2.4 prokop/thgtoa:release-20260531-a2724af prokop/thgtoa:v1.2.3 prokop/thgtoa:v1.2.1 prokop/thgtoa:v1.2.0 prokop/thgtoa:v1.1.6 prokop/thgtoa:v1.1.7 prokop/thgtoa:v1.1.8 prokop/thgtoa:v1.1.9
..
compare: prokop/thgtoa:v1.2.1
Branches Tags
prokop/thgtoa:gh-pages prokop/thgtoa:main prokop/thgtoa:343-whonix-route-update
prokop/thgtoa:v1.2.6 prokop/thgtoa:v1.2.6-pre1 prokop/thgtoa:v1.2.5 prokop/thgtoa:v1.2.4 prokop/thgtoa:release-20260531-a2724af prokop/thgtoa:v1.2.3 prokop/thgtoa:v1.2.1 prokop/thgtoa:v1.2.0 prokop/thgtoa:v1.1.6 prokop/thgtoa:v1.1.7 prokop/thgtoa:v1.1.8 prokop/thgtoa:v1.1.9
1 Commits
v1.2.6-pre1 .. v1.2.1
Author SHA1 Message Date
nopeitsnothing f667d020d5 Fix PDF build in CI 
Added workflow for building PDF. Progress.

Signed-off-by: nopeitsnothing <no@anonymousplanet.org>
 2026-04-12 04:51:12 -04:00
82 changed files with 2194 additions and 143349 deletions
Expand all files Collapse all files
.cz.toml
-9
View File
@@ -1,9 +0,0 @@
[tool.commitizen]
name = "cz_conventional_commits"
# enforce sign-off below as well
extra_arguments = ["-S", "--signoff"]
# harmless redundancy
[tool.commitizen.customize]
schema_pattern = '^(feat|add|fix|bugfix|revert|security|perf|refactor|change|chore|ci|docs|style|test|build)(\(.+\))?(!)?: .{1,72}(\n.*)*\nSigned-off-by: .+ <.+@.+>'
.github/workflows/01-build.yml
-85
View File
@@ -1,85 +0,0 @@
# 1. Push to main → 01-build.yml runs automatically → note the run ID
# 2. Manually trigger 02-sign.yml with that build run ID → note the sign run ID
# 3. Manually trigger 03-release.yml with: version=v1.2.5, sign_run_id=<id>
# 4. Manually trigger 04-changelog.yml with: version=v1.2.5
name: 📖 Build PDFs
on:
workflow_dispatch:
inputs:
build_mode:
description: 'PDF build mode'
required: true
default: 'both'
type: choice
options:
- light
- dark
- both
push:
branches:
- main
paths:
- "docs/**"
- "mkdocs.yml"
- "scripts/**"
- ".github/workflows/01-build.yml"
permissions:
contents: read
jobs:
build:
name: Build PDFs
runs-on: ubuntu-latest
outputs:
build_mode: ${{ steps.mode.outputs.build_mode }}
run_id: ${{ github.run_id }}
steps:
- name: 🛠️ Checkout
uses: actions/checkout@v7
- name: 🐍 Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: 📦 Install Python dependencies
run: pip install "mkdocs-material[imaging]" pillow numpy
- name: 🖼️ Install poppler and qpdf
run: |
sudo apt-get update -qq
sudo apt-get install -y poppler-utils qpdf
- name: Setup Chrome
uses: browser-actions/setup-chrome@v2
with:
chrome-version: 120
install-dependencies: true
install-chromedriver: true
- name: 🖨️ Resolve build mode
id: mode
run: |
MODE="${{ inputs.build_mode || 'both' }}"
echo "build_mode=$MODE" >> $GITHUB_OUTPUT
echo "Building in mode: $MODE"
- name: 🖨️ Build PDFs
env:
CI: true
run: python scripts/build_guide_pdf.py --${{ steps.mode.outputs.build_mode }}
- name: 📤 Upload PDF artifacts
uses: actions/upload-artifact@v4
with:
name: pdfs
path: |
export/thgtoa.pdf
export/thgtoa-dark.pdf
if-no-files-found: warn
retention-days: 90
compression-level: 0
.github/workflows/02-sign.yml
-266
View File
@@ -1,266 +0,0 @@
name: 🔏 Sign PDFs
# Can be triggered:
# 1. Automatically after build.yml completes on main
# 2. Manually, pointing at a specific build run to pull PDFs from
on:
workflow_dispatch:
inputs:
build_run_id:
description: 'build.yml run ID to download PDFs from'
required: true
type: string
# Download artifacts from other runs + commit export/ files back to the repo
permissions:
actions: read
contents: write
pull-requests: write
jobs:
sign:
name: Hash & Sign PDFs
runs-on: ubuntu-latest
outputs:
light_sha256: ${{ steps.hashes.outputs.light_sha256 }}
dark_sha256: ${{ steps.hashes.outputs.dark_sha256 }}
light_b2: ${{ steps.hashes.outputs.light_b2 }}
dark_b2: ${{ steps.hashes.outputs.dark_b2 }}
steps:
- name: 🛠️ Checkout (for pgp/ key reference only)
uses: actions/checkout@v7
with:
sparse-checkout: pgp
sparse-checkout-cone-mode: true
- name: 📥 Download PDF artifacts
uses: actions/download-artifact@v4
with:
name: pdfs
path: export/
run-id: ${{ inputs.build_run_id }}
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: 📋 List downloaded files
run: ls -lh export/
- name: "#️⃣ Hash PDFs"
id: hashes
run: |
cd export
for f in thgtoa.pdf thgtoa-dark.pdf; do
[ -f "$f" ] || continue
sha256sum "$f" | awk '{print $1}' > "${f}.sha256"
b2sum "$f" | awk '{print $1}' > "${f}.b2sum"
done
# Combined summary files
sha256sum thgtoa.pdf thgtoa-dark.pdf 2>/dev/null > sha256sums.txt || \
sha256sum thgtoa.pdf 2>/dev/null > sha256sums.txt
b2sum thgtoa.pdf thgtoa-dark.pdf 2>/dev/null > b2sums.txt || \
b2sum thgtoa.pdf 2>/dev/null > b2sums.txt
light_sha256=$(cat thgtoa.pdf.sha256 2>/dev/null || echo "")
dark_sha256=$(cat thgtoa-dark.pdf.sha256 2>/dev/null || echo "")
light_b2=$(cat thgtoa.pdf.b2sum 2>/dev/null || echo "")
dark_b2=$(cat thgtoa-dark.pdf.b2sum 2>/dev/null || echo "")
echo "light_sha256=$light_sha256" >> $GITHUB_OUTPUT
echo "dark_sha256=$dark_sha256" >> $GITHUB_OUTPUT
echo "light_b2=$light_b2" >> $GITHUB_OUTPUT
echo "dark_b2=$dark_b2" >> $GITHUB_OUTPUT
echo "--- SHA-256 ---"
cat sha256sums.txt
echo "--- BLAKE2b ---"
cat b2sums.txt
# GPG sign — detached ASCII-armor signatures use .asc extension
- name: 🔑 Install GPG
run: |
sudo apt-get update -qq
sudo apt-get install -y gnupg
- name: 🔏 Import GPG signing key
env:
GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
run: |
echo "$GPG_PRIVATE_KEY" | gpg --batch --import
echo "$GPG_PASSPHRASE" | gpg --batch --yes --passphrase-fd 0 \
--pinentry-mode loopback --list-secret-keys
- name: 🔏 Sign PDFs and hash files
env:
GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }}
run: |
sign() {
local file="$1"
[ -f "$file" ] || return 0
echo "$GPG_PASSPHRASE" | gpg --batch --yes --passphrase-fd 0 \
--pinentry-mode loopback \
--detach-sign --armor --output "${file}.asc" "$file"
echo "Signed: $file → ${file}.asc"
}
sign export/thgtoa.pdf
sign export/thgtoa-dark.pdf
sign export/sha256sums.txt
sign export/b2sums.txt
# Commit export/ back to main
- name: 📦 Checkout full repo for commit
uses: actions/checkout@v7
with:
ref: main
fetch-depth: 0
path: repo
- name: 📂 Copy export files into repo
run: |
mkdir -p repo/export
cp -v export/* repo/export/
- name: 🔏 Configure GPG commit signing
env:
GPG_PRIVATE_KEY: ${{ secrets.GPG_PRIVATE_KEY }}
run: |
mkdir -p ~/.gnupg
echo "$GPG_PRIVATE_KEY" | gpg --batch --quiet --import > /dev/null 2>&1 || true
FINGERPRINT=$(gpg --batch --list-secret-keys --with-colons 2>/dev/null \
| awk -F: '/^fpr/ { print $10; exit }')
git config --global commit.gpgSign true
git config --global gpg.program gpg
git config --global gpg.exectimeout 180
git config --global user.signingkey "$FINGERPRINT"
git config --global user.name "github-actions[bot]"
git config --global user.email "github-actions[bot]@users.noreply.github.com"
# If no change in git diff, do nothing
- name: 📤 Commit and push export/ to main
working-directory: repo
run: |
git add export/
if git diff --cached --quiet; then
echo "Nothing to commit — export/ is already up to date."
else
export GNUPGHOME=~/.gnupg
gpg --list-secret-keys --with-colons > /dev/null 2>&1 || true
git commit -S -m "chore(export): update PDFs, hashes and signatures [skip ci]"
git config --global credential.helper 'cache --timeout=600'
git push origin main
fi
# Upload artifacts for 03-release.yml and verify job to consume
- name: 📤 Upload signatures artifact
uses: actions/upload-artifact@v4
with:
name: signatures
path: |
export/sha256sums.txt
export/b2sums.txt
export/thgtoa.pdf.sha256
export/thgtoa-dark.pdf.sha256
export/thgtoa.pdf.b2sum
export/thgtoa-dark.pdf.b2sum
export/thgtoa.pdf.asc
export/thgtoa-dark.pdf.asc
export/sha256sums.txt.asc
export/b2sums.txt.asc
if-no-files-found: error
retention-days: 90
compression-level: 0
- name: 📤 Upload signed PDFs artifact
uses: actions/upload-artifact@v4
with:
name: pdfs-signed
path: |
export/thgtoa.pdf
export/thgtoa-dark.pdf
if-no-files-found: warn
retention-days: 90
compression-level: 0
# Verify — runs after sign, surfaces results as a job summary
verify:
name: Verify hashes & signatures
runs-on: ubuntu-latest
needs: sign
# Always run so the summary is visible even if sign partially failed
if: always()
# Do a sparse checkout on given patterns. Each pattern should be separated with new lines
steps:
- name: 🛠️ Checkout scripts and public key
uses: actions/checkout@v7
with:
sparse-checkout: |
scripts/verify_pdf.py
pgp
- name: 📥 Download signatures artifact
uses: actions/download-artifact@v4
with:
name: signatures
path: export/
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: 📥 Download signed PDFs artifact
uses: actions/download-artifact@v4
with:
name: pdfs-signed
path: export/
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: 🔑 Install GPG and import public key
run: |
sudo apt-get update -qq
sudo apt-get install -y gnupg
gpg --import pgp/anonymousplanet.asc
- name: 🐍 Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: 🔍 Run verify_pdf.py
id: verify
run: |
# Capture output and exit code separately so we can write the
# summary regardless of whether verification passed or failed.
set +e
output=$(python scripts/verify_pdf.py --hashes --signatures --export-dir export 2>&1)
exit_code=$?
set -e
echo "exit_code=$exit_code" >> $GITHUB_OUTPUT
# ── Job summary ──────────────────────────────────────────────
{
if [ "$exit_code" -eq 0 ]; then
echo "## ✅ Verification passed"
else
echo "## ❌ Verification failed"
fi
echo ""
echo "**Run:** [\`${{ github.run_id }}\`](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) &nbsp;·&nbsp; **Commit:** [\`${GITHUB_SHA::7}\`](${{ github.server_url }}/${{ github.repository }}/commit/${{ github.sha }}) &nbsp;·&nbsp; **By:** \`${{ github.actor }}\`"
echo ""
echo "### Script output"
echo '```'
echo "$output"
echo '```'
echo ""
echo "### Hashes"
echo '```'
echo "── SHA-256 ──────────────────────────────────────────────────────"
cat export/sha256sums.txt 2>/dev/null || echo "(not found)"
echo ""
echo "── BLAKE2b ──────────────────────────────────────────────────────"
cat export/b2sums.txt 2>/dev/null || echo "(not found)"
echo '```'
} >> $GITHUB_STEP_SUMMARY
# Propagate failure so the job is marked red if verification fails
exit $exit_code
.github/workflows/03-release.yml
-192
View File
@@ -1,192 +0,0 @@
name: 🚀 Release
# Manual only — run this deliberately after build and sign are confirmed good.
# Provide the 02-sign.yml run ID to pull artifacts from. The release tag is
# automatically passed to the tag input. Exports "inputs.version" to $TAG.
on:
workflow_dispatch:
inputs:
sign_run_id:
description: '02-sign.yml run ID to pull signatures and PDFs from'
required: true
type: string
prerelease:
description: 'Mark as pre-release?'
required: false
default: false
type: boolean
version:
description: 'Version string to record (e.g. v1.2.4) — required'
required: true
type: string
permissions:
contents: write # create releases and tags
actions: read # download artifacts from other runs
jobs:
release:
name: Publish GitHub Release
runs-on: ubuntu-latest
steps:
- name: 🛠️ Checkout (for pgp/)
uses: actions/checkout@v7
with:
fetch-depth: 0
sparse-checkout: pgp
sparse-checkout-cone-mode: true
# Download artifacts from the specified sign run
- name: 📥 Download signatures artifact
uses: actions/download-artifact@v4
with:
name: signatures
path: release/
run-id: ${{ inputs.sign_run_id }}
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: 📥 Download signed PDFs artifact
uses: actions/download-artifact@v4
with:
name: pdfs-signed
path: release/
run-id: ${{ inputs.sign_run_id }}
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: 📋 List release assets
run: ls -lh release/
# Read hashes for the release body
- name: "#️⃣ Read hashes"
id: hashes
run: |
read_hash() { cat "release/$1" 2>/dev/null || echo "(not built)"; }
echo "light_sha256=$(read_hash thgtoa.pdf.sha256)" >> $GITHUB_OUTPUT
echo "dark_sha256=$(read_hash thgtoa-dark.pdf.sha256)" >> $GITHUB_OUTPUT
echo "light_b2=$(read_hash thgtoa.pdf.b2sum)" >> $GITHUB_OUTPUT
echo "dark_b2=$(read_hash thgtoa-dark.pdf.b2sum)" >> $GITHUB_OUTPUT
# VirusTotal
- name: 🦠 Upload PDFs to VirusTotal
id: vt
uses: crazy-max/ghaction-virustotal@v5
with:
vt_api_key: ${{ secrets.VT_API_KEY }}
files: |
release/thgtoa.pdf
release/thgtoa-dark.pdf
- name: 🔗 Build VT report URLs
id: vt_urls
run: |
light_hash=$(cat release/thgtoa.pdf.sha256 2>/dev/null || echo "")
dark_hash=$(cat release/thgtoa-dark.pdf.sha256 2>/dev/null || echo "")
if [ -n "$light_hash" ]; then
echo "light_vt=https://www.virustotal.com/gui/file/${light_hash}" >> $GITHUB_OUTPUT
else
echo "light_vt=(not built)" >> $GITHUB_OUTPUT
fi
if [ -n "$dark_hash" ]; then
echo "dark_vt=https://www.virustotal.com/gui/file/${dark_hash}" >> $GITHUB_OUTPUT
else
echo "dark_vt=(not built)" >> $GITHUB_OUTPUT
fi
# Generate release tag — timestamp + short SHA, always unique
- name: 🏷️ Generate release tag
id: tag
run: |
SHORT_SHA=$(echo "${{ github.sha }}" | cut -c1-7)
DATE=$(date -u +'%Y%m%d')
TAG="${{ inputs.version }}"
NAME="Release ${DATE} (${SHORT_SHA})"
echo "tag=$TAG" >> $GITHUB_OUTPUT
echo "name=$NAME" >> $GITHUB_OUTPUT
echo "Tag: $TAG"
# Create GitHub Release
- name: 🚀 Create GitHub Release
uses: softprops/action-gh-release@v2
with:
tag_name: ${{ steps.tag.outputs.tag }}
name: ${{ steps.tag.outputs.name }}
prerelease: ${{ inputs.prerelease || false }}
draft: true
fail_on_unmatched_files: false
body: |
## 📖 The Hitchhiker's Guide to Online Anonymity
Built from [`${{ inputs.version }}`](${{ github.server_url }}/${{ github.repository }}/releases/tag/${{ inputs.version }}).
---
### 📄 Release assets
| File | Description |
|------|-------------|
| `thgtoa.pdf` | Light mode PDF |
| `thgtoa-dark.pdf` | Dark mode PDF (hacker theme) |
| `sha256sums.txt` | SHA-256 checksums (both files) |
| `b2sums.txt` | BLAKE2b checksums (both files) |
| `thgtoa.pdf.sha256` | SHA-256 — light PDF |
| `thgtoa-dark.pdf.sha256` | SHA-256 — dark PDF |
| `thgtoa.pdf.b2sum` | BLAKE2b — light PDF |
| `thgtoa-dark.pdf.b2sum` | BLAKE2b — dark PDF |
| `*.asc` | GPG detached signatures (ASCII armor) |
---
### #️⃣ Hashes
**thgtoa.pdf** (light)
```text
SHA-256 ${{ steps.hashes.outputs.light_sha256 }}
BLAKE2b ${{ steps.hashes.outputs.light_b2 }}
```
**thgtoa-dark.pdf** (dark)
```text
SHA-256 ${{ steps.hashes.outputs.dark_sha256 }}
BLAKE2b ${{ steps.hashes.outputs.dark_b2 }}
```
---
### 🔏 Verifying GPG signatures
```sh
# Import the release signing key
gpg --import pgp/anonymousplanet-release.asc
# Verify PDFs
gpg --verify thgtoa.pdf.asc thgtoa.pdf
gpg --verify thgtoa-dark.pdf.asc thgtoa-dark.pdf
# Verify hash files
gpg --verify sha256sums.txt.asc sha256sums.txt
gpg --verify b2sums.txt.asc b2sums.txt
```
---
### 🦠 VirusTotal scans
| File | Report |
|------|--------|
| `thgtoa.pdf` | ${{ steps.vt_urls.outputs.light_vt }} |
| `thgtoa-dark.pdf` | ${{ steps.vt_urls.outputs.dark_vt }} |
files: |
release/thgtoa.pdf
release/thgtoa-dark.pdf
release/sha256sums.txt
release/b2sums.txt
release/thgtoa.pdf.sha256
release/thgtoa-dark.pdf.sha256
release/thgtoa.pdf.b2sum
release/thgtoa-dark.pdf.b2sum
release/thgtoa.pdf.asc
release/thgtoa-dark.pdf.asc
release/sha256sums.txt.asc
release/b2sums.txt.asc
.github/workflows/04-changelog.yml
-58
View File
@@ -1,58 +0,0 @@
name: 📝 Update Changelog
# Manual only — run after a release is published. Provide the exact version
# string (e.g. v1.2.4) to prepend to the changelog. Version is required to
# prevent silent auto-increment drift from release tags.
on:
workflow_dispatch:
inputs:
version:
description: 'Version string to record (e.g. v1.2.4) — required'
required: true
type: string
dry_run:
description: 'Dry run — print entry without committing'
required: false
default: false
type: boolean
permissions:
contents: write # commit changelog back to main
jobs:
changelog:
name: Prepend changelog entry
runs-on: ubuntu-latest
steps:
- name: 🛠️ Checkout
uses: actions/checkout@v7
with:
# Use a PAT so the commit triggers downstream workflows (GITHUB_TOKEN won't)
token: ${{ secrets.CHANGELOG_PAT || secrets.GITHUB_TOKEN }}
fetch-depth: 0
- name: 🐍 Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.13"
- name: 📝 Generate and prepend changelog entry
env:
DRY_RUN: ${{ inputs.dry_run || 'false' }}
MANUAL_VERSION: ${{ inputs.version }}
GH_SHA: ${{ github.sha }}
GH_REF: ${{ github.ref_name }}
TRIGGERING_SHA: ${{ github.event.workflow_run.head_sha || github.sha }}
run: python scripts/update_changelog.py
- name: 📤 Commit changelog
if: ${{ inputs.dry_run != 'true' }}
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add docs/changelog/index.md
# Only commit if there's actually a change
git diff --cached --quiet && echo "No changelog change to commit." || \
git commit -m "docs: update changelog [skip ci]"
git push
.github/workflows/build-pdf.yml
+55
View File
@@ -0,0 +1,55 @@
name: 📖 Build PDF
on:
workflow_dispatch:
pull_request:
paths:
- "docs/**"
- "mkdocs.yml"
- "scripts/build_guide_pdf.py"
- ".github/workflows/build-pdf.yml"
push:
branches:
- main
paths:
- "docs/**"
- "mkdocs.yml"
- "scripts/build_guide_pdf.py"
- ".github/workflows/build-pdf.yml"
permissions:
contents: read
jobs:
pdf:
name: MkDocs + print to PDF
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.12"
- name: Install MkDocs Material
run: pip install mkdocs-material
- name: Install Chromium
run: |
sudo apt-get update
sudo apt-get install -y --no-install-recommends chromium
- name: Build PDF
env:
CI: true
run: python scripts/build_guide_pdf.py
- name: Upload PDF artifact
uses: actions/upload-artifact@v7
with:
name: guide-pdf
path: export/guide.pdf
if-no-files-found: error
retention-days: 90
.github/workflows/publish.yml
+2 -1
View File
@@ -14,6 +14,7 @@ jobs:
- name: Deploy docs
uses: mhausenblas/mkdocs-deploy-gh-pages@master
# Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
CUSTOM_DOMAIN: anonymousplanet.net
CUSTOM_DOMAIN: anonymousplanet.org
.gitignore
+22 -29
View File
@@ -1,29 +1,22 @@
# Visual Studio (Windows) solution metadata
.vs/
.vscode/
# Python (MkDocs, scripts/build_guide_pdf.py)
__pycache__/
*.py[cod]
*$py.class
.venv/
venv/
env/
ENV/
.env
# Cache
.cache/
# MkDocs build output and local PDF export
site/
_site/
_site_test/
build/
# Export directory — track only hashes and signatures, not the PDFs themselves
export/thgtoa.pdf.sha256
export/thgtoa-dark.pdf.sha256
export/thgtoa.pdf.b2sum
export/thgtoa-dark.pdf.b2sum
export/*.asc
# Visual Studio (Windows) solution metadata
.vs/
.vscode/
# Python (MkDocs, scripts/build_guide_pdf.py)
__pycache__/
*.py[cod]
*$py.class
.venv/
venv/
env/
ENV/
.env
# Cache
.cache/
# MkDocs build output and local PDF export
site/
_site/
_site_test/
export/
.markdownlint.yaml
+18 -1
View File
@@ -62,7 +62,24 @@ MD012:
# Consecutive blank lines
maximum: 1
# MD013/line-length - Line length
MD013: false
#
MD013:
# Number of characters
line_length: 80
# Number of characters for headings
heading_line_length: 80
# Number of characters for code blocks
code_block_line_length: 160
# Include code blocks
code_blocks: false
# Include tables
tables: false
# Include headings
headings: true
# Strict length checking (e.g. allow for longer URLs)
strict: false
# Stern length checking
stern: false
# MD014/commands-show-output - Dollar signs used before commands without showing output
# TODO: set false for now but we should consider enabling it
.pre-commit-config.yaml
+5 -12
View File
@@ -10,21 +10,14 @@ repos:
- id: check-added-large-files
- id: check-merge-conflict
- id: check-symlinks
- id: detect-private-key
- id: end-of-file-fixer
- id: trailing-whitespace
- id: mixed-line-ending
args: [--fix=lf]
- repo: https://github.com/commitizen-tools/commitizen
rev: v4.8.3
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.41.0
hooks:
- id: commitizen
stages: [commit-msg]
- repo: local
hooks:
- id: require-commit-body
name: Avoid bad commits
language: script
entry: scripts/hooks/require-commit-body.sh
stages: [commit-msg]
- id: markdownlint
- id: markdownlint-fix
CHANGELOG.md
+33
View File
@@ -0,0 +1,33 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
## [1.2.1] - 2026-04-11
### Added
- GitHub Actions workflow **Build guide PDF** (`.github/workflows/build-pdf.yml`): installs Chromium on `ubuntu-latest`, runs `scripts/build_guide_pdf.py`, uploads `export/guide.pdf` as the `guide-pdf` artifact. Runs on `workflow_dispatch`, on pushes to `main` that touch docs or build inputs, and on matching pull requests.
- `scripts/build_guide_pdf.py` to build the MkDocs site and render the guide to a single PDF (`export/guide.pdf` by default) using a Chromium-based browser (Chrome or Edge) headless print-to-PDF.
- `docs/stylesheets/extra.css` and `extra_css` in `mkdocs.yml` for shared site styling.
- This `CHANGELOG.md`.
### Changed
- `README.md` “Ways to read or export the guide”: hosted link, local `mkdocs serve`, PDF build via the script, ODT note, raw Markdown link.
- Guide landing layout: wrap the opening block in `docs/guide/index.md` with a `guide-intro-lead` container so the logo and first sections share one layout context for web and print.
- `.gitignore` to exclude local build outputs `export/`, `site/`, and `_site_test/`.
- `scripts/build_guide_pdf.py`: when the `CI` environment variable is set, pass Chromium flags (`--no-sandbox`, `--disable-setuid-sandbox`, `--disable-dev-shm-usage`) so headless print works on typical CI images.
- `README.md`: note the **Build guide PDF** GitHub Actions workflow and the `guide-pdf` artifact.
### Fixed
- `docs/guide/index.md`: replace broken reference-style internal links (`[label][label:]`) with working same-page fragment links to the correct headings; correct the mismatched “Real-Name System” cross-reference; fix a broken footnote marker on the “free (unallocated) space of your hard drive” list item.
[Unreleased]: https://github.com/Anon-Planet/thgtoa/compare/v1.2.1...HEAD
[1.2.1]: https://github.com/Anon-Planet/thgtoa/releases/tag/v1.2.1
CLA.md
-81
View File
@@ -1,81 +0,0 @@
# Contributor License Agreement
This project is licensed under the **Creative Commons Attribution-ShareAlike 4.0 International License (CC BY-SA 4.0)**.
By submitting a contribution to this repository, you agree to the terms described in this document.
---
## What Is a CLA?
A Contributor License Agreement (CLA) clarifies the terms under which you contribute to this project. It does not transfer ownership of your work—you keep all rights to what you create. It establishes that your contribution can be distributed under this project's license, and that you understand and accept the obligations that come with it.
---
## Our License: CC BY-SA 4.0
This repository uses the [Creative Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/).
> **Note on license history:** This project previously used CC BY-NC 4.0 (non-commercial). The switch to CC BY-SA 4.0 removes the non-commercial restriction and replaces it with a share-alike requirement. Contributions submitted before this change were made under the prior license; all new contributions fall under CC BY-SA 4.0.
In plain terms, CC BY-SA 4.0 means:
- **Attribution (BY):** Anyone who uses, adapts, or redistributes this work must give appropriate credit to the original authors, provide a link to the license, and indicate if changes were made.
- **ShareAlike (SA):** Anyone who distributes adapted versions of this work must do so under the same license—CC BY-SA 4.0—or a compatible one. Derivative works cannot be relicensed under more restrictive terms.
The full legal text is available at: <https://creativecommons.org/licenses/by-sa/4.0/legalcode>
---
## What Counts as a Contribution
A "contribution" is any material you intentionally submit to this repository for inclusion in the project. This includes but is not limited to:
- Written content (guides, documentation, articles, explanations)
- Edits, corrections, or translations of existing content
- Code, scripts, configuration files, or tooling
- Issues, bug reports, and feature requests that include original written content
- Pull requests and their descriptions
- Comments that substantively add to the project's content
Minor factual corrections, typo fixes, and purely mechanical formatting changes are contributed in good faith and treated as submitted under the same terms.
---
## Your Rights as a Contributor
Contributing to this project does **not** transfer copyright ownership of your work to the project maintainers or the Anonymous Planet collective. You retain full copyright over your original contributions.
By contributing, you grant the project a perpetual, worldwide, non-exclusive, royalty-free license to use, reproduce, adapt, and distribute your contribution under CC BY-SA 4.0—consistent with the license terms the entire project operates under.
---
## Your Obligations as a Contributor
When you submit a contribution, you confirm that:
1. **You have the right to submit it.** The contribution is your own original work, or you have the necessary rights to submit it under CC BY-SA 4.0. You are not submitting material that is proprietary, confidential, or owned by a third party without their permission.
2. **It is compatible with CC BY-SA 4.0.** If your contribution incorporates third-party material, that material must already be licensed under CC BY-SA 4.0 or a [compatible license](https://creativecommons.org/share-your-work/licensing-considerations/compatible-licenses/). Do not submit content under CC BY-NC 4.0 or any other license that conflicts with CC BY-SA 4.0.
3. **Attribution will carry forward.** You understand that your contribution—along with your credit as a contributor—may be included in redistributed or adapted versions of this project, and that downstream users will be required to attribute the project and preserve the CC BY-SA 4.0 license.
4. **Derivative works stay open.** You understand that anyone who builds on this project's content (including your contributions) must release their adaptations under CC BY-SA 4.0 or a compatible license. This is the core share-alike obligation.
---
## How Acceptance Works
This project does not use a formal CLA signature process. Acceptance is implicit:
> **By opening a pull request, submitting an issue with original content, or otherwise contributing material to this repository, you indicate that you have read this document and agree to its terms.**
If you are contributing on behalf of an organization or employer, you confirm that you are authorized to submit contributions under these terms on their behalf.
---
## Questions
If you are unsure whether your contribution is compatible with CC BY-SA 4.0, or have questions about these terms, open an issue before submitting. Maintainers will do their best to clarify.
For the full license text: <https://creativecommons.org/licenses/by-sa/4.0/legalcode>
CNAME
-1
View File
@@ -1 +0,0 @@
anonymousplanet.net
LICENSE
-427
View File
@@ -1,427 +0,0 @@
Attribution-ShareAlike 4.0 International
=======================================================================
Creative Commons Corporation ("Creative Commons") is not a law firm and
does not provide legal services or legal advice. Distribution of
Creative Commons public licenses does not create a lawyer-client or
other relationship. Creative Commons makes its licenses and related
information available on an "as-is" basis. Creative Commons gives no
warranties regarding its licenses, any material licensed under their
terms and conditions, or any related information. Creative Commons
disclaims all liability for damages resulting from their use to the
fullest extent possible.
Using Creative Commons Public Licenses
Creative Commons public licenses provide a standard set of terms and
conditions that creators and other rights holders may use to share
original works of authorship and other material subject to copyright
and certain other rights specified in the public license below. The
following considerations are for informational purposes only, are not
exhaustive, and do not form part of our licenses.
Considerations for licensors: Our public licenses are
intended for use by those authorized to give the public
permission to use material in ways otherwise restricted by
copyright and certain other rights. Our licenses are
irrevocable. Licensors should read and understand the terms
and conditions of the license they choose before applying it.
Licensors should also secure all rights necessary before
applying our licenses so that the public can reuse the
material as expected. Licensors should clearly mark any
material not subject to the license. This includes other CC-
licensed material, or material used under an exception or
limitation to copyright. More considerations for licensors:
wiki.creativecommons.org/Considerations_for_licensors
Considerations for the public: By using one of our public
licenses, a licensor grants the public permission to use the
licensed material under specified terms and conditions. If
the licensor's permission is not necessary for any reason--for
example, because of any applicable exception or limitation to
copyright--then that use is not regulated by the license. Our
licenses grant only permissions under copyright and certain
other rights that a licensor has authority to grant. Use of
the licensed material may still be restricted for other
reasons, including because others have copyright or other
rights in the material. A licensor may make special requests,
such as asking that all changes be marked or described.
Although not required by our licenses, you are encouraged to
respect those requests where reasonable. More considerations
for the public:
wiki.creativecommons.org/Considerations_for_licensees
=======================================================================
Creative Commons Attribution-ShareAlike 4.0 International Public
License
By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution-ShareAlike 4.0 International Public License ("Public
License"). To the extent this Public License may be interpreted as a
contract, You are granted the Licensed Rights in consideration of Your
acceptance of these terms and conditions, and the Licensor grants You
such rights in consideration of benefits the Licensor receives from
making the Licensed Material available under these terms and
conditions.
Section 1 -- Definitions.
a. Adapted Material means material subject to Copyright and Similar
Rights that is derived from or based upon the Licensed Material
and in which the Licensed Material is translated, altered,
arranged, transformed, or otherwise modified in a manner requiring
permission under the Copyright and Similar Rights held by the
Licensor. For purposes of this Public License, where the Licensed
Material is a musical work, performance, or sound recording,
Adapted Material is always produced where the Licensed Material is
synched in timed relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.
c. BY-SA Compatible License means a license listed at
creativecommons.org/compatiblelicenses, approved by Creative
Commons as essentially the equivalent of this Public License.
d. Copyright and Similar Rights means copyright and/or similar rights
closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or
categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
Rights.
e. Effective Technological Measures means those measures that, in the
absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright
Treaty adopted on December 20, 1996, and/or similar international
agreements.
f. Exceptions and Limitations means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.
g. License Elements means the license attributes listed in the name
of a Creative Commons Public License. The License Elements of this
Public License are Attribution and ShareAlike.
h. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
License.
i. Licensed Rights means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to
all Copyright and Similar Rights that apply to Your use of the
Licensed Material and that the Licensor has authority to license.
j. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.
k. Share means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the
public may access the material from a place and at a time
individually chosen by them.
l. Sui Generis Database Rights means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
as amended and/or succeeded, as well as other essentially
equivalent rights anywhere in the world.
m. You means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.
Section 2 -- Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License,
the Licensor hereby grants You a worldwide, royalty-free,
non-sublicensable, non-exclusive, irrevocable license to
exercise the Licensed Rights in the Licensed Material to:
a. reproduce and Share the Licensed Material, in whole or
in part; and
b. produce, reproduce, and Share Adapted Material.
2. Exceptions and Limitations. For the avoidance of doubt, where
Exceptions and Limitations apply to Your use, this Public
License does not apply, and You do not need to comply with
its terms and conditions.
3. Term. The term of this Public License is specified in Section
6(a).
4. Media and formats; technical modifications allowed. The
Licensor authorizes You to exercise the Licensed Rights in
all media and formats whether now known or hereafter created,
and to make technical modifications necessary to do so. The
Licensor waives and/or agrees not to assert any right or
authority to forbid You from making technical modifications
necessary to exercise the Licensed Rights, including
technical modifications necessary to circumvent Effective
Technological Measures. For purposes of this Public License,
simply making modifications authorized by this Section 2(a)
(4) never produces Adapted Material.
5. Downstream recipients.
a. Offer from the Licensor -- Licensed Material. Every
recipient of the Licensed Material automatically
receives an offer from the Licensor to exercise the
Licensed Rights under the terms and conditions of this
Public License.
b. Additional offer from the Licensor -- Adapted Material.
Every recipient of Adapted Material from You
automatically receives an offer from the Licensor to
exercise the Licensed Rights in the Adapted Material
under the conditions of the Adapter's License You apply.
c. No downstream restrictions. You may not offer or impose
any additional or different terms or conditions on, or
apply any Effective Technological Measures to, the
Licensed Material if doing so restricts exercise of the
Licensed Rights by any recipient of the Licensed
Material.
6. No endorsement. Nothing in this Public License constitutes or
may be construed as permission to assert or imply that You
are, or that Your use of the Licensed Material is, connected
with, or sponsored, endorsed, or granted official status by,
the Licensor or others designated to receive attribution as
provided in Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not
licensed under this Public License, nor are publicity,
privacy, and/or other similar personality rights; however, to
the extent possible, the Licensor waives and/or agrees not to
assert any such rights held by the Licensor to the limited
extent necessary to allow You to exercise the Licensed
Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this
Public License.
3. To the extent possible, the Licensor waives any right to
collect royalties from You for the exercise of the Licensed
Rights, whether directly or through a collecting society
under any voluntary or waivable statutory or compulsory
licensing scheme. In all other cases the Licensor expressly
reserves any right to collect such royalties.
Section 3 -- License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the
following conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified
form), You must:
a. retain the following if it is supplied by the Licensor
with the Licensed Material:
i. identification of the creator(s) of the Licensed
Material and any others designated to receive
attribution, in any reasonable manner requested by
the Licensor (including by pseudonym if
designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of
warranties;
v. a URI or hyperlink to the Licensed Material to the
extent reasonably practicable;
b. indicate if You modified the Licensed Material and
retain an indication of any previous modifications; and
c. indicate the Licensed Material is licensed under this
Public License, and include the text of, or the URI or
hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any
reasonable manner based on the medium, means, and context in
which You Share the Licensed Material. For example, it may be
reasonable to satisfy the conditions by providing a URI or
hyperlink to a resource that includes the required
information.
3. If requested by the Licensor, You must remove any of the
information required by Section 3(a)(1)(A) to the extent
reasonably practicable.
b. ShareAlike.
In addition to the conditions in Section 3(a), if You Share
Adapted Material You produce, the following conditions also apply.
1. The Adapter's License You apply must be a Creative Commons
license with the same License Elements, this version or
later, or a BY-SA Compatible License.
2. You must include the text of, or the URI or hyperlink to, the
Adapter's License You apply. You may satisfy this condition
in any reasonable manner based on the medium, means, and
context in which You Share Adapted Material.
3. You may not offer or impose any additional or different terms
or conditions on, or apply any Effective Technological
Measures to, Adapted Material that restrict exercise of the
rights granted under the Adapter's License You apply.
Section 4 -- Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that
apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
to extract, reuse, reproduce, and Share all or a substantial
portion of the contents of the database;
b. if You include all or a substantial portion of the database
contents in a database in which You have Sui Generis Database
Rights, then the database in which You have Sui Generis Database
Rights (but not its individual contents) is Adapted Material,
including for purposes of Section 3(b); and
c. You must comply with the conditions in Section 3(a) if You Share
all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
c. The disclaimer of warranties and limitation of liability provided
above shall be interpreted in a manner that, to the extent
possible, most closely approximates an absolute disclaimer and
waiver of all liability.
Section 6 -- Term and Termination.
a. This Public License applies for the term of the Copyright and
Similar Rights licensed here. However, if You fail to comply with
this Public License, then Your rights under this Public License
terminate automatically.
b. Where Your right to use the Licensed Material has terminated under
Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided
it is cured within 30 days of Your discovery of the
violation; or
2. upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any
right the Licensor may have to seek remedies for Your violations
of this Public License.
c. For the avoidance of doubt, the Licensor may also offer the
Licensed Material under separate terms or conditions or stop
distributing the Licensed Material at any time; however, doing so
will not terminate this Public License.
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
License.
Section 7 -- Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different
terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the
Licensed Material not stated herein are separate from and
independent of the terms and conditions of this Public License.
Section 8 -- Interpretation.
a. For the avoidance of doubt, this Public License does not, and
shall not be interpreted to, reduce, limit, restrict, or impose
conditions on any use of the Licensed Material that could lawfully
be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is
deemed unenforceable, it shall be automatically reformed to the
minimum extent necessary to make it enforceable. If the provision
cannot be reformed, it shall be severed from this Public License
without affecting the enforceability of the remaining terms and
conditions.
c. No term or condition of this Public License will be waived and no
failure to comply consented to unless expressly agreed to by the
Licensor.
d. Nothing in this Public License constitutes or may be interpreted
as a limitation upon, or waiver of, any privileges and immunities
that apply to the Licensor or You, including from the legal
processes of any jurisdiction or authority.
=======================================================================
Creative Commons is not a party to its public
licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
will be considered the “Licensor.” The text of the Creative Commons
public licenses is dedicated to the public domain under the CC0 Public
Domain Dedication. Except for the limited purpose of indicating that
material is shared under a Creative Commons public license or as
otherwise permitted by the Creative Commons policies published at
creativecommons.org/policies, Creative Commons does not authorize the
use of the trademark "Creative Commons" or any other trademark or logo
of Creative Commons without its prior written consent including,
without limitation, in connection with any unauthorized modifications
to any of its public licenses or any other arrangements,
understandings, or agreements concerning use of licensed material. For
the avoidance of doubt, this paragraph does not form part of the
public licenses.
Creative Commons may be contacted at creativecommons.org.
README.md
+29 -23
View File
@@ -1,32 +1,38 @@
<!-- markdownlint-disable MD041 -->
<div align="center">
<a href="https://anonymousplanet.net">
<img src="https://anonymousplanet.net/media/anon_planet.svg"></a>
<p><em>The comprehensive guide for online anonymity and OpSec.</em></p>
<a href="https://github.com/Anon-Planet/thgtoa/stargazers">
<img src="https://img.shields.io/github/stars/Anon-Planet?style=social"></a>
<a href="https://github.com/Anon-Planet/thgtoa/actions/workflows/03-release.yml">
<img src="https://img.shields.io/github/actions/workflow/status/Anon-Planet/thgtoa/03-release.yml?label=build"></a>
<a href="https://github.com/Anon-Planet/thgtoa/releases/latest">
<img src="https://img.shields.io/github/v/release/Anon-Planet/thgtoa?include_prereleases&sort=semver&display_name=tag&style=flat&logo=github&logoColor=green&labelColor=black&color=black"></a>
<a href="https://opencollective.com/thgtoa">
<img src="https://img.shields.io/opencollective/backers/thgtoa?style=flat&logo=open-collective&logoColor=white&label=Open%20Collective%20backers"></a>
<a href="https://github.com/Anon-Planet/thgtoa/issues">
<img src="https://img.shields.io/github/issues-closed/Anon-Planet/thgtoa?style=flat&logo=github&labelColor=rgba(0%2C%20255%2C%200%2C%200.05)&color=green"></a>
</p>
</div>
Welcome.
The purpose: providing an introduction to various online tracking techniques, online ID verification techniques, and detailed guidance to creating and maintaining (truly) anonymous online identities. <span style="color: red">**It is written with hope for activists, journalists, scientists, lawyers, whistle-blowers, and good people being oppressed, censored, and harassed anywhere!**</span> This guide has no affiliation with the [Anonymous](https://en.wikipedia.org/wiki/Anonymous_(hacker_group)) <sup>[[Wikiless]](https://wikiless.com/wiki/Anonymous_(hacker_group))</sup> <sup>[[Archive.org]](https://web.archive.org/web/https://en.wikipedia.org/wiki/Anonymous_(hacker_group))</sup> collective/movement.
**[IMPORTANT RECOMMENDATION FOR UKRAINIANS. ВАЖЛИВА РЕКОМЕНДАЦІЯ ДЛЯ УКРАЇНЦІВ](briar.html)**
The website and projects are free (as in freedom) and not affiliated with any donor or projects discussed, [licensed](LICENSE.html) under **Creative Commons Attribution-ShareAlike 4.0 International** ([cc-by-sa-4.0](https://creativecommons.org/licenses/by-sa/4.0/) <sup>[[Archive.org]](https://web.archive.org/web/https://creativecommons.org/licenses/by-sa/4.0/)</sup>), and is **not sponsored/endorsed by any commercial/governmental entity**. This means that you are free to use our guide for pretty much any purpose **including commercially** as long as you attribute it. There are no ads or any affiliate links.
This is a maintained guide with the aim of providing an introduction to various online tracking techniques, online ID verification techniques, and detailed guidance to creating and maintaining (truly) anonymous online identities. <span style="color: red">**It is written with hope for activists, journalists, scientists, lawyers, whistle-blowers, and good people being oppressed, censored, harassed anywhere!**</span> This guide has no affiliation with the [Anonymous](https://en.wikipedia.org/wiki/Anonymous_(hacker_group)) <sup>[[Wikiless]](https://wikiless.com/wiki/Anonymous_(hacker_group))</sup> <sup>[[Archive.org]](https://web.archive.org/web/https://en.wikipedia.org/wiki/Anonymous_(hacker_group))</sup> collective/movement.
This guide is an open-source non-profit initiative, [licensed](LICENSE.html) under **Creative Commons Attribution-NonCommercial 4.0 International** ([cc-by-nc-4.0](https://creativecommons.org/licenses/by-nc/4.0/) <sup>[[Archive.org]](https://web.archive.org/web/https://creativecommons.org/licenses/by-nc/4.0/)</sup>) and is **not sponsored/endorsed by any commercial/governmental entity**. This means that you are free to use our guide for pretty much any purpose **excluding commercially** as long as you do attribute it. There are no ads or any affiliate links.
**If you would like to make a donation to help this project, you can do so from [here](donations.html) where you will also find the project goals. All the donations will be strictly used within the context of this project. All donations and spendings are logged on the donations page.**
**Ways to read or export the guide**
- **In your browser:** [Hitchhiker's Guide](https://anonymousplanet.net/) (hosted site). After a local build you can also open `site/guide/index.html` directly.
- **In your browser:** [Hitchhiker's Guide](https://www.anonymousplanet.org/guide/) (hosted site). After a local build you can also open `site/guide/index.html` directly.
- **Local HTML preview:** from the repository root, with Python 3 and [MkDocs Material](https://squidfunk.github.io/mkdocs-material/getting-started/) installed (`pip install mkdocs-material`), run `mkdocs serve` and open the URL printed in the terminal (for example `http://127.0.0.1:8000`).
- **PDF (local build):** from the repository root, using the same environment, run:
```bash
python scripts/build_guide_pdf.py
```
This runs `mkdocs build` (output defaults to `./site`), then uses **Google Chrome** or **Microsoft Edge** in headless mode to print `site/guide/index.html` to **`export/guide.pdf`** (images and styling preserved). If the site is already built: `python scripts/build_guide_pdf.py --skip-mkdocs`. Other options: `--site-dir`, `--pdf`, and `python scripts/build_guide_pdf.py --help`.
On **GitHub Actions**, the [Build guide PDF](https://github.com/Anon-Planet/thgtoa/actions/workflows/build-pdf.yml) workflow does the same using Chromium on Ubuntu when you push to `main` or open a pull request that touches the guide or build inputs; download the **`guide-pdf`** artifact from a successful run. You can also run it manually (**Actions** → **Build guide PDF** → **Run workflow**).
- **OpenDocument (ODT):** not produced by this repository (previous hosted export removed).
- **Raw Markdown (very large):** [docs/guide/index.md on GitHub](https://raw.githubusercontent.com/Anon-Planet/thgtoa/refs/heads/main/docs/guide/index.md)
**Mirrors:**
- <del>Hidden service: <http://thgtoa3jzy3doku7hkna32htpghjijefscwvh4dyjgfydbbjkeiohgid.onion/></del> **Host down**
Feel free to submit issues using Github Issues with the repository link above. Criticism, opinions, and ideas are welcome!
**Follow or contact us on:**
Discussion Channels:
- Matrix room: <https://matrix.to/#/#anonymity:anonymousplanet.net>
- Matrix space: <https://matrix.to/#/#psa:anonymousplanet.net>
Have a good read and feel free to share and/or recommend it!
docs/CNAME
+1 -1
View File
@@ -1 +1 @@
anonymousplanet.net
anonymousplanet.org
docs/about/index.md
+114 -145
View File
@@ -1,145 +1,114 @@
---
title: "Anonymous Planet"
description: "We are the maintainers of the Hitchhiker's Guide and the PSA Matrix space."
hide:
- toc
schema:
"@context": https://schema.org
"@type": Organization
"@id": https://anonymousplanet.net/
name: Anonymous Planet
url: https://anonymousplanet.net/about/
logo: ../media/profile.png
sameAs:
- https://github.com/Anon-Planet
- https://opencollective.com/anonymousplanetorg
---
<div class="hero-block">
<div class="hero-eyebrow">Made by people with skin in the game.</div>
<h1 class="hero-title">Anonymous Planet<span class="hero-subtitle">Open source. No ads. No affiliates. No profit.</span></h1>
<p class="hero-tagline">
Written by people with backgrounds in signals intelligence, forensics, and Linux systems,
not influencers with affiliate links.
</p>
<div class="hero-cta-row">
<a href="../guide/" class="hero-cta hero-cta--primary">Read the Guide</a>
<a href="../contribute/" class="hero-cta hero-cta--secondary">Support the Project</a>
</div>
</div>
---
## Who We Are { #who }
Anonymous Planet are the maintainers of [_The Hitchhiker's Guide_](../guide/index.md) and the [_PSA Community_](https://psa.anonymousplanet.net). The project exists to provide open-source tools and resources for people who need them: activists, journalists, scientists, lawyers, whistleblowers, and anyone facing oppression, censorship, or harassment.
We have extensive backgrounds in signals intelligence, forensics, and various Linux distributions. We are not a privacy influencer operation with a bunch of recommendations and affiliate links. Everything here is compiled into a single, cohesive set of instructions and sub-guides — free as in freedom.
We are high-risk individuals. We do this because it matters.
!!! note "Disclaimer"
This guide is a work in progress and will probably never be "finished". Some information may be outdated. Always cross-reference independently and check for updated versions regularly. No single resource can provide 100% security, anonymity, or privacy.
!!! tip "Where to start"
Go to [the beginning of the guide](../guide/index.md) or use the search at the top right. The [Techlore Go Incognito playlist](https://www.youtube.com/playlist?list=PL3KeV6Ui_4CayDGHw64OFXEPHgXLkrtJO) is also a good 2–3 hour introduction before diving in.
---
## Maintainers { #maintainers }
<div class="maintainer-bio">
<img src="../media/nope-keyoxide-profile.png" alt="nope" class="maintainer-avatar">
<div class="maintainer-text" markdown="1">
Nope -- background in signals intelligence (SIGINT), software engineering, "hacking", privacy software engineering, operational security, drone piloting and repair. Years ago, I realized there really wasn't a definitive guide for whistleblowers, without having to dig on various sites including darknet locations that could provide potentially incorrect or misleading information. I haven't stopped working on that since. We're the people this guide is written for - the threat model isn't hypothetical for us. I stay anonymous by necessity, not preference. Previously this project was ran by Lena, the founder and a few other people with various backgrounds. Obviously, not much else can be said, but we are active members of the intelligence community (IC) and privacy/security circles. We strive to be the definitive source, not just a glorified recommendation website.
</div>
</div>
<!-- <div class="maintainer-bio">
<img src="../media/daskolburn-keyoxide-profile.png" alt="daskolburn" class="maintainer-avatar">
<div class="maintainer-text" markdown="1">
<>
</div>
</div> -->
---
## Community { #community }
<div class="index-grid">
<!-- <div class="index-card">
<h3 class="index-card__title">Matrix Space</h3>
<p class="index-card__body">Our Matrix.org hosted community space. Read the rules before joining. Admins: <code>@daskolburn:thomcat.rocks</code> and <code>@thehidden:tchncs.de</code>.</p>
<a href="https://matrix.to/#/#psa:anonymousplanet.net" class="index-card__link">Join the Space</a>
<a href="https://matrix.to/#/#nth:anonymousplanet.net" class="index-card__link" style="margin-top:0.4em;">Join the Room</a>
<a href="https://psa.anonymousplanet.net/" class="index-card__link" style="margin-top:0.4em;">Read the Rules</a>
</div> -->
<div class="index-card">
<h3 class="index-card__title">Mastodon</h3>
<p class="index-card__body">Follow us for announcements on the Fediverse.</p>
<a href="https://ioc.exchange/@unknown" class="index-card__link" rel="me">@unknown@ioc.exchange</a>
</div>
<div class="index-card">
<h3 class="index-card__title">X / Twitter</h3>
<p class="index-card__body">Announcements also cross-posted to X.</p>
<a href="https://x.com/anonplanetorg" class="index-card__link">@anonplanetorg</a>
</div>
<div class="index-card">
<h3 class="index-card__title">GitHub Issues</h3>
<p class="index-card__body">Report errors, broken links, or outdated content. Pull requests welcome across all our mirrors.</p>
<a href="https://github.com/Anon-Planet/thgtoa/issues" class="index-card__link">Open an issue</a>
</div>
</div>
---
## Contact { #contact }
Email: <contact@anonymousplanet.net>
For mirrors, see the [Mirrors](../mirrors/index.md) page and the links in the site footer.
For version comparison, see [Comparing Guide Versions](../guide/index.md#comparing-versions).
---
## Recommended Reading { #reading }
!!! warning "Disclosure"
Some linked resources may contain sponsored content, affiliate links, paid services, or monetized content. Anonymous Planet does not endorse and is not sponsored by any commercial entity. We do not participate in any affiliate programs.
??? tip "Privacy & security"
- [AnarSec](https://www.anarsec.guide/)
- [EFF Surveillance Self-Defense](https://ssd.eff.org/)
- [Prism-Break](https://prism-break.org/)
- [Privacy Guides](https://privacyguides.org)
- [Techlore](https://techlore.tech)
- [The New Oil](https://thenewoil.org)
- [PrivacyTools.io](https://privacytools.io)
??? tip "Blogs"
- [CIA Officer's Blog](https://officercia.mirror.xyz/)
- [Edward Snowden — Continuing Ed](https://edwardsnowden.substack.com/)
- [Madaidan's Insecurities](https://madaidans-insecurities.github.io/)
- [Seirdy's Home](https://seirdy.one/)
??? tip "Useful resources"
- [KYC? Not me](https://kycnot.me/)
- [Library Genesis](https://en.wikipedia.org/wiki/Library_Genesis)
- [Real World Onion Sites](https://github.com/alecmuffett/real-world-onion-sites)
- [Sci-Hub](https://en.wikipedia.org/wiki/Sci-Hub)
- [Terms of Service, Didn't Read](https://tosdr.org)
- [Whonix Documentation](https://www.whonix.org/wiki/Documentation)
---
!!! note "We are not affiliated with Anonymous or Riseup"
We hold no affiliation with the [Anonymous](https://en.wikipedia.org/wiki/Anonymous_(hacker_group)) hacker collective or with Riseup. One or two community members uses Riseup resources personally — that is the full extent of any connection.
---
title: "About Anonymous Planet"
description: We are the maintainers of the Hitchhiker's Guide and the PSA Matrix space.
schema:
"@context": https://schema.org
"@type": Organization
"@id": https://www.anonymousplanet.org/
name: Anonymous Planet
url: https://www.anonymousplanet.org/about/
logo: ../media/favicon.png
sameAs:
- https://github.com/Anon-Planet
- https://opencollective.com/anonymousplanetorg
- https://mastodon.social/@anonymousplanet
---
![Anonymous Planet logo](../media/profile.png){ align=right }
**Anonymous Planet** are the maintainers of the [_Hitchhiker's Guide_](https://anonymousplanet.org/guide.html) and the [_PSA Community_](https://psa.anonymousplanet.org). It is responsible for maintaining the projects and code repositories.
The purpose: providing an introduction to various online tracking techniques, online ID verification techniques, and detailed guidance to creating and maintaining (truly) anonymous online identities. It is written with the hopes that good people (e.g., activists, journalists, scientists, lawyers, whistle-blowers, etc.) will be able to fight oppression, censorship and harassment! The website and projects are free (as in freedom) and not affiliated with any donor or projects discussed.
??? Note "Where do I start?"
Start either by going to [the beginning](../guide/index.md) or using the search at top right of the page. It is also available at whatever point you are in your reading.
??? Note "Notes on the journey"
This guide is a work in progress. It will probably never be "finished". You may (will) find broken links when you click on some search results and during some navigation steps. Please report these. Otherwise, most of the search functionality is a great experience and can help you find linked topics. Try to search for something in one section of the reading. It will show up in many other places.
??? Note "Disclaimer"
There might be some wrong or outdated information in this guide because no one is perfect. Your experience may vary. Remember, check regularly for an updated version of this guide. Please do your own independent, well-thought research. There is no one resource online that can provide 100% security, anonymity, and/or privacy.
This guide is a non-profit open-source initiative, licensed under Creative Commons **Attribution-NonCommercial** 4.0 International ([cc-by-nc-4.0](https://creativecommons.org/licenses/by-nc/4.0/) <sup>[[Archive.org]](https://web.archive.org/web/https://creativecommons.org/licenses/by-nc/4.0/)</sup>).
- For mirrors see [Mirrors](../mirrors/index.md) and the links at the bottom right of the page. You should see these on every page.
- For help in comparing versions see [Comparing versions](../guide/index.md#appendix-a6-comparing-versions)
Feel free to submit issues **(please do report anything wrong)** using GitHub Issues at: <https://github.com/Anon-Planet/thgtoa/issues>. We also accept Merge Requests (MR) from our Gitlab and many other places. Do not hesitate to report issues and suggestions!
??? Note "Discuss ideas on Matrix for real-time chat"
We offer a Matrix.org hosted space of our own. Check it out!
- Read [the rules](https://psa.anonymousplanet.org/), please
- Matrix Room: https://matrix.to/#/#nth:anonymousplanet.net
- Matrix Space: https://matrix.to/#/#psa:anonymousplanet.net
- Admins: @daskolburn:thomcat.rocks and @thehidden:tchncs.de
Follow us on:
- Twitter at <https://twitter.com/AnonyPla>
- Mastodon at <https://mastodon.social/@anonymousplanet>
To contact me, see the updated information on the website or send an e-mail to <contact@anonymousplanet.org>
**Please consider [donating](../guide/index.md#donations) if you enjoy the project and want to support the hosting fees or support the funding of initiatives like the hosting of Tor Exit Nodes.**
### Recommended Reading
Some of those resources may, in order to sustain their project, contain or propose:
- Sponsored commercial content
- Monetized content through third party platforms (such as YouTube)
- Affiliate links to commercial services
- Paid Services such as consultancy
- Premium content such as ad-free content or updated content
- Merchandising
_Note that these websites could contain affiliate/sponsored content and/or merchandising. This guide does not endorse and is not sponsored by any commercial entity in any way._
If you skipped those, you should really still consider viewing this YouTube playlist from the Techlore Go Incognito project (<https://github.com/techlore-official/go-incognito> <sup>[[Archive.org]](https://web.archive.org/web/https://github.com/techlore-official/go-incognito)</sup>) as an introduction before going further: <https://www.youtube.com/playlist?list=PL3KeV6Ui_4CayDGHw64OFXEPHgXLkrtJO> <sup>[[Invidious]](https://yewtu.be/playlist?list=PL3KeV6Ui_4CayDGHw64OFXEPHgXLkrtJO)</sup>. This guide will cover many of the topics in the videos of this playlist with more details and references as well as some added topics not covered within that series. This will just take you 2 or 3 hours to watch it all.
_Anonymous Planet_ **does not** participate in any sponsoring, endorsement, advertising, or other affiliate programs for any entity. We only rely on anonymous donations in a closed, transparent loop system.
??? Note "Privacy related"
- AnarSec: <https://www.anarsec.guide/>
- EFF Surveillance Self-Defense: <https://ssd.eff.org/>
- Prism-Break: <https://prism-break.org/>
- Privacy Guides: <https://privacyguides.org>
- Techlore: <https://techlore.tech>
- The New Oil: <https://thenewoil.org>
- PrivacyTools.io: <https://privacytools.io>
??? Note "Blogs and personal websites"
- CIA Officer's Blog: <https://officercia.mirror.xyz/>
- Continuing Ed: <https://edwardsnowden.substack.com/>
- Madaidan's Insecurities: <https://madaidans-insecurities.github.io/>
- Seirdy's Home: <https://seirdy.one/>
??? Note "Useful resources"
- KYC? Not me: <https://kycnot.me/>
- Library Genesis: <https://en.wikipedia.org/wiki/Library_Genesis> <sup>[[Wikiless]](https://wikiless.com/wiki/Library_Genesis)</sup> (see their latest known URL in the Wikipedia article)
- Real World Onion Sites: <https://github.com/alecmuffett/real-world-onion-sites>
- Sci-Hub <https://en.wikipedia.org/wiki/Sci-Hub> <sup>[[Wikiless]](https://wikiless.com/wiki/Sci-Hub)</sup> (see their latest known URL in the main Wikipedia article)
- Terms of Service, Didn't Read: <https://tosdr.org>
- Whonix Documentation: <https://www.whonix.org/wiki/Documentation>
??? Note "We are not affiliated with Anonymous or Riseup"
One or two of our community members uses or has used the resources of Riseup. We are not affiliated with Riseup in any manner.
We also hold **no affiliation** with the [Anonymous](https://en.wikipedia.org/wiki/Anonymous_(hacker_group)) <sup>[[Wikiless]](https://wikiless.com/wiki/Anonymous_(hacker_group))</sup> <sup>[[Archive.org]](https://web.archive.org/web/https://en.wikipedia.org/wiki/Anonymous_(hacker_group))</sup> hacker collective.
## License
!!! Danger ""
:fontawesome-brands-creative-commons: :fontawesome-brands-creative-commons-by: :fontawesome-brands-creative-commons-nd: This guide is an open-source non-profit initiative, licensed under [Creative Commons Attribution-NonCommercial 4.0 International](https://github.com/Anon-Planet/thgtoa/blob/master/LICENSE.md) and is not sponsored/endorsed by any commercial/governmental entity. This means that you are free to use our guide for pretty much any purpose excluding commercially as long as you do attribute it. There are no ads or any affiliate links.
docs/changelog/index.md
-177
View File
@@ -1,177 +0,0 @@
---
title: "Changelog"
description: "Release notes for the Hitchhiker's Guide to Online Anonymity."
schema:
"@context": https://schema.org
"@type": Organization
"@id": https://anonymousplanet.net/
name: Anonymous Planet
url: https://anonymousplanet.net/changelog/
logo: ../media/profile.png
sameAs:
- https://github.com/Anon-Planet
- https://opencollective.com/anonymousplanetorg
---
<div class="hero-block">
<div class="hero-eyebrow">Auto-generated after every release.</div>
<h1 class="hero-title">Changelog<span class="hero-subtitle">What changed, and when.</span></h1>
<p class="hero-tagline">
Follows <a href="https://keepachangelog.com/en/1.1.0/">Keep a Changelog</a> and
<a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.
Generated from conventional commits by machine, only.
</p>
<div class="hero-cta-row">
<a href="https://github.com/Anon-Planet/thgtoa/releases" class="hero-cta hero-cta--primary">GitHub Releases</a>
<a href="../verify/" class="hero-cta hero-cta--secondary">Verify a Release</a>
</div>
</div>
<!-- Change nothing below this line, please. -->
---
## [v1.2.6-pre1]
!!! Note "Meta"
- Various website improvements (CSS)
!!! Note "Changed"
- Adjust keyring path use the new relative path: pgp/anonymousplanet.asc
- 02-sign.yml: use a fpr match to lock a specific key
- 02-sign.yml: quick mkdir -p repo/export before copying files to the dir
- Moved the Acknowledgements section to the bottom
!!! Note "Added"
- COM Class Identifiers (CLSID/GUID) (NEW)
- Windows Global Device Identifier (GDID) (NEW)
- USB bus telemetry (device enumeration history) (NEW)
!!! Note "Improved"
- Glossary (`docs/includes/glossary.md`) and removed inline expansions where applicable
## [v1.2.5]
!!! Note "Meta"
- Website theme customization
- License change to accomodate our fiscal host Open Source Collective
!!! Note "Changed"
- Comprehensive updates throughout the guide reflecting the transition to Whonix 18.x as the newest version
- Replaced outdated Whonix.org wiki docs links with GitHub releases mirror and Archive.org backups
- Updated Virtualbox hardening instructions (e.g., network time desync offsets, Spectre/Meltdown mitigations)
- Added AppArmor enabling guidance for Debian-based Whonix 18.x Workstation VMs
- Upgraded download instructions to use GitHub Releases as primary source with Archive.org fallback
- Added new "Whonix Improvements" section documenting key changes from 17.x to 18.x (automated release upgrade, improved Qubes integration)
- Updated Qubes OS compatibility notes: Whonix 18.x officially supported on R4.3+, Whonix 17.x compatible with R4.2+
- Enhanced system verification instructions after upgrades (checkvm, tor --verify)
- Improved documentation links to use clean markdown format with Archive.org mirrors for resilience
- Added comprehensive upgrade path guidance with backup procedures
- Updated 196! Wikipedia reference links throughout the entire guide
!!! Note "Added"
- All Whonix.org/wiki links now have Archive.org mirror backups for availability
- Upgrade path documented: Whonix 17 to 18 with automated release-upgrade support
- Detailed Qubes OS compatibility notes for both Whonix versions
- You can now get the Anonymous Planet PGP keyring from the site (copy/paste or download)
!!! Note "Improved"
- Virtualbox hardening section reorganized
- AppArmor configuration guidance added where applicable (Whonix 18.x)
- KVM alternative documented in Appendix N for Linux users seeking better security than VirtualBox
- Whonix Improvements subsection added before "Pick your guest workstation" VMs section
- Removed appendix-style writing
## [v1.2.4]
!!! Note "Meta"
- Rename workflows (GH - now we can know the order)
!!! Note "Changed"
- Change the repo URL for our tor mirror
- Fix recommended reading admonition
- Refactoring some things and removing others
- More meta changes to the pipeline
- Rewrite developer guide for current pipeline
!!! Note "Fixed"
- Fix an inline reference
- Use the Anonymous Planet RSK for releases (we used the MSK for testing)
- Prevent history dump and filter noise commits
- Actually save per-page PDFs for qpdf, not PNGs
- Fail fast with helpful message if pdftoppm or qpdf missing
## [v1.2.3]
CI/CD pipeline split into independent stages, dark PDF quality improved, release signing automated, and the changelog now updates itself on every build. Skipping v1.2.2 which was a placeholder and contained broken Python unsuitable for a tag/release.
???+ tip "Added"
- **Dark mode PDF** (`scripts/convert.py`): pixel-level converter replaces the broken `--prefers-color-scheme=dark` Chromium flag. Produces a 200 DPI hacker-themed PDF (`#1f1f31` background, `#e0e0e0` text, `#5e8bde` links) with batched page processing to avoid OOM on large documents.
- **Three independent CI workflows** replacing the old monolithic `build-sign-release.yml`:
- `01-build.yml`: builds PDFs and uploads them as an artifact; no secrets required, can be re-run freely.
- `02-sign.yml`: downloads the PDF artifact, computes SHA-256 and BLAKE2b hashes, GPG-signs all outputs, and uploads a `signatures` artifact. Can be re-run against any historical build.
- `03-release.yml`: downloads both artifacts, uploads to VirusTotal, and publishes a tagged GitHub Release with all 12 assets attached. Can be triggered manually against any previous sign run.
- **`scripts/update_changelog.py`**: reads `git log` since the last version tag, categorises commits by conventional-commit prefix, and prepends a new entry to this file automatically after each successful build.
- **`04-changelog.yml`** workflow: commits the auto-generated changelog entry back to `main` after every build, with `dry_run` and `manual_version` dispatch inputs for safe local testing.
- **`scripts/tag_release.py`**: interactive guided helper for maintainers to create GPG-signed annotated tags. Checks clean tree and branch, auto-increments the version, pulls the message from the changelog, resolves the release signing key, creates and verifies the tag, then prints the push command.
- **`docs/code/develop.md`**: full developer reference covering prerequisites, local build instructions, the pipeline flow, all required GitHub Secrets, the release process, verification steps, and a troubleshooting section for every known CI failure mode.
!!! warning "Changed"
- `build-sign-release.yml` deprecated (now removed) - push triggers removed, manual dispatch only. Will be deleted once in-flight runs complete.
- The full pipeline (build → sign → release → changelog) now chains automatically via `workflow_run` on every push to `main`.
- GPG signing uses `--pinentry-mode loopback` and `--passphrase-fd 0` to avoid interactive prompts on headless runners.
- VirusTotal scans moved to the release stage so they run once per release, not once per build.
- `.gitignore` updated to track `.b2` per-file hash files alongside existing `.sha256` and `.sig` entries.
- Stale information removed from the guide; deprecated ODT section in Appendix A6 commented out.
- Footer copyright information corrected.
!!! bug "Fixed"
- `_save_images_as_pdf` in `convert.py` was passing raw PNG files to `qpdf --pages`, which only accepts PDF inputs. Fixed by quantizing each page to palette mode (256 colours, FASTOCTREE) and saving as a single-page PDF before merging.
- `convert.py` now fails immediately with install instructions if `pdftoppm` or `qpdf` are missing, instead of crashing with an unhelpful `FileNotFoundError`.
- Pillow `KeyError: 'JPEG'` on CI resolved by installing `mkdocs-material[imaging]` and using palette-mode PDF encoding instead of RGB+JPEG.
- Orphaned footnote citations `[^536]` and `[^537]` (Australian privacy law and the Identify and Disrupt Act) restored at the key disclosure law paragraph in the guide.
- Broken internal links and mismatched cross-references throughout the guide corrected.
---
## [v1.2.1]
First automated PDF build and the start of the CI pipeline.
???+ tip "Added"
- `scripts/build_guide_pdf.py`: builds the MkDocs site and renders the full guide to a single PDF via headless Chromium (Chrome or Edge). Supports `--dark`, `--light`, and `--both` modes.
- GitHub Actions workflow that installs Chromium, runs the build script, and uploads `export/thgtoa.pdf` as an artifact on every push to `main` or manual dispatch.
- `docs/stylesheets/extra.css` for shared site styling.
- This changelog.
!!! warning "Changed"
- `README.md` updated with instructions for local PDF export and a note about the GitHub Actions artifact.
- `.gitignore` updated to exclude local build outputs (`export/`, `site/`, `_site_test/`).
!!! bug "Fixed"
- Broken reference-style internal links throughout `docs/guide/index.md` replaced with correct fragment links.
- Broken footnote marker on the "free (unallocated) space" list item in the guide.
---
[v1.2.6-pre1]: https://github.com/Anon-Planet/thgtoa/releases/tag/v1.2.6-pre1
[v1.2.5]: https://github.com/Anon-Planet/thgtoa/releases/tag/v1.2.5
[v1.2.4]: https://github.com/Anon-Planet/thgtoa/releases/tag/v1.2.4
[v1.2.3]: https://github.com/Anon-Planet/thgtoa/releases/tag/v1.2.3
[v1.2.1]: https://github.com/Anon-Planet/thgtoa/releases/tag/v1.2.1
docs/code/index.md
+63 -303
View File
@@ -1,309 +1,69 @@
---
title: "Content Contributions"
description: "How to contribute to the Hitchhiker's Guide — building, signing, releasing, and writing."
hide:
- toc
schema:
"@context": https://schema.org
"@type": Organization
"@id": https://anonymousplanet.net/
name: Anonymous Planet
url: https://anonymousplanet.net/code/
logo: ../media/profile.png
sameAs:
- https://github.com/Anon-Planet
- https://opencollective.com/anonymousplanetorg
title: Content Contributions
---
You can [submit bugs and feature requests](https://github.com/Anon-Planet/thgtoa/issues/new) with detailed information about your issue or idea:
<div class="hero-block">
<div class="hero-eyebrow">Open source. Every PR matters.</div>
<h1 class="hero-title">Contribute<span class="hero-subtitle">Help us improve the Hitchhiker's Guide..</span></h1>
<p class="hero-tagline">
Contributions range from fixing a typo to writing entire new sections.
</p>
<div class="hero-cta-row">
<a href="https://github.com/Anon-Planet/thgtoa/issues/new" class="hero-cta hero-cta--primary">Open an Issue</a>
<a href="#pipeline" class="hero-cta hero-cta--secondary">Release Pipeline</a>
</div>
</div>
- If you'd like to propose an addition, please follow the standards outlined here.
- If you're reporting an issue, please be sure to include the expected behaviour, the observed behaviour, and steps to reproduce the problem.
- This can require technical knowledge, but you can also get involved in conversations about bug reports and feature requests. This is a great way to get involved without getting too overwhelmed!
- [Help fellow committers test recently submitted pull requests](https://github.com/Anon-Planet/thgtoa/pulls). Simply by pulling down a pull request and testing it, you can help ensure our new code contributions for stability and quality.
For those of you who are looking to add content to the guide, include the following:
##### <u>Pull Requests</u>
- **Do** create a [topic branch] to work on instead of working directly on `main`. This helps to:
+ Protect the process.
+ Ensures users are aware of commits on the branch being considered for merge.
+ Allows for a location for more commits to be offered without mingling with other contributor changes.
+ Allows contributors to make progress while a PR is still being reviewed.
- **Do** follow the [50/72 rule] for Git commit messages.
- **Do** write "WIP" on your PR and/or open a [draft PR] if submitting unfinished changes..
- **Do** make sure the title of a draft PR makes it immediately clear that it's a draft
- **Do** target your pull request to the **main branch**.
- **Do** specify a descriptive title to make searching for your pull request easier.
- **Don't** leave your pull request description blank.
- **Don't** abandon your pull request. Being responsive helps us land your changes faster.
- **Don't** post questions in older closed PRs.
- **Do** stick to the guide to find common style issues.
- **Don't** make mass changes (such as replacing "I" with "we") using automated serach/replace functionality.
+ Search/replace doesn't understand context, and as such, will inevitably cause inconsistencies and make the guide harder to read.
+ If it's part of a larger PR, it'll also make the reviewer's life harder, as they'll have to go through manually and undo everything by hand.
+ _If you're going to make mass changes, take the time to do it properly_. Otherwise we'll just have to undo it anyway.
+ If your change contains backslashes (`\`), either escape them with another backslash (`\\`) or put them in a ```code block```.
When reporting guide issues:
- **Do** write a detailed description of your issue and use a descriptive title.
- **Do** make it as detailed as possible and don't just submit 50 line changes without explaining.
- **Don't** file duplicate reports; search for your bug before filing a new report.
- **Don't** attempt to report issues on a closed PR.
### Large PRs
Please split large sets of changes into multiple PRs. For example, a PR that adds Windows 11 support, removes Windows AME references, and fixes typos can be split into 3 PRs. This makes PRs easier to review prior to merging.
For an example of what _not_ to do, see: <https://github.com/Anon-Planet/thgtoa/pull/51>. This PR contains enough changes to split into multiple smaller and individually reviewable PRs.
### Updating PRs
While a PR is being reviewed, modifications may be made to it by the reviewer prior to merging. If this is the case, a new branch will be created for the PR's review. If you would like to submit a change to a PR that is in the process of being reviewed, _do not update the PR directly_. This will only cause merge conflicts and delay the PR from being merged. Instead, submit your changes to the PR's review branch.
For an example of what _not_ to do, see: <https://github.com/Anon-Planet/thgtoa/pull/51>. Instead of submitting changes to the PR directly, they should have been submitted as changes to the PR's associated review branch.
---
## Setup { #setup }
Install these before anything else.
=== "Linux / macOS"
```sh
# Python 3.11+
python3 --version
# poppler (pdftoppm) and qpdf
sudo apt install poppler-utils qpdf # Debian/Ubuntu
brew install poppler qpdf # macOS
# GPG
sudo apt install gnupg # Debian/Ubuntu
brew install gnupg # macOS
# Python dependencies
pip install "mkdocs-material[imaging]" pillow numpy
```
=== "Windows"
```powershell
# Python 3.11+ from https://python.org
# poppler: https://github.com/oschwartz10612/poppler-windows/releases
# Extract and add the bin\ folder to PATH
# qpdf: https://github.com/qpdf/qpdf/releases
# Extract and add the bin\ folder to PATH
# GPG: https://gpg4win.org
# Python dependencies
pip install "mkdocs-material[imaging]" pillow numpy
```
You also need **Google Chrome** or **Microsoft Edge** installed for the light-mode PDF build (headless Chromium).
---
## Repository Layout { #layout }
```txt
.github/
workflows/
01-build.yml # builds PDFs, uploads artifact
02-sign.yml # hashes + GPG signs, uploads signatures artifact
03-release.yml # publishes GitHub Release with all assets
04-changelog.yml # prepends a new entry to docs/changelog/index.md
publish.yml # deploys MkDocs site to GitHub Pages
docs/
guide/index.md # the guide (single Markdown file)
changelog/ # release notes
code/ # this page
export/ # PDF output (PDFs gitignored; .sha256, .b2sum, .asc tracked)
pgp/ # public signing keys
scripts/
build_guide_pdf.py # MkDocs + Chromium PDF builder
convert.py # pixel-based dark mode PDF converter
install_fonts.py # install fonts locally
update_changelog.py # auto-generates changelog entries from git log
setup_workflow.py # GitHub Secrets setup assistant
verify_pdf.py # signature verification helper
archived/
tag_release.py # ARCHIVED — GPG tag helper (not used in current flow)
```
---
## Building Locally { #build }
```sh
python scripts/build_guide_pdf.py --both
```
Builds the MkDocs site, renders it to `export/thgtoa.pdf` via headless Chromium, then produces `export/thgtoa-dark.pdf`.
| Flag | Effect |
|------|--------|
| `--both` | Light PDF then dark PDF |
| _(none)_ | Light PDF only |
| `--dark` | Dark PDF only (light PDF must already exist) |
Build only the dark PDF from an existing light:
```sh
python scripts/convert.py export/thgtoa.pdf export/thgtoa-dark.pdf
```
| Flag | Default | Description |
|------|---------|-------------|
| `--dpi` | `200` | Rasterization DPI |
| `--batch-size` | `50` | Pages per batch — reduce if OOM |
| `--bg` | `1f1f31` | Background colour (hex) |
| `--text` | `e0e0e0` | Body text colour (hex) |
| `--link` | `5e8bde` | Link colour (hex) |
Preview the site:
```sh
mkdocs serve
# Opens at http://127.0.0.1:8000
```
---
## Contributing Content { #contributing }
<div class="index-grid">
<div class="index-card">
<h3 class="index-card__title">Use a Topic Branch</h3>
<p class="index-card__body">Never commit directly to <code>main</code>. Use a topic branch per change so PRs stay reviewable and independent.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">Small PRs</h3>
<p class="index-card__body">Split large changes into multiple PRs — one for new content, one for fixes, one for style. Big PRs block merges and create review debt.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">Conventional Commits</h3>
<p class="index-card__body">All commits must follow <code>&lt;type&gt;(&lt;scope&gt;): &lt;description&gt;</code> format. Enforced by the <code>commitizen</code> pre-commit hook.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">Describe Your Changes</h3>
<p class="index-card__body">Never leave a PR description blank. Include what changed, why, and any context a reviewer needs. Link related issues.</p>
</div>
</div>
### Commit Types
| Type | Changelog bucket |
|------|-----------------|
| `feat`, `feature`, `add` | Added |
| `fix`, `bugfix`, `revert`, `security` | Fixed |
| `perf`, `refactor`, `change`, `chore`, `ci`, `docs`, `style`, `test`, `build` | Changed |
Examples:
```sh
feat: add dark-mode PDF export
fix(scripts): handle locked PDF on Windows
docs: update developer workflow guide
chore(ci): pin Chrome version to 120
```
### Rules
- **Do** target PRs at the `main` branch
- **Do** write "WIP" or open a draft PR for unfinished work
- **Do** follow the [50/72 rule](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) for commit messages
- **Don't** make mass search/replace changes without context-checking every instance
- **Don't** abandon a PR mid-review — stay responsive
- **Don't** modify a PR directly while it's under active review — submit changes to the review branch instead
For an example of what _not_ to do, see [PR #51](https://github.com/Anon-Planet/thgtoa/pull/51).
!!! warning "Before you push"
- Make sure the working tree is clean (`git status`)
- Run `mkdocs build` locally if you changed `docs/` to catch broken links
- If you added footnotes, verify each has both a definition `[^N]:` and at least one inline citation `[^N]`
---
## Release Pipeline { #pipeline }
The pipeline is fully manual after the initial build — no step triggers the next automatically. This prevents version mismatches between what was built, what was signed, and what gets released.
```txt
push to main (or manual trigger)
│
▼
01-build.yml
Builds thgtoa.pdf + thgtoa-dark.pdf.
Uploads artifact: pdfs — note the run ID.
│
│ manually trigger 02-sign.yml with the build run ID
▼
02-sign.yml
Hashes (SHA-256 + BLAKE2b) and GPG-signs all files.
Commits export/ back to main.
Uploads: signatures, pdfs-signed — note the run ID.
│
│ manually trigger 03-release.yml with the sign run ID
▼
03-release.yml
Runs VirusTotal. Creates GitHub Release tagged release-YYYYMMDD-<short-sha>.
│
│ manually trigger 04-changelog.yml with the version string
▼
04-changelog.yml
Prepends a new ## [vX.Y.Z] entry to docs/changelog/index.md and commits.
```
### Release Tags
Tags use the format `release-YYYYMMDD-<short-sha>`, e.g. `release-20260527-abc1234`. No version decision is needed at release time — the tag is always unique and traceable to the exact commit.
The version string (e.g. `v1.2.4`) is a separate, human-assigned label that lives only in the changelog.
### Triggering Each Step
**Build:** Push to `main` or go to **Actions → Build PDFs → Run workflow**. Note the run ID.
**Sign:** **Actions → Sign PDFs → Run workflow**, enter the build run ID. Note the run ID.
**Release:** **Actions → Release → Run workflow**, enter the sign run ID.
**Changelog:** **Actions → Update Changelog → Run workflow**, enter the version string. Use `dry_run: true` to preview.
---
## Verifying a Release { #verify }
```sh
# Import the release signing key
gpg --import pgp/anonymousplanet.asc
# Verify the PDFs
gpg --verify thgtoa.pdf.asc thgtoa.pdf
gpg --verify thgtoa-dark.pdf.asc thgtoa-dark.pdf
# Verify the hash files
gpg --verify sha256sums.txt.asc sha256sums.txt
gpg --verify b2sums.txt.asc b2sums.txt
# Check the PDF hashes match
sha256sum -c sha256sums.txt
b2sum -c b2sums.txt
```
Expected output:
```txt
gpg: Signature made Sun 31 May 2026 03:23:26 AM EDT
gpg: using EDDSA key C3023DBEA3FB38C438BA1EEDCEC60AEDE8B992A2
gpg: Good signature from "Anonymous Planet Release Signing Key" [ultimate]
Primary key fingerprint: C302 3DBE A3FB 38C4 38BA 1EED CEC6 0AED E8B9 92A2
```
You can safely ignore GitHub/Codeberg warnings like "The email in this signature doesn't match the committer email."
---
## Troubleshooting { #troubleshooting }
**`cairosvg` missing during MkDocs build**
`pip install "mkdocs-material[imaging]"` — required by the `social` plugin.
**`KeyError: 'JPEG'` in convert.py**
`sudo apt install libjpeg-dev && pip install --force-reinstall pillow`
**`qpdf: can't find PDF header`**
qpdf only accepts PDF inputs — ensure you are on the current version of `convert.py`.
**GPG signing fails — `No secret key`**
Re-export: `gpg --armor --export-secret-keys <fingerprint>` and re-paste the full block including headers into the `GPG_PRIVATE_KEY` secret.
**GPG signing fails — `Bad passphrase`**
The `GPG_PASSPHRASE` secret has a trailing space or newline. Re-paste without surrounding whitespace.
**`03-release.yml` fails on VirusTotal**
`VT_API_KEY` is missing, invalid, or over the 500 req/day free-tier limit. Re-run after a few minutes.
**`02-sign.yml` fails downloading PDF artifact**
Wrong `build_run_id`, or the artifact expired (90-day retention). Trigger a new build.
**Changelog already contains version X**
`update_changelog.py` errors if the version is already present. Choose the next version string.
**Footnote warnings — `link '#fnref:N' has no anchor`**
A definition `[^N]:` exists without a matching inline citation. Add the citation or remove the orphaned definition.
**Thank you** for taking the few moments to read this far! You're already way ahead of the
curve, so keep it up!
[discussions]: https://github.com/Anon-Planet/thgtoa/discussions
[issues]: https://github.com/Anon-Planet/thgtoa/issues
[help fellow users with open issues]: https://github.com/Anon-Planet/thgtoa/issues
[topic branch]: http://git-scm.com/book/en/Git-Branching-Branching-Workflows#Topic-Branches
[Qubes#7457]: https://github.com/QubesOS/qubes-issues/issues/7457
[50/72 rule]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[draft pr]: https://help.github.com/en/articles/about-pull-requests#draft-pull-requests
[console output]: https://docs.github.com/en/free-pro-team@latest/github/writing-on-github/creating-and-highlighting-code-blocks#fenced-code-blocks
[verification steps]: https://docs.github.com/en/free-pro-team@latest/github/writing-on-github/basic-writing-and-formatting-syntax#task-lists
[reference associated issues]: https://github.com/blog/1506-closing-issues-via-pull-requests
[help fellow committers test recently submitted pull requests]: https://github.com/Anon-Planet/thgtoa/pulls
docs/constitution/index.md
+87 -89
View File
@@ -1,89 +1,87 @@
---
title: "A Constitution"
description: "The rules, values, and principles governing the Anonymous Planet initiative and PSA community."
hide:
- toc
---
<div class="hero-block">
<div class="hero-eyebrow">Applicable to all projects of the initiative.</div>
<h1 class="hero-title">A Constitution<span class="hero-subtitle">The rules we hold ourselves to.</span></h1>
<div class="hero-cta-row">
<a href="#principles" class="hero-cta hero-cta--primary">Our Principles</a>
<a href="#goals" class="hero-cta hero-cta--secondary">Core Goals</a>
</div>
</div>
---
## Principles { #principles }
<div class="index-grid">
<div class="index-card">
<h3 class="index-card__title">Anonymity Above Everything</h3>
<p class="index-card__body">Anonymity is necessary to maintain the balance of power — for journalists, whistleblowers, lawyers, scientists, and victims of oppression. Anonymity first, even if that means using proprietary means. Security and privacy are second. The ends may at times justify proprietary means.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">Independence</h3>
<p class="index-card__body">Anonymous Planet has no affiliation with the "Anonymous" collective and does not endorse their activities. Any overlap between their activities and this guide is purely coincidental.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">Accessibility</h3>
<p class="index-card__body">The Hitchhiker's Guide will always be available online, offline (PDF, ODT), and via the Tor network. Removing any of these access methods is hostile to the mission.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">Freedom</h3>
<p class="index-card__body">All projects are and will remain free, open-source, and non-commercial. Proprietary tools may be recommended where they serve anonymity. All scientific knowledge should be free — we support Sci-Hub and LibGen. Any attempt to erode the freedom of information in our projects is hostile.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">Verifiability &amp; Reproducibility</h3>
<p class="index-card__body">We will be transparent about our biases — anyone claiming to be unbiased is lying. All content shall be verifiable and fact-checked via academic references, reputable media, official documentation, expert review, and direct testing by collaborators.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">Innocence</h3>
<p class="index-card__body">Suspected offenders are innocent until proven guilty. Zero tolerance for abuse of power. Accusers bear the burden of proof. Offenders have the right to face their accuser, appeal to an uninvolved third party, and receive due process.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">Freedom of Thought</h3>
<p class="index-card__body">Open-minded and pragmatic — no gatekeeping. Critical thinking and harsh criticism are welcome. Ad-hominem attacks and slurs are not.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">No Tolerance for Intolerance</h3>
<p class="index-card__body">See the <a href="https://en.wikipedia.org/wiki/Paradox_of_tolerance">Paradox of Tolerance</a>. Hate speech is included.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">No Analytics</h3>
<p class="index-card__body">We will never use analytics. Hosting platforms (e.g. GitHub Pages) may gather analytics outside our control. As the initiative grows, we will move away from these platforms where possible.</p>
</div>
<div class="index-card">
<h3 class="index-card__title">No Profit</h3>
<p class="index-card__body">Excess donations fund our projects first, then initiatives like Tor exit nodes. All donations, spendings, source code, and goals are public. No sponsored content, no affiliate links, no product placements, no advertising. Donations never influence recommendations.</p>
</div>
</div>
It is possible that, coincidentally, a donation could correlate with a recommendation. Where this occurs it will be clearly stated that the donation was welcome, but confers no visibility, coverage, endorsement, or preferential recommendation.
---
## Goals { #goals }
**Core goal:** Help people who need anonymity maintain their physical and digital safety.
**Non-goal:** Help people use this knowledge for harmful purposes.
We know our content can be misused. We believe that giving one good person a safe, anonymous voice is worth the risk of a few using it for ill — in the same way that a fair rule of law accepts that freeing nine criminals is better than imprisoning one innocent person.
---
_Yours faithfully, Anonymous Planet_
---
title: Impressum
---
# A Constitution for an Anonymous Planet.
To amend the rules and regulations of the network and of the PSA community, this constitution is hereby set forth. It is applicable to all the projects of the initiative, especially the Hitchhiker's Guide to Online Anonymity. All members/collaborators must abide by these lines when contributing within the context of the initiative.
## Requirements
> Content is licensed under **[Creative Commons Attribution NonCommercial](https://creativecommons.org/licenses/by-nc/3.0/)** to prevent commercial usage.
### Anonymity above everything.
Anonymity is necessary to maintain the balance of power, specifically to help journalists, whistleblowers, lawyers, scientists, and victims of oppression. Anonymity first, even if that means using non-free and/or proprietary means. Security and privacy are second, again, even if using non-free or non-open-source and/or proprietary means. In this sense, the ends may at times justify proprietary means.
### Independence.
The Anonymous Planet initiative has no affiliation with the "Anonymous" collective and does not endorse their activities.
Any overlap of their activities and our guide are purely coincidental.
### Accessibility.
We will strive to always keep available the following methods of reading the Hitchhiker's Guide:
- online;
- offline (e.g., PDF, ODT);
- via the Tor network
### Freedom.
Maintain free, open-source, and non-commercial nature of all our projects. This does not mean proprietary and/or closed-source tools won't be recommendeded. All scientific knowledge should be free for anyone and we support and encourage Sci-Hub and LibGen. Any attempt to erode the freedom of information and flow of knowledge of our projects, in any manner, is hostile.
### Verifiability, falsifiability and reproducibility.
We will make every effort to be transparent about any and all bias we have.
Anyone claiming to be unbiased is lying, therefore we will not falsely claim to be.
All our content shall be verifiable, reproducible and fact-checked:
- academic references (e.g., studies, papers, and peer reviewed publications);
- reputable media references (e.g., articles, videos, and documentaries);
- official documentation (e.g., manuals, field guides, and technical documents);
- renowned and reputable expert review;
- direct testing by our own collaborators for falsifiablity
### Innocence.
Suspected offenders are innocent until proven guilty, with zero tolerance for abuse of power or position.
Any accusing/moderating member is:
- Subject to the burden of proving the wrong-doing of the offender.
- Required to motivate any sanction.
Any offender has the right to:
- Face their accuser (know who is accusing them).
- Appeal sanctions to an uninvolved third party.
- Participate in their own incrimination (the burden of proof lies with the accuser).
- Due process of the above.
### Freedom of thought.
Open-minded and pragmatic - with no tolerance for gatekeeping.
Critical thinking and fact-checking are strongly encouraged; we welcome criticism including of a harsh nature (excluding ad-hominem and slurs).
### We do not tolerate intolerance.
See the [Paradox of Tolerance](https://en.wikipedia.org/wiki/Paradox_of_tolerance), which includes hate speech.
### No analytics.
Note that, while we will never use analytics, the (now free) platforms hosting our content might be gathering such analytics outside of our control, such as Github pages. As the initiative progresses, we will strive to avoid these as soon as possible.
### No profit.
Any excess donations will only be used to support our main projects first and possibly support other intitiatives (like hosting Tor exit nodes). In all cases, we abide by the following principles:
- Funding transparency (i.e., all donations, spendings, source code, and future goals will be public).
- Acceptance of donations from any entity anonymously or acknowledged (opt-in) will not have any influence on our content.
- No sponsored content.
- No affiliate links.
- No product placements.
- No advertising.
**Disclaimer: it is possible that, coincidentally, a donation could correlate with a recommendation. It will then be clearly stated that while the donation was welcome, the donating entity will not be gaining visibility/coverage/endorsement/recommendations due to such a donation.**
## Core Goals.
Help people in need of anonymity to maintain both their physical and digital safety.
## Non-Goals.
Help any people who are using this knowledge for bad purposes. Helping people takes precedence and we know our content can be used nefariously. Our initiative believes in having one good person given an anonymous voice, safely, is worth the risk of having several using our content for evil. As we do adhere to a fair "rule of law" system which, having 9 criminals and 1 innocent person free, is much better than having one innocent person in prison among 9 criminals.
**Yours faithfully, Anonymous Planet**
docs/contribute/index.md
+111 -176
View File
@@ -1,176 +1,111 @@
---
title: Contribute & Donate
description: "Support the Anonymous Planet project through crypto donations or content contributions. No fiat. No tracking. No profit."
hide:
- toc
---
<div class="hero-block">
<div class="hero-eyebrow">Support the project if you can!</div>
<h1 class="hero-title">No ads. No grants.<br><span class="hero-subtitle">Anonymous donations welcome.</span></h1>
<p class="hero-tagline">
Donations fund Tor .onion hosting, domain registration, bulletproof mail hosting, and exit node operations.
Every cent is logged below. No profit is ever made.
</p>
<div class="hero-cta-row">
<a href="#xmr" class="hero-cta hero-cta--primary">Donate with Monero (XMR)</a>
<a href="#btc" class="hero-cta hero-cta--secondary">Donate with Bitcoin (BTC)</a>
</div>
</div>
<div class="donate-goals-block">
<h3 class="donate-goals-title">Current Goals</h3>
<ul class="donate-goals-list">
<li class="donate-goal donate-goal--done"><span class="donate-goal-icon">✓</span> VPS for .onion hosting <strong>funded</strong></li>
<li class="donate-goal donate-goal--done"><span class="donate-goal-icon">✓</span> Domain <code>anonymousplanet.net</code> — <strong>secured until 2029</strong></li>
<li class="donate-goal donate-goal--open"><span class="donate-goal-icon">○</span> Decent mail hosting</li>
<li class="donate-goal donate-goal--open"><span class="donate-goal-icon">○</span> VPS for general project services</li>
</ul>
</div>
---
## Donate with Monero (XMR) { #xmr }
Monero is the preferred donation method. Transactions are private by default.
<div class="donate-stat-row">
<div class="donate-stat"><span class="donate-stat-label">Total received</span><span class="donate-stat-value">7.101317 XMR</span></div>
<div class="donate-stat"><span class="donate-stat-label">Remaining balance</span><span class="donate-stat-value">0 XMR</span></div>
</div>
<div class="donate-address-block">
<div class="donate-address-label">XMR address</div>
<code class="donate-address">46crzj54eL493BA68pPT4A1MZyKQxrpZu9tVNsfsoa5nT85QqCt8cDTfy1fcTH1oyjdtUbhmpZ4QcVtfEXB337Ng6PS21ML</code>
<div class="donate-qr">
<img src="../media/monero.png" alt="Monero QR code" loading="lazy">
</div>
</div>
---
## Donate with Bitcoin (BTC) { #btc }
Bitcoin donations are accepted on both SegWit and legacy addresses.
<div class="donate-stat-row">
<div class="donate-stat"><span class="donate-stat-label">Total received</span><span class="donate-stat-value">1.89353 mBTC</span></div>
<div class="donate-stat"><span class="donate-stat-label">Remaining balance</span><span class="donate-stat-value">0 mBTC</span></div>
</div>
<div class="donate-address-block">
<div class="donate-address-label">SegWit address</div>
<code class="donate-address">bc1qp9g2c6dquh5lnvft50esxsl97kupdpyqyd4kkv</code>
<div class="donate-address-label" style="margin-top:1em;">Legacy address</div>
<code class="donate-address">1BBgBSVe6w4DWq2BewUQhDEjsNovhfPswD</code>
<div class="donate-qr donate-qr--row">
<figure>
<img src="../media/bitcoin-segwit.png" alt="Bitcoin SegWit QR code" loading="lazy">
<figcaption>SegWit</figcaption>
</figure>
<figure>
<img src="../media/bitcoin-legacy.png" alt="Bitcoin Legacy QR code" loading="lazy">
<figcaption>Legacy</figcaption>
</figure>
</div>
</div>
---
## Contribute Content { #contribute }
<div class="index-grid">
<div class="index-card">
<h3 class="index-card__title">Submit a PR</h3>
<p class="index-card__body">Fix errors, add sections, or update outdated advice. Follow the contributing guidelines and use conventional commit syntax.</p>
<a href="../code/" class="index-card__link">Developer guide</a>
</div>
<div class="index-card">
<h3 class="index-card__title">Use a Mirror</h3>
<p class="index-card__body">GitHub, Codeberg, GitLab, Disroot, and a Tor onion. Pick the one that fits your threat model.</p>
<a href="../mirrors/" class="index-card__link">View mirrors</a>
</div>
</div>
---
## Transparency Log
All donations and spendings are recorded here. <span style="color:var(--status-error)">Red entries</span> indicate funds tied to services that were lost.
### Donations
| Date / Time | Amount | Note |
|---|---|---|
| 2021-02-06 16:48 | 0.1 XMR | |
| 2021-03-15 00:09 | 1.24869 mBTC | |
| 2021-03-15 08:41 | 0.07896 mBTC | |
| 2021-03-31 16:28 | 1 XMR | :heart: Generous donation |
| 2021-04-03 22:31 | 0.5 XMR | :heart: Generous donation |
| 2021-05-07 06:22 | 0.010433 XMR | |
| 2021-06-16 03:05 | 0.03 XMR | |
| 2021-06-27 18:39 | 0.05 XMR | |
| 2021-07-12 07:24 | 0.02 XMR | |
| 2021-07-16 14:31 | 0.1 mBTC | |
| 2021-07-20 21:01 | 0.058981 XMR | |
| 2021-07-24 15:16 | 0.000000000001 XMR | |
| 2021-07-25 02:37 | 0.000000000001 XMR | |
| 2021-08-03 00:17 | 0.04119 XMR | |
| 2021-08-07 15:05 | 0.206328 XMR | |
| 2021-08-10 11:42 | 0.21 mBTC | |
| 2021-08-13 00:25 | 0.25 XMR | |
| 2021-08-14 04:58 | 0.25588 mBTC | |
| 2021-08-30 17:32 | 0.000000000001 XMR | |
| 2021-09-17 14:34 | 0.018 XMR | |
| 2021-10-01 06:23 | 0.000000002137 XMR | |
| 2021-10-02 19:16 | 1 XMR | :heart: Generous donation |
| 2021-10-17 15:40 | 0.02 XMR | |
| 2021-10-18 16:06 | 0.1958 XMR | |
| 2021-11-12 20:42 | 0.02 XMR | |
| 2021-11-14 18:28 | 0.018 XMR | |
| 2021-12-03 21:38 | 0.10134 XMR | |
| 2021-12-16 01:16 | 1 XMR | :heart: Generous donation |
| 2021-12-16 18:06 | 0.017 XMR | |
| 2022-01-09 17:54 | 0.045918 XMR | |
| 2022-01-15 17:35 | 0.014 XMR | |
| 2022-01-24 21:08 | 0.010786 XMR | |
| 2022-01-26 12:07 | 0.010391 XMR | |
| 2022-02-03 19:59 | 0.013013 XMR | |
| 2022-02-18 17:27 | 0.019 XMR | |
| 2022-03-14 10:25 | 0.0139887 XMR | |
| 2022-07-30 03:51 | 0.0222 XMR | |
| 2022-09-28 05:13 | 2 XMR | |
| 2022-08-19 | SimpleLogin Lifetime Premium | In-kind |
| 2022-09-19 | 0.345024 XMR | :heart: From a previous maintainer |
### Spendings
| Date | Amount | Purpose | Status |
|---|---|---|---|
| 2021-03-12 | 0.08181 XMR | Domain `anonymousplanet.net` (1 yr) | Active |
| 2021-03-16 | 1.20179 mBTC | Domain renewal (+3 yr, 4 yr total) | Active |
| 2021-04-01 | 0.8317 XMR | VPS for Tor mirror hosting | Active |
| 2021-04-05 | 0.99367 mBTC | Mail hosting (1 yr) | <span class="status-indicator status-error">Lost</span> |
| 2021-04-13 | 0.71895 mBTC | Mail hosting (ext. to 2 yr) | <span class="status-indicator status-error">Lost</span> |
| 2021-04-25 | 0.02892 mBTC | Wallet transfer fee | — |
| 2021-07-13 | 0.78463 mBTC | BTC→XMR consolidation swap | — |
| 2021-07-13 | 0.067261 XMR | Tor exit node 01 (3 mo) | <span class="status-indicator status-error">Lost</span> |
| 2021-07-15 | 0.151959 XMR | Tor exit node 02 (6 mo) | <span class="status-indicator status-error">Lost</span> |
| 2021-08-16 | 0.253331 XMR | Tor exit node 03 (12 mo) | <span class="status-indicator status-error">Lost</span> |
| 2021-08-18 | −0.56588 mBTC / +0.081904 XMR | AtomicSwap BTC→XMR | — |
| 2021-08-19 | 0.0644 XMR | Mail hosting extension | <span class="status-indicator status-error">Lost</span> |
| 2021-09-18 | 0.246971 XMR | Tor exit node 01 renewal (1 yr) | <span class="status-indicator status-error">Lost</span> |
| 2021-10-04 | 0.26954 XMR | Domain ext. to 2029 | Active |
| 2021-10-06 | 0.236073 XMR | Tor exit node 04 (12 mo) | <span class="status-indicator status-error">Lost</span> |
| 2021-10-18 | 0.01952 XMR | Privex.io VPS test (1 mo) | <span class="status-indicator status-warning">Ended</span> |
| 2021-10-30 | 0.240787 XMR | Synapse hosting VPS (12 mo) | <span class="status-indicator status-error">Lost</span> |
| 2022-01-01 | 0.28055 XMR | Tor exit node 02 renewal (1 yr) | <span class="status-indicator status-error">Lost</span> |
| 2022-02-02 | 0.966793 XMR | Special project sponsorship (UDHR) | <span class="status-indicator status-error">Lost</span> |
| 2022-07-11 | 0.503232 XMR | 1984.is VPS (12 mo) | <span class="status-indicator status-warning">Ended</span> |
| 2022-09-19 | 0.345024 XMR | VPS RAM/disk upgrade | <span class="status-indicator status-warning">Ended</span> |
!!! note "About lost funds"
Entries marked **Lost** represent funds spent on services that are no longer available.
---
title: How to Get Involved
---
There are multiple ways you can add to the guide. Donations to support this project are welcome but are entirely optional. Those donations are mainly used to pay for Tor onion hosting (VPS), mail hosting, domain name registration, and to maintain/run Tor exit nodes. **No profit is ever being made**. All donations and spendings are being logged here below for transparency. Some costs for load balancer servers have been omitted for privacy reasons, but are not paid for with existing Anonymous Planet finances.
<span style="color: red">**Current project donation goals:**</span>
- <del>Funding for a VPS for hosting our .onion website</del>: **done**
- <del>Funding for extending our domain name</del>: **Recovery of original domain secured until 2029**
- Funding for a decent mail hosting
- Funding for a VPS for hosting various services
## Donate using Monero (XMR)
Total Monero donations received: **7.101317184263 XMR**
Total Monero remaining: **2.059336719397 XMR**
Here is the address for the main project:
```46crzj54eL493BA68pPT4A1MZyKQxrpZu9tVNsfsoa5nT85QqCt8cDTfy1fcTH1oyjdtUbhmpZ4QcVtfEXB337Ng6PS21ML```
![][1]
## Donate using Bitcoin (BTC)
Total Bitcoin donations received: **1.89353 mBTC**
Total Bitcoin remaining: **0 mBTC**
Here are the addresses for the main project:
SegWit address: ```bc1qp9g2c6dquh5lnvft50esxsl97kupdpyqyd4kkv```
Legacy address: ```1BBgBSVe6w4DWq2BewUQhDEjsNovhfPswD```
![][2]_____________________![][3]
## Content Contributions
You can easily contribute code or information suggestions at our code repositories listed at the bottom of the website and on the [Mirrors](../mirrors/index.md) tab above. We have many options that are easily accessible. Please follow our [contributing guidelines](../code/index.md) and use good PR syntax.
**Thank you for any contribution. All donations will be mentioned on this page.**
### Donations log
- 2021-02-06 16:48: 0.1 XMR
- 2021-03-15 00:09: 1.24869 mBTC
- 2021-03-15 08:41: 0.07896 mBTC
- 2021-03-31 16:28: 1 XMR (Special thanks for this very generous donation)
- 2021-04-03 22:31: 0.5 XMR (Special thanks for this very generous donation)
- 2021-05-07 06:22: 0.010433355105 XMR
- 2021-06-16 03:05: 0.03 XMR
- 2021-06-27 18:39: 0.05 XMR
- 2021-07-12 07:24: 0.02 XMR
- 2021-07-16 14:31: 0.1 mBTC
- 2021-07-20 21:01: 0.058981 XMR
- 2021-07-24 15:16: 0.000000000001 XMR
- 2021-07-25 02:37: 0.000000000001 XMR
- 2021-08-03 00:17: 0.04119191113 XMR
- 2021-08-07 15:05: 0.206328241262 XMR
- 2021-08-10 11:42: 0.21 mBTC
- 2021-08-13 00:25: 0.25 XMR
- 2021-08-14 04:58: 0.25588 mBTC
- 2021-08-30 17:32: 0.000000000001 XMR
- 2021-09-17 14:34: 0.018 XMR
- 2021-10-01 06:23: 0.000000002137 XMR
- 2021-10-02 19:16: 1 XMR (Special thanks for this very generous donation)
- 2021-10-17 15:40: 0.02 XMR
- 2021-10-18 16:06: 0.1958 XMR
- 2021-11-12 20:42: 0.02 XMR
- 2021-11-14 18:28: 0.018 XMR
- 2021-12-03 21:38: 0.10134722595 XMR
- 2021-12-16 01:16: 1 XMR (Special thanks for this very generous donation)
- 2021-12-16 18:06: 0.017 XMR
- 2022-01-09 17:54: 0.045918219893 XMR
- 2022-01-15 17:35: 0.014 XMR
- 2022-01-24 21:08: 0.010786 XMR
- 2022-01-26 12:07: 0.010391 XMR
- 2022-02-03 19:59: 0.013013984 XMR
- 2022-02-18 17:27: 0.019 XMR
- 2022-03-14 10:25: 0.0139887 XMR
- 2022-07-30 03:51: 0.0222 XMR
- 2022-09-28 05:13: 2 XMR
- 2022-08-19: SimpleLogin.io Lifetime Premium
- 2022-09-19: 0.345024603905 XMR (Special thanks to a previous maintainer)
#### Spendings log
- 2021-03-12: 0.08181086 XMR (+fees) for domain anonymousplanet.org (1 year)
- 2021-03-16: 1.20179 mBTC (+fees) for domain anonymousplanet.org renewal (extension 3 years totalling 4 years)
- 2021-04-01: 0.8317 XMR (+fees) for basic VPS for Tor Mirror hosting
- <del>2021-04-05: 0.99367 mBTC (+fees +exchange from XMR to BTC) for Mail Hosting (1 year): <span style="color: red">**Lost**</span>
- <del>2021-04-13: 0.71895 mBTC (+fees +exchange from XMR to BTC) for Mail Hosting (extension to 2 years)</del>: <span style="color: red">**Lost**</span>
- 2021-04-25: 0.02892 mBTC (Wallet to Wallet transfer fee)
- 2021-07-13: 0.78463 mBTC (+fees +exchange from BTC to XMR) for consolidation
- <del>2021-07-13: 0.067261698061 XMR (+fees) for a Tor Exit Node (01) Hosting (3 months)</del>: <span style="color: red">**Lost**</span>
- <del>2021-07-15: 0.151959953047 XMR (+fees) for a Tor Exit Node (02) Hosting (6 months)</del>: <span style="color: red">**Lost**</span>
- <del>2021-08-16: 0.253331471239 XMR (+fees) for a Tor Exit Node (03) Hosting (12 months)</del>: <span style="color: red">**Lost**</span>
- 2021-08-18: AtomicSwap conversion from remaining mBTC (-0.56588) to XMR (+0.081904862179)
- <del>2021-08-19: 0.0644 XMR (+fees) for Mail Hosting extension</del>: <span style="color: red">**Lost**</span>
- <del>2021-09-18: 0.246971511836 XMR (+fees) for renewal 1 year of Tor Exit Node 01</del>: <span style="color: red">**Lost**</span>
- 2021-10-04: 0.26954 XMR (+fees) for domain anonymousplanet.org extension until 2029
- <del>2021-10-06: 0.236073464623 XMR (+fees) for a Tor Exit Node (04) Hosting (12 months)</del>: <span style="color: red">**Lost**</span>
- <del>2021-10-18: 0.01952 XMR (+fees) for testing a new VPS hosting provider (Privex.io) for one month</del>: <span style="color: red">**Ended**</span>
- <del>2021-10-30: 0.240787814495 XMR (+fees) for a Synapse Hosting VPS (12 months) with bots to help grow the community. This is a test program that will be converted into a Tor Exit Node in case of failure</del>: <span style="color: red">**Lost**</span>
- <del>2022-01-01: 0.28055816111 XMR (+fees) for renewal 1 year of Tor Exit Node 02</del>: <span style="color: red">**Lost**</span>
- <del>2022-02-02: 0.966793601024 XMR (+fees) to sponsor a special project (w/ Universal Declaration of Human Rights)</del>: <span style="color: red">**Lost**</span>
- <del>2022-07-11: 0.503232784687 XMR (+fees) for 1984.is VPS (12 months)</del>: <span style="color: red">**Ended**</span>
- <del>2022-09-19: 0.345024603905 XMR (+fees) for upgrading VPS RAM/Disk</del>: <span style="color: red">**Ended**</span>
[1]: ../media/monero.png
[2]: ../media/bitcoin-segwit.png
[3]: ../media/bitcoin-legacy.png
docs/fonts/eb-garamond/eb-garamond-latin-400-italic.woff2
BIN
View File
Binary file not shown.
docs/fonts/eb-garamond/eb-garamond-latin-400-normal.woff2
BIN
View File
Binary file not shown.
docs/fonts/eb-garamond/eb-garamond-latin-700-italic.woff2
BIN
View File
Binary file not shown.
docs/fonts/eb-garamond/eb-garamond-latin-700-normal.woff2
BIN
View File
Binary file not shown.
docs/fonts/eb-garamond/eb-garamond-latin-ext-400-italic.woff2
BIN
View File
Binary file not shown.
docs/fonts/eb-garamond/eb-garamond-latin-ext-400-normal.woff2
BIN
View File
Binary file not shown.
docs/fonts/eb-garamond/eb-garamond-latin-ext-700-italic.woff2
BIN
View File
Binary file not shown.
docs/fonts/eb-garamond/eb-garamond-latin-ext-700-normal.woff2
BIN
View File
Binary file not shown.
docs/fonts/fira-code/fira-code-latin-ext-wght-normal.woff2
BIN
View File
Binary file not shown.
docs/fonts/fira-code/fira-code-latin-wght-normal.woff2
BIN
View File
Binary file not shown.
docs/guide/index.md
+1228 -1579
View File
File diff suppressed because it is too large Load Diff
docs/includes/glossary.md
-101
View File
@@ -1,101 +0,0 @@
<!-- Abbreviation definitions. No prose. -->
<!-- markdownlint-disable MD041 -->
*[AEM]: Anti Evil Maid
*[AES]: Advanced Encryption Standard
*[AML]: Anti-Money Laundering
*[APT]: Advanced Persistent Threat
*[ARP]: Address Resolution Protocol
*[ASLR]: Address Space Layout Randomization
*[BGP]: Border Gateway Protocol
*[BIOS]: Basic Input/Output System
*[CA]: Certificate Authority
*[CDN]: Content Delivery Network
*[CLI]: Command Line Interface
*[CLSID]: COM Class Identifiers
*[CNAME]: Canonical Name (DNS record type)
*[CRL]: Certificate Revocation List
*[CSP]: Content Security Policy
*[CT]: Certificate Transparency
*[CVE]: Common Vulnerabilities and Exposures
*[DDoS]: Distributed Denial of Service
*[DEA]: Disposable Email Address
*[DEP]: Data Execution Prevention
*[DHCP]: Dynamic Host Configuration Protocol
*[DNS]: Domain Name System
*[DNSSEC]: Domain Name System Security Extensions
*[DoH]: DNS over HTTPS
*[DoS]: Denial of Service
*[DoT]: DNS over TLS
*[DRM]: Digital Rights Management
*[DSP]: Digital Signal Processor
*[ECH]: Encrypted Client Hello
*[ECPA]: Electronic Communications Privacy Act
*[EFF]: Electronic Frontier Foundation
*[EIDV]: Electronic Identity Verification
*[EXIF]: Exchangeable Image File Format
*[FIDO]: Fast Identity Online
*[FISA]: Foreign Intelligence Surveillance Act
*[FOSS]: Free and Open-Source Software
*[FSB]: Federal Security Service (Russian Federation)
*[GDID]: Global Device Identifier (Windows OS)
*[GDPR]: General Data Protection Regulation
*[GEOINT]: Geospatial Intelligence
*[GFW]: Great Firewall of China
*[GSM]: Global System for Mobile Communications
*[HUMINT]: Human Intelligence
*[IANAL]: I Am Not A Lawyer
*[ICMP]: Internet Control Message Protocol
*[IMEI]: International Mobile Equipment Identity
*[IMSI]: International Mobile Subscriber Identity
*[IoT]: Internet of Things
*[ISP]: Internet Service Provider
*[IV]: Initialization Vector
*[KDF]: Key Derivation Function
*[KYC]: Know Your Customer
*[LUKS]: Linux Unified Key Setup
*[MAC]: Media Access Control (hardware address) or Message Authentication Code
*[MITM]: Man-in-the-Middle
*[MNO]: Mobile Network Operator
*[MTU]: Maximum Transmission Unit
*[NAT]: Network Address Translation
*[NIST]: National Institute of Standards and Technology
*[NLP]: Natural Language Processing
*[NTFS]: New Technology File System
*[OEM]: Original Equipment Manufacturer
*[OPSec]: Operational Security
*[OPSEC]: Operational Security
*[OSINT]: Open-Source Intelligence
*[OTP]: One-Time Password or One-Time Pad
*[PGP]: Pretty Good Privacy
*[PKI]: Public Key Infrastructure
*[POP]: Point of Presence
*[PQ]: Post-Quantum
*[PQXDH]: Post-Quantum Extended Diffie-Hellman
*[PSP]: A hardware-based security subsystem built into AMD processors
*[PTR]: Pointer (DNS record type)
*[QUIC]: Quick UDP Internet Connections
*[RF]: Radio Frequency
*[RSA]: Rivest-Shamir-Adleman (asymmetric cryptographic algorithm)
*[SDR]: Software-Defined Radio
*[SIGINT]: Signals Intelligence
*[SNI]: Server Name Indication
*[SOC]: System on a Chip or Security Operations Center
*[SSH]: Secure Shell
*[SSL]: Secure Sockets Layer
*[SSID]: Service Set Identifier (Wi-Fi network name)
*[TCP]: Transmission Control Protocol
*[TLS]: Transport Layer Security
*[TOR]: The Onion Router
*[Tor]: The Onion Router
*[TPM]: Trusted Platform Module
*[UA]: User Agent
*[UEFI]: Unified Extensible Firmware Interface
*[UUID]: Universally Unique Identifier
*[VoIP]: Voice over Internet Protocol
*[VPN]: Virtual Private Network
*[WebRTC]: Web Real-Time Communication
*[XMPP]: Extensible Messaging and Presence Protocol
*[XMP]: Extensible Metadata Platform
*[XSS]: Cross-Site Scripting
*[XTLS]: XTLS Protocol (Xray TLS)
docs/index.md
+21 -45
View File
@@ -1,60 +1,36 @@
---
title: "Home"
description: "The Hitchhiker's Guide to Online Anonymity"
title: ""
description: We are the maintainers of the Hitchhiker's Guide and the PSA Matrix space.
schema:
"@context": https://schema.org
"@type": WebPage
"@id": https://anonymousplanet.net/
"@type": Organization
"@id": https://www.anonymousplanet.org/
name: Anonymous Planet
url: https://anonymousplanet.net/
logo: media/profile.svg
url: https://www.anonymousplanet.org/authors/
logo: ../media/favicon.png
sameAs:
- https://github.com/Anon-Planet
- https://opencollective.com/anonymousplanetorg
- https://mastodon.social/@anonymousplanet
---
<div class="hero-block">
<h1 class="hero-title">The Hitchhiker's Guide<br><span class="hero-subtitle">to Online Anonymity (and Privacy)</span></h1>
<p class="hero-tagline">
You are being tracked. Your metadata is being sold. Your identity is a product. This guide is your manual out.
</p>
<div class="hero-cta-row">
<a href="guide/" class="hero-cta hero-cta--primary">Read the Guide</a>
<a href="verify/" class="hero-cta hero-cta--secondary">Verify &amp; Download</a>
</div>
</div>
![Anonymous Planet logo](media/profile.png){ align=right }
<div class="principles-strip">
<span class="principle"><span class="principle-no">No ads.</span></span>
<span class="principle-sep">/</span>
<span class="principle"><span class="principle-no">No affiliate links.</span></span>
<span class="principle-sep">/</span>
<span class="principle"><span class="principle-no">No bullshit.</span></span>
</div>
**Welcome to the Hitchhiker's Guide.**
<div class="index-grid">
Please share this project if you enjoy it and you think it might be useful to others.
<div class="index-card">
<h3 class="index-card__title">Read Online</h3>
<p class="index-card__body">The full guide — tracking techniques, ID verification, anonymous identity creation, and operational security from first principles.</p>
<a href="guide/" class="index-card__link">Open guide</a>
</div>
Anonymous Planet is a collective of volunteers and contributors. No one person is considered more valuable than another, and no one person should be viewed as having "more impact" on Anonymous Planet.
<div class="index-card">
<h3 class="index-card__title">Download PDF</h3>
<p class="index-card__body">Offline copy as PDF or ODT. Verify the file's integrity with the provided SHA256 checksum and GPG signature before trusting it.</p>
<a href="export/thgtoa.pdf" class="index-card__link">Get the files</a>
</div>
??? person "Das Kolburn"
<div class="index-card">
<h3 class="index-card__title">Tor Mirror</h3>
<p class="index-card__body">Access over the Tor network. The .onion address means your IP and destination stay private — no exit node exposure.</p>
<a href="mirrors/" class="index-card__link">View mirrors</a>
</div>
- [:simple-github: GitHub](https://github.com/NobodySpecial256 "@NobodySpecial256")
- [:fontawesome-solid-envelope: E-mail](mailto:contact@anonymousplanet.org)
- [:simple-matrix: Personal Matrix](https://matrix.to/#/@daskolburn:thomcat.rocks "@daskolburn:thomcat.rocks"), [:simple-matrix: Org Matrix](https://matrix.to/#/@daskolburn:anonymousplanet.net "@daskolburn:anonymousplanet.net")
<div class="index-card">
<h3 class="index-card__title">Verify Authenticity</h3>
<p class="index-card__body">Check GPG signatures, SHA256 hashes, and fetch our public keyring. Never trust a download you haven't verified.</p>
<a href="verify/" class="index-card__link">How to verify</a>
</div>
??? person "Nope"
</div>
- [:simple-github: GitHub](https://github.com/nopeitsnothing "@nopeitsnothing")
- [:simple-mastodon: Mastodon](https://ioc.exchange/@unknown "@unknown@ioc.exchange"){rel=me}
- [:fontawesome-solid-house: Homepage](https://www.itsnothing.net)
- [:fontawesome-solid-envelope: E-mail](mailto:contact@anonymousplanet.org)
- [:simple-matrix: Personal Matrix](https://matrix.to/#/@thehidden:tchncs.de "@thehidden:tchncs.de"), [:simple-matrix: Org Matrix](https://matrix.to/#/@nope:anonymousplanet.net "@nope:anonymousplanet.net")
docs/media/anon_planet.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 120 KiB

docs/media/anon_planet.svg
-79
View File
@@ -1,79 +0,0 @@
<svg width="100%" viewBox="0 0 680 260" role="img" xmlns="http://www.w3.org/2000/svg">
<title>Anonymous Planet</title>
<desc>A hacker terminal style logo: an eye shape with a curved orbital arc passing through it and a small satellite riding the arc, set inside a bracket frame</desc>
<style>
.ap-frame { stroke: #0a8a3d80; }
.ap-fill { fill: #eef6ee; }
.ap-line { stroke: #0a8a3d; }
.ap-line-faint { stroke: #0a8a3d80; }
.ap-core { fill: #007a3d; }
.ap-accent { stroke: #007a3d; }
.ap-accent-fill { fill: #007a3d; }
[data-md-color-scheme="slate"] .ap-frame { stroke: #0b850080; }
[data-md-color-scheme="slate"] .ap-fill { fill: #0f1f0f; }
[data-md-color-scheme="slate"] .ap-line { stroke: #039634; }
[data-md-color-scheme="slate"] .ap-line-faint { stroke: #0b850080; }
[data-md-color-scheme="slate"] .ap-core { fill: #00f080; }
[data-md-color-scheme="slate"] .ap-accent { stroke: #00f080; }
[data-md-color-scheme="slate"] .ap-accent-fill { fill: #00f080; }
@media (prefers-color-scheme: dark) {
.ap-frame { stroke: #0b850080; }
.ap-fill { fill: #0f1f0f; }
.ap-line { stroke: #039634; }
.ap-line-faint { stroke: #0b850080; }
.ap-core { fill: #00f080; }
.ap-accent { stroke: #00f080; }
.ap-accent-fill { fill: #00f080; }
}
</style>
<defs>
<marker id="ap-arrow" viewBox="0 0 10 10" refX="8" refY="5" markerWidth="6" markerHeight="6" orient="auto-start-reverse"><path d="M2 1L8 5L2 9" fill="none" stroke="context-stroke" stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round"/></marker>
</defs>
<path class="ap-frame" d="M250 40 L230 40 L230 110" fill="none" stroke-width="1.5"/>
<path class="ap-frame" d="M430 40 L450 40 L450 110" fill="none" stroke-width="1.5"/>
<path class="ap-frame" d="M250 220 L230 220 L230 150" fill="none" stroke-width="1.5"/>
<path class="ap-frame" d="M430 220 L450 220 L450 150" fill="none" stroke-width="1.5"/>
<path class="ap-fill ap-line" d="M255 130 C 285 85, 395 85, 425 130 C 395 175, 285 175, 255 130 Z" stroke-width="0.75"/>
<circle class="ap-line" cx="340" cy="130" r="32" fill="none" stroke-width="0.5"/>
<circle class="ap-core" cx="340" cy="130" r="13" opacity="0.10"/>
<circle class="ap-line" cx="340" cy="130" r="13" fill="none" stroke-width="0.5"/>
<g class="ap-line-faint" stroke-width="0.5">
<line x1="340" y1="98" x2="340" y2="106"/>
<line x1="340" y1="154" x2="340" y2="162"/>
<line x1="308" y1="130" x2="316" y2="130"/>
<line x1="364" y1="130" x2="372" y2="130"/>
</g>
<circle class="ap-core" cx="340" cy="130" r="2.5"/>
<g>
<circle class="ap-fill ap-line" cx="255" cy="130" r="3" stroke-width="1"/>
<circle class="ap-fill ap-line" cx="425" cy="130" r="3" stroke-width="1"/>
<circle class="ap-fill ap-line" cx="295" cy="98" r="2.5" stroke-width="1"/>
<circle class="ap-fill ap-line" cx="385" cy="98" r="2.5" stroke-width="1"/>
<circle class="ap-fill ap-line" cx="295" cy="162" r="2.5" stroke-width="1"/>
<circle class="ap-fill ap-line" cx="385" cy="162" r="2.5" stroke-width="1"/>
</g>
<path class="ap-accent" d="M225 185 C 300 130, 380 130, 455 75" fill="none" stroke-width="2" stroke-linecap="round"/>
<circle class="ap-accent-fill" cx="225" cy="185" r="3"/>
<circle class="ap-accent-fill" cx="455" cy="75" r="3"/>
<g transform="translate(403, 95) rotate(-32)">
<rect class="ap-fill ap-accent" x="-7" y="-5" width="14" height="10" rx="1.5" stroke-width="1"/>
<rect class="ap-accent" x="-22" y="-2" width="12" height="4" fill="none" stroke-width="0.75"/>
<line class="ap-accent" x1="-22" y1="0" x2="-10" y2="0" stroke-width="0.5"/>
<rect class="ap-accent" x="10" y="-2" width="12" height="4" fill="none" stroke-width="0.75"/>
<line class="ap-accent" x1="10" y1="0" x2="22" y2="0" stroke-width="0.5"/>
<line class="ap-accent" x1="0" y1="-5" x2="0" y2="-11" stroke-width="0.75"/>
<circle class="ap-accent-fill" cx="0" cy="-11" r="1.5"/>
</g>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 3.8 KiB

docs/media/apple-touch-icon.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 5.8 KiB

docs/media/favicon-dark.svg
-7
View File
@@ -1,7 +0,0 @@
<svg width="220" height="220" viewBox="0 0 220 220" role="img" xmlns="http://www.w3.org/2000/svg">
<title>Anonymous Planet favicon mark: a simplified eye outline with a solid pupil</title>
<desc>A minimal eye outline with a filled pupil, simplified for legibility at very small sizes such as a browser favicon.</desc>
<path d="M 25,110 Q 110,64 195,110 Q 110,156 25,110 Z" fill="none" stroke="#00f080" stroke-width="6" stroke-linejoin="round"/>
<circle cx="110" cy="110" r="17" fill="#060d06" stroke="#00f080" stroke-width="3"/>
<circle cx="110" cy="110" r="5" fill="#00f080"/>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 594 B

docs/media/favicon-light.ico
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 3.3 KiB

docs/media/favicon-light.svg
-7
View File
@@ -1,7 +0,0 @@
<svg width="220" height="220" viewBox="0 0 220 220" role="img" xmlns="http://www.w3.org/2000/svg">
<title>Anonymous Planet favicon mark: a simplified eye outline with a solid pupil</title>
<desc>A minimal eye outline with a filled pupil, simplified for legibility at very small sizes such as a browser favicon.</desc>
<path d="M 25,110 Q 110,64 195,110 Q 110,156 25,110 Z" fill="none" stroke="#4a3800" stroke-width="6" stroke-linejoin="round"/>
<circle cx="110" cy="110" r="17" fill="#1a1a1a" stroke="#4a3800" stroke-width="3"/>
<circle cx="110" cy="110" r="5" fill="#4a3800"/>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 594 B

docs/media/favicon.ico
BIN
View File
Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 3.6 KiB

After

Width:  |  Height:  |  Size: 4.2 KiB

docs/media/logo-mark-dark.svg
-36
View File
@@ -1,36 +0,0 @@
<svg width="220" height="150" viewBox="0 0 220 150" role="img" xmlns="http://www.w3.org/2000/svg">
<title>Anonymous Planet mark: a simplified eye with a striated iris and crosshair reticle</title>
<desc>A standalone eye mark with a radially striated iris and a crosshair target reticle over the pupil, used as a compact icon without the full seal border.</desc>
<path d="M 29,72 Q 110,29 191,72" fill="none" stroke="#00f080" stroke-width="1" opacity="0.45"/>
<path d="M 25,80 Q 110,34 195,80 Q 110,126 25,80 Z" fill="none" stroke="#00f080" stroke-width="2.6" stroke-linejoin="round"/>
<g stroke="#00f080" stroke-width="1" opacity="0.6" stroke-linecap="round">
<line x1="30.4" y1="83.9" x2="18.7" y2="89.1"/>
<line x1="34.3" y1="89.1" x2="25.2" y2="97.0"/>
<line x1="39.6" y1="93.0" x2="33.0" y2="103.5"/>
</g>
<circle cx="110" cy="80" r="32" fill="none" stroke="#00f080" stroke-width="0.8" opacity="0.5"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(0.0 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(22.5 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(45.0 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(67.5 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(90.0 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(112.5 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(135.0 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(157.5 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(180.0 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(202.5 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(225.0 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(247.5 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(270.0 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(292.5 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(315.0 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(337.5 110 80)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<circle cx="110" cy="80" r="17" fill="#060d06"/>
<g stroke="#00f080" stroke-width="1.6" stroke-linecap="round">
<line x1="110" y1="56" x2="110" y2="70"/>
<line x1="110" y1="90" x2="110" y2="104"/>
<line x1="86" y1="80" x2="100" y2="80"/>
<line x1="134" y1="80" x2="120" y2="80"/>
</g>
<circle cx="110" cy="80" r="2.1" fill="#00f080"/>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 3.3 KiB

docs/media/logo-mark-light.svg
-36
View File
@@ -1,36 +0,0 @@
<svg width="220" height="150" viewBox="0 0 220 150" role="img" xmlns="http://www.w3.org/2000/svg">
<title>Anonymous Planet mark: a simplified eye with a striated iris and crosshair reticle</title>
<desc>A standalone eye mark with a radially striated iris and a crosshair target reticle over the pupil, used as a compact icon without the full seal border.</desc>
<path d="M 29,72 Q 110,29 191,72" fill="none" stroke="#4a3800" stroke-width="1" opacity="0.45"/>
<path d="M 25,80 Q 110,34 195,80 Q 110,126 25,80 Z" fill="none" stroke="#4a3800" stroke-width="2.6" stroke-linejoin="round"/>
<g stroke="#4a3800" stroke-width="1" opacity="0.6" stroke-linecap="round">
<line x1="30.4" y1="83.9" x2="18.7" y2="89.1"/>
<line x1="34.3" y1="89.1" x2="25.2" y2="97.0"/>
<line x1="39.6" y1="93.0" x2="33.0" y2="103.5"/>
</g>
<circle cx="110" cy="80" r="32" fill="none" stroke="#4a3800" stroke-width="0.8" opacity="0.5"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(0.0 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(22.5 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(45.0 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(67.5 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(90.0 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(112.5 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(135.0 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(157.5 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(180.0 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(202.5 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(225.0 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(247.5 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(270.0 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(292.5 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(315.0 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="110" y1="63" x2="110" y2="48" transform="rotate(337.5 110 80)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<circle cx="110" cy="80" r="17" fill="#1a1a1a"/>
<g stroke="#4a3800" stroke-width="1.6" stroke-linecap="round">
<line x1="110" y1="56" x2="110" y2="70"/>
<line x1="110" y1="90" x2="110" y2="104"/>
<line x1="86" y1="80" x2="100" y2="80"/>
<line x1="134" y1="80" x2="120" y2="80"/>
</g>
<circle cx="110" cy="80" r="2.1" fill="#4a3800"/>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 3.3 KiB

docs/media/logo-seal-dark.svg
-102
View File
@@ -1,102 +0,0 @@
<svg width="340" height="340" viewBox="0 0 340 340" role="img" xmlns="http://www.w3.org/2000/svg">
<title>Anonymous Planet seal: an eye with a striated iris and crosshair reticle, under watch by two satellites, circuit traces and a subtle grid inside a ringed badge</title>
<desc>A circular seal mark. A horizontal eye sits at the center with a radially striated iris and a crosshair target reticle over the pupil. Two satellites float at different angles nearby, unconnected to the eye, representing observation from multiple vantage points. Short circuit-trace lines with node pads radiate toward the ring, and a faint coordinate grid sits behind everything, all inside a double-ring circular border with tick marks at the four cardinal points.</desc>
<defs>
<clipPath id="circleClip"><circle cx="170" cy="170" r="141"/></clipPath>
<clipPath id="eyeClip"><path d="M 85,170 Q 170,124 255,170 Q 170,216 85,170 Z"/></clipPath>
</defs>
<g clip-path="url(#circleClip)" stroke="#00f080" stroke-width="0.5" opacity="0.08">
<line x1="66" y1="20" x2="66" y2="320"/>
<line x1="20" y1="66" x2="320" y2="66"/>
<line x1="118" y1="20" x2="118" y2="320"/>
<line x1="20" y1="118" x2="320" y2="118"/>
<line x1="170" y1="20" x2="170" y2="320"/>
<line x1="20" y1="170" x2="320" y2="170"/>
<line x1="222" y1="20" x2="222" y2="320"/>
<line x1="20" y1="222" x2="320" y2="222"/>
<line x1="274" y1="20" x2="274" y2="320"/>
<line x1="20" y1="274" x2="320" y2="274"/>
</g>
<g>
<line x1="224" y1="264" x2="237" y2="286" stroke="#00f080" stroke-width="1" opacity="0.5"/>
<circle cx="237" cy="286" r="2.2" fill="#00f080"/>
<circle cx="224" cy="264" r="1.1" fill="#00f080"/>
<line x1="116" y1="264" x2="103" y2="286" stroke="#00f080" stroke-width="1" opacity="0.5"/>
<circle cx="103" cy="286" r="2.2" fill="#00f080"/>
<circle cx="116" cy="264" r="1.1" fill="#00f080"/>
<line x1="77" y1="224" x2="54" y2="237" stroke="#00f080" stroke-width="1" opacity="0.5"/>
<circle cx="54" cy="237" r="2.2" fill="#00f080"/>
<circle cx="77" cy="224" r="1.1" fill="#00f080"/>
<line x1="77" y1="116" x2="54" y2="103" stroke="#00f080" stroke-width="1" opacity="0.5"/>
<circle cx="54" cy="103" r="2.2" fill="#00f080"/>
<circle cx="77" cy="116" r="1.1" fill="#00f080"/>
<line x1="142" y1="66" x2="135" y2="41" stroke="#00f080" stroke-width="1" opacity="0.5"/>
<circle cx="135" cy="41" r="2.2" fill="#00f080"/>
<circle cx="142" cy="66" r="1.1" fill="#00f080"/>
<line x1="224" y1="77" x2="237" y2="54" stroke="#00f080" stroke-width="1" opacity="0.5"/>
<circle cx="237" cy="54" r="2.2" fill="#00f080"/>
<circle cx="224" cy="77" r="1.1" fill="#00f080"/>
</g>
<circle cx="170" cy="170" r="150" fill="none" stroke="#00f080" stroke-width="1.6"/>
<circle cx="170" cy="170" r="141" fill="none" stroke="#00f080" stroke-width="0.6" opacity="0.5"/>
<g stroke="#00f080" stroke-width="1.4" opacity="0.8" stroke-linecap="round">
<line x1="170" y1="20" x2="170" y2="32"/>
<line x1="170" y1="308" x2="170" y2="320"/>
<line x1="20" y1="170" x2="32" y2="170"/>
<line x1="308" y1="170" x2="320" y2="170"/>
</g>
<g clip-path="url(#eyeClip)">
<line x1="85" y1="130" x2="255" y2="130" stroke="#00f080" stroke-width="0.5" opacity="0.15"/>
<line x1="85" y1="145" x2="255" y2="145" stroke="#00f080" stroke-width="0.5" opacity="0.15"/>
<line x1="85" y1="160" x2="255" y2="160" stroke="#00f080" stroke-width="0.5" opacity="0.15"/>
<line x1="85" y1="180" x2="255" y2="180" stroke="#00f080" stroke-width="0.5" opacity="0.15"/>
<line x1="85" y1="195" x2="255" y2="195" stroke="#00f080" stroke-width="0.5" opacity="0.15"/>
<line x1="85" y1="210" x2="255" y2="210" stroke="#00f080" stroke-width="0.5" opacity="0.15"/>
</g>
<path d="M 89,162 Q 170,119 251,162" fill="none" stroke="#00f080" stroke-width="1" opacity="0.45"/>
<path d="M 85,170 Q 170,124 255,170 Q 170,216 85,170 Z" fill="none" stroke="#00f080" stroke-width="2.6" stroke-linejoin="round"/>
<g stroke="#00f080" stroke-width="1" opacity="0.6" stroke-linecap="round">
<line x1="90.4" y1="173.9" x2="78.7" y2="179.1"/>
<line x1="94.3" y1="179.1" x2="85.2" y2="187.0"/>
<line x1="99.6" y1="183.0" x2="93.0" y2="193.5"/>
</g>
<circle cx="170" cy="170" r="32" fill="none" stroke="#00f080" stroke-width="0.8" opacity="0.5"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(0.0 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(22.5 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(45.0 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(67.5 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(90.0 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(112.5 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(135.0 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(157.5 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(180.0 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(202.5 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(225.0 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(247.5 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(270.0 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(292.5 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(315.0 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(337.5 170 170)" stroke="#00f080" stroke-width="0.7" opacity="0.55"/>
<circle cx="170" cy="170" r="17" fill="#060d06"/>
<g stroke="#00f080" stroke-width="1.6" stroke-linecap="round">
<line x1="170" y1="146" x2="170" y2="160"/>
<line x1="170" y1="180" x2="170" y2="194"/>
<line x1="146" y1="170" x2="160" y2="170"/>
<line x1="194" y1="170" x2="180" y2="170"/>
</g>
<circle cx="170" cy="170" r="2.1" fill="#00f080"/>
<g transform="translate(104,98) rotate(35)" stroke="#00f080" fill="#00f080" stroke-linecap="round">
<rect x="-3.0" y="-3.0" width="6.0" height="6.0" rx="1.2" stroke="none"/>
<rect x="-1.3" y="-9.0" width="2.6" height="6.0" rx="0.6" stroke="none" opacity="0.9"/>
<rect x="-1.3" y="3.0" width="2.6" height="6.0" rx="0.6" stroke="none" opacity="0.9"/>
<line x1="-3.0" y1="0" x2="-10.4" y2="0" stroke-width="1.1"/>
<line x1="3.0" y1="0" x2="10.4" y2="0" stroke-width="1.1"/>
</g>
<g transform="translate(242,237) rotate(-60)" stroke="#00f080" fill="#00f080" stroke-linecap="round">
<rect x="-3.0" y="-3.0" width="6.0" height="6.0" rx="1.2" stroke="none"/>
<rect x="-1.3" y="-9.0" width="2.6" height="6.0" rx="0.6" stroke="none" opacity="0.9"/>
<rect x="-1.3" y="3.0" width="2.6" height="6.0" rx="0.6" stroke="none" opacity="0.9"/>
<line x1="-3.0" y1="0" x2="-10.4" y2="0" stroke-width="1.1"/>
<line x1="3.0" y1="0" x2="10.4" y2="0" stroke-width="1.1"/>
</g>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 7.7 KiB

docs/media/logo-seal-light.svg
-102
View File
@@ -1,102 +0,0 @@
<svg width="340" height="340" viewBox="0 0 340 340" role="img" xmlns="http://www.w3.org/2000/svg">
<title>Anonymous Planet seal: an eye with a striated iris and crosshair reticle, under watch by two satellites, circuit traces and a subtle grid inside a ringed badge</title>
<desc>A circular seal mark. A horizontal eye sits at the center with a radially striated iris and a crosshair target reticle over the pupil. Two satellites float at different angles nearby, unconnected to the eye, representing observation from multiple vantage points. Short circuit-trace lines with node pads radiate toward the ring, and a faint coordinate grid sits behind everything, all inside a double-ring circular border with tick marks at the four cardinal points.</desc>
<defs>
<clipPath id="circleClip"><circle cx="170" cy="170" r="141"/></clipPath>
<clipPath id="eyeClip"><path d="M 85,170 Q 170,124 255,170 Q 170,216 85,170 Z"/></clipPath>
</defs>
<g clip-path="url(#circleClip)" stroke="#4a3800" stroke-width="0.5" opacity="0.08">
<line x1="66" y1="20" x2="66" y2="320"/>
<line x1="20" y1="66" x2="320" y2="66"/>
<line x1="118" y1="20" x2="118" y2="320"/>
<line x1="20" y1="118" x2="320" y2="118"/>
<line x1="170" y1="20" x2="170" y2="320"/>
<line x1="20" y1="170" x2="320" y2="170"/>
<line x1="222" y1="20" x2="222" y2="320"/>
<line x1="20" y1="222" x2="320" y2="222"/>
<line x1="274" y1="20" x2="274" y2="320"/>
<line x1="20" y1="274" x2="320" y2="274"/>
</g>
<g>
<line x1="224" y1="264" x2="237" y2="286" stroke="#4a3800" stroke-width="1" opacity="0.5"/>
<circle cx="237" cy="286" r="2.2" fill="#4a3800"/>
<circle cx="224" cy="264" r="1.1" fill="#4a3800"/>
<line x1="116" y1="264" x2="103" y2="286" stroke="#4a3800" stroke-width="1" opacity="0.5"/>
<circle cx="103" cy="286" r="2.2" fill="#4a3800"/>
<circle cx="116" cy="264" r="1.1" fill="#4a3800"/>
<line x1="77" y1="224" x2="54" y2="237" stroke="#4a3800" stroke-width="1" opacity="0.5"/>
<circle cx="54" cy="237" r="2.2" fill="#4a3800"/>
<circle cx="77" cy="224" r="1.1" fill="#4a3800"/>
<line x1="77" y1="116" x2="54" y2="103" stroke="#4a3800" stroke-width="1" opacity="0.5"/>
<circle cx="54" cy="103" r="2.2" fill="#4a3800"/>
<circle cx="77" cy="116" r="1.1" fill="#4a3800"/>
<line x1="142" y1="66" x2="135" y2="41" stroke="#4a3800" stroke-width="1" opacity="0.5"/>
<circle cx="135" cy="41" r="2.2" fill="#4a3800"/>
<circle cx="142" cy="66" r="1.1" fill="#4a3800"/>
<line x1="224" y1="77" x2="237" y2="54" stroke="#4a3800" stroke-width="1" opacity="0.5"/>
<circle cx="237" cy="54" r="2.2" fill="#4a3800"/>
<circle cx="224" cy="77" r="1.1" fill="#4a3800"/>
</g>
<circle cx="170" cy="170" r="150" fill="none" stroke="#4a3800" stroke-width="1.6"/>
<circle cx="170" cy="170" r="141" fill="none" stroke="#4a3800" stroke-width="0.6" opacity="0.5"/>
<g stroke="#4a3800" stroke-width="1.4" opacity="0.8" stroke-linecap="round">
<line x1="170" y1="20" x2="170" y2="32"/>
<line x1="170" y1="308" x2="170" y2="320"/>
<line x1="20" y1="170" x2="32" y2="170"/>
<line x1="308" y1="170" x2="320" y2="170"/>
</g>
<g clip-path="url(#eyeClip)">
<line x1="85" y1="130" x2="255" y2="130" stroke="#4a3800" stroke-width="0.5" opacity="0.15"/>
<line x1="85" y1="145" x2="255" y2="145" stroke="#4a3800" stroke-width="0.5" opacity="0.15"/>
<line x1="85" y1="160" x2="255" y2="160" stroke="#4a3800" stroke-width="0.5" opacity="0.15"/>
<line x1="85" y1="180" x2="255" y2="180" stroke="#4a3800" stroke-width="0.5" opacity="0.15"/>
<line x1="85" y1="195" x2="255" y2="195" stroke="#4a3800" stroke-width="0.5" opacity="0.15"/>
<line x1="85" y1="210" x2="255" y2="210" stroke="#4a3800" stroke-width="0.5" opacity="0.15"/>
</g>
<path d="M 89,162 Q 170,119 251,162" fill="none" stroke="#4a3800" stroke-width="1" opacity="0.45"/>
<path d="M 85,170 Q 170,124 255,170 Q 170,216 85,170 Z" fill="none" stroke="#4a3800" stroke-width="2.6" stroke-linejoin="round"/>
<g stroke="#4a3800" stroke-width="1" opacity="0.6" stroke-linecap="round">
<line x1="90.4" y1="173.9" x2="78.7" y2="179.1"/>
<line x1="94.3" y1="179.1" x2="85.2" y2="187.0"/>
<line x1="99.6" y1="183.0" x2="93.0" y2="193.5"/>
</g>
<circle cx="170" cy="170" r="32" fill="none" stroke="#4a3800" stroke-width="0.8" opacity="0.5"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(0.0 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(22.5 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(45.0 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(67.5 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(90.0 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(112.5 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(135.0 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(157.5 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(180.0 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(202.5 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(225.0 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(247.5 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(270.0 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(292.5 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(315.0 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<line x1="170" y1="153" x2="170" y2="138" transform="rotate(337.5 170 170)" stroke="#4a3800" stroke-width="0.7" opacity="0.55"/>
<circle cx="170" cy="170" r="17" fill="#1a1a1a"/>
<g stroke="#4a3800" stroke-width="1.6" stroke-linecap="round">
<line x1="170" y1="146" x2="170" y2="160"/>
<line x1="170" y1="180" x2="170" y2="194"/>
<line x1="146" y1="170" x2="160" y2="170"/>
<line x1="194" y1="170" x2="180" y2="170"/>
</g>
<circle cx="170" cy="170" r="2.1" fill="#4a3800"/>
<g transform="translate(104,98) rotate(35)" stroke="#4a3800" fill="#4a3800" stroke-linecap="round">
<rect x="-3.0" y="-3.0" width="6.0" height="6.0" rx="1.2" stroke="none"/>
<rect x="-1.3" y="-9.0" width="2.6" height="6.0" rx="0.6" stroke="none" opacity="0.9"/>
<rect x="-1.3" y="3.0" width="2.6" height="6.0" rx="0.6" stroke="none" opacity="0.9"/>
<line x1="-3.0" y1="0" x2="-10.4" y2="0" stroke-width="1.1"/>
<line x1="3.0" y1="0" x2="10.4" y2="0" stroke-width="1.1"/>
</g>
<g transform="translate(242,237) rotate(-60)" stroke="#4a3800" fill="#4a3800" stroke-linecap="round">
<rect x="-3.0" y="-3.0" width="6.0" height="6.0" rx="1.2" stroke="none"/>
<rect x="-1.3" y="-9.0" width="2.6" height="6.0" rx="0.6" stroke="none" opacity="0.9"/>
<rect x="-1.3" y="3.0" width="2.6" height="6.0" rx="0.6" stroke="none" opacity="0.9"/>
<line x1="-3.0" y1="0" x2="-10.4" y2="0" stroke-width="1.1"/>
<line x1="3.0" y1="0" x2="10.4" y2="0" stroke-width="1.1"/>
</g>
</svg>
Side by Side

Before

Width:  |  Height:  |  Size: 7.7 KiB

docs/media/nope-keyoxide-profile.png
BIN
View File
Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 7.0 KiB

docs/mirrors/index.md
+23 -102
View File
@@ -1,120 +1,41 @@
---
title: "Mirrors"
description: "Every place you can read or download the Hitchhiker's Guide."
hide:
- toc
title: "Our Mirrors"
description: Maintainers of the Hitchhiker's Guide and the PSA Community.
schema:
"@context": https://schema.org
"@type": Organization
"@id": https://anonymousplanet.net/
"@id": https://www.anonymousplanet.org/
name: Anonymous Planet
url: https://anonymousplanet.net/mirrors/
logo: ../media/profile.png
url: https://www.anonymousplanet.org/mirrors/
logo: ../media/favicon.png
sameAs:
- https://github.com/Anon-Planet
- https://opencollective.com/anonymousplanetorg
- https://mastodon.social/@anonymousplanet
---
<div class="hero-block">
<div class="hero-eyebrow">Censorship-resistant by design.</div>
<h1 class="hero-title">Mirrors<span class="hero-subtitle">Pick the one that fits your threat model.</span></h1>
<p class="hero-tagline">
The guide is mirrored across GitHub, Codeberg, GitLab, Disroot, and a Tor onion.
We have contingencies in place.
A signed PDF is also available for offline reading.
</p>
<div class="hero-cta-row">
<a href="#read" class="hero-cta hero-cta--primary">Read the Guide</a>
<a href="#git" class="hero-cta hero-cta--secondary">Git Mirrors</a>
</div>
</div>
![metadata](../media/profile.png){ align=right }
---
## Read the Guide { #read }
!!! Note "Where to find the Hitchhiker's Guide"
<div class="index-grid">
- [Original](https://anonymousplanet.org)
- [Tor v3](http://thgtoa3jzy3doku7hkna32htpghjijefscwvh4dyjgfydbbjkeiohgid.onion) **Down**
- [Archive.org](https://web.archive.org/web/https://anonymousplanet.org)
- [Archive.today](https://archive.fo/anonymousplanet.org)
- [Archive.today over Tor](http://archiveiya74codqgiixo33q62qlrqtkgmcitqx5u2oeqnmn5bpcbiyd.onion/anonymousplanet.org)
<div class="index-card">
<h3 class="index-card__title">Original</h3>
<p class="index-card__body">The canonical source. Hosted on GitHub Pages at the project's primary domain.</p>
<a href="https://anonymousplanet.net" class="index-card__link">anonymousplanet.net</a>
</div>
!!! Note "PDF export (single file)"
<div class="index-card">
<h3 class="index-card__title">Tor Onion</h3>
<p class="index-card__body">v3 onion service. Currently <strong>down</strong>. Check back or use a clearnet mirror.</p>
<a href="http://thgtoa3jzy3doku7hkna32htpghjijefscwvh4dyjgfydbbjkeiohgid.onion" class="index-card__link">Onion address</a>
</div>
The guide is also available as a **PDF** (images and layout preserved). It is built automatically in GitHub Actions: open [**Build guide PDF**](https://github.com/Anon-Planet/thgtoa/actions/workflows/build-pdf.yml) on the [**thgtoa** source repository](https://github.com/Anon-Planet/thgtoa), pick a successful run, and download the **`guide-pdf`** artifact. You can start a fresh build anytime (**Actions** → **Build guide PDF** → **Run workflow**).
<div class="index-card">
<h3 class="index-card__title">PDF Export</h3>
<p class="index-card__body">A signed, single-file PDF built automatically from the source. Both light and dark editions. See the release notes for hash and signature files.</p>
<a href="https://github.com/Anon-Planet/thgtoa/releases" class="index-card__link">Releases</a>
</div>
To produce the same file locally, clone the repository and run `python scripts/build_guide_pdf.py` (Python, [MkDocs Material](https://squidfunk.github.io/mkdocs-material/getting-started/), and **Google Chrome** or **Microsoft Edge** required). More detail is in the [repository README](https://github.com/Anon-Planet/thgtoa#ways-to-read-or-export-the-guide).
<div class="index-card">
<h3 class="index-card__title">Archive.org</h3>
<p class="index-card__body">Wayback Machine snapshot. Useful if the primary domain is unreachable.</p>
<a href="https://web.archive.org/web/https://anonymousplanet.net" class="index-card__link">Wayback Machine</a>
</div>
!!! Note "Our official git mirrors"
<div class="index-card">
<h3 class="index-card__title">Archive.today</h3>
<p class="index-card__body">Alternative archival snapshot. Also accessible via their Tor onion.</p>
<a href="https://archive.fo/anonymousplanet.net" class="index-card__link">Archive.today</a>
</div>
<div class="index-card">
<h3 class="index-card__title">Archive.today (Tor)</h3>
<p class="index-card__body">Archive.today over Tor for censorship-resistant access.</p>
<a href="http://archiveiya74codqgiixo33q62qlrqtkgmcitqx5u2oeqnmn5bpcbiyd.onion/anonymousplanet.net" class="index-card__link">Onion</a>
</div>
</div>
---
## Git Mirrors { #git }
<div class="index-grid">
<div class="index-card">
<h3 class="index-card__title">GitHub</h3>
<p class="index-card__body">Primary development host. Issues, pull requests, and CI live here.</p>
<a href="https://github.com/anon-planet" class="index-card__link">github.com/anon-planet</a>
</div>
<div class="index-card">
<h3 class="index-card__title">Codeberg</h3>
<p class="index-card__body">EU-based, non-profit Gitea instance. No Microsoft.</p>
<a href="https://codeberg.org/anonymousplanet" class="index-card__link">codeberg.org</a>
</div>
<div class="index-card">
<h3 class="index-card__title">GitLab</h3>
<p class="index-card__body">GitLab.com mirror. Accepts merge requests.</p>
<a href="https://gitlab.com/anonymousplanetorg" class="index-card__link">gitlab.com</a>
</div>
<div class="index-card">
<h3 class="index-card__title">0xacab</h3>
<p class="index-card__body">Activist-run GitLab instance. Also accessible via Tor onion.</p>
<a href="https://0xacab.org/anonypla" class="index-card__link">0xacab.org</a>
<a href="http://wmj5kiic7b6kjplpbvwadnht2nh2qnkbnqtcv3dyvpqtz7ssbssftxid.onion/anonypla" class="index-card__link" style="margin-top:0.4em;">Onion</a>
</div>
<div class="index-card">
<h3 class="index-card__title">Disroot</h3>
<p class="index-card__body">Privacy-respecting Gitea instance. Also accessible via Tor onion.</p>
<a href="https://git.disroot.org/anon-planet" class="index-card__link">git.disroot.org</a>
<a href="http://kgtz2pmmov5jfvn3z4mqryffjnnw6krzrgxxoyaqhqckjrr4pckyhsqd.onion/anon-planet" class="index-card__link" style="margin-top:0.4em;">Onion</a>
</div>
<div class="index-card">
<h3 class="index-card__title">Darktea</h3>
<p class="index-card__body">Tor-only Gitea mirror. Only accessible via the onion address.</p>
<a href="http://it7otdanqu7ktntxzm427cba6i53w6wlanlh23v5i3siqmos47pzhvyd.onion/anonymousplanetorg" class="index-card__link">Onion only</a>
</div>
</div>
- [Github](https://github.com/anon-planet)
- [Darktea](http://it7otdanqu7ktntxzm427cba6i53w6wlanlh23v5i3siqmos47pzhvyd.onion/anonymousplanetorg) (Tor Only)
- [Gitlab](https://gitlab.com/anonymousplanetorg)
- [0xacab](https://0xacab.org/anonypla) ([Tor Onion](http://wmj5kiic7b6kjplpbvwadnht2nh2qnkbnqtcv3dyvpqtz7ssbssftxid.onion/anonypla))
- [Codeberg](https://codeberg.org/anonymousplanet)
- [Disroot](https://git.disroot.org/anon-planet) ([Tor Onion](http://kgtz2pmmov5jfvn3z4mqryffjnnw6krzrgxxoyaqhqckjrr4pckyhsqd.onion/anon-planet))
docs/overrides/main.html
-8
View File
@@ -1,8 +0,0 @@
{% extends "base.html" %}
<!-- for verifying Mastodon -->
{% block extrahead %}
<link href="https://ioc.exchange/@unknown" rel="me">
<link rel="icon" id="ap-favicon" href="{{ 'media/profile.png' | url }}" sizes="any">
<link rel="icon" type="image/
</script>
{% endblock %}
docs/overrides/partials/header.html
-66
View File
@@ -1,66 +0,0 @@
{% set class = "md-header" %}
{% if "navigation.tabs.sticky" in features %}
{% set class = class ~ " md-header--shadow md-header--lifted" %}
{% elif "navigation.tabs" not in features %}
{% set class = class ~ " md-header--shadow" %}
{% endif %}
<header class="{{ class }}" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="{{ lang.t('header') }}">
<a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ config.site_name | e }}" class="md-header__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo">
{% include "partials/logo.html" %}
</a>
<label class="md-header__button md-icon" for="__drawer">
{% set icon = config.theme.icon.menu or "material/menu" %}
{% include ".icons/" ~ icon ~ ".svg" %}
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
{{ config.site_name }}
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
{% if page.meta and page.meta.title %}
{{ page.meta.title }}
{% else %}
{{ page.title }}
{% endif %}
</span>
</div>
</div>
</div>
{% if config.theme.palette %}
{% if not config.theme.palette is mapping %}
{% include "partials/palette-toggle.html" %}
{% endif %}
{% endif %}
{% if not config.theme.palette is mapping %}
{% include "partials/javascripts/palette.html" %}
{% endif %}
{% if config.extra.alternate %}
{% include "partials/alternate.html" %}
{% endif %}
{% if "material/search" in config.plugins %}
{% set search = config.plugins["material/search"] | attr("config") %}
{% if search.enabled %}
<label class="md-header__button md-icon" for="__search">
{% set icon = config.theme.icon.search or "material/magnify" %}
{% include ".icons/" ~ icon ~ ".svg" %}
</label>
{% include "partials/search.html" %}
{% endif %}
{% endif %}
{% if config.repo_url %}
<div class="md-header__source">
{% include "partials/source.html" %}
</div>
{% endif %}
</nav>
{% if "navigation.tabs.sticky" in features %}
{% if "navigation.tabs" in features %}
{% include "partials/tabs.html" %}
{% endif %}
{% endif %}
</header>
docs/overrides/partials/palette-toggle.html
-70
View File
@@ -1,70 +0,0 @@
<div class="toggle-container toggle-container--header" id="ap-palette-toggle">
<div class="toggle-wrap">
<input type="checkbox" class="toggle-input" id="ap-toggle-input" aria-label="Turn the monitor on or off">
<label for="ap-toggle-input" class="toggle-track">
<div class="holo-glow"></div>
<div class="track-lines"><div class="track-line"></div></div>
<div class="toggle-thumb">
<div class="thumb-core"></div>
<div class="thumb-inner"></div>
<div class="thumb-scan"></div>
<div class="thumb-particles">
<div class="thumb-particle"></div>
<div class="thumb-particle"></div>
<div class="thumb-particle"></div>
<div class="thumb-particle"></div>
<div class="thumb-particle"></div>
</div>
</div>
<div class="energy-rings">
<div class="energy-ring"></div>
<div class="energy-ring"></div>
<div class="energy-ring"></div>
</div>
<div class="toggle-data">
<div class="data-text off">On</div>
<div class="data-text on">Off</div>
</div>
<div class="status-indicator off"></div>
<div class="status-indicator on"></div>
<div class="interface-lines">
<div class="interface-line"></div>
<div class="interface-line"></div>
<div class="interface-line"></div>
<div class="interface-line"></div>
<div class="interface-line"></div>
<div class="interface-line"></div>
</div>
<div class="toggle-reflection"></div>
</label>
</div>
</div>
<script>
(function () {
var KEY = "__palette";
var input = document.getElementById("ap-toggle-input");
if (!input) return;
function currentScheme() {
return document.body.getAttribute("data-md-color-scheme") || "slate";
}
function applyScheme(scheme) {
document.body.setAttribute("data-md-color-scheme", scheme);
var stored = { index: scheme === "default" ? 1 : 0 };
try {
localStorage.setItem(KEY, JSON.stringify(stored));
} catch (e) {
/* storage unavailable, fail silently */
}
}
input.checked = currentScheme() === "default";
input.addEventListener("change", function () {
applyScheme(input.checked ? "default" : "slate");
});
})();
</script>
docs/pgp/anonymousplanet.asc
-89
View File
@@ -1,89 +0,0 @@
-----BEGIN PGP PUBLIC KEY BLOCK-----
mDMEZc0QYxYJKwYBBAHaRw8BAQdAm8mOR8/0qWrm9Tqzfl9Ks5rjtIbQZLAR/qxH
HVGJsxi0LUFub255bW91cyBQbGFuZXQgRW1haWwgRW5jcnlwdGlvbi9TaWduaW5n
IEtleYiTBBMWCgA7FiEE/L0sq979H7ounnWRoags0t0s+JAFAmXNEGMCGwMFCwkI
BwICIgIGFQoJCAsCBBYCAwECHgcCF4AACgkQoags0t0s+JDbRAEAuZlBmMGgZ3bh
12Js9jjDcu+jhKqL4fJrJG5z9+KFkQwA/An1StA6EhcM7qlzZ5bzm2SZAbP9hQRZ
GmfaeU2P5KgHiHgEMBYKACAWIQSfpUNtDuNgmFFXOCUX7KBfdo3t9gUCaiCYTgId
AAAKCRAX7KBfdo3t9gNUAP9/SyGBYJ7s9YeqLHOJ+veQZjZYHvFGQ7yPn0Fetx0Z
LAD/UOQ8rP2QaldCMyVSG8SqfPd7n++SEAXWAl2gAo9mhg6IdQQQFgoAHRYhBJ+l
Q20O42CYUVc4JRfsoF92je32BQJmpEUQAAoJEBfsoF92je32tD8A/ir9hE8UjrJE
psG+PNfxYAwAagKUGbAMDUxQp3z+t81+AP45hYT4aR89zSQaankHLs3Lh7Cp5ael
NBe/BtfR9hCLAYkCMwQQAQgAHRYhBF7WeRgs0hkTAMDm6kyyELegkVLWBQJqIJiM
AAoJEEyyELegkVLWjZYP/j1k5vl+r0NDQXmE8hS9IKhaQPggP72iXc5RWeMQHuIv
b1laQZm64xerJNdAh0uk1bwfmJnVGfyxBUrlCgAIeVGRSlni2Rig4azaQ1IS0pqF
4sC1KzKEhEaNdkh3pJyGtP1cikcSjWeU2oYQou3/7VN3vNyW+n8OAVF+2fsC5d78
EvdpZgal+komb+J8Bt552uDbCCVI4TFIPBZmHWoXjaP6L+730YphbV7Aw0L5J6OO
ob0nzHn4X0dIvGE7Phdp2e1yNRUOSRLh8B/D5OiE9k7CaeYmJNPv5qOw/R+NgrrA
ZFnoOuwHo0D+aL9WT9q4aM/cDCEIbvhQ4l5ZhVGqZuQ9wxNCgPi3ZiZRTfk1PW4v
uMw1xGwXBKy7jDO12xWIWWv9MiwIQLw0OxSxKbr76rgucq7e7JrWr64rItu5Wm7F
8qxg2cwmDat6tFSRVWlEDy8oNkRMJNjdQJDu3ez9YOfJNnApAz94Of1XU7CUuYjY
PV88BaHdUBVtANEzy0iSDCcSj6auzLfv9dBN8cOdUxlVcrPf2jjK6JR/6qe6VWNp
wRg9VQW2fe8HJTMUt0o9qQBJUsF68KOHtIdoE4az9AyyBNKl67dKqLB9HoIItLzD
MJRcbS2p6plCTNagwPVvgtPRChll9JP3jLPVhRL2BixYVkbHUoJxsEfscTUl6Azt
tEtBbm9ueW1vdXMgUGxhbmV0IEVtYWlsIEVuY3J5cHRpb24vU2lnbmluZyBLZXkg
PGFub255bW91c3BsYW5ldEBkaXNyb290Lm9yZz6IkwQTFgoAOxYhBPy9LKve/R+6
Lp51kaGoLNLdLPiQBQJmhqXqAhsDBQsJCAcCAiICBhUKCQgLAgQWAgMBAh4HAheA
AAoJEKGoLNLdLPiQJ34A/RJT9Hyj7hT/0D1BbDU6s6YzD+/x7Pyq2+9kNSI0L77W
AQAAG+CfDrKDXJtBNKZVNFZpld3wUeoIOcAqLl7KpsVGCYh1BBAWCgAdFiEEn6VD
bQ7jYJhRVzglF+ygX3aN7fYFAmakRRAACgkQF+ygX3aN7fbypgEAnEg0IbWnpaLj
/4wU179vUZZu/Y0DE63GbJuZjj72hKUA/0xyzIgSvXByjoOkEwCn5w1+RPYXKw7Z
syERsDCUAAMIiQIzBBABCAAdFiEEXtZ5GCzSGRMAwObqTLIQt6CRUtYFAmogmIwA
CgkQTLIQt6CRUtafPQ/+LTWFU84tDZAM0Hp7bWB0dw8nP0JvNQ2WtZf0flh+r1tF
cmVnc9szZBh+zzSpY25iK5+Waa6+l1POYSQpkS67VR0Jrv9nL94YrRhqalSRWsjW
MQJO+Obu4LIRIqiMZLJlAd9Bg9FshYagbQDVDOI8v9mxqCzIVm3tBx1Jp57ATHgm
sMDWn7l1BI0SkLlG49LYxVDQ6QAx4XLCQw+JzdiJs+yExa5ymYmV61evVVbDV5UF
pEwW6nsuEDc68UN6npjr8OuGH5y+1ot1vaBderoXFZ8hRG/czzODX5L0zGDX9R2C
cGyIrv4AoXTtnbiVZGG6Vn1p3C/RMFZsVOMKvyQKh0rjcD9dqVQ4thI41o92jZ0V
K5ALjPiWe1kM4DVYgk/b46q9/8rjzYb4WJCwPQJkRBp36y26oRWM0JaY2Tobzt/H
3c8d36hQSXtjKLY27ZY5jL0N4vJaiclAuy03wKonmKlUc1ROUBEgNoZcvx6rLx6e
64G7ypOpvlQCcLT/3x+VqX+KTwf4bbigrlonFMpq2lX/uwvHDMfc9/yB5xaUKLpf
/zuk/gHKzAfKPItzEyRx5Lvql9Aywaa+/gTCZhwM3D6DzR5Q5waDXcdsptB+GZAi
5s+BTxe1a4H6PMobdNOsYDFa77QKQXtWdHkybhV5xzRRMoSdKi+zwvU77BRnwf24
OARlzRBjEgorBgEEAZdVAQUBAQdApPitK71WFqWUCycq2bWYYykmU1YFgea3q/V3
DfsbbhIDAQgHiHgEGBYKACAWIQT8vSyr3v0fui6edZGhqCzS3Sz4kAUCZc0QYwIb
DAAKCRChqCzS3Sz4kLhXAQDhI8tMCEWLu3MhG9pI8BBYH4fS7kuN8ggxqDSbRpKJ
dgEAk1CA06WvsH4/n0HmJ83sJSbmFGmEMp2RyvKbdCIW5gKYMwRlzRBIFgkrBgEE
AdpHDwEBB0CVyNrq08EGyU77is+cf7/vqDqi95rCeZvE7yRU7SYFDrQjQW5vbnlt
b3VzIFBsYW5ldCBNYXN0ZXIgU2lnbmluZyBLZXmIkgQTFgoAOxYhBJ+lQ20O42CY
UVc4JRfsoF92je32BQJlzRBIAhsDBQsJCAcCAiICBhUKCQgLAgQWAgMBAh4HAheA
AAoJEBfsoF92je32NywA+JKlENQl/Kn03FojFNC1Xw5dfNMKnDAs6lV/loSDtOYB
ALrDCc1eWeeBt0FQItPiNcGycBBbRtJciNJMu2AUQ9wCiJMEExYKADsWIQSfpUNt
DuNgmFFXOCUX7KBfdo3t9gUCZc0QSAIbAwULCQgHAgIiAgYVCgkICwIEFgIDAQIe
BwIXgAAKCRAX7KBfdo3t9jcsAQAAkqUQ1CX8qfTcWiMU0LVfDl180wqcMCzqVX+W
hIO05gEAusMJzV5Z54G3QVAi0+I1wbJwEFtG0lyI0ky7YBRD3AKIdQQQFgoAHRYh
BIs6dIkFNrrVDZN26/HLMvZ+MwKhBQJqIJYjAAoJEPHLMvZ+MwKhm7YA/Rdrap0+
zzfVtXomRmVkeIaabzxImPuYnvwvgSulFw0oAP9ZkmMjexGKnbuLc1znUNoUjKyR
SmpT0ezNJRPcB2x3DokCMwQQAQgAHRYhBF7WeRgs0hkTAMDm6kyyELegkVLWBQJq
IJcQAAoJEEyyELegkVLW2YQP/0ry3BvS1pmEl60Ty0smBtEfoYsqQOz4uMBeOYzN
IHXtFrw19XAZQjVXYRhUp9NOol6JY8KtqUg0LXQZaRWhVwbA6hMqDbFeT+l+Psu/
Ek3dghpwR6xEDSNcm3V1aznNgADcDkGLINbZ7ZW/iDnrws5JMDA0k3+Qt1d596Le
kv609g28bxGgt0YENUDFGwXTawO0PALMF3Xg4gwyGU8UELoCoUUWvCYEECqO1vWc
BrZNDNulp9ovfsC8A4BkAo6yCv6RPOJVGHaKlfsO81HvBz+pExT0S71DFX5Gm9Qo
zkDIEZKLuBji6zuhi88dm17vvDs2SKjVd9OnZhs8THbGW+4WRqU6woYMN1YJAedp
+hAaYhJjQfdnFXql7bY5f9uqiBLGy4c5BPoXGYQNi8GABCzUdoiBwsFM/DQ9L8qA
fA355CVayg3aODo/NGore3N2Gqxa0GUz21ImMRV/8EIR05zFRVHeR7gu2czDyGih
9eHadE2FAAmu2iifZcxKfe3ibSBijub11Wxkfei1gipQ/OvkEfCONVVNRyi6H9Kv
6lRP+2n93GQLxlcqxd1qW2tpAt8Pimetb0M20ZY3LkuxhXvsir3sRFRcU4dLSbld
7VdwG7AsMmmA98Tp6CKjzI9FS/JcZTDoAVw6PgDSthrK5ev2plALMtWrOg9TggYE
6a/nuDgEZc0QSBIKKwYBBAGXVQEFAQEHQP1nHDDQfCi8qGG2QJj/wmMUl8ZGEiAY
pVc/+S0ZIJEnAwEIB4h4BBgWCgAgFiEEn6VDbQ7jYJhRVzglF+ygX3aN7fYFAmXN
EEgCGwwACgkQF+ygX3aN7fbSGAD9GLAarXceWbfEUWYC4IwVJAKSHDPWSzLGgFnV
x/D3238A/RiJHKYzmigvFLL/A28WStW6P47CjNYjJCS490qG/L0GmDMEZc0J8xYJ
KwYBBAHaRw8BAQdAWIpOKf8GnTINRH7uW4oeGW4D4vfmK9xeQrnqn/TMIMe0JEFu
b255bW91cyBQbGFuZXQgUmVsZWFzZSBTaWduaW5nIEtleYiTBBMWCgA7FiEEwwI9
vqP7OMQ4uh7tzsYK7ei5kqIFAmXNCfMCGwMFCwkIBwICIgIGFQoJCAsCBBYCAwEC
HgcCF4AACgkQzsYK7ei5kqJJVgD+NKdW7U/uMWl6Ov1Ye9PPy6MbIyyCYd2j5snO
60e7msQA/0rxLaeLwzraevcE+WpdPMadxP2M8MxIKrKeAkKAe+IJiHUEEBYKAB0W
IQSfpUNtDuNgmFFXOCUX7KBfdo3t9gUCZqRFIAAKCRAX7KBfdo3t9o9LAP426yx7
1EP9sLKKpkkdAT19HJgsNBeA7SdR/DtMzWEbegD/f2oQYwVz3O1w7xuUqJMHS6/b
N1E8B78JSi576up9rA2IdQQQFgoAHRYhBJ+lQ20O42CYUVc4JRfsoF92je32BQJp
508bAAoJEBfsoF92je32TM8A/2j51Jc3owAx9STceeamG5GG7inq5jRMyKlMG4Kw
1y1lAQD2kKSR9tz/l4Yhvy96WOuQYb+uG0W78T12l2c61F/xBrg4BGXNCfMSCisG
AQQBl1UBBQEBB0DOf/mxiZClX/sJqtj7Ob+pCHbsMp9Wd4SHW7/PFaUKHwMBCAeI
eAQYFgoAIBYhBMMCPb6j+zjEOLoe7c7GCu3ouZKiBQJlzQnzAhsMAAoJEM7GCu3o
uZKie1EBAL5P2th3moOj4IDdXrP6KgdBB0kYweAHix0djG1jV/1+AQDrgVyMPBbT
Eztpvc4cyyGAmI42SLM/jKbqO2yWqwVoAg==
=ww/S
-----END PGP PUBLIC KEY BLOCK-----
docs/pgp/index.md
-164
View File
@@ -1,164 +0,0 @@
---
title: "PGP"
description: "Import our GPG keys to verify our releases and signed content."
hide:
- toc
schema:
"@context": https://schema.org
"@type": Organization
"@id": https://anonymousplanet.net/
name: Anonymous Planet PGP
url: https://anonymousplanet.net/pgp/
logo: ../media/profile.png
sameAs:
- https://github.com/Anon-Planet
- https://opencollective.com/anonymousplanetorg
---
<div class="hero-block">
<div class="hero-eyebrow">Trust, but verify.</div>
<h1 class="hero-title">Our Public Keys<span class="hero-subtitle">Import. Verify. Trust nothing blindly.</span></h1>
<p class="hero-tagline">
Anonymous Planet signs all releases and communications with GnuPG (PGP) keys.
Verify fingerprints against multiple independent sources before importing.
</p>
<div class="hero-cta-row">
<a href="anonymousplanet.asc" class="hero-cta hero-cta--primary">Download Public Keyring</a>
<a href="#keys" class="hero-cta hero-cta--secondary">View Fingerprints</a>
</div>
</div>
---
## Our Keys { #keys }
The full keyring is at `https://anonymousplanet.net/pgp/anonymousplanet.asc`.<br>Always verify fingerprints against our [GitHub releases](https://github.com/Anon-Planet/thgtoa/releases) before importing.
<div class="index-grid">
<div class="index-card">
<h3 class="index-card__title">Master Signing Key (MSK)</h3>
<p class="index-card__body">Announcements, signing subkeys, and trust anchoring. The root of our web of trust.</p>
<code class="pgp-fingerprint">9FA5 436D 0EE3 6098 5157 3825 17EC A05F 768D EDF6</code>
</div>
<div class="index-card">
<h3 class="index-card__title">Release Signing Key (RSK)</h3>
<p class="index-card__body">Signs all guide releases and distribution artifacts. Check this against every release.</p>
<code class="pgp-fingerprint">C302 3DBE A3FB 38C4 38BA 1EED CEC6 0AED E8B9 92A2</code>
</div>
<div class="index-card">
<h3 class="index-card__title">Email Encryption / Signing Key (ESK)</h3>
<p class="index-card__body">Use this to send us encrypted mail or verify signed correspondence from us.</p>
<code class="pgp-fingerprint">FCBD 2CAB DEFD 1FBA 2E9E 7591 A1A8 2CD2 DD2C F890</code>
</div>
</div>
---
## Key Rotation { #rotation }
Keys may be rotated periodically. Rotation is always announced via [GitHub Releases](https://github.com/Anon-Planet/thgtoa/releases) and the [changelog](../changelog/index.md). If a key you have on file does not appear here, treat it as compromised and re-import.
---
## Public Keyring { #keyring }
<div class="donate-address-block">
<div class="donate-address-label">Keyring URL</div>
<code class="donate-address">https://anonymousplanet.net/pgp/anonymousplanet.asc</code>
</div>
```txt
-----BEGIN PGP PUBLIC KEY BLOCK-----
mDMEZc0QYxYJKwYBBAHaRw8BAQdAm8mOR8/0qWrm9Tqzfl9Ks5rjtIbQZLAR/qxH
HVGJsxi0LUFub255bW91cyBQbGFuZXQgRW1haWwgRW5jcnlwdGlvbi9TaWduaW5n
IEtleYiTBBMWCgA7FiEE/L0sq979H7ounnWRoags0t0s+JAFAmXNEGMCGwMFCwkI
BwICIgIGFQoJCAsCBBYCAwECHgcCF4AACgkQoags0t0s+JDbRAEAuZlBmMGgZ3bh
12Js9jjDcu+jhKqL4fJrJG5z9+KFkQwA/An1StA6EhcM7qlzZ5bzm2SZAbP9hQRZ
GmfaeU2P5KgHiHgEMBYKACAWIQSfpUNtDuNgmFFXOCUX7KBfdo3t9gUCaiCYTgId
AAAKCRAX7KBfdo3t9gNUAP9/SyGBYJ7s9YeqLHOJ+veQZjZYHvFGQ7yPn0Fetx0Z
LAD/UOQ8rP2QaldCMyVSG8SqfPd7n++SEAXWAl2gAo9mhg6IdQQQFgoAHRYhBJ+l
Q20O42CYUVc4JRfsoF92je32BQJmpEUQAAoJEBfsoF92je32tD8A/ir9hE8UjrJE
psG+PNfxYAwAagKUGbAMDUxQp3z+t81+AP45hYT4aR89zSQaankHLs3Lh7Cp5ael
NBe/BtfR9hCLAYkCMwQQAQgAHRYhBF7WeRgs0hkTAMDm6kyyELegkVLWBQJqIJiM
AAoJEEyyELegkVLWjZYP/j1k5vl+r0NDQXmE8hS9IKhaQPggP72iXc5RWeMQHuIv
b1laQZm64xerJNdAh0uk1bwfmJnVGfyxBUrlCgAIeVGRSlni2Rig4azaQ1IS0pqF
4sC1KzKEhEaNdkh3pJyGtP1cikcSjWeU2oYQou3/7VN3vNyW+n8OAVF+2fsC5d78
EvdpZgal+komb+J8Bt552uDbCCVI4TFIPBZmHWoXjaP6L+730YphbV7Aw0L5J6OO
ob0nzHn4X0dIvGE7Phdp2e1yNRUOSRLh8B/D5OiE9k7CaeYmJNPv5qOw/R+NgrrA
ZFnoOuwHo0D+aL9WT9q4aM/cDCEIbvhQ4l5ZhVGqZuQ9wxNCgPi3ZiZRTfk1PW4v
uMw1xGwXBKy7jDO12xWIWWv9MiwIQLw0OxSxKbr76rgucq7e7JrWr64rItu5Wm7F
8qxg2cwmDat6tFSRVWlEDy8oNkRMJNjdQJDu3ez9YOfJNnApAz94Of1XU7CUuYjY
PV88BaHdUBVtANEzy0iSDCcSj6auzLfv9dBN8cOdUxlVcrPf2jjK6JR/6qe6VWNp
wRg9VQW2fe8HJTMUt0o9qQBJUsF68KOHtIdoE4az9AyyBNKl67dKqLB9HoIItLzD
MJRcbS2p6plCTNagwPVvgtPRChll9JP3jLPVhRL2BixYVkbHUoJxsEfscTUl6Azt
tEtBbm9ueW1vdXMgUGxhbmV0IEVtYWlsIEVuY3J5cHRpb24vU2lnbmluZyBLZXkg
PGFub255bW91c3BsYW5ldEBkaXNyb290Lm9yZz6IkwQTFgoAOxYhBPy9LKve/R+6
Lp51kaGoLNLdLPiQBQJmhqXqAhsDBQsJCAcCAiICBhUKCQgLAgQWAgMBAh4HAheA
AAoJEKGoLNLdLPiQJ34A/RJT9Hyj7hT/0D1BbDU6s6YzD+/x7Pyq2+9kNSI0L77W
AQAAG+CfDrKDXJtBNKZVNFZpld3wUeoIOcAqLl7KpsVGCYh1BBAWCgAdFiEEn6VD
bQ7jYJhRVzglF+ygX3aN7fYFAmakRRAACgkQF+ygX3aN7fbypgEAnEg0IbWnpaLj
/4wU179vUZZu/Y0DE63GbJuZjj72hKUA/0xyzIgSvXByjoOkEwCn5w1+RPYXKw7Z
syERsDCUAAMIiQIzBBABCAAdFiEEXtZ5GCzSGRMAwObqTLIQt6CRUtYFAmogmIwA
CgkQTLIQt6CRUtafPQ/+LTWFU84tDZAM0Hp7bWB0dw8nP0JvNQ2WtZf0flh+r1tF
cmVnc9szZBh+zzSpY25iK5+Waa6+l1POYSQpkS67VR0Jrv9nL94YrRhqalSRWsjW
MQJO+Obu4LIRIqiMZLJlAd9Bg9FshYagbQDVDOI8v9mxqCzIVm3tBx1Jp57ATHgm
sMDWn7l1BI0SkLlG49LYxVDQ6QAx4XLCQw+JzdiJs+yExa5ymYmV61evVVbDV5UF
pEwW6nsuEDc68UN6npjr8OuGH5y+1ot1vaBderoXFZ8hRG/czzODX5L0zGDX9R2C
cGyIrv4AoXTtnbiVZGG6Vn1p3C/RMFZsVOMKvyQKh0rjcD9dqVQ4thI41o92jZ0V
K5ALjPiWe1kM4DVYgk/b46q9/8rjzYb4WJCwPQJkRBp36y26oRWM0JaY2Tobzt/H
3c8d36hQSXtjKLY27ZY5jL0N4vJaiclAuy03wKonmKlUc1ROUBEgNoZcvx6rLx6e
64G7ypOpvlQCcLT/3x+VqX+KTwf4bbigrlonFMpq2lX/uwvHDMfc9/yB5xaUKLpf
/zuk/gHKzAfKPItzEyRx5Lvql9Aywaa+/gTCZhwM3D6DzR5Q5waDXcdsptB+GZAi
5s+BTxe1a4H6PMobdNOsYDFa77QKQXtWdHkybhV5xzRRMoSdKi+zwvU77BRnwf24
OARlzRBjEgorBgEEAZdVAQUBAQdApPitK71WFqWUCycq2bWYYykmU1YFgea3q/V3
DfsbbhIDAQgHiHgEGBYKACAWIQT8vSyr3v0fui6edZGhqCzS3Sz4kAUCZc0QYwIb
DAAKCRChqCzS3Sz4kLhXAQDhI8tMCEWLu3MhG9pI8BBYH4fS7kuN8ggxqDSbRpKJ
dgEAk1CA06WvsH4/n0HmJ83sJSbmFGmEMp2RyvKbdCIW5gKYMwRlzRBIFgkrBgEE
AdpHDwEBB0CVyNrq08EGyU77is+cf7/vqDqi95rCeZvE7yRU7SYFDrQjQW5vbnlt
b3VzIFBsYW5ldCBNYXN0ZXIgU2lnbmluZyBLZXmIkgQTFgoAOxYhBJ+lQ20O42CY
UVc4JRfsoF92je32BQJlzRBIAhsDBQsJCAcCAiICBhUKCQgLAgQWAgMBAh4HAheA
AAoJEBfsoF92je32NywA+JKlENQl/Kn03FojFNC1Xw5dfNMKnDAs6lV/loSDtOYB
ALrDCc1eWeeBt0FQItPiNcGycBBbRtJciNJMu2AUQ9wCiJMEExYKADsWIQSfpUNt
DuNgmFFXOCUX7KBfdo3t9gUCZc0QSAIbAwULCQgHAgIiAgYVCgkICwIEFgIDAQIe
BwIXgAAKCRAX7KBfdo3t9jcsAQAAkqUQ1CX8qfTcWiMU0LVfDl180wqcMCzqVX+W
hIO05gEAusMJzV5Z54G3QVAi0+I1wbJwEFtG0lyI0ky7YBRD3AKIdQQQFgoAHRYh
BIs6dIkFNrrVDZN26/HLMvZ+MwKhBQJqIJYjAAoJEPHLMvZ+MwKhm7YA/Rdrap0+
zzfVtXomRmVkeIaabzxImPuYnvwvgSulFw0oAP9ZkmMjexGKnbuLc1znUNoUjKyR
SmpT0ezNJRPcB2x3DokCMwQQAQgAHRYhBF7WeRgs0hkTAMDm6kyyELegkVLWBQJq
IJcQAAoJEEyyELegkVLW2YQP/0ry3BvS1pmEl60Ty0smBtEfoYsqQOz4uMBeOYzN
IHXtFrw19XAZQjVXYRhUp9NOol6JY8KtqUg0LXQZaRWhVwbA6hMqDbFeT+l+Psu/
Ek3dghpwR6xEDSNcm3V1aznNgADcDkGLINbZ7ZW/iDnrws5JMDA0k3+Qt1d596Le
kv609g28bxGgt0YENUDFGwXTawO0PALMF3Xg4gwyGU8UELoCoUUWvCYEECqO1vWc
BrZNDNulp9ovfsC8A4BkAo6yCv6RPOJVGHaKlfsO81HvBz+pExT0S71DFX5Gm9Qo
zkDIEZKLuBji6zuhi88dm17vvDs2SKjVd9OnZhs8THbGW+4WRqU6woYMN1YJAedp
+hAaYhJjQfdnFXql7bY5f9uqiBLGy4c5BPoXGYQNi8GABCzUdoiBwsFM/DQ9L8qA
fA355CVayg3aODo/NGore3N2Gqxa0GUz21ImMRV/8EIR05zFRVHeR7gu2czDyGih
9eHadE2FAAmu2iifZcxKfe3ibSBijub11Wxkfei1gipQ/OvkEfCONVVNRyi6H9Kv
6lRP+2n93GQLxlcqxd1qW2tpAt8Pimetb0M20ZY3LkuxhXvsir3sRFRcU4dLSbld
7VdwG7AsMmmA98Tp6CKjzI9FS/JcZTDoAVw6PgDSthrK5ev2plALMtWrOg9TggYE
6a/nuDgEZc0QSBIKKwYBBAGXVQEFAQEHQP1nHDDQfCi8qGG2QJj/wmMUl8ZGEiAY
pVc/+S0ZIJEnAwEIB4h4BBgWCgAgFiEEn6VDbQ7jYJhRVzglF+ygX3aN7fYFAmXN
EEgCGwwACgkQF+ygX3aN7fbSGAD9GLAarXceWbfEUWYC4IwVJAKSHDPWSzLGgFnV
x/D3238A/RiJHKYzmigvFLL/A28WStW6P47CjNYjJCS490qG/L0GmDMEZc0J8xYJ
KwYBBAHaRw8BAQdAWIpOKf8GnTINRH7uW4oeGW4D4vfmK9xeQrnqn/TMIMe0JEFu
b255bW91cyBQbGFuZXQgUmVsZWFzZSBTaWduaW5nIEtleYiTBBMWCgA7FiEEwwI9
vqP7OMQ4uh7tzsYK7ei5kqIFAmXNCfMCGwMFCwkIBwICIgIGFQoJCAsCBBYCAwEC
HgcCF4AACgkQzsYK7ei5kqJJVgD+NKdW7U/uMWl6Ov1Ye9PPy6MbIyyCYd2j5snO
60e7msQA/0rxLaeLwzraevcE+WpdPMadxP2M8MxIKrKeAkKAe+IJiHUEEBYKAB0W
IQSfpUNtDuNgmFFXOCUX7KBfdo3t9gUCZqRFIAAKCRAX7KBfdo3t9o9LAP426yx7
1EP9sLKKpkkdAT19HJgsNBeA7SdR/DtMzWEbegD/f2oQYwVz3O1w7xuUqJMHS6/b
N1E8B78JSi576up9rA2IdQQQFgoAHRYhBJ+lQ20O42CYUVc4JRfsoF92je32BQJp
508bAAoJEBfsoF92je32TM8A/2j51Jc3owAx9STceeamG5GG7inq5jRMyKlMG4Kw
1y1lAQD2kKSR9tz/l4Yhvy96WOuQYb+uG0W78T12l2c61F/xBrg4BGXNCfMSCisG
AQQBl1UBBQEBB0DOf/mxiZClX/sJqtj7Ob+pCHbsMp9Wd4SHW7/PFaUKHwMBCAeI
eAQYFgoAIBYhBMMCPb6j+zjEOLoe7c7GCu3ouZKiBQJlzQnzAhsMAAoJEM7GCu3o
uZKie1EBAL5P2th3moOj4IDdXrP6KgdBB0kYweAHix0djG1jV/1+AQDrgVyMPBbT
Eztpvc4cyyGAmI42SLM/jKbqO2yWqwVoAg==
=ww/S
-----END PGP PUBLIC KEY BLOCK-----
```
docs/stylesheets/accessibility.css
-108
View File
@@ -1,108 +0,0 @@
.md-typeset code,
.md-typeset .admonition code {
background-color: rgba(30, 10, 40, 0.80);
border: 1px solid rgba(125, 70, 152, 0.30);
padding: 0.2em 0.4em;
border-radius: 3px;
color: var(--crt-amber);
}
.md-typeset a::after,
a:not(.btn)::after {
content: "";
position: absolute;
bottom: -3px;
left: 0;
width: 0;
height: 1px;
background: var(--bg-card);
transition: width 0.2s ease;
}
.md-typeset a:hover::after,
a:not(.btn):hover::after {
width: 100%;
}
.admonition-note,
.admonition-todo,
.admonition-important {
background: linear-gradient(180deg,
var(--bg-secondary) 0%,
rgba(0, 255, 0, 0.05) 100%
) !important;
}
.admonition-tip,
.admonition-hint,
.admonition-new {
background: linear-gradient(180deg,
var(--bg-secondary) 0%,
rgba(0, 255, 0, 0.05) 100%
) !important;
}
.admonition-caution,
.admonition-warning {
background: linear-gradient(180deg,
var(--bg-secondary) 0%,
rgba(255, 165, 0, 0.08) 100%
) !important;
}
.admonition-error,
.admonition-failure {
background: linear-gradient(180deg,
var(--bg-secondary) 0%,
rgba(239, 68, 68, 0.08) 100%
) !important;
}
.md-typeset h1,
.md-typeset h2,
.md-typeset h3,
.md-footer h4,
.md-footer p {
animation: none !important;
}
@media (prefers-contrast: high) {
.admonition-note,
.admonition-tip,
.admonition-important,
.md-typeset details.admonition {
background: var(--bg-color) !important;
}
.md-nav__link {
color: var(--text-primary) !important;
}
}
@media (prefers-reduced-motion: reduce) {
.md-typeset h1,
.md-typeset h2,
.md-typeset h3,
.md-footer h4,
.md-footer p {
animation: none !important;
}
}
code, pre, kbd,
.md-typeset code,
.md-typeset pre,
.md-typeset kbd {
font-family: 'Fira Code VF', 'Fira Code', monospace;
font-feature-settings: "calt" 1;
font-variant-ligatures: contextual;
}
@supports not (font-variation-settings: normal) {
code, pre, kbd,
.md-typeset code,
.md-typeset pre,
.md-typeset kbd {
font-family: 'Fira Code', monospace;
}
}
docs/stylesheets/extra.css
+55
View File
@@ -0,0 +1,55 @@
/* Title sheet: visible only when printing / generating PDF (not on screen). */
.pdf-title-page {
display: none;
}
@media print {
.pdf-title-page {
display: block;
box-sizing: border-box;
text-align: center;
padding: 5rem 2rem 4rem;
page-break-after: always;
}
.pdf-title-page__title {
font-size: 1.65rem;
font-weight: 700;
line-height: 1.25;
margin: 0 0 1.25rem;
}
.pdf-title-page__subtitle {
font-size: 1.05rem;
line-height: 1.4;
margin: 0 0 2rem;
}
.pdf-title-page__meta {
font-size: 0.95rem;
font-style: normal;
margin: 0;
}
}
/* Guide landing: small floating logo so opening copy flows beside it (HTML + PDF). */
.guide-intro-lead {
overflow: auto;
}
.guide-intro-lead > p:first-child {
margin-top: 0;
}
.guide-intro-lead > p:first-child img {
float: right;
max-width: 6.5rem;
height: auto;
margin: 0 0 0.5rem 1rem;
}
@media print {
.guide-intro-lead > p:first-child img {
max-width: 5rem;
}
}
docs/stylesheets/footer.css
-351
View File
@@ -1,351 +0,0 @@
.md-footer {
background-color: var(--bg-primary);
border-top: 1px solid var(--border-color);
font-family: var(--code-font);
font-size: 0.75rem;
color: var(--text-muted);
}
.md-footer-meta {
background-color: var(--bg-primary);
border-top: 1px solid var(--border-color);
}
.md-footer-meta__inner {
display: flex;
align-items: center;
justify-content: space-between;
flex-wrap: wrap;
gap: 0.5em;
padding: 0.75em 1em;
}
.md-footer-copyright {
color: var(--text-muted);
font-family: var(--code-font);
font-size: 0.72rem;
line-height: 1.5;
}
.md-footer-copyright a {
color: var(--crt-amber);
text-decoration: none;
}
.md-footer-copyright a:hover {
color: var(--crt-green);
text-decoration: underline;
}
.md-social {
display: inline-flex;
flex-wrap: nowrap;
gap: 0.75em;
align-items: center;
}
.md-social__link {
display: inline-flex;
align-items: center;
white-space: nowrap;
margin: 0;
background-color: transparent;
opacity: 0.65;
transition: opacity 0.15s ease;
}
.md-social__link:hover {
opacity: 1;
}
.md-social__link svg {
width: 20px;
height: 20px;
flex-shrink: 0;
fill: var(--crt-green);
}
.md-footer__link {
font-family: var(--code-font);
font-size: 0.75rem;
color: var(--crt-amber);
}
.md-footer__link:hover {
color: var(--crt-green);
}
@media (max-width: 60em) {
.md-social { gap: 0.5em; }
.md-social__link svg { width: 18px; height: 18px; }
.md-footer-meta__inner { flex-direction: column; align-items: flex-start; }
}
@media (prefers-reduced-motion: reduce) {
.md-footer *,
.md-footer-meta * {
animation: none !important;
}
}
@media (prefers-contrast: high) {
.md-footer { border-top: 2px solid var(--text-primary); }
.md-social__link { opacity: 1; }
}
.hero-block {
text-align: center;
padding: 4em 1em 3em;
max-width: 800px;
margin: 0 auto;
}
.hero-eyebrow {
font-family: var(--code-font);
font-size: 0.7rem;
letter-spacing: 0.2em;
text-transform: uppercase;
color: var(--text-muted);
margin-bottom: 1em;
}
.hero-eyebrow::before {
content: "// ";
color: var(--accent-green);
}
.hero-title {
font-family: var(--font-main);
font-size: clamp(2.2rem, 6vw, 3.6rem);
font-weight: 700;
line-height: 1.1;
color: var(--crt-green) !important;
margin: 0 0 0.25em;
text-shadow: 0 0 30px rgba(0, 240, 128, 0.25);
}
.hero-block .hero-title::before {
content: none !important;
}
.hero-subtitle {
color: var(--crt-amber);
display: block;
font-size: 0.65em;
font-weight: 400;
letter-spacing: 0.04em;
opacity: 0.9;
}
.hero-tagline {
font-family: var(--font-main);
font-size: 1.1rem;
color: var(--text-secondary);
line-height: 1.7;
max-width: 56ch;
margin: 1.5em auto 2em;
}
.hero-cta-row {
display: flex;
gap: 1em;
justify-content: center;
flex-wrap: wrap;
margin-top: 0.5em;
}
.hero-cta {
font-family: var(--code-font);
font-size: 0.8rem;
letter-spacing: 0.06em;
text-transform: uppercase;
padding: 0.6em 1.6em;
border-radius: 3px;
text-decoration: none;
transition: all 0.18s ease;
display: inline-block;
}
.hero-cta--primary {
background: rgba(0, 240, 128, 0.12);
border: 1px solid var(--accent-green);
color: var(--crt-green);
}
.hero-cta--primary:hover {
background: rgba(0, 240, 128, 0.22);
box-shadow: 0 0 16px rgba(0, 240, 128, 0.25);
color: var(--crt-green);
}
.hero-cta--secondary {
background: transparent;
border: 1px solid var(--border-color);
color: var(--crt-amber);
}
.hero-cta--secondary:hover {
border-color: var(--crt-amber);
color: var(--crt-amber);
background: rgba(231, 217, 163, 0.07);
}
.alert-banner {
display: flex;
align-items: flex-start;
gap: 0.75em;
background: rgba(255, 76, 76, 0.07);
border: 1px solid rgba(255, 76, 76, 0.28);
border-left: 4px solid var(--crt-red);
padding: 0.85em 1.2em;
max-width: 70ch;
margin: 2.5em auto 3em;
border-radius: 0 4px 4px 0;
font-size: 0.88rem;
color: var(--text-primary);
line-height: 1.5;
}
.alert-banner .alert-icon {
color: var(--crt-red);
font-size: 1rem;
flex-shrink: 0;
margin-top: 0.05em;
}
.alert-banner a {
color: var(--crt-red);
font-weight: 600;
}
.alert-banner a:hover {
color: #ff6b6b;
}
.alert-banner code {
font-family: var(--code-font);
font-size: 0.82em;
background: rgba(255, 76, 76, 0.12);
padding: 0.1em 0.35em;
border-radius: 3px;
color: #ff8888;
}
.index-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(240px, 1fr));
gap: 1.25em;
max-width: 1000px;
margin: 0 auto 3.5em;
}
.index-card {
background: rgba(125, 70, 152, 0.10);
border: 1px solid rgba(125, 70, 152, 0.35);
border-radius: 6px;
padding: 1.5em 1.4em 1.3em;
transition: border-color 0.18s ease, box-shadow 0.18s ease;
display: flex;
flex-direction: column;
}
.index-card:hover {
border-color: rgba(125, 70, 152, 0.70);
box-shadow: 0 4px 20px rgba(125, 70, 152, 0.15);
}
.index-card__title {
font-family: var(--code-font);
font-size: 0.9rem;
color: var(--crt-amber) !important;
margin: 0 0 0.5em;
font-weight: 600;
letter-spacing: 0.02em;
}
.index-card .index-card__title::before {
content: none !important;
}
.index-card__body {
font-size: 0.88rem;
color: var(--text-secondary);
line-height: 1.55;
flex: 1;
margin: 0 0 1em;
}
.index-card__link {
font-family: var(--code-font);
font-size: 0.75rem;
color: var(--crt-green);
text-decoration: none;
letter-spacing: 0.04em;
transition: color 0.15s ease;
margin-top: auto;
}
.index-card__link:hover {
color: var(--accent-green);
text-decoration: underline;
}
.principles-strip {
text-align: center;
font-family: var(--code-font);
font-size: 0.95rem;
letter-spacing: 0.06em;
padding: 2em 1em 3em;
color: var(--text-muted);
}
.principle-no {
color: var(--crt-green);
font-weight: 700;
}
.principle-sep {
margin: 0 0.75em;
color: var(--border-color);
}
.quick-access-card {
background: rgba(125, 70, 152, 0.10);
border: 1px solid rgba(125, 70, 152, 0.35);
border-radius: 6px;
padding: 1.4em 1.3em 1.2em;
transition: border-color 0.18s ease, box-shadow 0.18s ease;
}
.quick-access-card:hover {
border-color: rgba(125, 70, 152, 0.70);
box-shadow: 0 4px 16px rgba(125, 70, 152, 0.15);
}
.quick-access-card h3,
.quick-access-card h4 {
font-family: var(--code-font);
font-size: 0.95rem;
color: var(--crt-amber) !important;
margin: 0 0 0.5em;
font-weight: 600;
}
.quick-access-card p {
font-size: 0.88rem;
color: var(--text-secondary);
line-height: 1.55;
margin: 0 0 0.9em;
}
.quick-access-card a {
font-family: var(--code-font);
font-size: 0.78rem;
color: var(--crt-amber);
text-decoration: none;
}
.quick-access-card a:hover {
color: var(--crt-green);
text-decoration: underline;
}
docs/stylesheets/going-dark.css
-486
View File
@@ -1,486 +0,0 @@
@font-face {
font-family: 'Fira Code VF';
src: url('../fonts/fira-code/fira-code-latin-ext-wght-normal.woff2') format('woff2');
font-weight: 300 700;
font-style: normal;
font-display: block;
unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F,
U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0,
U+2113, U+2C60-2C7F, U+A720-A7FF;
}
@font-face {
font-family: 'Fira Code VF';
src: url('../fonts/fira-code/fira-code-latin-wght-normal.woff2') format('woff2');
font-weight: 300 700;
font-style: normal;
font-display: block;
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC,
U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329,
U+2000-206F, U+20AC, U+2122, U+2191, U+2193,
U+2212, U+2215, U+FEFF, U+FFFD;
}
@font-face {
font-family: 'EB Garamond';
src: url('../fonts/eb-garamond/eb-garamond-latin-ext-400-normal.woff2') format('woff2');
font-weight: 400;
font-style: normal;
font-display: block;
unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F,
U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0,
U+2113, U+2C60-2C7F, U+A720-A7FF;
}
@font-face {
font-family: 'EB Garamond';
src: url('../fonts/eb-garamond/eb-garamond-latin-400-normal.woff2') format('woff2');
font-weight: 400;
font-style: normal;
font-display: block;
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC,
U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329,
U+2000-206F, U+20AC, U+2122, U+2191, U+2193,
U+2212, U+2215, U+FEFF, U+FFFD;
}
@font-face {
font-family: 'EB Garamond';
src: url('../fonts/eb-garamond/eb-garamond-latin-ext-400-italic.woff2') format('woff2');
font-weight: 400;
font-style: italic;
font-display: block;
unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F,
U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0,
U+2113, U+2C60-2C7F, U+A720-A7FF;
}
@font-face {
font-family: 'EB Garamond';
src: url('../fonts/eb-garamond/eb-garamond-latin-400-italic.woff2') format('woff2');
font-weight: 400;
font-style: italic;
font-display: block;
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC,
U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329,
U+2000-206F, U+20AC, U+2122, U+2191, U+2193,
U+2212, U+2215, U+FEFF, U+FFFD;
}
@font-face {
font-family: 'EB Garamond';
src: url('../fonts/eb-garamond/eb-garamond-latin-ext-700-normal.woff2') format('woff2');
font-weight: 700;
font-style: normal;
font-display: block;
unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F,
U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0,
U+2113, U+2C60-2C7F, U+A720-A7FF;
}
@font-face {
font-family: 'EB Garamond';
src: url('../fonts/eb-garamond/eb-garamond-latin-700-normal.woff2') format('woff2');
font-weight: 700;
font-style: normal;
font-display: block;
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC,
U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329,
U+2000-206F, U+20AC, U+2122, U+2191, U+2193,
U+2212, U+2215, U+FEFF, U+FFFD;
}
@font-face {
font-family: 'EB Garamond';
src: url('../fonts/eb-garamond/eb-garamond-latin-ext-700-italic.woff2') format('woff2');
font-weight: 700;
font-style: italic;
font-display: block;
unicode-range: U+0100-02AF, U+0304, U+0308, U+0329, U+1E00-1E9F,
U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0,
U+2113, U+2C60-2C7F, U+A720-A7FF;
}
@font-face {
font-family: 'EB Garamond';
src: url('../fonts/eb-garamond/eb-garamond-latin-700-italic.woff2') format('woff2');
font-weight: 700;
font-style: italic;
font-display: block;
unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC,
U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329,
U+2000-206F, U+20AC, U+2122, U+2191, U+2193,
U+2212, U+2215, U+FEFF, U+FFFD;
}
:root {
--bg-color: #020307;
--bg-primary: #060d06;
--bg-secondary: #0a150a;
--bg-card: #0f1f0f;
--text-primary: #c5c5c5;
--text-secondary: #a0a0a0;
--text-muted: #6b7a6b;
--accent-green: #00f080;
--accent-green-dim: #039634;
--crt-green: #00f080;
--crt-amber: #e7d9a3;
--crt-blue: #00d9ff;
--crt-red: #ff4c4c;
--border-color: #0b85005d;
--terminal-green-glow: rgba(0, 255, 0, 0.15);
--terminal-line-color: rgba(0, 255, 0, 0.30);
--terminal-border-faint: rgba(0, 255, 0, 0.08);
--status-success: #4ade80;
--status-warning: #fbbf24;
--status-error: #ef4444;
--status-info: #60a5fa;
--code-font: 'Fira Code VF', 'Fira Code', monospace;
--font-main: 'EB Garamond', Georgia, serif;
--md-primary-fg-color: #4052b500;
--md-default-bg-color: rgba(0, 255, 0, 0.08);
}
*, *::before, *::after {
box-sizing: border-box;
}
body {
background-color: var(--bg-color);
color: var(--text-primary);
font-family: var(--font-main);
line-height: 1.6;
margin: 0;
padding: 0;
}
h1 {
color: var(--crt-green);
font-weight: 700;
margin-top: 1.5em;
margin-bottom: 0.5em;
}
h2, h3, h4, h5, h6 {
color: var(--crt-green);
font-weight: 600;
margin-top: 1.25em;
margin-bottom: 0.5em;
}
p {
color: var(--text-primary);
margin-bottom: 1rem;
}
a {
color: var(--crt-green);
}
img {
max-width: 100%;
height: auto;
display: block;
margin: 20px auto;
animation: none !important;
background: none !important;
}
table {
width: 100%;
border-collapse: collapse;
margin: 20px 0;
color: var(--text-secondary);
}
th, td {
padding: 12px;
text-align: left;
border-bottom: 1px solid var(--border-color);
}
th {
background-color: var(--bg-color);
font-weight: bold;
}
tr:last-child td {
border-bottom: none;
}
.container {
max-width: 800px;
margin: 40px auto;
padding: 20px;
}
.card {
background-color: var(--bg-color);
border: 1px solid var(--border-color);
border-radius: 8px;
padding: 20px;
margin-bottom: 20px;
}
.no-js .md-sidebar {
align-self: auto;
}
[data-md-component="content"] .md-content__inner,
.md-typeset {
}
body:has([data-md-url*="/guide/"]) .md-typeset p,
body:has([data-md-url*="/guide/"]) .md-typeset li,
body:has([data-md-url*="/guide/"]) .md-typeset dt,
body:has([data-md-url*="/guide/"]) .md-typeset dd,
body:has([data-md-url*="/guide/"]) .md-typeset blockquote p {
font-family: var(--font-main);
font-size: 18px;
line-height: 1.75;
color: var(--text-primary);
}
@media print {
@page {
size: A4;
margin: 20mm;
}
body {
background-color: var(--bg-color) !important;
color: var(--text-primary) !important;
}
.card,
table th {
-webkit-print-color-adjust: exact !important;
print-color-adjust: exact !important;
background-color: var(--bg-card) !important;
color: var(--text-primary) !important;
}
.card {
break-inside: avoid;
}
nav, footer, button {
display: none !important;
}
}
[data-md-color-scheme="default"] {
--bg-color: #ffffff;
--bg-primary: #f8f8f8;
--bg-secondary: #f0f0f0;
--bg-card: #ececec;
--text-primary: #1a1a1a;
--text-secondary: #2c2c2c;
--text-muted: #555555;
--accent-green: #006633;
--accent-green-dim: #008844;
--crt-green: #005522;
--crt-amber: #4a3800;
--crt-blue: #003d6b;
--crt-red: #8b0000;
--border-color: #cccccc;
--terminal-green-glow: rgba(0, 102, 51, 0.08);
--terminal-line-color: #bbbbbb;
--terminal-border-faint: #e0e0e0;
--status-success: #1a5c2e;
--status-warning: #7a4f00;
--status-error: #8b0000;
--status-info: #003d6b;
--md-default-bg-color: #ffffff;
--md-default-fg-color: #1a1a1a;
--md-primary-fg-color: #1a1a1a;
--md-primary-bg-color: #ffffff;
--md-typeset-color: #1a1a1a;
--md-typeset-a-color: #003d6b;
--md-code-bg-color: #f4f4f4;
--md-code-fg-color: #1a1a1a;
}
[data-md-color-scheme="default"] body::before,
[data-md-color-scheme="default"] body::after {
display: none !important;
content: none !important;
background: none !important;
animation: none !important;
}
[data-md-color-scheme="default"] h1,
[data-md-color-scheme="default"] h2,
[data-md-color-scheme="default"] h3,
[data-md-color-scheme="default"] h4,
[data-md-color-scheme="default"] h5,
[data-md-color-scheme="default"] h6,
[data-md-color-scheme="default"] .md-typeset h1,
[data-md-color-scheme="default"] .md-typeset h2,
[data-md-color-scheme="default"] .md-typeset h3,
[data-md-color-scheme="default"] .md-typeset h4,
[data-md-color-scheme="default"] .md-typeset h5,
[data-md-color-scheme="default"] .md-typeset h6 {
color: var(--crt-green) !important;
font-family: var(--font-main);
}
[data-md-color-scheme="default"] body,
[data-md-color-scheme="default"] .md-typeset {
background-color: var(--bg-color);
color: var(--text-primary);
}
[data-md-color-scheme="default"] a,
[data-md-color-scheme="default"] .md-typeset a {
color: var(--crt-blue);
}
[data-md-color-scheme="default"] img,
[data-md-color-scheme="default"] .md-typeset img {
filter: none !important;
opacity: 1;
}
[data-md-color-scheme="default"] pre,
[data-md-color-scheme="default"] .md-typeset pre, {
background: #f4f4f4 !important;
color: #1a1a1a !important;
border-left-color: #888888 !important;
box-shadow: none !important;
}
[data-md-color-scheme="default"] code,
[data-md-color-scheme="default"] .md-typeset code {
background: #eeeeee !important;
color: #1a1a1a !important;
}
[data-md-color-scheme="default"] .md-header {
background-color: #1a1a1a;
color: #e8e8e8;
}
[data-md-color-scheme="default"] .md-header__button,
[data-md-color-scheme="default"] .md-header__topic,
[data-md-color-scheme="default"] .md-header__title,
[data-md-color-scheme="default"] .md-header__ellipsis {
color: #e8e8e8 !important;
}
[data-md-color-scheme="default"] .md-header__topic::before {
color: #a8d8a8;
animation: none;
}
[data-md-color-scheme="default"] .md-tabs {
background-color: #2a2a2a;
color: #cccccc;
}
[data-md-color-scheme="default"] .md-tabs__link {
color: #cccccc !important;
opacity: 1;
}
[data-md-color-scheme="default"] .md-tabs__link--active,
[data-md-color-scheme="default"] .md-tabs__link:hover {
color: #ffffff !important;
}
[data-md-color-scheme="default"] .md-tabs__link--active::after {
background-color: #a8d8a8;
}
[data-md-color-scheme="default"] .md-search__input {
background-color: rgba(255,255,255,0.12);
color: #e8e8e8;
}
[data-md-color-scheme="default"] .md-search__input::placeholder {
color: rgba(232,232,232,0.55);
}
[data-md-color-scheme="default"] .md-source {
color: #cccccc;
}
[data-md-color-scheme="default"] .admonition {
background: #f8f8f8 !important;
border-left-color: var(--accent-green) !important;
}
[data-md-color-scheme="default"] .admonition-title {
background: #eeeeee !important;
color: #1a1a1a !important;
}
[data-md-color-scheme="default"] th {
background-color: #eeeeee !important;
border-bottom-color: var(--crt-amber) !important;
}
[data-md-color-scheme="default"] td,
[data-md-color-scheme="default"] tr {
border-color: #cccccc !important;
color: #1a1a1a !important;
}
[data-md-color-scheme="slate"] body::before {
content: "";
position: fixed;
inset: 0;
pointer-events: none;
z-index: 9999;
background:
linear-gradient(rgba(18, 32, 12, 0) 50%, rgba(0, 20, 0, 0.10) 50%),
linear-gradient(90deg, rgba(12, 36, 18, 0) 50%, rgba(0, 16, 0, 0.08) 50%);
background-size: 100% 4px, 6px 100%;
animation: scanline 4ms linear infinite;
}
@keyframes scanline {
0% { background-position: 0 0, 0 0; }
100% { background-position: 0 4px, 6px 100%; }
}
[data-md-color-scheme="slate"] body::after {
content: "";
position: fixed;
inset: 0;
pointer-events: none;
z-index: 9997;
background: radial-gradient(
ellipse at center,
transparent 50%,
rgba(0, 0, 0, 0.30) 100%
);
animation: phosphorDecay 8s ease-out infinite;
}
@keyframes phosphorDecay {
0%, 100% { opacity: 0.4; }
50% { opacity: 0.2; }
}
@media (max-width: 768px) {
[data-md-color-scheme="slate"] body::before {
background-size: 100% 2px, 3px 100%;
animation-duration: 6ms;
}
}
@media (prefers-reduced-motion: reduce) {
[data-md-color-scheme="slate"] body::before,
[data-md-color-scheme="slate"] body::after {
animation: none !important;
}
}
[data-md-color-scheme="slate"] img,
[data-md-color-scheme="slate"] .md-typeset img {
filter: brightness(1.1);
}
docs/stylesheets/hacker-extra.css
-313
View File
@@ -1,313 +0,0 @@
.command-palette {
font-family: var(--code-font);
font-size: 0.75rem;
letter-spacing: 0.1em;
text-align: center;
color: var(--text-muted);
padding: 0.5em;
border-top: 1px dashed var(--terminal-line-color);
border-bottom: 1px dashed var(--terminal-line-color);
background: linear-gradient(90deg,
transparent 0%,
rgba(0, 255, 0, 0.03) 50%,
transparent 100%
);
}
.command-palette::before,
.command-palette::after {
content: "|";
color: var(--accent-green);
animation: cursorBlink 1s step-end infinite;
}
.headerlink {
color: var(--crt-green);
font-size: 0.8rem;
margin-left: 0.5em;
opacity: 0.7;
}
pre.highlight {
box-shadow: inset 0 0 20px rgba(20, 5, 30, 0.6);
}
pre.highlight .hll {
background-color: rgba(0, 255, 0, 0.05);
}
.palette-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(200px, 1fr));
gap: 1em;
}
.palette-item {
background: var(--bg-card);
border: 1px solid var(--border-color);
border-radius: 6px;
padding: 1.5em;
text-align: center;
transition: all 0.2s ease;
cursor: pointer;
}
.palette-item:hover {
border-color: var(--accent-green);
transform: translateY(-2px);
box-shadow: 0 4px 12px rgba(0, 255, 0, 0.2);
}
.palette-item .icon-label {
font-size: 2rem;
margin-bottom: 0.5em;
}
.palette-item a {
color: var(--text-primary);
text-decoration: none;
display: block;
}
.system-notification {
position: fixed;
top: 20px;
right: 20px;
background: var(--bg-color);
border-left: 4px solid var(--accent-green);
padding: 1em 1.5em;
border-radius: 4px;
font-family: var(--code-font);
font-size: 0.8rem;
box-shadow: 0 8px 24px rgba(0, 255, 0, 0.15);
z-index: 10000;
min-width: 300px;
animation: slideInRight 0.3s ease-out;
}
@keyframes slideInRight {
from { transform: translateX(100%); opacity: 0; }
to { transform: translateX(0); opacity: 1; }
}
@media (prefers-reduced-motion: reduce) {
.command-palette::before,
.command-palette::after,
.system-notification {
animation: none;
}
}
.donate-goals-block {
background: var(--bg-card);
border: 1px solid var(--border-color);
border-left: 4px solid var(--crt-amber);
border-radius: 6px;
padding: 1.5em 2em;
margin: 2em 0;
}
.donate-goals-title {
font-family: var(--code-font);
font-size: 0.85rem;
text-transform: uppercase;
letter-spacing: 0.12em;
color: var(--crt-amber);
margin-top: 0;
margin-bottom: 0.75em;
}
.donate-goals-list {
list-style: none;
padding: 0;
margin: 0;
display: flex;
flex-direction: column;
gap: 0.5em;
}
.donate-goal {
font-family: var(--code-font);
font-size: 0.92rem;
display: flex;
align-items: center;
gap: 0.6em;
padding: 0.35em 0;
}
.donate-goal-icon {
font-size: 1rem;
width: 1.2em;
text-align: center;
flex-shrink: 0;
}
.donate-goal--done {
color: var(--status-success);
text-decoration: line-through;
opacity: 0.75;
}
.donate-goal--open {
color: var(--text-primary);
}
.donate-goal--open .donate-goal-icon {
color: var(--crt-amber);
}
.donate-stat-row {
display: flex;
gap: 1.5em;
flex-wrap: wrap;
margin: 1em 0 1.5em;
}
.donate-stat {
display: flex;
flex-direction: column;
gap: 0.2em;
background: var(--bg-card);
border: 1px solid var(--border-color);
border-radius: 6px;
padding: 0.75em 1.25em;
min-width: 160px;
}
.donate-stat-label {
font-family: var(--code-font);
font-size: 0.72rem;
text-transform: uppercase;
letter-spacing: 0.1em;
color: var(--text-muted);
}
.donate-stat-value {
font-family: var(--code-font);
font-size: 1.15rem;
font-weight: bold;
color: var(--crt-amber);
}
.donate-address-block {
background: var(--bg-card);
border: 1px solid var(--border-color);
border-radius: 8px;
padding: 1.5em;
margin: 1em 0 2em;
}
.donate-address-label {
font-family: var(--code-font);
font-size: 0.72rem;
text-transform: uppercase;
letter-spacing: 0.1em;
color: var(--text-muted);
margin-bottom: 0.4em;
}
.donate-address {
display: block;
word-break: break-all;
font-size: 0.78rem;
background: rgba(0, 0, 0, 0.3);
border: 1px solid var(--border-color);
border-radius: 4px;
padding: 0.6em 0.9em;
color: var(--accent-green);
user-select: all;
cursor: text;
}
.donate-qr {
margin-top: 1.25em;
display: flex;
gap: 1em;
}
.donate-qr img {
max-width: 150px;
height: auto;
border: 1px solid var(--border-color);
border-radius: 4px;
padding: 4px;
background: #fff;
}
.donate-qr--row {
flex-direction: row;
flex-wrap: wrap;
}
.donate-qr figure {
margin: 0;
display: flex;
flex-direction: column;
align-items: center;
gap: 0.4em;
}
.donate-qr figcaption {
font-family: var(--code-font);
font-size: 0.72rem;
color: var(--text-muted);
text-transform: uppercase;
letter-spacing: 0.08em;
}
@media (max-width: 600px) {
.donate-stat-row {
flex-direction: column;
}
.donate-address {
font-size: 0.68rem;
}
.donate-qr--row {
flex-direction: column;
}
}
.pgp-fingerprint {
display: block;
margin-top: 0.75em;
word-break: break-all;
font-size: 0.78rem;
background: rgba(0, 0, 0, 0.3);
border: 1px solid var(--border-color);
border-radius: 4px;
padding: 0.5em 0.75em;
color: var(--crt-green);
user-select: all;
cursor: text;
letter-spacing: 0.04em;
}
.maintainer-bio {
display: flex;
align-items: flex-start;
gap: 1.25em;
margin-bottom: 1.5em;
}
.maintainer-avatar {
width: 72px;
height: 72px;
border: 2px solid var(--border-color);
flex-shrink: 0;
margin: 0;
}
.maintainer-text {
flex: 1;
min-width: 0;
}
.maintainer-text p {
margin-top: 0;
}
@media (max-width: 480px) {
.maintainer-bio {
flex-direction: column;
}
}
docs/stylesheets/hacker.css
-207
View File
@@ -1,207 +0,0 @@
@keyframes cursorBlink {
0%, 49% { opacity: 1; }
50%, 100% { opacity: 0; }
}
.md-header__topic::before {
content: "λ ";
color: var(--crt-amber);
font-family: var(--code-font);
margin-right: 0.25em;
animation: cursorBlink 1s step-end infinite;
}
@keyframes terminalLoad {
from { opacity: 0; transform: translateY(25px); }
to { opacity: 1; transform: translateY(0); }
}
.md-typeset h1 {
animation: terminalLoad 200ms ease-out forwards;
}
h1, h2, h3, h4, h5, h6 {
color: var(--crt-amber);
font-family: var(--font-main);
font-weight: bold;
}
h1, h2 {
margin-right: 0.02em;
}
strong,
p strong {
text-shadow: 0 0 1px var(--border-color);
}
pre {
background: rgba(30, 10, 40, 0.85);
border-left: 3px solid rgba(125, 70, 152, 0.55);
box-shadow: inset 0 0 0 1px rgba(125, 70, 152, 0.12);
}
pre[role="presentation"] [data-line] {
color: var(--text-muted);
font-family: var(--code-font);
user-select: none;
min-width: 3em;
text-align: right;
padding-right: 1em;
}
pre code .token-keyword { color: var(--crt-blue); font-weight: bold; }
pre code .token-string { color: var(--status-success); }
pre code .token-comment { color: var(--text-muted); font-style: italic; }
kbd,
.kbd,
[data-type="kbd"] {
background: var(--bg-secondary);
border: 1px solid var(--border-color);
border-bottom: 2px solid var(--border-color);
border-radius: 4px;
padding: 0.2em 0.5em;
font-family: var(--code-font);
font-size: 0.85em;
color: var(--accent-green);
text-shadow: 0 1px 2px rgba(0, 255, 0, 0.10);
transition: all 0.1s ease;
}
kbd:hover {
border-color: var(--accent-green);
box-shadow: 0 2px 8px rgba(0, 255, 0, 0.20);
transform: translateY(-1px);
}
.admonition {
border-left: 4px solid var(--accent-green);
background: linear-gradient(180deg, transparent 0%, rgba(0, 255, 0, 0.03) 100%);
}
.admonition-title {
font-family: var(--code-font);
letter-spacing: 0.02em;
text-transform: uppercase;
font-size: 0.85em;
color: var(--accent-green);
background: var(--terminal-green-glow);
padding: 0.4em 0.8em;
border-radius: 4px 0 0 4px;
}
.md-typeset details.admonition {
border: 1px solid var(--border-color);
background: var(--bg-primary);
border-radius: 6px;
overflow: hidden;
}
.md-typeset table:not([class]) {
font-family: var(--code-font);
font-size: 0.95em;
}
.md-typeset__table th {
background: var(--bg-secondary);
border-bottom: 2px solid var(--crt-amber);
font-weight: 700;
letter-spacing: 0.05em;
}
.md-typeset__table tr:hover {
background-color: var(--bg-primary);
}
blockquote {
border-left: 3px solid var(--accent-green);
margin: 1.5em 0;
padding-left: 1.5em;
background: linear-gradient(90deg, rgba(0, 255, 0, 0.05) 0%, transparent 100%);
}
blockquote p:first-of-type::before {
content: "› ";
color: var(--accent-green);
font-family: var(--code-font);
}
.md-typeset mark,
.highlight-mark {
background-color: rgba(255, 235, 0, 0.30);
color: inherit;
padding: 0.1em;
border-radius: 2px;
}
.status-indicator {
display: inline-flex;
align-items: center;
gap: 0.5em;
font-family: var(--code-font);
font-size: 0.85em;
text-transform: uppercase;
letter-spacing: 0.1em;
padding: 0.25em 0.5em;
border-radius: 4px;
}
.status-success { color: var(--status-success); background: rgba(74, 222, 128, 0.10); border: 1px solid rgba(74, 222, 128, 0.30); }
.status-warning { color: var(--status-warning); background: rgba(251, 191, 36, 0.10); border: 1px solid rgba(251, 191, 36, 0.30); }
.status-error { color: var(--status-error); background: rgba(239, 68, 68, 0.10); border: 1px solid rgba(239, 68, 68, 0.30); }
.status-info { color: var(--status-info); background: rgba(96, 165, 250, 0.10); border: 1px solid rgba(96, 165, 250, 0.30); }
.terminal-window {
background: linear-gradient(180deg, var(--bg-primary) 0%, var(--bg-card) 100%);
border: 2px solid var(--border-color);
border-radius: 8px;
padding: 1.5em;
position: relative;
box-shadow: 0 8px 32px rgba(0, 255, 0, 0.10);
}
.terminal-window::before {
content: "";
position: absolute;
top: -2px;
left: -2px;
right: -2px;
height: 3px;
background: linear-gradient(90deg, transparent, var(--accent-green), transparent);
opacity: 0.5;
}
::-webkit-scrollbar { width: 8px; height: 8px; }
::-webkit-scrollbar-track { background: var(--bg-primary); }
::-webkit-scrollbar-thumb { background: var(--terminal-green-glow); border-radius: 4px; }
::-webkit-scrollbar-thumb:hover { background: var(--accent-green-dim); }
.btn {
font-family: var(--code-font);
text-transform: uppercase;
letter-spacing: 0.05em;
font-size: 0.85em;
transition: all 0.2s ease;
}
@media (max-width: 768px) {
[data-md-color-scheme="slate"] body::before {
background-size: 100% 2px, 3px 100%;
animation-duration: 6ms;
}
}
@media (prefers-contrast: high) {
:root {
--accent-green: #fff;
--bg-primary: #000;
}
}
@media (prefers-reduced-motion: reduce) {
.md-header__topic::before,
.md-typeset h1 {
animation: none;
}
}
docs/stylesheets/navigation.css
-97
View File
@@ -1,97 +0,0 @@
.md-sidebar {
background-color: var(--bg-color);
}
.md-sidebar__scrollwrap {
overflow-x: hidden;
}
.md-header__topic {
font-family: var(--code-font);
font-size: 0.62rem;
letter-spacing: -0.02em;
opacity: 0.75;
}
.md-header__title {
font-size: 0.7rem;
}
.md-typeset h1::before {
content: "λ ";
color: var(--text-primary);
font-family: var(--code-font);
white-space: pre;
}
.md-nav__link {
font-family: var(--code-font);
font-size: 0.6rem;
letter-spacing: 0.01em;
color: var(--crt-amber);
transition: color 0.15s ease;
}
.md-nav--primary > .md-nav__list > .md-nav__item > .md-nav__link {
font-weight: 600;
}
.md-nav__link--active,
.md-nav__link[aria-current] {
color: var(--accent-green) !important;
font-weight: 600;
border-left: 2px solid var(--accent-green);
padding-left: 0.5em;
background-color: rgba(0, 255, 0, 0.06);
border-radius: 0 3px 3px 0;
}
.md-nav__link:hover {
color: var(--crt-green);
}
.md-nav__link:focus-visible {
outline: 1px solid var(--accent-green);
outline-offset: 2px;
border-radius: 2px;
}
[data-md-color-scheme="slate"] {
--md-default-bg-color: var(--bg-primary);
}
.md-header__button.md-icon {
padding: 0.5em;
animation: none;
}
.md-typeset {
max-width: none;
}
.md-typeset a {
color: var(--crt-green);
word-break: break-word;
}
@keyframes fadeIn {
from { opacity: 0; transform: translateY(-10px); }
to { opacity: 1; transform: translateY(0); }
}
.md-typeset h1,
.md-typeset h2,
.md-typeset h3 {
animation: fadeIn 0.4s ease-out;
}
.md-footer-meta {
background-color: var(--bg-primary);
border-top: 1px solid var(--border-color);
}
@media screen and (min-width: 76.25em) {
.md-main__inner {
flex-direction: row-reverse;
}
}
docs/stylesheets/print-light.css
-309
View File
@@ -1,309 +0,0 @@
@media print {
/* Reset all custom properties to light values */
:root,
[data-md-color-scheme],
[data-md-color-scheme="slate"] {
--bg-color: #ffffff;
--bg-primary: #ffffff;
--bg-secondary: #f8f8f8;
--bg-card: #f4f4f4;
--text-primary: #1a1a1a;
--text-secondary: #2c2c2c;
--text-muted: #555555;
--accent-green: #005c2e;
--accent-green-dim: #007a3d;
--crt-green: #005c2e;
--crt-amber: #5c4000;
--crt-blue: #00487a;
--crt-red: #8b0000;
--border-color: #cccccc;
--terminal-green-glow: transparent;
--terminal-line-color: #aaaaaa;
--terminal-border-faint: #dddddd;
--status-success: #1a5c2e;
--status-warning: #7a4f00;
--status-error: #8b0000;
--status-info: #003d6b;
--md-default-bg-color: #ffffff;
--md-default-fg-color: #1a1a1a;
--md-primary-fg-color: #1a1a1a;
--md-typeset-color: #1a1a1a;
--md-typeset-a-color: #00487a;
}
html, body {
background: #ffffff !important;
color: #1a1a1a !important;
font-family: 'EB Garamond', Georgia, 'Times New Roman', serif !important;
font-size: 11pt !important;
line-height: 1.65 !important;
margin: 0 !important;
padding: 0 !important;
}
body::before,
body::after {
display: none !important;
content: none !important;
background: none !important;
animation: none !important;
}
@page {
size: A4;
margin: 25mm 28mm 28mm 28mm;
}
@page :first {
margin-top: 30mm;
}
*, *::before, *::after {
animation: none !important;
transition: none !important;
text-shadow: none !important;
box-shadow: none !important;
}
/* Hide footnotes and inline reference superscripts in PDF output */
.footnote,
.md-typeset .footnote,
section.footnotes,
.md-typeset section.footnotes,
[id^="fn:"],
.md-typeset [id^="fn:"] {
display: none !important;
}
/* Hide inline footnote back-reference superscripts [^N] */
sup.footnote-ref,
.md-typeset sup.footnote-ref,
a.footnote-backref,
.md-typeset a.footnote-backref,
sup > a[href^="#fn"],
.md-typeset sup > a[href^="#fn"],
sup > a[href^="#fnref"],
.md-typeset sup > a[href^="#fnref"] {
display: none !important;
}
.md-header,
.md-footer,
.md-sidebar,
.md-nav,
.md-search,
.md-tabs,
.md-social,
.md-top,
[data-md-component="header"],
[data-md-component="sidebar"],
[data-md-component="footer"],
[data-md-component="toc"],
.headerlink,
.md-content__button {
display: none !important;
}
.md-main,
.md-main__inner,
.md-content {
display: block !important;
width: 100% !important;
max-width: 100% !important;
margin: 0 !important;
padding: 0 !important;
float: none !important;
}
.md-content__inner {
display: block !important;
width: 100% !important;
max-width: 100% !important;
margin: 0 !important;
padding: 0 0 0 12mm !important;
float: none !important;
}
h1, h2, h3, h4, h5, h6,
.md-typeset h1,
.md-typeset h2,
.md-typeset h3,
.md-typeset h4,
.md-typeset h5,
.md-typeset h6 {
color: #1a1a1a !important;
font-family: 'EB Garamond', Georgia, serif !important;
font-weight: 700 !important;
page-break-after: avoid;
break-after: avoid;
}
.md-typeset h1::before,
.md-typeset h2::before {
content: none !important;
}
h1, .md-typeset h1 { font-size: 20pt !important; margin: 18pt 0 6pt !important; }
h2, .md-typeset h2 { font-size: 15pt !important; margin: 14pt 0 5pt !important; }
h3, .md-typeset h3 { font-size: 12pt !important; margin: 10pt 0 4pt !important; }
h4, .md-typeset h4 { font-size: 11pt !important; margin: 8pt 0 3pt !important; }
h5, h6,
.md-typeset h5,
.md-typeset h6 { font-size: 10pt !important; margin: 6pt 0 2pt !important; }
p, li, dt, dd, blockquote p,
.md-typeset p,
.md-typeset li,
.md-typeset dt,
.md-typeset dd {
color: #1a1a1a !important;
font-family: 'EB Garamond', Georgia, serif !important;
font-size: 11pt !important;
line-height: 1.65 !important;
orphans: 3;
widows: 3;
}
a, .md-typeset a {
color: #00487a !important;
text-decoration: underline !important;
}
code, .md-typeset code {
font-family: 'Fira Code VF', 'Fira Code', 'Courier New', monospace !important;
font-size: 9pt !important;
background: #f4f4f4 !important;
color: #1a1a1a !important;
border: 1px solid #cccccc !important;
padding: 0.1em 0.3em !important;
border-radius: 2px !important;
}
pre, .md-typeset pre {
font-family: 'Fira Code VF', 'Fira Code', 'Courier New', monospace !important;
font-size: 8.5pt !important;
background: #f8f8f8 !important;
color: #1a1a1a !important;
border: 1px solid #cccccc !important;
border-left: 3px solid #555555 !important;
padding: 0.75em 1em !important;
white-space: pre-wrap !important;
word-break: break-all !important;
page-break-inside: avoid;
break-inside: avoid;
}
pre code, .md-typeset pre code {
background: none !important;
border: none !important;
padding: 0 !important;
font-size: inherit !important;
}
table, .md-typeset table {
border-collapse: collapse !important;
width: 100% !important;
page-break-inside: avoid;
break-inside: avoid;
font-size: 10pt !important;
}
th, .md-typeset th {
background: #eeeeee !important;
color: #1a1a1a !important;
border: 1px solid #aaaaaa !important;
padding: 5pt 8pt !important;
font-weight: 700 !important;
}
td, .md-typeset td {
color: #1a1a1a !important;
border: 1px solid #cccccc !important;
padding: 4pt 8pt !important;
}
tr:nth-child(even) td {
background: #f9f9f9 !important;
}
.admonition,
.md-typeset .admonition,
details.admonition {
background: #f8f8f8 !important;
border-left: 4px solid #555555 !important;
border: 1px solid #cccccc !important;
color: #1a1a1a !important;
page-break-inside: avoid;
break-inside: avoid;
}
.admonition-title,
.md-typeset .admonition-title {
background: #eeeeee !important;
color: #1a1a1a !important;
}
blockquote, .md-typeset blockquote {
border-left: 3px solid #999999 !important;
background: none !important;
color: #333333 !important;
padding-left: 1em !important;
margin: 0.75em 0 !important;
}
blockquote p::before,
.md-typeset blockquote p:first-of-type::before {
content: none !important;
}
img,
.md-typeset img,
figure img,
[data-md-color-scheme="slate"] img,
[data-md-color-scheme="slate"] .md-typeset img {
display: block !important;
margin-left: auto !important;
margin-right: auto !important;
max-width: 100% !important;
height: auto !important;
page-break-inside: avoid;
break-inside: avoid;
filter: none !important;
-webkit-filter: none !important;
opacity: 1 !important;
mix-blend-mode: normal !important;
image-rendering: auto !important;
-webkit-print-color-adjust: exact !important;
print-color-adjust: exact !important;
}
html::before, html::after,
body::before, body::after,
[data-md-color-scheme="slate"] body::before,
[data-md-color-scheme="slate"] body::after,
.md-header::before, .md-header::after {
display: none !important;
content: none !important;
background: none !important;
animation: none !important;
opacity: 0 !important;
position: static !important;
}
kbd, .md-typeset kbd {
background: #eeeeee !important;
border: 1px solid #aaaaaa !important;
border-bottom: 2px solid #888888 !important;
color: #1a1a1a !important;
font-family: 'Fira Code VF', 'Fira Code', monospace !important;
text-shadow: none !important;
box-shadow: none !important;
}
}
docs/stylesheets/toggle.css
-581
View File
@@ -1,581 +0,0 @@
/* Adapted from a holographic toggle concept (Uiverse.io by reglobby), recolored to match site palette */
.toggle-container {
position: relative;
width: 150px;
display: flex;
flex-direction: column;
align-items: center;
perspective: 800px;
z-index: 5;
}
.toggle-wrap {
position: relative;
width: 100%;
flex: 0 0 auto;
align-self: stretch;
height: 60px;
transform-style: preserve-3d;
}
.toggle-input {
position: absolute;
opacity: 0;
width: 0;
height: 0;
}
.toggle-track {
position: absolute;
width: 100%;
height: 100%;
background: rgba(0, 30, 10, 0.4);
border-radius: 30px;
cursor: pointer;
box-shadow:
0 0 15px rgba(0, 240, 128, 0.15),
inset 0 0 10px rgba(0, 0, 0, 0.8);
overflow: hidden;
backdrop-filter: blur(5px);
transition: all 0.6s cubic-bezier(0.23, 1, 0.32, 1);
border: 1px solid rgba(0, 240, 128, 0.3);
}
.toggle-track::before {
content: "";
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
background: radial-gradient(
ellipse at center,
rgba(0, 240, 128, 0.1) 0%,
rgba(0, 0, 0, 0) 70%
),
linear-gradient(90deg, rgba(0, 90, 40, 0.1) 0%, rgba(0, 30, 10, 0.2) 100%);
opacity: 0.6;
transition: all 0.6s cubic-bezier(0.23, 1, 0.32, 1);
}
.toggle-track::after {
content: "";
position: absolute;
top: 2px;
left: 2px;
right: 2px;
height: 10px;
background: linear-gradient(
90deg,
rgba(0, 240, 128, 0.3) 0%,
rgba(3, 150, 52, 0.1) 100%
);
border-radius: 30px 30px 0 0;
opacity: 0.7;
filter: blur(1px);
}
.track-lines {
position: absolute;
top: 50%;
left: 0;
width: 100%;
height: 1px;
transform: translateY(-50%);
overflow: hidden;
}
.track-line {
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
background: repeating-linear-gradient(
90deg,
rgba(0, 240, 128, 0.3) 0px,
rgba(0, 240, 128, 0.3) 5px,
transparent 5px,
transparent 15px
);
animation: track-line-move 3s linear infinite;
}
@keyframes track-line-move {
0% { transform: translateX(0); }
100% { transform: translateX(20px); }
}
.toggle-thumb {
position: absolute;
width: 54px;
height: 54px;
left: 3px;
top: 3px;
background: radial-gradient(
circle,
rgba(10, 60, 30, 0.9) 0%,
rgba(0, 30, 15, 0.8) 100%
);
border-radius: 50%;
box-shadow:
0 2px 15px rgba(0, 0, 0, 0.5),
inset 0 0 15px rgba(0, 240, 128, 0.5);
transition: all 0.6s cubic-bezier(0.23, 1, 0.32, 1);
z-index: 2;
border: 1px solid rgba(0, 240, 128, 0.6);
overflow: hidden;
transform-style: preserve-3d;
}
.thumb-core {
position: absolute;
width: 40px;
height: 40px;
top: 50%;
left: 50%;
transform: translate(-50%, -50%);
background: radial-gradient(
circle,
rgba(0, 240, 128, 0.6) 0%,
rgba(3, 150, 52, 0.2) 100%
);
border-radius: 50%;
box-shadow: 0 0 20px rgba(0, 240, 128, 0.5);
opacity: 0.9;
transition: all 0.6s cubic-bezier(0.23, 1, 0.32, 1);
}
.thumb-inner {
position: absolute;
width: 25px;
height: 25px;
top: 50%;
left: 50%;
transform: translate(-50%, -50%);
background: radial-gradient(
circle,
rgba(255, 255, 255, 0.8) 0%,
rgba(150, 255, 200, 0.5) 100%
);
border-radius: 50%;
box-shadow: 0 0 10px rgba(150, 255, 200, 0.7);
opacity: 0.7;
transition: all 0.6s cubic-bezier(0.23, 1, 0.32, 1);
animation: pulse 2s infinite alternate;
}
@keyframes pulse {
0% { opacity: 0.5; transform: translate(-50%, -50%) scale(0.9); }
100% { opacity: 0.8; transform: translate(-50%, -50%) scale(1.1); }
}
.thumb-scan {
position: absolute;
width: 100%;
height: 5px;
background: linear-gradient(
90deg,
rgba(0, 0, 0, 0) 0%,
rgba(0, 240, 128, 0.5) 20%,
rgba(255, 255, 255, 0.8) 50%,
rgba(0, 240, 128, 0.5) 80%,
rgba(0, 0, 0, 0) 100%
);
top: 0;
left: 0;
filter: blur(1px);
animation: thumb-scan 2s linear infinite;
opacity: 0.7;
}
@keyframes thumb-scan {
0% { top: -5px; opacity: 0; }
20% { opacity: 0.7; }
80% { opacity: 0.7; }
100% { top: 54px; opacity: 0; }
}
.thumb-particles {
position: absolute;
width: 100%;
height: 100%;
top: 0;
left: 0;
overflow: hidden;
}
.thumb-particle {
position: absolute;
width: 3px;
height: 3px;
background: rgba(150, 255, 200, 0.8);
border-radius: 50%;
box-shadow: 0 0 5px rgba(150, 255, 200, 0.8);
animation: thumb-particle-float 3s infinite ease-out;
opacity: 0;
}
.thumb-particle:nth-child(1) { top: 70%; left: 30%; animation-delay: 0.2s; }
.thumb-particle:nth-child(2) { top: 60%; left: 60%; animation-delay: 0.6s; }
.thumb-particle:nth-child(3) { top: 50%; left: 40%; animation-delay: 1s; }
.thumb-particle:nth-child(4) { top: 40%; left: 70%; animation-delay: 1.4s; }
.thumb-particle:nth-child(5) { top: 80%; left: 50%; animation-delay: 1.8s; }
@keyframes thumb-particle-float {
0% { transform: translateY(0) scale(1); opacity: 0; }
20% { opacity: 0.8; }
100% { transform: translateY(-30px) scale(0); opacity: 0; }
}
.toggle-data {
position: absolute;
width: 100%;
height: 100%;
z-index: 1;
}
.data-text {
position: absolute;
font-family: var(--code-font, monospace);
font-size: 12px;
font-weight: 500;
letter-spacing: 1px;
text-transform: uppercase;
transition: all 0.5s ease;
}
.data-text.off {
right: 12px;
top: 50%;
transform: translateY(-50%);
opacity: 1;
color: rgba(0, 240, 128, 0.6);
text-shadow: 0 0 5px rgba(0, 240, 128, 0.4);
}
.data-text.on {
left: 15px;
top: 50%;
transform: translateY(-50%);
opacity: 0;
color: rgba(231, 217, 163, 0.7);
text-shadow: 0 0 5px rgba(231, 217, 163, 0.4);
}
.status-indicator {
position: absolute;
width: 10px;
height: 10px;
border-radius: 50%;
background: radial-gradient(
circle,
rgba(0, 240, 128, 0.8) 0%,
rgba(3, 150, 52, 0.4) 100%
);
box-shadow: 0 0 10px rgba(0, 240, 128, 0.5);
animation: blink 2s infinite alternate;
transition: all 0.6s cubic-bezier(0.23, 1, 0.32, 1);
}
.status-indicator.off { top: 25px; right: 15px; }
.status-indicator.on {
top: 25px;
left: 15px;
opacity: 0;
background: radial-gradient(
circle,
rgba(231, 217, 163, 0.8) 0%,
rgba(180, 160, 100, 0.4) 100%
);
box-shadow: 0 0 10px rgba(231, 217, 163, 0.5);
}
@keyframes blink {
0%, 100% { opacity: 0.5; transform: scale(0.9); }
50% { opacity: 1; transform: scale(1.1); }
}
.energy-rings {
position: absolute;
width: 54px;
height: 54px;
left: 3px;
top: 3px;
pointer-events: none;
z-index: 1;
transition: all 0.6s cubic-bezier(0.23, 1, 0.32, 1);
}
.energy-ring {
position: absolute;
top: 50%;
left: 50%;
transform: translate(-50%, -50%);
border-radius: 50%;
border: 2px solid transparent;
opacity: 0;
}
.energy-ring:nth-child(1) {
width: 50px;
height: 50px;
border-top-color: rgba(0, 240, 128, 0.5);
border-right-color: rgba(0, 240, 128, 0.3);
animation: spin 3s linear infinite;
}
.energy-ring:nth-child(2) {
width: 40px;
height: 40px;
border-bottom-color: rgba(0, 240, 128, 0.5);
border-left-color: rgba(0, 240, 128, 0.3);
animation: spin 2s linear infinite reverse;
}
.energy-ring:nth-child(3) {
width: 30px;
height: 30px;
border-left-color: rgba(0, 240, 128, 0.5);
border-top-color: rgba(0, 240, 128, 0.3);
animation: spin 1.5s linear infinite;
}
@keyframes spin {
0% { transform: translate(-50%, -50%) rotate(0deg); }
100% { transform: translate(-50%, -50%) rotate(360deg); }
}
.interface-lines {
position: absolute;
width: 100%;
height: 100%;
pointer-events: none;
}
.interface-line {
position: absolute;
background: rgba(0, 240, 128, 0.3);
transition: all 0.6s cubic-bezier(0.23, 1, 0.32, 1);
}
.interface-line:nth-child(1) { width: 15px; height: 1px; bottom: -5px; left: 20px; }
.interface-line:nth-child(2) { width: 1px; height: 8px; bottom: -12px; left: 35px; }
.interface-line:nth-child(3) { width: 25px; height: 1px; bottom: -12px; left: 35px; }
.interface-line:nth-child(4) { width: 15px; height: 1px; bottom: -5px; right: 20px; }
.interface-line:nth-child(5) { width: 1px; height: 8px; bottom: -12px; right: 35px; }
.interface-line:nth-child(6) { width: 25px; height: 1px; bottom: -12px; right: 10px; }
.toggle-reflection {
position: absolute;
width: 100%;
height: 100%;
top: 0;
left: 0;
background: linear-gradient(
135deg,
rgba(255, 255, 255, 0.1) 0%,
rgba(255, 255, 255, 0) 40%
);
border-radius: 30px;
pointer-events: none;
}
.toggle-label {
position: relative;
margin-top: 20px;
font-family: var(--code-font, monospace);
font-size: 14px;
text-transform: uppercase;
letter-spacing: 2px;
text-align: center;
color: rgba(0, 240, 128, 0.7);
text-shadow: 0 0 10px rgba(0, 240, 128, 0.5);
transition: all 0.6s cubic-bezier(0.23, 1, 0.32, 1);
}
.holo-glow {
position: absolute;
width: 100%;
height: 100%;
border-radius: 30px;
background: radial-gradient(
ellipse at center,
rgba(0, 240, 128, 0.2) 0%,
rgba(0, 0, 0, 0) 70%
);
filter: blur(10px);
opacity: 0.5;
transition: all 0.6s cubic-bezier(0.23, 1, 0.32, 1);
z-index: 0;
}
/* checked state = "default" (light/printing press) scheme, amber accent.
Bound to both :checked AND the page's actual data-md-color-scheme so the
toggle can never visually drift from the real active palette (e.g. on
load, before the init script has a chance to sync the checkbox). */
body[data-md-color-scheme="default"] .toggle-input + .toggle-track,
.toggle-input:checked + .toggle-track {
background: rgba(40, 32, 10, 0.4);
border-color: rgba(231, 217, 163, 0.4);
box-shadow:
0 0 15px rgba(231, 217, 163, 0.2),
inset 0 0 10px rgba(0, 0, 0, 0.8);
}
.toggle-input:checked + .toggle-track::before, body[data-md-color-scheme="default"] .toggle-input + .toggle-track::before {
background: radial-gradient(
ellipse at center,
rgba(231, 217, 163, 0.1) 0%,
rgba(0, 0, 0, 0) 70%
),
linear-gradient(90deg, rgba(120, 100, 50, 0.1) 0%, rgba(40, 32, 10, 0.2) 100%);
}
.toggle-input:checked + .toggle-track::after, body[data-md-color-scheme="default"] .toggle-input + .toggle-track::after {
background: linear-gradient(
90deg,
rgba(231, 217, 163, 0.3) 0%,
rgba(180, 160, 100, 0.1) 100%
);
}
.toggle-input:checked + .toggle-track .track-line, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .track-line {
background: repeating-linear-gradient(
90deg,
rgba(231, 217, 163, 0.3) 0px,
rgba(231, 217, 163, 0.3) 5px,
transparent 5px,
transparent 15px
);
animation-direction: reverse;
}
.toggle-input:checked + .toggle-track .toggle-thumb, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .toggle-thumb {
left: calc(100% - 57px);
background: radial-gradient(
circle,
rgba(90, 75, 30, 0.9) 0%,
rgba(50, 40, 15, 0.8) 100%
);
border-color: rgba(231, 217, 163, 0.6);
box-shadow:
0 2px 15px rgba(0, 0, 0, 0.5),
inset 0 0 15px rgba(231, 217, 163, 0.5);
}
.toggle-input:checked + .toggle-track .thumb-core, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .thumb-core {
background: radial-gradient(
circle,
rgba(231, 217, 163, 0.6) 0%,
rgba(120, 100, 50, 0.2) 100%
);
box-shadow: 0 0 20px rgba(231, 217, 163, 0.5);
}
.toggle-input:checked + .toggle-track .thumb-inner, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .thumb-inner {
background: radial-gradient(
circle,
rgba(255, 255, 255, 0.8) 0%,
rgba(255, 240, 200, 0.5) 100%
);
box-shadow: 0 0 10px rgba(255, 240, 200, 0.7);
}
.toggle-input:checked + .toggle-track .thumb-scan, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .thumb-scan {
background: linear-gradient(
90deg,
rgba(0, 0, 0, 0) 0%,
rgba(231, 217, 163, 0.5) 20%,
rgba(255, 255, 255, 0.8) 50%,
rgba(231, 217, 163, 0.5) 80%,
rgba(0, 0, 0, 0) 100%
);
}
.toggle-input:checked + .toggle-track .thumb-particle, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .thumb-particle {
background: rgba(255, 240, 200, 0.8);
box-shadow: 0 0 5px rgba(255, 240, 200, 0.8);
}
.toggle-input:checked + .toggle-track .data-text.off, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .data-text.off { opacity: 0; }
.toggle-input:checked + .toggle-track .data-text.on, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .data-text.on { opacity: 1; }
.toggle-input:checked + .toggle-track .status-indicator.off, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .status-indicator.off { opacity: 0; }
.toggle-input:checked + .toggle-track .status-indicator.on, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .status-indicator.on { opacity: 1; }
.toggle-input:checked + .toggle-track .energy-rings, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .energy-rings { left: calc(100% - 57px); }
.toggle-input:checked + .toggle-track .energy-ring, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .energy-ring { opacity: 1; }
.toggle-input:checked + .toggle-track .energy-ring:nth-child(1), body[data-md-color-scheme="default"] .toggle-input + .toggle-track .energy-ring:nth-child(1) {
border-top-color: rgba(231, 217, 163, 0.5);
border-right-color: rgba(231, 217, 163, 0.3);
}
.toggle-input:checked + .toggle-track .energy-ring:nth-child(2), body[data-md-color-scheme="default"] .toggle-input + .toggle-track .energy-ring:nth-child(2) {
border-bottom-color: rgba(231, 217, 163, 0.5);
border-left-color: rgba(231, 217, 163, 0.3);
}
.toggle-input:checked + .toggle-track .energy-ring:nth-child(3), body[data-md-color-scheme="default"] .toggle-input + .toggle-track .energy-ring:nth-child(3) {
border-left-color: rgba(231, 217, 163, 0.5);
border-top-color: rgba(231, 217, 163, 0.3);
}
.toggle-input:checked + .toggle-track .interface-line, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .interface-line {
background: rgba(231, 217, 163, 0.3);
}
.toggle-input:checked ~ .toggle-label, body[data-md-color-scheme="default"] .toggle-input ~ .toggle-label {
color: rgba(231, 217, 163, 0.7);
text-shadow: 0 0 10px rgba(231, 217, 163, 0.5);
}
.toggle-input:checked + .toggle-track .holo-glow, body[data-md-color-scheme="default"] .toggle-input + .toggle-track .holo-glow {
background: radial-gradient(
ellipse at center,
rgba(231, 217, 163, 0.2) 0%,
rgba(0, 0, 0, 0) 70%
);
}
.toggle-input:hover + .toggle-track {
box-shadow:
0 0 20px rgba(0, 240, 128, 0.3),
inset 0 0 10px rgba(0, 0, 0, 0.8);
}
.toggle-input:checked:hover + .toggle-track, body[data-md-color-scheme="default"] .toggle-input:hover + .toggle-track {
box-shadow:
0 0 20px rgba(231, 217, 163, 0.3),
inset 0 0 10px rgba(0, 0, 0, 0.8);
}
.toggle-container--header {
width: 80px;
margin: 0 8px;
}
.toggle-container--header .toggle-wrap {
height: 32px;
}
.toggle-container--header .toggle-thumb,
.toggle-container--header .energy-rings { width: 28px; height: 28px; }
.toggle-container--header .thumb-core { width: 20px; height: 20px; }
.toggle-container--header .thumb-inner { width: 12px; height: 12px; }
.toggle-container--header .data-text { font-size: 8px; }
.toggle-container--header .toggle-label { display: none; }
.toggle-container--header .energy-ring:nth-child(1) { width: 26px; height: 26px; }
.toggle-container--header .energy-ring:nth-child(2) { width: 20px; height: 20px; }
.toggle-container--header .energy-ring:nth-child(3) { width: 15px; height: 15px; }
.toggle-input:checked + .toggle-track .toggle-thumb,
.toggle-container--header .toggle-input:checked + .toggle-track .toggle-thumb,
body[data-md-color-scheme="default"] .toggle-container--header .toggle-input + .toggle-track .toggle-thumb {
left: calc(100% - 31px);
}
.toggle-container--header .toggle-input:checked + .toggle-track .energy-rings,
body[data-md-color-scheme="default"] .toggle-container--header .toggle-input + .toggle-track .energy-rings {
left: calc(100% - 31px);
}
docs/twitter/index.md
+10
View File
@@ -0,0 +1,10 @@
---
title: Notice
---
# Anonymous Planet has left Twitter
Anonymous Planet has moved to Mastodon. This was largely due to Twitter being owned by Elon Musk, the $8 fees, and recent security issues that have come to light. We do not regret this decision, as it has only gotten worse for Twitter users since.
- [Twitter $8 Fee Exploited by Cybercriminals](https://heimdalsecurity.com/blog/twitter-8-fee-exploited-by-cybercriminals/)
Our mastodon can be found at [@anonymousplanet@mastodon.social](https://mastodon.social/@anonymousplanet)
docs/verify/index.md
-146
View File
@@ -1,146 +0,0 @@
---
title: "Verify"
description: "Verify the authenticity and integrity of Anonymous Planet releases."
hide:
- toc
schema:
"@context": https://schema.org
"@type": Organization
"@id": https://anonymousplanet.net/
name: Anonymous Planet
url: https://anonymousplanet.net/verify/
logo: ../media/profile.png
---
<div class="hero-block">
<div class="hero-eyebrow">Never blindly trust anything you download.</div>
<h1 class="hero-title">Verify Releases<span class="hero-subtitle">Signatures. Hashes. Trust nothing blindly.</span></h1>
<p class="hero-tagline">
Every release is GPG-signed and hashed. Verify before you read.
</p>
<div class="hero-cta-row">
<a href="#quick-verification" class="hero-cta hero-cta--primary">Quick Verification</a>
<a href="../pgp/" class="hero-cta hero-cta--secondary">Import Our Keys</a>
</div>
</div>
---
## What We Publish { #artifacts }
<div class="index-grid">
<div class="index-card">
<h3 class="index-card__title">PDF Guide</h3>
<p class="index-card__body"><code>thgtoa.pdf</code> and <code>thgtoa-dark.pdf</code> — the full guide in light and dark mode. The only canonical single-file export.</p>
<a href="https://github.com/Anon-Planet/thgtoa/releases" class="index-card__link">Latest release</a>
</div>
<div class="index-card">
<h3 class="index-card__title">Detached Signatures</h3>
<p class="index-card__body"><code>.asc</code> files for every PDF and hash file, signed with the Release Signing Key (RSK). Verify with <code>gpg --verify</code>.</p>
<a href="../pgp/" class="index-card__link">Our keys</a>
</div>
<div class="index-card">
<h3 class="index-card__title">Hash Files</h3>
<p class="index-card__body"><code>sha256sums.txt</code> and <code>b2sums.txt</code> for integrity. Both are also signed. Check with <code>sha256sum -c</code> or <code>b2sum -c</code>.</p>
<a href="#manual-verification" class="index-card__link">Manual steps</a>
</div>
</div>
---
## Quick Verification { #quick-verification }
### Using the Python Script (Recommended)
```sh
# Verify everything — hashes, signatures, and optionally VirusTotal
python scripts/verify_pdf.py --all
# Hashes only
python scripts/verify_pdf.py --hashes
# GPG signatures only
python scripts/verify_pdf.py --signatures
# VirusTotal scan status (requires VT_API_KEY env var)
python scripts/verify_pdf.py --vt
```
---
## Manual Verification { #manual-verification }
### 1. Import the key
```sh
gpg --import pgp/anonymousplanet.asc
```
Verify the fingerprint against our [PGP page](../pgp/index.md) and [GitHub releases](https://github.com/Anon-Planet/thgtoa/releases) before trusting it.
### 2. Verify the PDFs
```sh
gpg --verify export/thgtoa.pdf.asc export/thgtoa.pdf
gpg --verify export/thgtoa-dark.pdf.asc export/thgtoa-dark.pdf
```
Expected output:
```text
gpg: Signature made Sun 31 May 2026 03:23:26 AM EDT
gpg: using EDDSA key C3023DBEA3FB38C438BA1EEDCEC60AEDE8B992A2
gpg: Good signature from "Anonymous Planet Release Signing Key" [ultimate]
Primary key fingerprint: C302 3DBE A3FB 38C4 38BA 1EED CEC6 0AED E8B9 92A2
```
!!! note "About the WARNING"
`WARNING: This key is not certified with a trusted signature` is expected. It means the key has not been co-signed by another key in your web of trust — not that the signature is invalid.
### 3. Check hashes
=== "Linux / macOS"
```sh
sha256sum -c sha256sums.txt
b2sum -c b2sums.txt
```
=== "Windows (PowerShell)"
```powershell
Get-FileHash -Algorithm SHA256 export\thgtoa.pdf | Select-Object Hash
# Compare with the value in thgtoa.pdf.sha256
```
### 4. VirusTotal (optional)
```sh
export VT_API_KEY=your_vt_api_key
python scripts/verify_pdf.py --vt
```
Or open the VirusTotal report URLs listed in the release notes directly.
---
## Troubleshooting { #troubleshooting }
**"Good signature" but wrong owner?**
Ensure you imported the correct key from [`pgp/`](../pgp/index.md). Check the fingerprint matches the RSK: `C302 3DBE A3FB 38C4 38BA 1EED CEC6 0AED E8B9 92A2`.
**Hash mismatch?**
Re-download the file. Verify you are using the correct hash file for the edition (light vs dark). Check for disk errors.
**GPG not installed?**
| Platform | Command |
|---|---|
| Debian / Ubuntu | `sudo apt install gnupg` |
| RHEL / Fedora | `sudo dnf install gnupg2` |
| macOS | `brew install gnupg` |
| Windows | [Gpg4win](https://gpg4win.org) |
export/b2sums.txt
-2
View File
@@ -1,2 +0,0 @@
ed1fff860d113609cbeaf38beef5342b473d5f09b9263020ef0a82f42ba9c8d4d17ad2743267a76b0f315c4719f9866d3e2018bc8f4eb64a46d0fcbec0c6ee2f thgtoa.pdf
1bd77081bf7f2962f8a52a141e286fc7cb571e17b1b551d1baab5fd892cf874a1ace903301f263d7073251a1c53a4d141aa346fb0c87ea0af0b96703127f5133 thgtoa-dark.pdf
export/sha256sums.txt
-2
View File
@@ -1,2 +0,0 @@
85e8824dcda6176ac4444fdc92ff5272527065aabb2c240d3e2f87418aa255b3 thgtoa.pdf
28675b585406f0e0543e4f63d5cff6507a064bf4d91db9ff82e4a826e8c8959d thgtoa-dark.pdf
export/thgtoa-dark.pdf
-56926
View File
File diff suppressed because one or more lines are too long
export/thgtoa.pdf
-76628
View File
File diff suppressed because one or more lines are too long
mkdocs.yml
+34 -70
View File
@@ -1,29 +1,24 @@
site_name: The Hitchhiker's Guide
site_name: Hitchhiker's Guide
site_author: Anonymous Planet
site_description: "The comprehensive guide for online #anonymity and #opsec."
site_dir: "site"
docs_dir: "docs"
exclude_docs: |
includes/
site_url: "https://anonymousplanet.net/"
site_description: "The comprehensive guide for online anonymity and OpSec."
site_dir: '/site/'
docs_dir: 'docs/'
site_url: "https://www.anonymousplanet.org/"
repo_url: "https://github.com/Anon-Planet/thgtoa"
repo_name: ""
#edit_uri: ""blob/main/docs/{path}?plain=1""
#edit_uri: ""
theme:
name: material
custom_dir: docs/overrides
locale: en
favicon: media/profile.png
icon:
logo: material/bird
repo: simple/github
font: false # all fonts self-hosted in docs/fonts/
font:
text: Public Sans
code: Liberation Mono
features:
- navigation.instant
- navigation.instant.prefetch
- navigation.tabs
- navigation.sections
- navigation.path
- toc.integrate
- navigation.top
- search.suggest
@@ -33,59 +28,43 @@ theme:
- content.code.copy
language: en
palette:
- scheme: slate
primary: hacker
accent: green
toggle:
icon: material/monitor-off
name: Printing Press
- scheme: default
primary: custom
accent: custom
toggle:
icon: material/monitor
name: Monitor
icon: material/eye-outline
name: Switch to dark mode
primary: green
accent: blue
- scheme: slate
toggle:
icon: material/eye
name: Switch to light mode
primary: grey
accent: teal
plugins:
- social: {}
# - with-pdf:
- search:
separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
# - meta: {}
# - macros: {}
# - meta: {}
# - git-latest-tag: {}
# - git-authors: {}
# - git-latest-release: {}
# Soon this will all be minified (It's a personal WIP that I already have stashed in git)
extra_css:
- stylesheets/hacker.css
- stylesheets/hacker-extra.css
- stylesheets/going-dark.css
- stylesheets/toggle.css
- stylesheets/navigation.css
- stylesheets/footer.css
- stylesheets/accessibility.css
# print-light.css is NOT included here - it's only injected during PDF builds via build_guide_pdf.py
# extra_css:
# - stylesheets/hacker-core.css
# - stylesheets/components.css
# - stylesheets/accessibility.css
# - stylesheets/print-and-utilities.css
copyright: >-
&copy; 2023-2026 Anonymous Planet & contributors &mdash;
licensed under <a href="https://creativecommons.org/licenses/by-sa/4.0/" rel="license">CC BY-SA 4.0</a>.
- stylesheets/extra.css
extra:
social:
- icon: simple/mastodon
link: https://ioc.exchange/@unknown
link: https://mastodon.social/@anonymousplanet
name: Mastodon
- icon: simple/x
link: https://x.com/anonplanetorg
name: X
- icon: simple/gitlab
link: http://wmj5kiic7b6kjplpbvwadnht2nh2qnkbnqtcv3dyvpqtz7ssbssftxid.onion/
name: "0xacab"
- icon: simple/gitea
link: http://it7otdanqu7ktntxzm427cba6i53w6wlanlh23v5i3siqmos47pzhvyd.onion/anonypla
link: http://it7otdanqu7ktntxzm427cba6i53w6wlanlh23v5i3siqmos47pzhvyd.onion/anonymousplanetorg
name: Darktea
- icon: simple/github
link: https://github.com/anon-planet
@@ -96,11 +75,8 @@ extra:
- icon: simple/codeberg
link: https://codeberg.org/anonymousplanet
name: Codeberg
- icon: simple/torbrowser
link: https://gitlab.torproject.org/anonymousplanet/the-hitchhikers-guide
name: Gitlab at Tor Project
# - icon: simple/torbrowser
# link: http://thgtoa3jzy3doku7hkna32htpghjijefscwvh4dyjgfydbbjkeiohgid.onion/ (defunct)
# link: http://thgtoa3jzy3doku7hkna32htpghjijefscwvh4dyjgfydbbjkeiohgid.onion/
# name: Hidden service
markdown_extensions:
@@ -131,31 +107,19 @@ markdown_extensions:
- pymdownx.keys: {}
- pymdownx.mark: {}
- pymdownx.tilde: {}
- abbr
- pymdownx.snippets:
base_path: ["docs"]
auto_append:
- includes/glossary.md
- pymdownx.snippets: {}
- pymdownx.tasklist:
custom_checkbox: true
- attr_list: {}
- def_list: {}
- md_in_html: {}
- meta: {}
- abbr: {}
- tables: {}
- footnotes: {}
- toc:
permalink: "λ"
permalink: true
toc_depth: 3
nav:
- "Home": index.md
- "Verify": verify/index.md
- "Guide": guide/index.md
- "Code": code/index.md
- "Donations": contribute/index.md
- "A Constitution": constitution/index.md
- "Mirrors": mirrors/index.md
- "Changelog": changelog/index.md
- "Anonymous Planet": about/index.md
- "PGP": pgp/index.md
copyright: |
&copy; 2023-2025 <a href="https://anonymousplanet.org/" target="_blank" rel="noopener">Anonymous Planet</a>
pgp/anonymousplanet-email.asc
+69
View File
@@ -0,0 +1,69 @@
-----BEGIN PGP PUBLIC KEY BLOCK-----
mQINBGNnDKYBEADEwpJcPVDJLJHlaRtBtVVJ2p2SaNwbZKgeI2zfpiLu4rTmpxUp
cbyW5S3mI++kGt4ljcKTzQM0+upr2hcdZi/rpwliHLOxsC32cvTy4YtPmoKdOalo
blJ9+llDbl0lBBvnqQcqFhnDMPXQPsaewWmCpGjwCwnQpxXLWmKhTYMxoQtzzZ8U
oagorLwASkb6+NZoha96ayDlE41KNErI51U8qiVxMR+8iN8pcJ1l3XA9bfMKBz45
TnlaoJ391CvJUgJ9535FjifmOyWTB0OYgJptMPz+n0K5jTOE7mvoqT6a/hqbAGDp
5i5LgSYVPfJqZsdrkQBMwO5pW9XymH7hNHPhaX6nPkDB8RLKexqso9pzLapG8WNC
sk+jxTC77TOFh9CniGks7UZoa0pRdhA5sGD0Wjh8eWgDRqdgYEmqviuulWnJDti0
dIQNixzh+TylEO8YNJyz49KUIr/ckapHfPI1BZWUyZZLpcvNvT/2IzcEeT3Tgmfr
IZsk2U91kA9z+BKEx8mJ7V5KZo7ku0uVgAtQn5oyluSIptUGwYu5DqhnZAqKXZok
S7i2NMghrPMM/Wf048VXuxO1Dx7CwP7Q1LCNhwL0jsLWtXIJVm7NtTt+1Vj/M4EH
Fl4g0B7iK6JiZEPYEp5YGSWpyhpSTKQaOOCHHKSCIjVx6VLm+/Xbaf6/TwARAQAB
tEtBbm9ueW1vdXMgUGxhbmV0IEVtYWlsIEVuY3J5cHRpb24vU2lnbmluZyBLZXkg
PGNvbnRhY3RAYW5vbnltb3VzcGxhbmV0Lm9yZz6JAk4EEwEKADgWIQS20XV2MqKA
+Z8ty/25q52Tr/BbnAUCY2cMpgIbAwULCQgHAwUVCgkICwUWAgMBAAIeAQIXgAAK
CRC5q52Tr/BbnOA7EACeevkcNYbacvNJx+E8cAHyVRS7kuSWDfV0EvCeiCsZ3+sq
q9CFADbBn4wXuELdFcPSME5UGOMpZ3MVwWocHyRrU+axseO/OCgbl15nxgk3lsSK
Tew/1YHnjTIfpDkSOw5kT86yxea9/bpIWVzb1aCkKxVogr1cXzvBdYRWV5qC3BP4
EITVs+5fX4kfW80ZoX6juopI7ymqRzEL9iml1ydWIr+cAwYYzhGvyBjrzm7psV2/
C+X9dXsLexQlb9Ef1WJA6R+z92f/HFUhjrEPTKpypWZIZhwkXMUDeykn5A9Szaqw
JcJ4kI2xrvRu1bQW5v+kptXHCjNHVFpEg2sh1hoIy+HZ6WRjurHJ4XXo2nQ3520I
ohLmPFnNvR0zwG+EcEeilMDtsTHkzcLZ5LcUlXRU1EhtdHTGceMAyxDvbMx6Wazm
dfPctzDUCfe8haJN1ZlcgJIVyc+xaEEbLS8CmKkNP9lP0N6J5m2KFeVq/rRs1iA4
MZdjmUkEt7/AyrfQXAVwogQtfNA7p1c0r2CZCgWn4rrRlqXe+A9oQUfNf/GcFwDl
WE/5BYeLDK11F28WxV2ryhRtGdEMsscIfDGOiWmBrb3hWWiwcTEOOCCzAeOx+0XS
c7L8elP6/wDO3KilCr2Qb9Iwn61AZFC1ITneAcSoiWBu6UhSZeUp+f2YrVmmIoh1
BBAWCgAdFiEEnqmCeGOfHNhT4JbL/5RQdYemqbkFAmNnDacACgkQ/5RQdYemqbmV
DgEAjIsvDnzUMb8SweLcowiT+Hm+wWYoa9Szc5wv0o+HjccBAN5/0LhCOpkQOfbF
zLUUHosdPnOljr8/qsHdl5zdg98ItEtBbm9ueW1vdXMgUGxhbmV0IEVtYWlsIEVu
Y3J5cHRpb24vU2lnbmluZyBLZXkgPGFub255bW91c3BsYW5ldEBkaXNyb290Lm9y
Zz6JAlEEEwEIADsWIQS20XV2MqKA+Z8ty/25q52Tr/BbnAUCY7fjdgIbAwULCQgH
AgIiAgYVCgkICwIEFgIDAQIeBwIXgAAKCRC5q52Tr/BbnIKBD/9F661+INgEEU8N
oX+5/4AnSoaLHWht/IjFqGvmVnWjFhbu5IH0SqYm58CXwV3Has+jggBt71ab/Wjw
8G7RQ8ERZnPzusn4dckSARMim/ikPYSNM/tZ+dVHXdiHRz0KOXh6vDD/yfZa5IxR
G5zrF8Anh2h87JA1q6UdaTKKJzAQLm/uzMAsw+5F5ihOSxpXuJzb7wpqPbPdx2z0
pNqCzSi089Ez0R+MVMsPErCDe7DIq18JCRI6zJBhAH8PXBWmOWDWfxuIbaCFND88
ML7QSUfSqEZylop8ZImvLc+0/pX2PP2pbVrEfa6JfY0hJX19flkVFK06lpZ2Zc02
0ZAiQXFURIC8zscEO2qSHWukSrUpw9ZjBGqsCTcE/aQvgV8zxgTUc80X2ORhAISz
YgNNgThKJWu9YF+1mqkcm91TIE+cSiPySzWqSerwcY4d2Kvg9zcWyl1Fek84Hftl
MkqojL5C77x8DVCLqc1oXmlQ4B6h6FLF/vQ1lQeweKyvl38uLA2HEPC/yl5bW8y8
3dSM64JRC0l3vGoyHGtO5+oMcsAtUE53e3+4LA3yX777JhyQD+PAwtLVDZfpPWv4
OSmeh5xOcnhODpH/BYu14sfCxkgQLzG+RIefQDOg1opeq3uTTbcH79VP7sI7TNga
asZmYx1xusGFyZaTAMV9OOf1xvLoWrkCDQRjZwymARAA0KiQ7KxvLDKwT5sKx13t
5KufHcVDOg5oplG9ZA+qZAI79yPJPG//6D62XI+JpqDFNi4hV/yK/Ghnkikg3eQO
7Hzetqi5O9W8w7eztcHsG3g5+LoBEOly7nGB29BkayBD2febKxmY1zhwzvTaNp61
+wAMANtdQgCMuGRcGaUu2LauxHMlvKteSeqLSOMxeDI2SmzqG95l7OrGA6+RPxoA
WcILM++CyJYlhlUhjWy4RAEXZcACM5o5prprOruRI5ZaE+P26emwIgSSXB2UZS6x
2zj7xvZE5m49V82vjEmAI8+T0ISNBmEVoIsfW3+G1jKc8QmBi28j06xLGmqdgqlV
uJhucLnR7IWoPQpFVY0rCK+kOx3KwaLOxpSKe5qb4VteefxIBirAXQqZ3V3CDYl5
ZXpP12iAImYKxNtQP6k7KkvNkSBxnQyMSCDbnh/8ervVhDuxUK1LfyPuiDCs4ec7
ePHTOtZUqk0SVlDMYm+cITiL8SDv1i9juo2Gxjo+8NauZMrN1kU/zOEbbaV/YXpY
b/x2mEUcBR34iyveABLj+d+pJvZkVshC0P7MlmkrNyiqAvjbc56qva6Q0Bj3EDS1
NHJAl5bum9sGyo90aRExVH166D0mYTuOFmR8KHvULaaH+IQ0rkvJKB6Ig9B0gCNo
9YKBIv6lfRFm498B0OdWyikAEQEAAYkCNgQYAQoAIBYhBLbRdXYyooD5ny3L/bmr
nZOv8FucBQJjZwymAhsMAAoJELmrnZOv8Fuc51YP/id/HH55XBMUaA8gOGOPLid2
xK9TgpA/lRx7oW+pea9xuQnvs7MpqT9iKy9aDutWbAXqk9ejF15qKQ2rU5A7W77x
fsBKxxdzCMV11ivvsH4UgKy270RZskMU1+8KDesYx0fC4xPPoP04o4cCf4uOdYaV
sDphDX3tccIr2DbkVOba7SH74SkWGhfDD2e2DZoiB+IUv9DKZjzVKeKMzJQwR5j5
mI9rijRz3x5cBfuYp2/mjEUtl93c8iVHkl9NM2mAsKjKer5cljju5/0qFoVPpSf/
ECIqxDIRrIylZ8iu/LvZXibt4KRnAU0mCKCRdBFn1I6FCpd60TOwzzcs6InqNsE2
IB1+XI2u87Kgoi1Ct1jp1JIPJZ724nfx7VNlvJt6JxOLeotxiHcL002+OUxwtYu+
ueEqqv54oB32cVdJhKOLnh3n77Wy58SxluyA9OCvFMwnx4ojNK89bMOc7r2FRb6h
k8XwP6vu7G2o6p1qdVp33ia3qBg4dWItvIVTbutizQvMU89MReWVBxDlBHk7NS36
Tgme/eh1treN711QH38m9e8OF5zQzvyRjEBsX+TX78cD5XP3xqk8oXhlJM1S0zfb
slnPWgU4obnz4cRhGBXpQyuVtFGsvZ7UYlvUgrZOVvc3rtZLFdHjWJUEmQBZNpKA
J0nsuzwoKTRfhIDlYN7e
=Mkw3
-----END PGP PUBLIC KEY BLOCK-----
pgp/anonymousplanet-master.asc
+14
View File
@@ -0,0 +1,14 @@
-----BEGIN PGP PUBLIC KEY BLOCK-----
mDMEY2cLxRYJKwYBBAHaRw8BAQdA1wWVN04/7B2thXG3Ppm9nj9BXOosgFUCq+6m
7q7jDUG0QUFub255bW91cyBQbGFuZXQgTWFzdGVyIFNpZ25pbmcgS2V5IChodHRw
czovL2Fub255bW91c3BsYW5ldC5vcmcpiJAEExYKADgWIQSeqYJ4Y58c2FPglsv/
lFB1h6apuQUCY2cLxQIbAwULCQgHAwUVCgkICwUWAgMBAAIeAQIXgAAKCRD/lFB1
h6apuVvhAP0UTSY/QchH8LfHaw1inGaViik9rALbjdBeVRWofwyRSQD8DH2LRX3v
f/DgBOK7Li6OL05s9wsEYwoF+8B1qWJinQu4OARjZwvFEgorBgEEAZdVAQUBAQdA
xO3KbSonM28D2uTNHpXFRneFL3LqUO+8JW14eULOdxoDAQgHiHgEGBYKACAWIQSe
qYJ4Y58c2FPglsv/lFB1h6apuQUCY2cLxQIbDAAKCRD/lFB1h6apuZ32AQCiiR0d
bD29xEmQYf4b9F77jAdFFr2DoEGjeZBPoTrJywEA8m1dD5ZOS0qn1Yz3WkTgBflL
/0VkU6m06r/KxLL4fg0=
=4NMF
-----END PGP PUBLIC KEY BLOCK-----
pgp/anonymousplanet-release.asc
+16
View File
@@ -0,0 +1,16 @@
-----BEGIN PGP PUBLIC KEY BLOCK-----
mDMEY2cNGBYJKwYBBAHaRw8BAQdAbKn/ExAQ+aq6/o2yc04B9jx5PMloaxux1eoT
iKwQgX60JEFub255bW91cyBQbGFuZXQgUmVsZWFzZSBTaWduaW5nIEtleYiQBBMW
CgA4FiEEg6bPnvV6wltcf10pKF5gSKEjIbIFAmNnDRgCGwMFCwkIBwMFFQoJCAsF
FgIDAQACHgECF4AACgkQKF5gSKEjIbI5+QD/YSQ5E+LW4YJEAQQ+D3LFsGtGGRf3
qQRD5plsUvTtBfsA/15EJaIjzSwrsf/3wsW48zSYKCer/nrhGY9y5yd0m2gBiHUE
EBYKAB0WIQSeqYJ4Y58c2FPglsv/lFB1h6apuQUCY2cNxAAKCRD/lFB1h6apuXun
AQCSNwZBNybUZzN/K4Zl1j6uhCqqnvbUlO80wvbHDMXpywD/dpabqjmpfxfJC20n
t3OFxKSeIbfJ0VHvoHKpwcaGuwC4OARjZw0YEgorBgEEAZdVAQUBAQdAE7WMDHTx
zWp542lXGLxSsiE4gtMvVxkEneKmZWwzbDcDAQgHiHgEGBYKACAWIQSDps+e9XrC
W1x/XSkoXmBIoSMhsgUCY2cNGAIbDAAKCRAoXmBIoSMhsowLAP42HbiJIsIodWwn
C3yBzwGrd1xRtf/91MpQUgFpCx7xuAD9G0F3l04hKkjxiHK+wJ27LnYcigaTVdje
6d7bt7TerwE=
=Hgos
-----END PGP PUBLIC KEY BLOCK-----
pgp/anonymousplanet.asc
-89
View File
@@ -1,89 +0,0 @@
-----BEGIN PGP PUBLIC KEY BLOCK-----
mDMEZc0QYxYJKwYBBAHaRw8BAQdAm8mOR8/0qWrm9Tqzfl9Ks5rjtIbQZLAR/qxH
HVGJsxi0LUFub255bW91cyBQbGFuZXQgRW1haWwgRW5jcnlwdGlvbi9TaWduaW5n
IEtleYiTBBMWCgA7FiEE/L0sq979H7ounnWRoags0t0s+JAFAmXNEGMCGwMFCwkI
BwICIgIGFQoJCAsCBBYCAwECHgcCF4AACgkQoags0t0s+JDbRAEAuZlBmMGgZ3bh
12Js9jjDcu+jhKqL4fJrJG5z9+KFkQwA/An1StA6EhcM7qlzZ5bzm2SZAbP9hQRZ
GmfaeU2P5KgHiHgEMBYKACAWIQSfpUNtDuNgmFFXOCUX7KBfdo3t9gUCaiCYTgId
AAAKCRAX7KBfdo3t9gNUAP9/SyGBYJ7s9YeqLHOJ+veQZjZYHvFGQ7yPn0Fetx0Z
LAD/UOQ8rP2QaldCMyVSG8SqfPd7n++SEAXWAl2gAo9mhg6IdQQQFgoAHRYhBJ+l
Q20O42CYUVc4JRfsoF92je32BQJmpEUQAAoJEBfsoF92je32tD8A/ir9hE8UjrJE
psG+PNfxYAwAagKUGbAMDUxQp3z+t81+AP45hYT4aR89zSQaankHLs3Lh7Cp5ael
NBe/BtfR9hCLAYkCMwQQAQgAHRYhBF7WeRgs0hkTAMDm6kyyELegkVLWBQJqIJiM
AAoJEEyyELegkVLWjZYP/j1k5vl+r0NDQXmE8hS9IKhaQPggP72iXc5RWeMQHuIv
b1laQZm64xerJNdAh0uk1bwfmJnVGfyxBUrlCgAIeVGRSlni2Rig4azaQ1IS0pqF
4sC1KzKEhEaNdkh3pJyGtP1cikcSjWeU2oYQou3/7VN3vNyW+n8OAVF+2fsC5d78
EvdpZgal+komb+J8Bt552uDbCCVI4TFIPBZmHWoXjaP6L+730YphbV7Aw0L5J6OO
ob0nzHn4X0dIvGE7Phdp2e1yNRUOSRLh8B/D5OiE9k7CaeYmJNPv5qOw/R+NgrrA
ZFnoOuwHo0D+aL9WT9q4aM/cDCEIbvhQ4l5ZhVGqZuQ9wxNCgPi3ZiZRTfk1PW4v
uMw1xGwXBKy7jDO12xWIWWv9MiwIQLw0OxSxKbr76rgucq7e7JrWr64rItu5Wm7F
8qxg2cwmDat6tFSRVWlEDy8oNkRMJNjdQJDu3ez9YOfJNnApAz94Of1XU7CUuYjY
PV88BaHdUBVtANEzy0iSDCcSj6auzLfv9dBN8cOdUxlVcrPf2jjK6JR/6qe6VWNp
wRg9VQW2fe8HJTMUt0o9qQBJUsF68KOHtIdoE4az9AyyBNKl67dKqLB9HoIItLzD
MJRcbS2p6plCTNagwPVvgtPRChll9JP3jLPVhRL2BixYVkbHUoJxsEfscTUl6Azt
tEtBbm9ueW1vdXMgUGxhbmV0IEVtYWlsIEVuY3J5cHRpb24vU2lnbmluZyBLZXkg
PGFub255bW91c3BsYW5ldEBkaXNyb290Lm9yZz6IkwQTFgoAOxYhBPy9LKve/R+6
Lp51kaGoLNLdLPiQBQJmhqXqAhsDBQsJCAcCAiICBhUKCQgLAgQWAgMBAh4HAheA
AAoJEKGoLNLdLPiQJ34A/RJT9Hyj7hT/0D1BbDU6s6YzD+/x7Pyq2+9kNSI0L77W
AQAAG+CfDrKDXJtBNKZVNFZpld3wUeoIOcAqLl7KpsVGCYh1BBAWCgAdFiEEn6VD
bQ7jYJhRVzglF+ygX3aN7fYFAmakRRAACgkQF+ygX3aN7fbypgEAnEg0IbWnpaLj
/4wU179vUZZu/Y0DE63GbJuZjj72hKUA/0xyzIgSvXByjoOkEwCn5w1+RPYXKw7Z
syERsDCUAAMIiQIzBBABCAAdFiEEXtZ5GCzSGRMAwObqTLIQt6CRUtYFAmogmIwA
CgkQTLIQt6CRUtafPQ/+LTWFU84tDZAM0Hp7bWB0dw8nP0JvNQ2WtZf0flh+r1tF
cmVnc9szZBh+zzSpY25iK5+Waa6+l1POYSQpkS67VR0Jrv9nL94YrRhqalSRWsjW
MQJO+Obu4LIRIqiMZLJlAd9Bg9FshYagbQDVDOI8v9mxqCzIVm3tBx1Jp57ATHgm
sMDWn7l1BI0SkLlG49LYxVDQ6QAx4XLCQw+JzdiJs+yExa5ymYmV61evVVbDV5UF
pEwW6nsuEDc68UN6npjr8OuGH5y+1ot1vaBderoXFZ8hRG/czzODX5L0zGDX9R2C
cGyIrv4AoXTtnbiVZGG6Vn1p3C/RMFZsVOMKvyQKh0rjcD9dqVQ4thI41o92jZ0V
K5ALjPiWe1kM4DVYgk/b46q9/8rjzYb4WJCwPQJkRBp36y26oRWM0JaY2Tobzt/H
3c8d36hQSXtjKLY27ZY5jL0N4vJaiclAuy03wKonmKlUc1ROUBEgNoZcvx6rLx6e
64G7ypOpvlQCcLT/3x+VqX+KTwf4bbigrlonFMpq2lX/uwvHDMfc9/yB5xaUKLpf
/zuk/gHKzAfKPItzEyRx5Lvql9Aywaa+/gTCZhwM3D6DzR5Q5waDXcdsptB+GZAi
5s+BTxe1a4H6PMobdNOsYDFa77QKQXtWdHkybhV5xzRRMoSdKi+zwvU77BRnwf24
OARlzRBjEgorBgEEAZdVAQUBAQdApPitK71WFqWUCycq2bWYYykmU1YFgea3q/V3
DfsbbhIDAQgHiHgEGBYKACAWIQT8vSyr3v0fui6edZGhqCzS3Sz4kAUCZc0QYwIb
DAAKCRChqCzS3Sz4kLhXAQDhI8tMCEWLu3MhG9pI8BBYH4fS7kuN8ggxqDSbRpKJ
dgEAk1CA06WvsH4/n0HmJ83sJSbmFGmEMp2RyvKbdCIW5gKYMwRlzRBIFgkrBgEE
AdpHDwEBB0CVyNrq08EGyU77is+cf7/vqDqi95rCeZvE7yRU7SYFDrQjQW5vbnlt
b3VzIFBsYW5ldCBNYXN0ZXIgU2lnbmluZyBLZXmIkgQTFgoAOxYhBJ+lQ20O42CY
UVc4JRfsoF92je32BQJlzRBIAhsDBQsJCAcCAiICBhUKCQgLAgQWAgMBAh4HAheA
AAoJEBfsoF92je32NywA+JKlENQl/Kn03FojFNC1Xw5dfNMKnDAs6lV/loSDtOYB
ALrDCc1eWeeBt0FQItPiNcGycBBbRtJciNJMu2AUQ9wCiJMEExYKADsWIQSfpUNt
DuNgmFFXOCUX7KBfdo3t9gUCZc0QSAIbAwULCQgHAgIiAgYVCgkICwIEFgIDAQIe
BwIXgAAKCRAX7KBfdo3t9jcsAQAAkqUQ1CX8qfTcWiMU0LVfDl180wqcMCzqVX+W
hIO05gEAusMJzV5Z54G3QVAi0+I1wbJwEFtG0lyI0ky7YBRD3AKIdQQQFgoAHRYh
BIs6dIkFNrrVDZN26/HLMvZ+MwKhBQJqIJYjAAoJEPHLMvZ+MwKhm7YA/Rdrap0+
zzfVtXomRmVkeIaabzxImPuYnvwvgSulFw0oAP9ZkmMjexGKnbuLc1znUNoUjKyR
SmpT0ezNJRPcB2x3DokCMwQQAQgAHRYhBF7WeRgs0hkTAMDm6kyyELegkVLWBQJq
IJcQAAoJEEyyELegkVLW2YQP/0ry3BvS1pmEl60Ty0smBtEfoYsqQOz4uMBeOYzN
IHXtFrw19XAZQjVXYRhUp9NOol6JY8KtqUg0LXQZaRWhVwbA6hMqDbFeT+l+Psu/
Ek3dghpwR6xEDSNcm3V1aznNgADcDkGLINbZ7ZW/iDnrws5JMDA0k3+Qt1d596Le
kv609g28bxGgt0YENUDFGwXTawO0PALMF3Xg4gwyGU8UELoCoUUWvCYEECqO1vWc
BrZNDNulp9ovfsC8A4BkAo6yCv6RPOJVGHaKlfsO81HvBz+pExT0S71DFX5Gm9Qo
zkDIEZKLuBji6zuhi88dm17vvDs2SKjVd9OnZhs8THbGW+4WRqU6woYMN1YJAedp
+hAaYhJjQfdnFXql7bY5f9uqiBLGy4c5BPoXGYQNi8GABCzUdoiBwsFM/DQ9L8qA
fA355CVayg3aODo/NGore3N2Gqxa0GUz21ImMRV/8EIR05zFRVHeR7gu2czDyGih
9eHadE2FAAmu2iifZcxKfe3ibSBijub11Wxkfei1gipQ/OvkEfCONVVNRyi6H9Kv
6lRP+2n93GQLxlcqxd1qW2tpAt8Pimetb0M20ZY3LkuxhXvsir3sRFRcU4dLSbld
7VdwG7AsMmmA98Tp6CKjzI9FS/JcZTDoAVw6PgDSthrK5ev2plALMtWrOg9TggYE
6a/nuDgEZc0QSBIKKwYBBAGXVQEFAQEHQP1nHDDQfCi8qGG2QJj/wmMUl8ZGEiAY
pVc/+S0ZIJEnAwEIB4h4BBgWCgAgFiEEn6VDbQ7jYJhRVzglF+ygX3aN7fYFAmXN
EEgCGwwACgkQF+ygX3aN7fbSGAD9GLAarXceWbfEUWYC4IwVJAKSHDPWSzLGgFnV
x/D3238A/RiJHKYzmigvFLL/A28WStW6P47CjNYjJCS490qG/L0GmDMEZc0J8xYJ
KwYBBAHaRw8BAQdAWIpOKf8GnTINRH7uW4oeGW4D4vfmK9xeQrnqn/TMIMe0JEFu
b255bW91cyBQbGFuZXQgUmVsZWFzZSBTaWduaW5nIEtleYiTBBMWCgA7FiEEwwI9
vqP7OMQ4uh7tzsYK7ei5kqIFAmXNCfMCGwMFCwkIBwICIgIGFQoJCAsCBBYCAwEC
HgcCF4AACgkQzsYK7ei5kqJJVgD+NKdW7U/uMWl6Ov1Ye9PPy6MbIyyCYd2j5snO
60e7msQA/0rxLaeLwzraevcE+WpdPMadxP2M8MxIKrKeAkKAe+IJiHUEEBYKAB0W
IQSfpUNtDuNgmFFXOCUX7KBfdo3t9gUCZqRFIAAKCRAX7KBfdo3t9o9LAP426yx7
1EP9sLKKpkkdAT19HJgsNBeA7SdR/DtMzWEbegD/f2oQYwVz3O1w7xuUqJMHS6/b
N1E8B78JSi576up9rA2IdQQQFgoAHRYhBJ+lQ20O42CYUVc4JRfsoF92je32BQJp
508bAAoJEBfsoF92je32TM8A/2j51Jc3owAx9STceeamG5GG7inq5jRMyKlMG4Kw
1y1lAQD2kKSR9tz/l4Yhvy96WOuQYb+uG0W78T12l2c61F/xBrg4BGXNCfMSCisG
AQQBl1UBBQEBB0DOf/mxiZClX/sJqtj7Ob+pCHbsMp9Wd4SHW7/PFaUKHwMBCAeI
eAQYFgoAIBYhBMMCPb6j+zjEOLoe7c7GCu3ouZKiBQJlzQnzAhsMAAoJEM7GCu3o
uZKie1EBAL5P2th3moOj4IDdXrP6KgdBB0kYweAHix0djG1jV/1+AQDrgVyMPBbT
Eztpvc4cyyGAmI42SLM/jKbqO2yWqwVoAg==
=ww/S
-----END PGP PUBLIC KEY BLOCK-----
pgp/core-devs/README.md
+23 -23
View File
@@ -1,23 +1,23 @@
# Import
```sh
$ gpg --import pgp/core-devs/*
```
# Verify
```sh
$ gpg --verify pgp/core-devs/than/than-crypto.txt
gpg: Signature made Sat 19 Jul 2025 02:04:10 AM EDT
gpg: using EDDSA key 8B3A74890536BAD50D9376EBF1CB32F67E3302A1
gpg: Good signature from "nopenothinghere@proton.me <nopenothinghere@proton.me>" [ultimate]
gpg: aka "Nope Nothing (Anonymous Planet Contact) <no@anonymousplanet.net>" [ultimate]
gpg: aka "Nope Nothing (Systems Administrator) <admin@itsnothing.net>" [ultimate]
Primary key fingerprint: 8B3A 7489 0536 BAD5 0D93 76EB F1CB 32F6 7E33 02A1
```
## All signing keys are signed by the Master Signing Key
TODO
# Import
```bash
$ gpg --import pgp/core-devs/*
```
# Verify
```bash
$ gpg --verify pgp/core-devs/than/than-crypto.txt
gpg: Signature made Sat 19 Jul 2025 02:04:10 AM EDT
gpg: using EDDSA key 8B3A74890536BAD50D9376EBF1CB32F67E3302A1
gpg: Good signature from "nopenothinghere@proton.me <nopenothinghere@proton.me>" [ultimate]
gpg: aka "Nope Nothing (Anonymous Planet Contact) <no@anonymousplanet.org>" [ultimate]
gpg: aka "Nope Nothing (Systems Administrator) <admin@itsnothing.net>" [ultimate]
Primary key fingerprint: 8B3A 7489 0536 BAD5 0D93 76EB F1CB 32F6 7E33 02A1
```
## All signing keys are signed by the Master Signing Key
TODO
scripts/archived/README.md
-7
View File
@@ -1,7 +0,0 @@
# scripts/archived
Scripts kept for reference but no longer part of the active pipeline.
| Script | Why archived |
|--------|-------------|
| `tag_release.py` | Created GPG-signed `vX.Y.Z` annotated tags. Superseded by the `release-YYYYMMDD-<sha>` timestamp tagging built into `03-release.yml`. Re-enable if semver release tagging is reintroduced. |
scripts/archived/tag_release.py
-407
View File
@@ -1,407 +0,0 @@
#!/usr/bin/env python3
"""Release tagging helper for Anonymous Planet maintainers.
Creates a GPG-signed annotated git tag using the release key, with a
message derived from the changelog entry for that version.
Usage:
python scripts/tag_release.py # auto-detect next version
python scripts/tag_release.py --version v1.2.4
python scripts/tag_release.py --version v1.2.4 --key <fingerprint>
python scripts/tag_release.py --version v1.2.4 --dry-run
What it does:
1. Checks the working tree is clean and the branch is main
2. Resolves the version (auto-increments patch if not given)
3. Finds the matching ## [vX.Y.Z] entry in the changelog
4. Lists available signing keys and selects the release key
5. Creates a signed annotated tag: git tag -s vX.Y.Z -u <key> -m <message>
6. Verifies the tag signature
7. Prints the push command
Requirements:
- git
- GPG with the release signing key imported
"""
# The Hitchhiker's Guide to Online Anonymity © 2026 by Anonymous Planet is licensed under Creative
# Commons Attribution-NonCommercial 4.0 International
from __future__ import annotations
import argparse
import re
import subprocess
import sys
from pathlib import Path
# Default release signing key fingerprint.
# Maintainers with a different key can pass --key on the CLI.
DEFAULT_SIGNING_KEY = "C3023DBEA3FB38C438BA1EEDCEC60AEDE8B992A2"
CHANGELOG = Path(__file__).resolve().parent.parent / "docs" / "changelog" / "index.md"
# --------------------------------------------------------------------------- #
# Helpers
# --------------------------------------------------------------------------- #
def repo_root() -> Path:
return Path(__file__).resolve().parent.parent
def run(cmd: list[str], check: bool = True) -> subprocess.CompletedProcess:
return subprocess.run(cmd, capture_output=True, text=True, check=check)
def git(*args: str, check: bool = True) -> str:
return run(["git", *args], check=check).stdout.strip()
def check_gpg_installed() -> bool:
try:
return run(["gpg", "--version"], check=False).returncode == 0
except FileNotFoundError:
return False
# --------------------------------------------------------------------------- #
# Git state checks
# --------------------------------------------------------------------------- #
def check_clean_tree() -> bool:
"""Return True if the working tree and index are clean."""
status = git("status", "--porcelain")
return status == ""
def current_branch() -> str:
return git("rev-parse", "--abbrev-ref", "HEAD")
def latest_tag() -> str | None:
"""Return the most recent vX.Y.Z tag, or None."""
out = run(["git", "tag", "--sort=-version:refname", "--list", "v*"], check=False).stdout
for line in out.splitlines():
if re.match(r"^v\d+\.\d+\.\d+", line.strip()):
return line.strip()
return None
def tag_exists(version: str) -> bool:
out = run(["git", "tag", "--list", version], check=False).stdout.strip()
return bool(out)
def head_sha() -> str:
return git("rev-parse", "HEAD")
def short_sha() -> str:
return git("rev-parse", "--short", "HEAD")
# --------------------------------------------------------------------------- #
# Version logic
# --------------------------------------------------------------------------- #
def auto_increment(tag: str | None) -> str:
"""Bump the patch number of tag, or return v1.0.0 if no tag exists."""
if not tag:
return "v1.0.0"
m = re.match(r"^v?(\d+)\.(\d+)\.(\d+)", tag)
if not m:
return "v1.0.0"
return f"v{m.group(1)}.{m.group(2)}.{int(m.group(3)) + 1}"
def normalise_version(v: str) -> str:
return v if v.startswith("v") else f"v{v}"
# --------------------------------------------------------------------------- #
# Changelog parsing
# --------------------------------------------------------------------------- #
def extract_changelog_entry(version: str) -> str | None:
"""Return the raw text of the ## [version] section, or None if not found."""
if not CHANGELOG.exists():
return None
content = CHANGELOG.read_text(encoding="utf-8")
# Find the heading for this version
pattern = re.compile(
rf"^(## \[{re.escape(version)}\].*?)(?=^## \[|\Z)",
re.MULTILINE | re.DOTALL,
)
m = pattern.search(content)
if not m:
return None
return m.group(1).strip()
def changelog_to_tag_message(version: str, entry: str | None, sha: str) -> str:
"""Convert a changelog entry into a clean tag message."""
if not entry:
return f"{version}\n\nNo changelog entry found for {version}.\nCommit: {sha}"
lines = []
current_bucket = None
for line in entry.splitlines():
# Skip the ## [vX.Y.Z] heading — we'll add our own first line
if re.match(r"^## \[", line):
continue
# Skip admonition headers like !!! Note "Added" → use bucket name as section
m = re.match(r'^!!!\s+\w+\s+"(.+)"', line)
if m:
current_bucket = m.group(1)
lines.append(f"\n{current_bucket}:")
continue
# Skip Meta bucket entirely
if current_bucket == "Meta":
continue
# Strip 4-space admonition indent and leading bullet dash
stripped = re.sub(r"^ {4}", "", line)
stripped = re.sub(r"^- ", " - ", stripped)
# Skip blank lines inside admonitions (keep structure clean)
if stripped.strip():
lines.append(stripped)
body = "\n".join(lines).strip()
return f"{version}\n\n{body}\n\nCommit: {sha}"
# --------------------------------------------------------------------------- #
# GPG key selection
# --------------------------------------------------------------------------- #
def list_secret_keys() -> list[dict]:
"""Return a list of available secret keys with fingerprint and uid."""
result = run(["gpg", "--list-secret-keys", "--with-colons"], check=False)
keys = []
current: dict = {}
for line in result.stdout.splitlines():
parts = line.split(":")
if parts[0] == "sec":
if current:
keys.append(current)
current = {"fingerprint": None, "uid": None, "key_id": parts[4] if len(parts) > 4 else ""}
elif parts[0] == "fpr" and current is not None:
if not current.get("fingerprint"):
current["fingerprint"] = parts[9] if len(parts) > 9 else ""
elif parts[0] == "uid" and current is not None:
if not current.get("uid"):
current["uid"] = parts[9] if len(parts) > 9 else ""
if current:
keys.append(current)
return keys
def resolve_signing_key(preferred: str) -> str | None:
"""
Return the fingerprint to use for signing.
Prefers the key matching `preferred` (full fingerprint or key ID suffix).
Falls back to interactive selection if not found.
"""
keys = list_secret_keys()
if not keys:
return None
# Try to match preferred fingerprint/key ID
preferred_upper = preferred.upper()
for k in keys:
fp = (k.get("fingerprint") or "").upper()
kid = (k.get("key_id") or "").upper()
if preferred_upper in (fp, kid) or fp.endswith(preferred_upper) or kid.endswith(preferred_upper):
return k["fingerprint"]
# Not found — show what's available and ask
print("\n⚠ Preferred key not found in keyring. Available keys:\n")
for i, k in enumerate(keys, 1):
print(f" {i}. {k.get('fingerprint', 'N/A')}")
print(f" {k.get('uid', 'Unknown')}\n")
try:
choice = input(f"Select key (1–{len(keys)}) or press Enter to abort: ").strip()
if not choice:
return None
idx = int(choice) - 1
if 0 <= idx < len(keys):
return keys[idx]["fingerprint"]
except (ValueError, EOFError):
pass
return None
# --------------------------------------------------------------------------- #
# Tag creation and verification
# --------------------------------------------------------------------------- #
def create_signed_tag(version: str, key_fingerprint: str, message: str, dry_run: bool) -> bool:
"""Create a GPG-signed annotated tag. Returns True on success."""
sha = head_sha()
cmd = [
"git", "tag",
"-s", version,
sha,
"-u", key_fingerprint,
"-m", message,
]
print(f"\n{'─' * 70}")
print(f" Tag: {version}")
print(f" Commit: {sha[:12]}")
print(f" Key: {key_fingerprint}")
print(f"{'─' * 70}")
print("\nTag message:\n")
for line in message.splitlines():
print(f" {line}")
print()
if dry_run:
print("── DRY RUN — tag not created. Remove --dry-run to proceed.\n")
return True
confirm = input("Create this tag? [y/N] ").strip().lower()
if confirm != "y":
print("Aborted.")
return False
result = run(cmd, check=False)
if result.returncode != 0:
print(f"\n✗ Tag creation failed:\n{result.stderr}")
return False
print(f"\n✓ Tag {version} created.")
return True
def verify_tag(version: str) -> bool:
"""Verify the GPG signature on the tag."""
result = run(["git", "tag", "-v", version], check=False)
output = result.stdout + result.stderr
if result.returncode == 0:
print("\n✓ Tag signature verified:")
for line in output.splitlines():
if any(k in line for k in ("gpg:", "Primary", "using", "issuer", "Good")):
print(f" {line.strip()}")
return True
else:
print(f"\n✗ Tag signature verification failed:\n{output}")
return False
# --------------------------------------------------------------------------- #
# Main
# --------------------------------------------------------------------------- #
def main() -> int:
ap = argparse.ArgumentParser(
description="Create a GPG-signed release tag from the changelog."
)
ap.add_argument(
"--version", "-v",
help="Version to tag, e.g. v1.2.4 (default: auto-increment from latest tag)",
)
ap.add_argument(
"--key", "-k",
default=DEFAULT_SIGNING_KEY,
help=f"GPG key fingerprint to sign with (default: {DEFAULT_SIGNING_KEY})",
)
ap.add_argument(
"--dry-run", "-n",
action="store_true",
help="Print the tag message and exit without creating the tag",
)
args = ap.parse_args()
root = repo_root()
print("\n" + "=" * 70)
print(" RELEASE TAGGER — Anonymous Planet")
print("=" * 70)
# 1. GPG available?
if not check_gpg_installed():
print("\n✗ GPG is not installed or not in PATH.")
print(" Install with: sudo apt install gnupg | brew install gnupg")
return 1
# 2. Working tree clean?
if not check_clean_tree():
print("\n✗ Working tree is not clean. Commit or stash changes first.")
result = run(["git", "status", "--short"], check=False)
print(result.stdout)
return 1
# 3. On main?
branch = current_branch()
if branch != "main":
print(f"\n⚠ You are on branch '{branch}', not 'main'.")
confirm = input(" Tag anyway? [y/N] ").strip().lower()
if confirm != "y":
return 1
# 4. Resolve version
last_tag = latest_tag()
version = normalise_version(args.version) if args.version else auto_increment(last_tag)
print(f"\n Latest tag: {last_tag or '(none)'}")
print(f" New version: {version}")
print(f" Branch: {branch}")
print(f" HEAD: {short_sha()}")
if tag_exists(version) and not args.dry_run:
print(f"\n✗ Tag {version} already exists.")
print(" Use --version to specify a different version, or delete the tag first:")
print(f" git tag -d {version}")
return 1
# 5. Build tag message from changelog
entry = extract_changelog_entry(version)
if not entry:
print(f"\n⚠ No changelog entry found for {version}.")
print(f" Add a '## [{version}]' section to {CHANGELOG.relative_to(root)}")
print(" and re-run, or proceed with a minimal message.")
confirm = input(" Proceed with minimal message? [y/N] ").strip().lower()
if confirm != "y":
return 1
message = changelog_to_tag_message(version, entry, head_sha())
# 6. Resolve signing key
print(f"\n Signing key: {args.key}")
key = resolve_signing_key(args.key)
if not key:
print("\n✗ Could not resolve a signing key. Aborting.")
print(" Import the release key with:")
print(" gpg --import pgp/anonymousplanet.asc")
return 1
print(f" Resolved to: {key}")
# 7. Create tag
if not create_signed_tag(version, key, message, args.dry_run):
return 1
if args.dry_run:
return 0
# 8. Verify
if not verify_tag(version):
return 1
# 9. Push instructions
print("\n" + "=" * 70)
print(" ✓ All done. Push the tag with:")
print(f"\n git push origin {version}\n")
print(" The 03-release.yml workflow can then be triggered manually from")
print(" GitHub Actions to publish the GitHub Release for this tag.")
print("=" * 70 + "\n")
return 0
if __name__ == "__main__":
raise SystemExit(main())
scripts/build_guide_pdf.py
+161 -477
View File
@@ -1,477 +1,161 @@
#!/usr/bin/env python3
"""Build light-mode PDF with MkDocs + Chromium, then produce dark-mode PDF via convert.py.
Usage:
python scripts/build_guide_pdf.py # Light PDF only (clean light theme)
python scripts/build_guide_pdf.py --dark # Dark PDF only (requires light PDF to exist)
python scripts/build_guide_pdf.py --both # Light PDF, then dark PDF
Examples:
python scripts/build_guide_pdf.py --site-dir build/html --pdf-light export/thgtoa.pdf
python scripts/build_guide_pdf.py --both --pdf-light export/thgtoa.pdf --pdf-dark export/thgtoa-dark.pdf
"""
from __future__ import annotations
import argparse
import html as _html_mod
import os
import re
import subprocess
import sys
import tempfile
import time
from pathlib import Path
def repo_root() -> Path:
return Path(__file__).resolve().parent.parent
def find_chromium_executable() -> Path | None:
"""Find a Chromium-based browser on the system (prioritizes WSL/Linux paths).
On WSL Windows, checks WSL tools first, then falls back to Windows paths.
"""
import os as _os
import shutil
wsl_paths = [
"/usr/bin/google-chrome",
"/usr/bin/google-chrome-stable",
"/usr/bin/chromium-browser",
"/usr/bin/chromium",
"/usr/bin/microsoft-edge",
"/usr/bin/microsoft-edge-stable",
"/usr/bin/microsoft-edge-dev",
"/snap/bin/chromium",
"/usr/local/bin/chrome",
"/opt/google-chrome/",
]
for p in wsl_paths:
if os.path.isfile(p):
return Path(p)
for name in ("google-chrome-stable", "google-chrome", "chromium-browser", "chromium",
"microsoft-edge-stable", "microsoft-edge", "msedge", "chrome"):
w = shutil.which(name)
if w:
return Path(w)
if sys.platform == "win32":
paths = [
Path(_os.environ.get("PROGRAMFILES(X86)", "")) / "Microsoft/Edge/Application/msedge.exe",
Path(_os.environ.get("LOCALAPPDATA", "")) / "Microsoft/Edge/Application/msedge.exe",
Path(_os.environ.get("PROGRAMFILES", "")) / "Google/Chrome/Application/chrome.exe",
]
for p in paths:
if p.is_file():
return p
return None
def run_mkdocs(site_dir: Path) -> None:
"""Build MkDocs site."""
site_dir.mkdir(parents=True, exist_ok=True)
subprocess.run(
[sys.executable, "-m", "mkdocs", "build", "-d", str(site_dir)],
cwd=repo_root(),
check=True,
)
def inject_print_light_css(html_file: Path) -> Path:
"""Inject print-light.css inline into the built HTML for light PDF builds."""
html_path = html_file.resolve()
print_light_css = repo_root() / "docs" / "stylesheets" / "print-light.css"
if not print_light_css.is_file():
print(f"Warning: {print_light_css} not found, skipping CSS injection.", file=sys.stderr)
return html_path
css_content = print_light_css.read_text(encoding="utf-8")
html_content = html_path.read_text(encoding="utf-8")
head_match = re.search(r"<head(?:[^>]*)>", html_content, re.IGNORECASE)
if not head_match:
print("Warning: Could not find <head> tag in HTML, skipping CSS injection.", file=sys.stderr)
return html_path
insert_pos = head_match.end()
style_block = (
"\n<!-- Light PDF theme: injected inline so file:// URI resolves correctly -->\n"
"<style>\n"
+ css_content
+ "\n</style>\n"
)
new_html = html_content[:insert_pos] + style_block + html_content[insert_pos:]
output_file = html_path.with_stem(html_path.stem + "-light-pdf")
output_file.write_text(new_html, encoding="utf-8")
return output_file
def print_to_pdf(browser: Path, html_file: Path, pdf_out: Path) -> Path:
"""Render html_file to pdf_out via headless Chromium."""
pdf_out.parent.mkdir(parents=True, exist_ok=True)
partial = pdf_out.parent / f".{pdf_out.name}.writing"
partial.unlink(missing_ok=True)
html_file = inject_print_light_css(html_file)
uri = html_file.resolve().as_uri()
cmd = [str(browser)]
if os.environ.get("CI"):
cmd += ["--no-sandbox", "--disable-setuid-sandbox", "--disable-dev-shm-usage"]
cmd += [
"--headless=new",
"--disable-gpu",
"--no-pdf-header-footer",
"--print-background",
"--no-margins",
f"--print-to-pdf={partial.resolve()}",
uri,
]
subprocess.run(cmd, check=True, timeout=600)
deadline = time.time() + 120
while time.time() < deadline:
if partial.exists() and partial.stat().st_size > 0:
break
time.sleep(0.25)
else:
partial.unlink(missing_ok=True)
raise RuntimeError(f"PDF was not written to {partial}")
try:
if pdf_out.exists():
pdf_out.unlink()
except PermissionError:
fallback = pdf_out.with_name(f"{pdf_out.stem}-new{pdf_out.suffix}")
fallback.unlink(missing_ok=True)
partial.replace(fallback)
return fallback
partial.replace(pdf_out)
return pdf_out
# ---------------------------------------------------------------------------
# Front matter: ToC parsing + HTML generation
# ---------------------------------------------------------------------------
def parse_toc_headings(guide_md: Path) -> list[tuple[int, str]]:
"""Extract H2 and H3 headings from the guide markdown source.
Returns a list of (level, title) tuples in document order.
Strips MkDocs anchor suffixes like { #some-id } and common inline markup.
Skips headings inside fenced code blocks.
"""
headings: list[tuple[int, str]] = []
in_fence = False
fence_re = re.compile(r"^\s*```")
heading_re = re.compile(r"^(#{2,3})\s+(.+?)(?:\s*\{[^}]*\})?\s*$")
inline_re = re.compile(
r"\*{1,2}([^*]+)\*{1,2}" # **bold** / *italic*
r"|`[^`]+`" # `code`
r"|\[([^\]]+)\]\([^)]*\)" # [text](url)
)
for line in guide_md.read_text(encoding="utf-8").splitlines():
if fence_re.match(line):
in_fence = not in_fence
continue
if in_fence:
continue
m = heading_re.match(line)
if m:
level = len(m.group(1))
raw = m.group(2).strip()
title = inline_re.sub(
lambda x: x.group(1) or x.group(2) or "", raw
).strip()
headings.append((level, title))
return headings
def create_toc_html(tmp_dir: str, headings: list[tuple[int, str]], is_dark: bool) -> str:
"""Write a research-style Table of Contents HTML file and return its path.
H2 entries: full-width row with dot leader.
H3 entries: indented, italic, muted colour.
Layout matches the cover page (A4, same font stack, no Chromium margins).
"""
if is_dark:
bg = "#1f1f31"
fg = "#e0e0e0"
muted = "#a0a0c0"
rule = "#4a4a6a"
h3color = "#b8b8d8"
else:
bg = "#ffffff"
fg = "#1a1a1a"
muted = "#555555"
rule = "#cccccc"
h3color = "#444466"
rows: list[str] = []
for level, title in headings:
safe = _html_mod.escape(title)
if level == 2:
rows.append(
f'<div class="toc-h2">'
f'<span class="toc-title">{safe}</span>'
f'<span class="toc-dots"></span>'
f"</div>"
)
else:
rows.append(f'<div class="toc-h3">{safe}</div>')
body = "\n".join(rows)
css = (
"* { box-sizing: border-box; margin: 0; padding: 0; }\n"
"@page { size: A4; margin: 0; }\n"
"html, body {\n"
f" width: 210mm;\n"
f" background: {bg};\n"
f" color: {fg};\n"
" font-family: 'EB Garamond', Georgia, 'Times New Roman', serif;\n"
"}\n"
".page {\n"
" width: 210mm;\n"
" min-height: 297mm;\n"
" padding: 25mm 28mm 28mm 28mm;\n"
"}\n"
".toc-heading {\n"
" font-size: 18pt;\n"
" font-weight: normal;\n"
" letter-spacing: 0.04em;\n"
" margin-bottom: 8mm;\n"
" padding-bottom: 3mm;\n"
f" border-bottom: 1px solid {rule};\n"
f" color: {fg};\n"
"}\n"
".toc-h2 {\n"
" display: flex;\n"
" align-items: baseline;\n"
" font-size: 10.5pt;\n"
" font-weight: normal;\n"
f" color: {fg};\n"
" margin-top: 3.5pt;\n"
" margin-bottom: 1.5pt;\n"
"}\n"
".toc-title {\n"
" white-space: nowrap;\n"
" overflow: hidden;\n"
" flex-shrink: 0;\n"
" max-width: 85%;\n"
"}\n"
".toc-dots {\n"
" flex: 1;\n"
f" border-bottom: 1px dotted {muted};\n"
" margin: 0 4pt;\n"
" position: relative;\n"
" top: -2pt;\n"
" min-width: 8pt;\n"
"}\n"
".toc-h3 {\n"
" font-size: 9pt;\n"
f" color: {h3color};\n"
" padding-left: 10mm;\n"
" margin-top: 1pt;\n"
" margin-bottom: 1pt;\n"
" font-style: italic;\n"
"}\n"
)
html = (
'<!DOCTYPE html>\n<html>\n<head>\n<meta charset="UTF-8">\n'
f"<style>\n{css}</style>\n</head>\n<body>\n"
'<div class="page">\n'
' <p class="toc-heading">Table of Contents</p>\n'
f"{body}\n"
"</div>\n</body>\n</html>\n"
)
html_path = os.path.join(tmp_dir, "toc.html")
with open(html_path, "w", encoding="utf-8") as f:
f.write(html)
return html_path
# ---------------------------------------------------------------------------
# Shared Chromium render helper
# ---------------------------------------------------------------------------
def _render_html_to_pdf(
browser: Path, html_path: str, pdf_path: str, ci: bool = False
) -> None:
"""Render a local HTML file to PDF via headless Chromium."""
cmd = [
str(browser),
"--headless=new",
"--disable-gpu",
"--no-pdf-header-footer",
"--print-background",
"--no-margins",
f"--print-to-pdf={pdf_path}",
Path(html_path).resolve().as_uri(),
]
if ci:
cmd[1:1] = ["--no-sandbox", "--disable-setuid-sandbox", "--disable-dev-shm-usage"]
subprocess.run(cmd, check=True, capture_output=True, timeout=120)
# ---------------------------------------------------------------------------
# Front matter assembly: cover + ToC prepended to body PDF
# ---------------------------------------------------------------------------
def prepend_front_matter(browser: Path, pdf_path: Path, is_dark: bool) -> Path:
"""Render cover + ToC and prepend them to pdf_path in-place.
- Cover HTML is sourced from convert.py (single definition).
- ToC headings are parsed from docs/guide/index.md.
- Merged order: cover -> toc -> body, via a single qpdf call.
"""
sys.path.insert(0, str(repo_root() / "scripts"))
from convert import create_cover_page # noqa: PLC0415
guide_md = repo_root() / "docs" / "guide" / "index.md"
ci = bool(os.environ.get("CI"))
print(" Parsing ToC headings...", flush=True)
headings = parse_toc_headings(guide_md)
n_h2 = sum(1 for l, _ in headings if l == 2)
n_h3 = sum(1 for l, _ in headings if l == 3)
print(f" Found {len(headings)} headings ({n_h2} H2, {n_h3} H3).", flush=True)
with tempfile.TemporaryDirectory() as tmp:
print(" Rendering cover page...", flush=True)
cover_html = create_cover_page(tmp, is_dark=is_dark)
cover_pdf = os.path.join(tmp, "cover.pdf")
_render_html_to_pdf(browser, cover_html, cover_pdf, ci=ci)
print(" Rendering ToC page...", flush=True)
toc_html = create_toc_html(tmp, headings, is_dark=is_dark)
toc_pdf = os.path.join(tmp, "toc.pdf")
_render_html_to_pdf(browser, toc_html, toc_pdf, ci=ci)
merged = str(pdf_path.parent / f".{pdf_path.name}.with-front")
subprocess.run(
["qpdf", "--empty", "--pages",
cover_pdf, toc_pdf, str(pdf_path),
"--", merged],
check=True,
)
Path(merged).replace(pdf_path)
return pdf_path
# ---------------------------------------------------------------------------
# Dark PDF build (delegates to convert.py which adds its own front matter)
# ---------------------------------------------------------------------------
def build_dark_pdf(light_pdf: Path, dark_pdf: Path) -> Path:
"""Convert the light PDF to dark mode using scripts/convert.py."""
convert_script = repo_root() / "scripts" / "convert.py"
print(f"Converting {light_pdf.name} -> {dark_pdf.name} (dark mode)...")
subprocess.run(
[sys.executable, str(convert_script), str(light_pdf), str(dark_pdf)],
check=True,
)
return dark_pdf
# ---------------------------------------------------------------------------
# CLI
# ---------------------------------------------------------------------------
def main() -> int:
root = repo_root()
ap = argparse.ArgumentParser(
description="Build MkDocs + single-page guide PDF (light and/or dark mode)."
)
ap.add_argument(
"--site-dir",
type=Path,
default=root / "build" / "html",
help="MkDocs output directory (default: ./build/html)",
)
ap.add_argument(
"--pdf-light",
type=Path,
default=root / "export" / "thgtoa.pdf",
help="Output path for light PDF (default: ./export/thgtoa.pdf)",
)
ap.add_argument(
"--pdf-dark",
type=Path,
default=root / "export" / "thgtoa-dark.pdf",
help="Output path for dark PDF (default: ./export/thgtoa-dark.pdf)",
)
ap.add_argument(
"--skip-mkdocs",
action="store_true",
help="Reuse existing site dir; skip MkDocs build.",
)
mode = ap.add_mutually_exclusive_group()
mode.add_argument("--dark", action="store_true",
help="Dark PDF only (light PDF must already exist)")
mode.add_argument("--both", action="store_true",
help="Build light PDF, then dark PDF")
args = ap.parse_args()
build_light = not args.dark
build_dark = args.dark or args.both
# --- Light PDF ---
if build_light:
guide_html = args.site_dir / "guide" / "index.html"
if not args.skip_mkdocs:
run_mkdocs(args.site_dir)
if not guide_html.is_file():
print(f"Missing {guide_html}; run without --skip-mkdocs first.", file=sys.stderr)
return 1
browser = find_chromium_executable()
if not browser:
print(
"No Chromium-based browser found (Chrome, Edge, or Chromium). "
"Install Google Chrome or Microsoft Edge, or add Chromium to PATH.",
file=sys.stderr,
)
return 1
out_light = print_to_pdf(browser, guide_html, args.pdf_light)
out_light = prepend_front_matter(browser, out_light, is_dark=False)
size_kb = out_light.stat().st_size // 1024
print(f"Wrote {out_light.resolve()} ({size_kb} KiB) [Light Mode]")
# --- Dark PDF ---
if build_dark:
if not args.pdf_light.exists():
print(
f"Light PDF not found at {args.pdf_light}. "
"Run without --dark first, or use --both.",
file=sys.stderr,
)
return 1
out_dark = build_dark_pdf(args.pdf_light, args.pdf_dark)
size_kb = out_dark.stat().st_size // 1024
print(f"Wrote {out_dark.resolve()} ({size_kb} KiB) [Dark Mode]")
return 0
if __name__ == "__main__":
raise SystemExit(main())
#!/usr/bin/env python3
"""Build the MkDocs site, then render docs/guide/ to a single PDF via a Chromium-based browser.
Uses headless Chrome/Edge print-to-PDF (embeds images). WeasyPrint-based mkdocs-with-pdf is
omitted here because it needs GTK/Pango (awkward on Windows).
Usage (from repo root):
python scripts/build_guide_pdf.py
python scripts/build_guide_pdf.py --site-dir build/html --pdf export/guide.pdf
"""
from __future__ import annotations
import argparse
import os
import shutil
import subprocess
import sys
import time
from pathlib import Path
def repo_root() -> Path:
return Path(__file__).resolve().parent.parent
def find_chromium_executable() -> Path | None:
if sys.platform == "win32":
paths = [
Path(os.environ.get("PROGRAMFILES(X86)", "")) / "Microsoft/Edge/Application/msedge.exe",
Path(os.environ.get("LOCALAPPDATA", "")) / "Microsoft/Edge/Application/msedge.exe",
Path(os.environ.get("PROGRAMFILES", "")) / "Google/Chrome/Application/chrome.exe",
Path(os.environ.get("PROGRAMFILES(X86)", "")) / "Google/Chrome/Application/chrome.exe",
Path(os.environ.get("LOCALAPPDATA", "")) / "Google/Chrome/Application/chrome.exe",
]
for p in paths:
if p.is_file():
return p
for name in ("chrome", "msedge"):
w = shutil.which(name)
if w:
return Path(w)
elif sys.platform == "darwin":
for p in (
"/Applications/Google Chrome.app/Contents/MacOS/Google Chrome",
"/Applications/Microsoft Edge.app/Contents/MacOS/Microsoft Edge",
"/Applications/Chromium.app/Contents/MacOS/Chromium",
):
if os.path.isfile(p):
return Path(p)
for name in ("google-chrome-stable", "google-chrome", "chromium-browser", "chromium", "chrome"):
w = shutil.which(name)
if w:
return Path(w)
return None
def run_mkdocs(site_dir: Path) -> None:
site_dir.mkdir(parents=True, exist_ok=True)
subprocess.run(
[sys.executable, "-m", "mkdocs", "build", "-d", str(site_dir)],
cwd=repo_root(),
check=True,
)
def print_to_pdf(browser: Path, html_file: Path, pdf_out: Path) -> Path:
"""Write PDF to ``pdf_out``. Uses a temp file first so an open ``guide.pdf`` on Windows
does not block the build: if the final path is locked, writes ``guide-new.pdf`` instead.
"""
pdf_out.parent.mkdir(parents=True, exist_ok=True)
partial = pdf_out.parent / f".{pdf_out.name}.writing"
partial.unlink(missing_ok=True)
uri = html_file.resolve().as_uri()
# Chromium headless print; allow time for fonts/images on very large pages.
cmd = [str(browser)]
if os.environ.get("CI"):
# GitHub Actions / other CI runners often need these for Chromium to start.
cmd += [
"--no-sandbox",
"--disable-setuid-sandbox",
"--disable-dev-shm-usage",
]
cmd += [
"--headless=new",
"--disable-gpu",
"--no-pdf-header-footer",
f"--print-to-pdf={partial.resolve()}",
uri,
]
subprocess.run(cmd, check=True, timeout=600)
deadline = time.time() + 120
while time.time() < deadline:
if partial.exists() and partial.stat().st_size > 0:
break
time.sleep(0.25)
else:
partial.unlink(missing_ok=True)
raise RuntimeError(f"PDF was not written to {partial}")
try:
if pdf_out.exists():
pdf_out.unlink()
except PermissionError:
fallback = pdf_out.with_name(f"{pdf_out.stem}-new{pdf_out.suffix}")
fallback.unlink(missing_ok=True)
partial.replace(fallback)
return fallback
partial.replace(pdf_out)
return pdf_out
def main() -> int:
root = repo_root()
ap = argparse.ArgumentParser(description="Build MkDocs + single-page guide PDF.")
ap.add_argument(
"--site-dir",
type=Path,
default=root / "site",
help="MkDocs output directory (default: ./site)",
)
ap.add_argument(
"--pdf",
type=Path,
default=root / "export" / "guide.pdf",
help="Output PDF path (default: ./export/guide.pdf)",
)
ap.add_argument("--skip-mkdocs", action="store_true", help="Reuse existing site dir; only run print-to-pdf.")
args = ap.parse_args()
guide_html = args.site_dir / "guide" / "index.html"
if not args.skip_mkdocs:
run_mkdocs(args.site_dir)
if not guide_html.is_file():
print(f"Missing {guide_html}; run without --skip-mkdocs first.", file=sys.stderr)
return 1
browser = find_chromium_executable()
if not browser:
print(
"No Chromium-based browser found (Chrome, Edge, or Chromium). "
"Install Google Chrome or Microsoft Edge, or add Chromium to PATH.",
file=sys.stderr,
)
return 1
out = print_to_pdf(browser, guide_html, args.pdf)
size_kb = out.stat().st_size // 1024
print(f"Wrote {out.resolve()} ({size_kb} KiB)")
if out.resolve() != args.pdf.resolve():
print(
f"Note: {args.pdf.name} was in use; close it and rename or replace with the file above.",
file=sys.stderr,
)
return 0
if __name__ == "__main__":
raise SystemExit(main())
scripts/convert.py
-508
View File
@@ -1,508 +0,0 @@
#!/usr/bin/env python3
"""
Dark-mode PDF converter (pixel-based, batch-safe).
Rasterizes each page with pdftoppm, applies the hacker theme palette
pixel-by-pixel, then reassembles into a PDF. Processes in batches of 50
pages to stay within memory limits on large documents, then merges with qpdf.
Usage:
python scripts/convert.py INPUT.pdf [OUTPUT.pdf]
python scripts/convert.py INPUT.pdf [OUTPUT.pdf] [--dpi 200]
[--bg 1f1f31] [--text e0e0e0] [--link 5e8bde]
[--batch-size 50]
Examples:
python scripts/convert.py export/thgtoa.pdf export/thgtoa-dark.pdf
python scripts/convert.py export/thgtoa.pdf --dpi 150 --bg 0d1117
Note: Adds a cover page at the start with title/subtitle/version info.
"""
from __future__ import annotations
import argparse
import glob
import os
import subprocess
import sys
import tempfile
from pathlib import Path
import numpy as np
from PIL import Image
# --------------------------------------------------------------------------- #
# Defaults (Hacker theme)
# --------------------------------------------------------------------------- #
DEFAULT_BG = (0x1f, 0x1f, 0x31)
DEFAULT_TEXT = (0xe0, 0xe0, 0xe0)
DEFAULT_LINK = (0x5e, 0x8b, 0xde)
DEFAULT_DPI = 200
DEFAULT_BATCH = 50
def hex_to_rgb(h: str) -> tuple:
h = h.lstrip('#')
return tuple(int(h[i:i+2], 16) for i in (0, 2, 4))
def apply_dark_theme(
img: Image.Image,
bg=DEFAULT_BG,
text=DEFAULT_TEXT,
link=DEFAULT_LINK,
) -> Image.Image:
"""
Remap a white-background page image to a dark theme.
Strategy:
- Near-white pixels (page background) → bg color
- Dark, low-saturation pixels (text) → text color
- Blue-dominant dark pixels (links) → link color
- High-saturation pixels (photos/images) → preserved exactly as-is
(no dark remapping; images stay at natural colors)
The key fix vs. the old version: output is initialized from the *original*
pixels, so any pixel that doesn't match a remap mask keeps its source color.
This prevents the "black blobs" bug where image regions fell through to the
zero-initialized buffer.
"""
arr = np.array(img.convert('RGB'), dtype=np.float32)
norm = arr / 255.0
# Luminance (Rec. 601)
lum = (
0.299 * norm[:, :, 0] +
0.587 * norm[:, :, 1] +
0.114 * norm[:, :, 2]
)
# Saturation (HSV model, vectorised)
ch_min = np.min(norm, axis=2)
ch_max = np.max(norm, axis=2)
# Suppress the numpy divide error, idc
# division happens on all elements including the zero ones
with np.errstate(divide='ignore', invalid='ignore'):
sat = np.where(ch_max > 0.001, (ch_max - ch_min) / ch_max, 0.0).astype(np.float32)
# --- Masks ---
# High-saturation = image/photo content — leave untouched
is_image = sat > 0.20
# Near-white page background
is_bg = (lum > 0.88) & ~is_image
# Blue-ish hyperlinks: blue channel dominant, dark, not an image
is_link = (
~is_image &
~is_bg &
(norm[:, :, 2] > 0.30) &
(norm[:, :, 2] > norm[:, :, 0] * 1.20) &
(lum < 0.75)
)
# Dark ink (text, borders, rules): not image, not bg, not link
is_text = ~is_image & ~is_bg & ~is_link & (lum < 0.85)
# --- Build output from original pixels ---
# Start from a copy so anything not matched keeps source color.
out = arr.copy()
bg_f = np.array(bg, dtype=np.float32)
text_f = np.array(text, dtype=np.float32)
link_f = np.array(link, dtype=np.float32)
# Full-strength remap for text: anything that was dark ink becomes text_color
# at full brightness. No partial blend — partial blends leave mid-gray elements
# (captions, borders, muted labels) at unreadable intermediate values.
bg_mask3 = is_bg[..., np.newaxis]
text_mask3 = is_text[..., np.newaxis]
link_mask3 = is_link[..., np.newaxis]
out = np.where(bg_mask3, bg_f, out)
out = np.where(text_mask3, text_f, out)
out = np.where(link_mask3, link_f, out)
return Image.fromarray(out.clip(0, 255).astype(np.uint8))
def _save_images_as_pdf(images: list, output_path: str) -> None:
"""Save a list of RGB PIL images as a PDF without requiring libjpeg.
Pillow's PDF writer defaults to JPEG encoding for RGB images, which
fails when libjpeg is absent in the environment. Fix: quantize each
image to palette mode (256 colours, FASTOCTREE) so Pillow uses
zlib/deflate instead of JPEG, save each as an individual single-page
PDF, then merge the page PDFs with qpdf.
Colour fidelity is preserved — the hacker theme uses only a handful
of distinct colours so 256-colour quantization is visually lossless.
"""
import tempfile as _tempfile
with _tempfile.TemporaryDirectory() as staging:
page_pdfs = []
for i, img in enumerate(images):
page_path = os.path.join(staging, f'p{i:05d}.pdf')
img.quantize(colors=256, method=Image.Quantize.FASTOCTREE).save(
page_path, format='PDF'
)
page_pdfs.append(page_path)
subprocess.run(
['qpdf', '--empty', '--pages'] + page_pdfs + ['--', output_path],
check=True,
)
def _check_qpdf() -> bool:
return subprocess.run(
['qpdf', '--version'], capture_output=True
).returncode == 0
def _check_dependencies() -> None:
"""Verify required system tools are available before doing any work."""
missing = []
for tool in ('pdftoppm', 'qpdf'):
if subprocess.run(['which', tool], capture_output=True).returncode != 0:
missing.append(tool)
if missing:
tools = ', '.join(missing)
instructions = (
f"Install with:\n"
f" Linux/WSL: sudo apt install poppler-utils qpdf\n"
f" macOS: brew install poppler qpdf\n"
f" Windows: see docs/code/develop.md"
)
raise RuntimeError(
f"Missing required system tool(s): {tools}\n{instructions}"
)
def create_cover_page(tmp_dir: str, is_dark: bool) -> str:
"""Create a research-style text-only cover page for Chromium rendering."""
if is_dark:
bg_color = '#1f1f31'
text_color = '#e0e0e0'
rule_color = '#4a4a6a'
meta_color = '#a0a0c0'
else:
bg_color = '#ffffff'
text_color = '#1a1a1a'
rule_color = '#cccccc'
meta_color = '#555555'
html_path = os.path.join(tmp_dir, 'cover.html')
with open(html_path, 'w', encoding='utf-8') as f:
f.write(f"""<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<style>
* {{
box-sizing: border-box;
margin: 0;
padding: 0;
}}
@page {{
size: A4;
margin: 0;
}}
html, body {{
width: 210mm;
height: 297mm;
background: {bg_color};
color: {text_color};
font-family: 'EB Garamond', Georgia, 'Times New Roman', serif;
}}
.page {{
width: 210mm;
height: 297mm;
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
padding: 30mm 25mm;
text-align: center;
}}
.title {{
font-size: 28pt;
font-weight: normal;
line-height: 1.25;
letter-spacing: 0.01em;
margin-bottom: 10mm;
}}
.rule {{
width: 80mm;
height: 1px;
background: {rule_color};
margin: 0 auto 10mm auto;
}}
.subtitle {{
font-size: 13pt;
font-weight: normal;
font-style: italic;
color: {meta_color};
margin-bottom: 14mm;
}}
.meta {{
font-size: 11pt;
color: {meta_color};
line-height: 1.9;
}}
.meta strong {{
color: {text_color};
font-weight: normal;
}}
.version {{
font-size: 11pt;
color: {meta_color};
margin-top: 12mm;
letter-spacing: 0.05em;
}}
</style>
</head>
<body>
<div class="page">
<p class="title">The Hitchhiker&#8217;s Guide<br>to Online Anonymity</p>
<div class="rule"></div>
<p class="subtitle">The comprehensive guide for online anonymity and OpSec.</p>
<div class="meta">
<p><strong>Author</strong> &nbsp; Anonymous Planet</p>
<p><strong>License</strong> &nbsp; Creative Commons BY-SA 4.0</p>
<p><strong>Source</strong> &nbsp; https://anonymousplanet.net</p>
</div>
<p class="version">v1.2.5 &mdash; June 2026</p>
</div>
</body>
</html>""")
return html_path
def convert_pdf_to_dark(
input_path: str | Path,
output_path: str | Path,
dpi: int = DEFAULT_DPI,
bg=DEFAULT_BG,
text=DEFAULT_TEXT,
link=DEFAULT_LINK,
batch_size: int = DEFAULT_BATCH,
) -> None:
"""
Full pipeline: rasterize → apply dark theme → reassemble as PDF.
For large documents, pages are processed in batches of `batch_size` to
avoid OOM, then merged with qpdf. Falls back to single-pass Pillow save
if qpdf is not available (fine for small documents).
Adds a cover page at the start with title/subtitle/version info.
"""
input_path = str(input_path)
output_path = str(output_path)
_check_dependencies()
with tempfile.TemporaryDirectory() as tmp:
# 1. Rasterize all pages
prefix = os.path.join(tmp, 'page')
result = subprocess.run(
['pdftoppm', '-r', str(dpi), '-png', input_path, prefix],
capture_output=True,
)
if result.returncode != 0:
raise RuntimeError(
f"pdftoppm failed:\n{result.stderr.decode()}"
)
pages = sorted(glob.glob(prefix + '-*.png'))
if not pages:
raise RuntimeError(
"pdftoppm produced no output pages — "
"is the PDF valid and not password-protected?"
)
total = len(pages)
print(f" Converting {total} page(s) at {dpi} DPI…", flush=True)
out_dir = os.path.dirname(output_path)
if out_dir:
os.makedirs(out_dir, exist_ok=True)
# Determine theme from filename for cover page
pdf_output = Path(output_path)
pdf_name = pdf_output.stem.lower()
is_dark = 'dark' in pdf_name
print(f" Theme: {'Going dark' if is_dark else 'Light mode'}")
# 2. Build front matter: cover + ToC
# Import ToC helpers from build_guide_pdf.py (single source of truth).
scripts_dir = str(Path(__file__).resolve().parent)
if scripts_dir not in sys.path:
sys.path.insert(0, scripts_dir)
from build_guide_pdf import parse_toc_headings, create_toc_html # noqa: PLC0415
cover_html_path = create_cover_page(tmp, is_dark)
browser = find_chromium_executable()
if not browser:
raise RuntimeError(
"No Chromium-based browser found; needed for cover page rendering.\n"
"Install Chrome, Edge, or add Chromium to PATH."
)
cover_pdf = os.path.join(tmp, 'cover.pdf')
cmd = [str(browser), "--headless=new", "--disable-gpu",
"--no-pdf-header-footer", "--print-background", "--no-margins",
f"--print-to-pdf={cover_pdf}", cover_html_path]
subprocess.run(cmd, check=True, capture_output=True)
guide_md = Path(__file__).resolve().parent.parent / 'docs' / 'guide' / 'index.md'
if guide_md.is_file():
print(" Building ToC...", flush=True)
headings = parse_toc_headings(guide_md)
toc_html_path = create_toc_html(tmp, headings, is_dark)
toc_pdf = os.path.join(tmp, 'toc.pdf')
cmd_toc = [str(browser), "--headless=new", "--disable-gpu",
"--no-pdf-header-footer", "--print-background", "--no-margins",
f"--print-to-pdf={toc_pdf}", toc_html_path]
subprocess.run(cmd_toc, check=True, capture_output=True)
front_pages = [cover_pdf, toc_pdf]
else:
print(" Warning: guide/index.md not found, skipping ToC.", file=sys.stderr)
front_pages = [cover_pdf]
# 3. Process pages with theme remapping
use_batches = total > batch_size and _check_qpdf()
if use_batches:
batch_dir = os.path.join(tmp, 'batches')
os.makedirs(batch_dir)
batch_files = []
for start in range(0, total, batch_size):
batch = pages[start:start + batch_size]
batch_num = start // batch_size + 1
batch_path = os.path.join(batch_dir, f'batch_{batch_num:04d}.pdf')
print(
f" Batch {batch_num}/{(total + batch_size - 1) // batch_size}: "
f"pages {start + 1}–{start + len(batch)}",
flush=True,
)
dark = [apply_dark_theme(Image.open(p), bg, text, link) for p in batch]
_save_images_as_pdf(dark, batch_path)
batch_files.append(batch_path)
# Merge batches with front matter using qpdf
print(" Merging batches and front matter...", flush=True)
subprocess.run(
['qpdf', '--empty', '--pages'] + front_pages + batch_files + ['--', output_path],
check=True,
)
else:
# Single-pass for small documents or when qpdf is unavailable
dark_pages = []
for i, p in enumerate(pages, 1):
if i % 50 == 0 or i == 1:
print(f" Page {i}/{total}", flush=True)
dark_pages.append(apply_dark_theme(Image.open(p), bg, text, link))
_save_images_as_pdf(dark_pages, output_path)
# Prepend front matter to the single-pass output
if not use_batches:
tmp_body = os.path.join(tmp, 'body_only.pdf')
os.rename(output_path, tmp_body)
subprocess.run(
['qpdf', '--empty', '--pages'] + front_pages + [tmp_body] + ['--', output_path],
check=True,
)
size_mb = os.path.getsize(output_path) / 1024 / 1024
print(f" Saved → {output_path} ({size_mb:.1f} MB)")
def find_chromium_executable() -> Path | None:
"""Find a Chromium-based browser on the system (prioritizes WSL/Linux paths).
On WSL Windows, checks WSL tools first, then falls back to Windows paths.
"""
import os as _os
import shutil
import sys
# First, check WSL/Linux locations (common for WSL Windows)
wsl_paths = [
"/usr/bin/google-chrome",
"/usr/bin/google-chrome-stable",
"/usr/bin/chromium-browser",
"/usr/bin/chromium",
"/usr/bin/microsoft-edge",
"/usr/bin/microsoft-edge-stable",
"/usr/bin/microsoft-edge-dev",
"/snap/bin/chromium",
"/usr/local/bin/chrome",
"/opt/google-chrome/",
]
for p in wsl_paths:
if _os.path.isfile(p):
return Path(p)
# Then check shutil.which (standard PATH, includes WSL paths)
for name in ("google-chrome-stable", "google-chrome", "chromium-browser", "chromium",
"microsoft-edge-stable", "microsoft-edge", "msedge", "chrome"):
w = shutil.which(name)
if w:
return Path(w)
# Finally, Windows-specific paths (if running natively on Windows)
if sys.platform == "win32":
paths = [
Path(_os.environ.get("PROGRAMFILES(X86)", "")) / "Microsoft/Edge/Application/msedge.exe",
Path(_os.environ.get("LOCALAPPDATA", "")) / "Microsoft/Edge/Application/msedge.exe",
Path(_os.environ.get("PROGRAMFILES", "")) / "Google/Chrome/Application/chrome.exe",
]
for p in paths:
if p.is_file():
return p
return None
# --------------------------------------------------------------------------- #
# CLI
# --------------------------------------------------------------------------- #
def main() -> int:
parser = argparse.ArgumentParser(description='Convert a PDF to dark mode.')
parser.add_argument('input', help='Input PDF path')
parser.add_argument('output', nargs='?', help='Output PDF path (optional)')
parser.add_argument('--dpi', type=int, default=DEFAULT_DPI, help='Rasterization DPI (default: 200)')
parser.add_argument('--batch-size', type=int, default=DEFAULT_BATCH, help='Pages per batch (default: 50)')
parser.add_argument('--bg', default='1f1f31', help='Background hex color (default: 1f1f31)')
parser.add_argument('--text', default='e0e0e0', help='Body text hex color (default: e0e0e0)')
parser.add_argument('--link', default='5e8bde', help='Link/blue hex color (default: 5e8bde)')
args = parser.parse_args()
if not args.output:
base = Path(args.input).stem
args.output = str(Path(args.input).parent / f"{base}-dark.pdf")
convert_pdf_to_dark(
args.input,
args.output,
dpi=args.dpi,
bg=hex_to_rgb(args.bg),
text=hex_to_rgb(args.text),
link=hex_to_rgb(args.link),
batch_size=args.batch_size,
)
return 0
if __name__ == '__main__':
raise SystemExit(main())
scripts/hooks/require-commit-body.sh
-58
View File
@@ -1,58 +0,0 @@
#!/usr/bin/env bash
COMMIT_MSG_FILE="$1"
if [ -z "$COMMIT_MSG_FILE" ]; then
echo "require-commit-body: no commit message file supplied" >&2
exit 1
fi
stripped=$(grep -v '^\s*#' "$COMMIT_MSG_FILE" | sed 's/[[:space:]]*$//')
subject=$(echo "$stripped" | sed -n '1p')
separator=$(echo "$stripped" | sed -n '2p')
body=$(echo "$stripped" | tail -n +3 | grep -v '^\s*$')
if [ -z "$subject" ]; then
echo ""
echo " COMMIT REJECTED: subject line is empty." >&2
echo ""
exit 1
fi
if [ -z "$separator" ] && [ -z "$body" ]; then
echo ""
echo " COMMIT REJECTED: commit has no body." >&2
echo ""
echo " Every commit must explain *why*, not just *what*." >&2
echo " Format:" >&2
echo ""
echo " type(scope): short subject" >&2
echo ""
echo " Explain the motivation for this change. What problem does" >&2
echo " it solve? Why is this the right approach? Reference any" >&2
echo " relevant issues, prior art, or context." >&2
echo ""
exit 1
fi
if [ -n "$separator" ]; then
echo ""
echo " COMMIT REJECTED: no blank line between subject and body." >&2
echo ""
echo " The second line of a commit message must be blank." >&2
echo ""
exit 1
fi
if [ -z "$body" ]; then
echo ""
echo " COMMIT REJECTED: commit body is empty." >&2
echo ""
echo " Add at least one line after the blank separator explaining" >&2
echo " why this change was made." >&2
echo ""
exit 1
fi
exit 0
scripts/install_fonts.py
-94
View File
@@ -1,94 +0,0 @@
#!/usr/bin/env python3
"""
Download self-hosted fonts for the thgtoa MkDocs site.
Run once from the repo root. Requires network access (uses npm registry
via a temporary npm pack, or direct URLs from fontsource CDN as fallback).
Usage:
python scripts/install_fonts.py
Fonts installed:
docs/fonts/eb-garamond/ - EB Garamond 400/700 normal+italic (latin, latin-ext)
docs/fonts/fira-code/ - Fira Code variable (latin, latin-ext)
"""
import os
import subprocess
import sys
import tarfile
import tempfile
import shutil
REPO_ROOT = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
FONTS_DIR = os.path.join(REPO_ROOT, "docs", "fonts")
EB_GARAMOND_DIR = os.path.join(FONTS_DIR, "eb-garamond")
FIRA_CODE_DIR = os.path.join(FONTS_DIR, "fira-code")
EB_GARAMOND_FILES = [
"eb-garamond-latin-400-normal.woff2",
"eb-garamond-latin-400-italic.woff2",
"eb-garamond-latin-700-normal.woff2",
"eb-garamond-latin-700-italic.woff2",
"eb-garamond-latin-ext-400-normal.woff2",
"eb-garamond-latin-ext-400-italic.woff2",
"eb-garamond-latin-ext-700-normal.woff2",
"eb-garamond-latin-ext-700-italic.woff2",
]
FIRA_CODE_FILES = [
"fira-code-latin-wght-normal.woff2",
"fira-code-latin-ext-wght-normal.woff2",
]
def npm_pack(package: str, tmpdir: str) -> str:
"""Run npm pack and return the path to the extracted package dir."""
result = subprocess.run(
["npm", "pack", package, "--silent"],
cwd=tmpdir, capture_output=True, text=True
)
if result.returncode != 0:
raise RuntimeError(f"npm pack failed for {package}:\n{result.stderr}")
tgz = os.path.join(tmpdir, result.stdout.strip())
with tarfile.open(tgz, "r:gz") as tf:
tf.extractall(tmpdir)
return os.path.join(tmpdir, "package")
def install_package(package: str, files: list[str], dest: str) -> None:
os.makedirs(dest, exist_ok=True)
with tempfile.TemporaryDirectory() as tmpdir:
print(f" Fetching {package} ...")
pkg_dir = npm_pack(package, tmpdir)
files_dir = os.path.join(pkg_dir, "files")
for fname in files:
src = os.path.join(files_dir, fname)
if not os.path.exists(src):
print(f" WARNING: {fname} not found in package", file=sys.stderr)
continue
dst = os.path.join(dest, fname)
shutil.copy2(src, dst)
size = os.path.getsize(dst)
print(f" + {fname} ({size // 1024}K)")
def main() -> None:
print("Installing self-hosted fonts for thgtoa...\n")
if shutil.which("npm") is None:
print("ERROR: npm not found. Install Node.js and re-run.", file=sys.stderr)
sys.exit(1)
print("EB Garamond (fontsource):")
install_package("@fontsource/eb-garamond", EB_GARAMOND_FILES, EB_GARAMOND_DIR)
print("\nFira Code Variable (fontsource):")
install_package("@fontsource-variable/fira-code", FIRA_CODE_FILES, FIRA_CODE_DIR)
print("\nDone. Font files written to docs/fonts/")
print("Commit docs/fonts/ to the repository so it is served with the site.")
if __name__ == "__main__":
main()
scripts/setup_workflow.py
-291
View File
@@ -1,291 +0,0 @@
#!/usr/bin/env python3
"""Setup helper for PDF workflow configuration.
This script helps you configure the necessary GitHub Secrets for the automated
PDF build, signing, and VirusTotal scanning workflows.
Usage:
python scripts/setup_workflow.py
Requirements:
- Python 3.8+
- GPG installed (for key export)
- Access to GitHub repository settings
What it does:
1. Validates your GPG key setup
2. Exports the public key for verification
3. Provides instructions for adding secrets to GitHub
"""
# The Hitchhiker's Guide to Online Anonymity © 2026 by Anonymous Planet is licensed under Creative
# Commons Attribution-NonCommercial 4.0 International
from __future__ import annotations
import subprocess
import sys
from pathlib import Path
# Computes the root directory of the repository based on the current file’s location
def repo_root() -> Path:
return Path(__file__).resolve().parent.parent
# Determines whether the GPG command-line tool is available on the current system
def check_gpg_installed() -> bool:
"""Check if GPG is installed and accessible."""
try:
result = subprocess.run(
["gpg", "--version"],
capture_output=True,
text=True,
timeout=10,
)
return result.returncode == 0
except (FileNotFoundError, subprocess.TimeoutExpired):
return False
# Checks whether the GPG tool is installed and accessible on the system
# Export public keys, parse, and read selection of keys from the GPG keyring
def list_gpg_keys() -> list[dict]:
"""List all GPG keys in the keyring."""
try:
result = subprocess.run(
["gpg", "--list-keys", "--with-colons"],
capture_output=True,
text=True,
check=True,
)
keys = []
current_key = {}
for line in result.stdout.split('\n'):
if line.startswith('pub:'):
if current_key:
keys.append(current_key)
parts = line.split(':')
current_key = {
'type': parts[1],
'key_id': parts[4],
'fingerprint': parts[9] if len(parts) > 9 else None,
'created': parts[5],
'expires': parts[6],
'uid': None,
}
elif line.startswith('uid:'):
parts = line.split(':')
current_key['uid'] = parts[9] if len(parts) > 9 else None
if current_key:
keys.append(current_key)
return keys
except subprocess.CalledProcessError as e:
print(f"Error listing GPG keys: {e}")
return []
def export_public_key(key_id: str, output_file: Path | None = None) -> str | None:
"""Export a public key in ASCII armor format."""
try:
result = subprocess.run(
["gpg", "--armor", "--export", key_id],
capture_output=True,
text=True,
check=True,
)
if output_file:
output_file.write_text(result.stdout)
print(f"✓ Public key exported to {output_file}")
return result.stdout
except subprocess.CalledProcessError as e:
print(f"Error exporting public key: {e}")
return None
# Exporting the given private key in ASCII armor format (requires passphrase)
def export_private_key(key_id: str, output_file: Path | None = None) -> str | None:
"""Export a private key in ASCII armor format (requires passphrase)."""
try:
# This will prompt for passphrase interactively
result = subprocess.run(
["gpg", "--armor", "--export-secret-keys", key_id],
capture_output=True,
text=True,
check=True,
)
if output_file:
output_file.write_text(result.stdout)
print(f"✓ Private key exported to {output_file}")
return result.stdout
# return None if export fails (e.g. wrong passphrase, key not found)
except subprocess.CalledProcessError as e:
print(f"Error exporting private key: {e}")
return None
# Validate that the selected GPG key has signing capability
def validate_gpg_key(key_id: str) -> bool:
"""Validate that a GPG key has signing capability."""
try:
result = subprocess.run(
["gpg", "--list-keys", "--with-colons", key_id],
capture_output=True,
text=True,
check=True,
)
# Check for 's' (signing) in the pub line
for line in result.stdout.split('\n'):
if line.startswith('pub:'):
flags = line.split(':')[1]
return 's' in flags
return False
except subprocess.CalledProcessError:
return False
# Print instructions for configuring GitHub Secrets
def print_setup_instructions():
"""Print instructions for configuring GitHub Secrets."""
print("\n" + "="*70)
print("GITHUB SECRETS SETUP INSTRUCTIONS")
print("="*70)
print("""
To enable the automated PDF workflow, you need to add three secrets to your
GitHub repository:
1. GPG_PRIVATE_KEY
- Your GPG private key in ASCII armor format
- Used to sign PDFs and hash files
- IMPORTANT: Keep this secret! Never commit it publicly
2. GPG_PASSPHRASE
- The passphrase for your GPG private key
- Required to unlock the private key for signing
3. VT_API_KEY (optional but recommended)
- VirusTotal API key for malware scanning
TROUBLESHOOTING:
- If GPG signing fails: Check that your key has signing capability ('s' flag)
- If passphrase is wrong: Verify you're using the correct passphrase
- If VT scan fails: Ensure API key is valid and within rate limits
""")
def main() -> int:
print("\n" + "="*70)
print("PDF WORKFLOW SETUP HELPER")
print("="*70)
# Check GPG installation
if not check_gpg_installed():
print("⚠ WARNING: GPG is not installed or not in PATH")
print("Please install GPG before continuing:")
print(" - Linux: sudo apt install gnupg")
print("\nContinuing anyway...")
# List available keys
print("\n🔑 Available GPG Keys:")
print("-" * 70)
keys = list_gpg_keys()
if not keys:
print("No GPG keys found in your keyring.")
print("Generate a key with: gpg --full-generate-key")
return 1
for i, key in enumerate(keys, 1):
status = "✓" if validate_gpg_key(key['key_id']) else "✗"
print(f"\n{i}. {status} Key ID: {key['key_id']}")
print(f" Fingerprint: {key.get('fingerprint', 'N/A')}")
print(f" UID: {key.get('uid', 'Unknown')}")
print(f" Created: {key.get('created', 'Unknown')}")
if key.get('expires'):
print(f" Expires: {key['expires']}")
# Ask user to select key
print("\n" + "-" * 70)
try:
choice = input("\nEnter the number of the key you want to use (1-{}): ".format(len(keys)))
selected_index = int(choice) - 1
if not (0 <= selected_index < len(keys)):
print("Invalid selection!")
return 1
except ValueError:
print("Invalid input! Please enter a number.")
return 1
selected_key = keys[selected_index]
# Validate key has signing capability
if not validate_gpg_key(selected_key['key_id']):
print(f"\n⚠ WARNING: Selected key does not have signing capability!")
print("You need a key with 's' (signing) flag for PDF signatures.")
confirm = input("Continue anyway? (y/N): ")
if confirm.lower() != 'y':
return 1
# Export public key
print(f"\n📤 Exporting public key for {selected_key['uid']}...")
public_key_file = repo_root() / "pgp" / "workflow-public.asc"
public_key = export_public_key(selected_key['key_id'], public_key_file)
if not public_key:
print("Failed to export public key!")
return 1
# Show public key info
print("\n✓ Public Key Information:")
print("-" * 70)
for line in public_key.split('\n')[:5]:
print(line)
print("...")
# Instructions for private key export
print("\n🔐 Private Key Export:")
print("-" * 70)
print("""
To get your private key for the GPG_PRIVATE_KEY secret:
1. Run this command (you'll be prompted for passphrase):
gpg --armor --export-secret-keys {} > workflow-private.asc
2. Copy the ENTIRE output including BEGIN and END lines
3. Add it to GitHub Secrets as 'GPG_PRIVATE_KEY'
⚠ IMPORTANT: Keep your private key secure! Never commit it publicly.
""".format(selected_key['key_id']))
# Print setup instructions
print_setup_instructions()
print("\n" + "="*70)
print("SETUP COMPLETE!")
print("="*70)
print(f"\nPublic key saved to: {public_key_file}")
print("Next steps:")
print("1. Export your private key (see instructions above)")
print("2. Add all three secrets to GitHub repository settings")
print("3. Test the workflow by triggering a manual build")
print("\nFor more information, see: docs/guide/dev-workflow.md\n")
return 0
if __name__ == "__main__":
raise SystemExit(main())
scripts/update_changelog.py
-240
View File
@@ -1,240 +0,0 @@
#!/usr/bin/env python3
"""Auto-generate and prepend a changelog entry to docs/changelog/index.md.
Called by .github/workflows/04-changelog.yml. Reads git log since the last
changelog version, categorises commits by conventional-commit prefix,
and prepends a new ## [vX.Y.Z] section in the MkDocs admonition format used
by the rest of the file.
Environment variables:
MANUAL_VERSION Version string to record (required when run from CI).
Falls back to auto-increment from the changelog for local runs.
TRIGGERING_SHA The commit SHA that triggered this run (used as range end).
DRY_RUN If "true", print the entry and exit without writing.
Note: version is sourced from the changelog file, not from git tags. Git tags
are no longer used as the version authority. The changelog is the source of truth.
"""
from __future__ import annotations
import os
import re
import subprocess
from datetime import datetime, timezone
from pathlib import Path
CHANGELOG = Path(__file__).resolve().parent.parent / "docs" / "changelog" / "index.md"
# Conventional-commit prefixes → changelog bucket
BUCKET_MAP: dict[str, str] = {
"feat": "Added",
"feature": "Added",
"add": "Added",
"fix": "Fixed",
"bugfix": "Fixed",
"perf": "Changed",
"refactor": "Changed",
"change": "Changed",
"chore": "Changed",
"ci": "Changed",
"docs": "Changed",
"style": "Changed",
"test": "Changed",
"revert": "Fixed",
"security": "Fixed",
"build": "Changed",
}
BUCKET_ORDER = ["Added", "Changed", "Fixed"]
def run(cmd: list[str]) -> str:
result = subprocess.run(cmd, capture_output=True, text=True)
return result.stdout.strip()
def auto_increment_version(current: str | None) -> str:
"""Bump the patch number of the current version, or default to v1.0.0."""
if not current:
return "v1.0.0"
m = re.match(r"^v?(\d+)\.(\d+)\.(\d+)", current)
if not m:
return "v1.0.0"
major, minor, patch = int(m.group(1)), int(m.group(2)), int(m.group(3))
return f"v{major}.{minor}.{patch + 1}"
def version_from_changelog() -> str | None:
"""Parse the most recent ## [vX.Y.Z] heading from the changelog file.
This is the primary version source — the changelog is the authority,
not git tags.
"""
if not CHANGELOG.exists():
return None
for line in CHANGELOG.read_text(encoding="utf-8").splitlines():
m = re.match(r"^## \[(v\d+\.\d+\.\d+)\]", line)
if m:
return m.group(1)
return None
def commits_since(ref: str | None, until: str) -> list[str]:
"""Return one-line commit messages between ref and until (exclusive/inclusive).
When no ref is given we fall back to the merge-base between HEAD and
origin/main to avoid dumping the entire history into the changelog.
"""
if ref:
log_range = f"{ref}..{until}"
else:
merge_base = run(["git", "merge-base", "HEAD", "origin/main"])
if merge_base:
log_range = f"{merge_base}..{until}"
else:
# Truly brand new repo with no remote — limit to last 50 commits
log_range = f"-50 {until}"
out = run(["git", "log", "--pretty=format:%s", log_range])
return [line.strip() for line in out.splitlines() if line.strip()]
def categorise(messages: list[str]) -> dict[str, list[str]]:
"""Sort commit messages into Added / Changed / Fixed buckets."""
buckets: dict[str, list[str]] = {b: [] for b in BUCKET_ORDER}
NOISE = re.compile(
r"""
\[skip\ ci\] # CI skip marker
| ^Merge\ (pull\ request|branch) # merge commits
| ^chore:\ bump # version bump chores
| update\ changelog # self-referential
| ^\d+/\d+ # numbered commit series (e.g. 3/8)
| ^Tweaking # vague WIP messages
| ^Moving\ some # vague WIP messages
| \ pt\d+$ # "...pt2", "...pt3" suffixes
| ^Fix\ (workflow|path|README)$ # one-word infrastructure fixes
| ^Still\ broken # embarrassing mid-fix notes
| ^WIP\b # work in progress
| ^Forgot\ to # oops commits
| ^Revert\ " # reverts (surface the original instead)
| ^One\ job\ to\ rule # joke commit messages
""",
re.VERBOSE | re.IGNORECASE,
)
for msg in messages:
if NOISE.search(msg):
continue
m = re.match(r"^(\w+)(?:\([^)]+\))?!?:\s*(.+)$", msg)
if m:
prefix = m.group(1).lower()
description = m.group(2).strip()
bucket = BUCKET_MAP.get(prefix, "Changed")
else:
description = msg
bucket = "Changed"
description = description[0].upper() + description[1:] if description else description
buckets[bucket].append(description)
return buckets
def format_admonition(bucket: str, items: list[str]) -> str:
lines = [f'!!! Note "{bucket}"', ""]
for item in items:
lines.append(f" - {item}")
lines.append("")
return "\n".join(lines)
def build_entry(version: str, buckets: dict[str, list[str]], sha: str) -> str:
date = datetime.now(timezone.utc).strftime("%Y-%m-%d")
lines = [f"## [{version}]", ""]
lines.append('!!! Note "Meta"')
lines.append("")
lines.append(f" - Released {date} from [`{sha[:7]}`](https://github.com/Anon-Planet/thgtoa/commit/{sha})")
lines.append("")
for bucket in BUCKET_ORDER:
if buckets.get(bucket):
lines.append(format_admonition(bucket, buckets[bucket]))
if not any(buckets[b] for b in BUCKET_ORDER):
lines.append('!!! Note "Changed"')
lines.append("")
lines.append(" - Minor updates and maintenance")
lines.append("")
return "\n".join(lines)
def prepend_entry(entry: str) -> None:
"""Insert the new entry after the # Release Notes heading."""
content = CHANGELOG.read_text(encoding="utf-8")
insert_at = content.find("\n## ")
if insert_at == -1:
content = content.rstrip() + "\n\n" + entry + "\n"
else:
content = content[: insert_at + 1] + entry + "\n" + content[insert_at + 1 :]
CHANGELOG.write_text(content, encoding="utf-8")
def already_has_version(version: str) -> bool:
if not CHANGELOG.exists():
return False
return f"## [{version}]" in CHANGELOG.read_text(encoding="utf-8")
def main() -> int:
dry_run = os.environ.get("DRY_RUN", "false").lower() == "true"
manual_version = os.environ.get("MANUAL_VERSION", "").strip()
triggering_sha = os.environ.get("TRIGGERING_SHA", "HEAD").strip() or "HEAD"
# Version authority: MANUAL_VERSION (required in CI) → changelog → auto-increment.
# Git tags are intentionally not consulted.
last_cl_ver = version_from_changelog()
new_version = manual_version or auto_increment_version(last_cl_ver)
print(f"Last CL version: {last_cl_ver or '(none)'}")
print(f"New version: {new_version}")
print(f"Triggering SHA: {triggering_sha}")
if already_has_version(new_version) and not manual_version:
print(f"Changelog already contains {new_version} — nothing to do.")
return 0
if already_has_version(new_version) and manual_version:
print(f"::error::Changelog already contains {new_version}. Choose a different version.")
return 1
# Collect commits since the last changelog version (using it as a git ref
# is a best-effort — if the tag doesn't exist, commits_since handles it gracefully).
messages = commits_since(last_cl_ver, triggering_sha)
print(f"Commits found: {len(messages)}")
for m in messages:
print(f" {m}")
buckets = categorise(messages)
entry = build_entry(new_version, buckets, triggering_sha)
print("\n--- Generated entry ---")
print(entry)
print("-----------------------\n")
if dry_run:
print("DRY RUN — not writing to file.")
return 0
prepend_entry(entry)
print(f"Prepended {new_version} to {CHANGELOG}")
return 0
if __name__ == "__main__":
raise SystemExit(main())
scripts/verify_pdf.py
-260
View File
@@ -1,260 +0,0 @@
#!/usr/bin/env python3
"""Verification script for thgtoa PDF releases.
Verifies SHA-256 hashes, BLAKE2b hashes, and GPG signatures (.asc) for
the light and dark PDFs. Optionally checks VirusTotal scan status.
Usage:
python scripts/verify_pdf.py
python scripts/verify_pdf.py --hashes
python scripts/verify_pdf.py --signatures
python scripts/verify_pdf.py --vt
python scripts/verify_pdf.py --file export/thgtoa.pdf --hashes
"""
from __future__ import annotations
import argparse
import hashlib
import json
import os
import subprocess
import sys
import urllib.request
from pathlib import Path
def repo_root() -> Path:
return Path(__file__).resolve().parent.parent
def _read_bare_hash(hash_file: Path) -> str | None:
"""Read a bare hex digest from a single-value hash file."""
try:
return hash_file.read_text(encoding="utf-8").strip().split()[0]
except (OSError, IndexError):
return None
def _read_hash_from_sumfile(sum_file: Path, pdf_path: Path) -> str | None:
"""Read a hash from a two-column sumfile (sha256sum / b2sum format).
Matches on the filename only (not the full path) so the file can be used
regardless of where the PDFs sit on disk.
"""
if not sum_file.exists():
return None
target = pdf_path.name
try:
for line in sum_file.read_text(encoding="utf-8").splitlines():
parts = line.strip().split(None, 1)
if len(parts) == 2 and Path(parts[1].lstrip("*")).name == target:
return parts[0]
except OSError:
return None
return None
# Hash verification
def _sha256(path: Path) -> str:
h = hashlib.sha256()
with path.open("rb") as fh:
for chunk in iter(lambda: fh.read(65536), b""):
h.update(chunk)
return h.hexdigest()
def _blake2b(path: Path) -> str:
h = hashlib.blake2b()
with path.open("rb") as fh:
for chunk in iter(lambda: fh.read(65536), b""):
h.update(chunk)
return h.hexdigest()
def verify_hashes(pdf: Path, export_dir: Path) -> bool:
"""Verify all available hash files for a PDF. Returns True if all pass."""
stem = pdf.name # e.g. "thgtoa.pdf" or "thgtoa-dark.pdf"
results: list[bool] = []
checks = [
("SHA-256", _sha256, export_dir / f"{stem}.sha256", export_dir / "sha256sums.txt"),
("BLAKE2b", _blake2b, export_dir / f"{stem}.b2sum", export_dir / "b2sums.txt"),
]
for algo, fn, bare_file, sum_file in checks:
# Resolve expected hash — prefer bare file, fall back to sumfile
expected = _read_bare_hash(bare_file) if bare_file.exists() else None
if expected is None:
expected = _read_hash_from_sumfile(sum_file, pdf)
if expected is None:
print(f" ⚠ {algo}: no hash file found (checked {bare_file.name}, {sum_file.name})")
continue
actual = fn(pdf)
ok = actual == expected
results.append(ok)
mark = "✓" if ok else "✗"
print(f" {mark} {algo}")
if not ok:
print(f" expected: {expected}")
print(f" actual: {actual}")
return all(results) if results else False
# Signature verification
def verify_signature(pdf: Path) -> bool | None:
"""Verify the .asc detached signature for a PDF.
Returns True on success, False on failure, None if GPG is not installed
or the signature file is missing.
"""
sig = pdf.with_suffix(pdf.suffix + ".asc")
if not sig.exists():
print(f" ⚠ Signature file not found: {sig.name}")
return None
try:
result = subprocess.run(
["gpg", "--verify", str(sig), str(pdf)],
capture_output=True,
text=True,
check=False,
)
except FileNotFoundError:
print(" ⚠ GPG not installed — skipping signature verification")
return None
if result.returncode == 0:
print(f" ✓ GPG signature valid")
# Surface the key info line from stderr (that's where gpg writes it)
for line in result.stderr.splitlines():
if any(kw in line for kw in ("Good signature", "key ID", "fingerprint", "using")):
print(f" {line.strip()}")
return True
else:
print(f" ✗ GPG signature INVALID")
for line in result.stderr.splitlines():
if line.strip():
print(f" {line.strip()}")
return False
# VirusTotal
def check_virustotal(pdf: Path, api_key: str) -> bool:
"""Query VirusTotal for the SHA-256 of a PDF. Returns True if clean."""
file_hash = _sha256(pdf)
url = f"https://www.virustotal.com/api/v3/files/{file_hash}"
req = urllib.request.Request(url, headers={"x-apikey": api_key})
try:
with urllib.request.urlopen(req, timeout=30) as resp:
data = json.loads(resp.read().decode())
except urllib.error.HTTPError as e:
if e.code == 404:
print(f" ⚠ Not yet scanned on VirusTotal (hash: {file_hash[:16]}…)")
else:
print(f" ⚠ VirusTotal HTTP error: {e.code}")
return False
except Exception as e:
print(f" ⚠ VirusTotal error: {e}")
return False
stats = data.get("data", {}).get("attributes", {}).get("last_analysis_stats", {})
malicious = stats.get("malicious", 0)
suspicious = stats.get("suspicious", 0)
undetected = stats.get("undetected", 0)
harmless = stats.get("harmless", 0)
total = malicious + suspicious + undetected + harmless
clean = malicious == 0 and suspicious == 0
mark = "✓" if clean else "✗"
print(f" {mark} VirusTotal ({malicious} malicious, {suspicious} suspicious, "
f"{harmless} clean / {total} engines)")
print(f" https://www.virustotal.com/gui/file/{file_hash}")
return clean
def main() -> int:
root = repo_root()
export = root / "export"
ap = argparse.ArgumentParser(
description="Verify thgtoa PDF hashes, signatures, and VirusTotal status.",
formatter_class=argparse.RawDescriptionHelpFormatter,
epilog=__doc__,
)
ap.add_argument(
"--file",
type=Path,
default=None,
metavar="PDF",
help="Verify a single PDF instead of both light and dark",
)
ap.add_argument(
"--export-dir",
type=Path,
default=export,
metavar="DIR",
help=f"Directory containing hash and signature files (default: {export})",
)
ap.add_argument("--hashes", action="store_true", help="Verify hashes only")
ap.add_argument("--signatures", action="store_true", help="Verify signatures only")
ap.add_argument("--vt", action="store_true", help="Check VirusTotal status")
args = ap.parse_args()
# Default: verify everything
do_hashes = args.hashes or not any([args.hashes, args.signatures, args.vt])
do_sigs = args.signatures or not any([args.hashes, args.signatures, args.vt])
do_vt = args.vt or not any([args.hashes, args.signatures, args.vt])
# Resolve PDFs to check
if args.file:
pdfs = [args.file]
else:
pdfs = [export / "thgtoa.pdf", export / "thgtoa-dark.pdf"]
vt_api_key = os.environ.get("VT_API_KEY", "")
overall_pass = True
for pdf in pdfs:
bar = "─" * 60
print(f"\n{bar}")
print(f" {pdf.name}")
print(bar)
if not pdf.exists():
print(f" ⚠ File not found: {pdf} — skipping")
overall_pass = False
continue
if do_hashes:
ok = verify_hashes(pdf, args.export_dir)
if not ok:
overall_pass = False
if do_sigs:
result = verify_signature(pdf)
if result is False:
overall_pass = False
if do_vt:
if not vt_api_key:
print(" ⚠ VT_API_KEY not set — skipping VirusTotal check")
else:
ok = check_virustotal(pdf, vt_api_key)
if not ok:
overall_pass = False
print(f"\n{'─' * 60}")
if overall_pass:
print(" ✓ All checks passed")
else:
print(" ✗ One or more checks failed")
print()
return 0 if overall_pass else 1
if __name__ == "__main__":
raise SystemExit(main())