Skip to content

Commit ca6feba

Browse files
maxdinechclaude
andcommitted
docs: add Delos fork documentation to README
Document custom security patches and release workflow for maintaining patched Supabase Auth releases. Includes: - 4 security patches overview - Branch strategy - Release workflow for new upstream versions - Docker image naming - Configuration options 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent 7345c01 commit ca6feba

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,63 @@ It is originally based on the excellent
1616

1717
If you wish to contribute to the project, please refer to the [contributing guide](/CONTRIBUTING.md).
1818

19+
---
20+
21+
## Delos Fork
22+
23+
This is a fork maintained by [Delos Intelligence](https://delos.so) with custom security enhancements. We maintain patched releases based on stable upstream versions.
24+
25+
### Security Patches
26+
27+
This fork includes **4 custom security patches**:
28+
29+
1. **Timing Attack Prevention** - Bcrypt-based constant-time password verification to prevent user enumeration
30+
2. **Cache-Control Headers** - RFC 6749 compliant `Cache-Control: no-store` headers on all token endpoints
31+
3. **Require Current Password** - Optional protection against password changes via session hijacking
32+
4. **OTP Brute Force Protection** - Max 3 failed OTP attempts with automatic token invalidation
33+
34+
### Branch Strategy
35+
36+
- **`main`** - Tracks upstream/master (stable releases only)
37+
- **`delos-production`** - Rolling development with all patches
38+
- **`release/vX.Y.Z-delos`** - Stable release branches for production
39+
40+
See [PR #3](../../pull/3) for a complete diff of all custom patches.
41+
42+
### Docker Images
43+
44+
Published to GitHub Container Registry:
45+
```
46+
ghcr.io/delos-intelligence/auth:v2.183.0-delos
47+
```
48+
49+
### Release Workflow
50+
51+
When Supabase releases a new version (e.g., v2.184.0):
52+
53+
1. **Update main**: `git checkout main && git merge upstream/master`
54+
2. **Create release branch**: `git checkout -b release/v2.184.0-delos v2.184.0`
55+
3. **Cherry-pick patches** from `delos-production`
56+
4. **Run quality checks**: `make vet && make sec && make build`
57+
5. **Tag and push**: `git tag v2.184.0-delos && git push origin release/v2.184.0-delos v2.184.0-delos`
58+
6. **Build Docker image**: `docker build -t ghcr.io/delos-intelligence/auth:v2.184.0-delos .`
59+
7. **Deploy to staging** and test all security patches
60+
8. **Deploy to production**
61+
62+
### Additional Configuration
63+
64+
```bash
65+
# Require current password for password changes (default: false)
66+
GOTRUE_SECURITY_UPDATE_PASSWORD_REQUIRE_CURRENT_PASSWORD="true"
67+
```
68+
69+
OTP brute force protection is always enabled (max 3 attempts, automatic token invalidation).
70+
71+
---
72+
1973
## Table of Contents
2074

75+
- [Delos Fork](#delos-fork)
2176
- [Quick Start](#quick-start)
2277
- [Running in Production](#running-in-production)
2378
- [Configuration](#configuration)

0 commit comments

Comments
 (0)