RivetDocs is currently in active development. Security fixes ship on the latest minor release line.
| Version | Supported |
|---|---|
| 1.x | ✅ |
| < 1.0 | ❌ |
We recommend pinning RIVETDOCS_VERSION to a specific patch release in
production and following the CHANGELOG for upgrade notes.
Production dependency advisories are surfaced two ways: the CI audit job
(pnpm audit --prod --audit-level=high) blocks merges on new high/critical
production advisories, and Dependabot opens grouped update PRs weekly. Once an
advisory affecting a production dependency is confirmed, we target the
following times from confirmation to a tagged patch release:
| Severity | Target to patched release |
|---|---|
| Critical | 72 hours |
| High | 7 days |
| Moderate | 30 days |
| Low | next scheduled dependency cycle |
These targets apply to advisories with a realistic exploitation path against a default deployment. An advisory that is not reachable in our configuration (for example, a build-time-only dependency) may be deferred to the next dependency cycle with a note recorded in CHANGELOG-SECURITY.md.
Please do not open a public issue for suspected security problems.
Instead, use GitHub's private vulnerability reporting feature. You can expect:
- An acknowledgement within 72 hours.
- A coordinated disclosure timeline — typically 30–90 days depending on severity and complexity — with a patch, advisory, and credit (unless you request anonymity).
When reporting, please include:
- A clear description of the vulnerability and its impact.
- Minimal reproduction steps or proof-of-concept.
- The RivetDocs version (
RIVETDOCS_VERSIONfrom your.env) and deployment shape (Docker Compose, Kubernetes, etc.). - Any suggested mitigations if you have them.
In scope:
- The code in this repository (
apps/,packages/,docker/,scripts/). - The published container images at
ghcr.io/thetractorhacker/rivetdocs-*. - The default
compose.ymldeployment topology.
Out of scope:
- Vulnerabilities in third-party dependencies that are already tracked upstream (please report those to the upstream project).
- Social-engineering, physical attacks, or denial-of-service by resource exhaustion against your own instance.
- Issues that require prior compromise of the host or database.
Thank you for helping keep RivetDocs and its users safe.