Skip to content

docs(readme): update for v0.6 - #57

Merged
florianjs merged 1 commit into
mainfrom
docs/readme-v0.6
Oct 8, 2026
Merged

florianjs merged 1 commit into
mainfrom
docs/readme-v0.6

Conversation

@florianjs

Copy link
Copy Markdown
Owner

Brings the README in line with v0.6.0.

Outdated since v0.6.0

  • Grafana: the password is now generated by the installer, no longer admin / admin.
  • Panic mode: the key is derived from the panic password, the IV is 12 bytes and unique per value, and activation is done by entering the panic password.
  • Rate limits: login, registration and panic restore now have separate limits, and the table shows the current values.
  • Node 22 in the badge and the prerequisites.
  • Dev compose: Postgres is published on 127.0.0.1.
  • Upgrading: a link to the v0.6.0 release notes.

New features

  • Bonus points, shop and bounties.
  • Torznab with Prowlarr, Sonarr and Radarr, plus IMDb/TMDb/TVDB IDs.
  • English and French UI, with how to add a language.
  • npm test.

Already inaccurate before v0.6.0

  • Stack: Nuxt 4, not Nuxt 3, in the tech stack table.
  • Announces: HTTP only. UDP and WebSocket are disabled in the code.
  • Privacy: the last login IP is stored per user, and peer IPs live in Redis while a peer is active. The README claimed "no raw IP persistence".
  • Zero-Knowledge auth: a note that the stored verifier is enough to log in, so database backups must be protected (audit finding H8, still open).
  • Screenshots: removed the "Forum" screenshot, which was a duplicate of the homepage image.

Links

  • The Documentation link now points to the docs site.
  • Nuxt i18n, DOMPurify and sanitize-html are added to the acknowledgements.

🤖 Generated with Claude Code

- new features: bonus shop, bounties, torznab and media ids, i18n
- node 22, nuxt 4, http-only announces (udp and websocket are disabled)
- panic mode: key from the panic password, per-value iv, new activation flow
- grafana password is now generated, current rate limits and privacy notes
- document the zero-knowledge auth limitation, translations and npm test
- link the documentation site and the v0.6.0 upgrade notes

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 8, 2026

Copy link
Copy Markdown

Review in Change Stack →

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: e6b6de98-0f62-4041-9d92-bb81075d76bf
📥 Commits

Reviewing files that changed from the base of the PR and between 106b702 and 72df7c7.

📒 Files selected for processing (1)
  • README.md
 ___________________________________________________________
< Veni, Vidi, Codici Fixi. I came, I saw, I fixed the code. >
 -----------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@florianjs
florianjs merged commit 5181cae into main Oct 8, 2026
1 check was pending
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