Skip to content

Bring the docs up to date and match platform hosts exactly - #16

Merged
stefan-azentrius merged 1 commit into
mainfrom
docs-and-exact-hosts
Oct 25, 2026
Merged

stefan-azentrius merged 1 commit into
mainfrom
docs-and-exact-hosts

Conversation

@stefan-azentrius

Copy link
Copy Markdown
Contributor
  • Platform hosts: platform_of takes a host as Instagram or Facebook only when it is the domain itself or a real subdomain of it, no longer any host that merely ends with the name (evilinstagram.com). The host allowlist already kept such hosts out; this makes the check exact on its own. New tests in tests/test_urls.py, three of which fail with the old code.
  • CHANGELOG: a section "Unreleased" for everything on main since 0.1.1 (the browser extension, cookies per platform, the cookie state in the health check, packs from partial downloads, the Instagram pause and more). The release renames it.
  • Security notes (README, SECURITY.md): the login cookie (400 days, an HMAC of the token, the same on every device, revoked only by a new token), the bearer token, the public /healthz with the cookie state, and where platform cookies live: secrets/, /data/cookies/ from the extension, and a copy per job that a stop in the middle of a download leaves until the job expires.
  • Legal: a sentence on passing posts on to other apps, and one on the single cookie Sharewerk sets.
  • NOTICE: PyAV and the FFmpeg libraries its wheels bring.
  • .env.example: every SHAREWERK_* setting the code reads, including host, port, data folder and the trusted proxies.
  • README: the development start listens on 127.0.0.1, the PWA update test is listed, a note on the proxy example's address, the error texts as the page shows them, and the image size and quality of a pack.

- **Platform hosts:** `platform_of` takes a host as Instagram or Facebook only when it is the domain itself or a real subdomain of it, no longer any host that merely ends with the name (`evilinstagram.com`). The host allowlist already kept such hosts out; this makes the check exact on its own. New tests in `tests/test_urls.py`, three of which fail with the old code.
- **CHANGELOG:** a section "Unreleased" for everything on `main` since 0.1.1 (the browser extension, cookies per platform, the cookie state in the health check, packs from partial downloads, the Instagram pause and more). The release renames it.
- **Security notes (README, SECURITY.md):** the login cookie (400 days, an HMAC of the token, the same on every device, revoked only by a new token), the bearer token, the public `/healthz` with the cookie state, and where platform cookies live: `secrets/`, `/data/cookies/` from the extension, and a copy per job that a stop in the middle of a download leaves until the job expires.
- **Legal:** a sentence on passing posts on to other apps, and one on the single cookie Sharewerk sets.
- **NOTICE:** PyAV and the FFmpeg libraries its wheels bring.
- **`.env.example`:** every `SHAREWERK_*` setting the code reads, including host, port, data folder and the trusted proxies.
- **README:** the development start listens on 127.0.0.1, the PWA update test is listed, a note on the proxy example's address, the error texts as the page shows them, and the image size and quality of a pack.
@stefan-azentrius
stefan-azentrius merged commit 7d8cc73 into main Oct 25, 2026
8 checks passed
@stefan-azentrius
stefan-azentrius deleted the docs-and-exact-hosts branch October 25, 2026 21:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant