Interim release: documentation updates and rate limiting improvements
- Add applesauce library reference documentation - Add rate limiting test report for Badger - Add memory monitoring for rate limiter (platform-specific implementations) - Enhance PID-controlled adaptive rate limiting - Update Neo4j and Badger monitors with improved load metrics - Add docker-compose configuration - Update README and configuration options 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
This commit was merged in pull request #3.
This commit is contained in:
19
README.md
19
README.md
@@ -6,10 +6,23 @@
|
||||
[](https://pkg.go.dev/next.orly.dev)
|
||||
[](https://geyser.fund/project/orly)
|
||||
|
||||
zap me: <20>mlekudev@getalby.com
|
||||
zap me: <20>mlekudev@getalby.com
|
||||
|
||||
follow me on [nostr](https://jumble.social/users/npub1fjqqy4a93z5zsjwsfxqhc2764kvykfdyttvldkkkdera8dr78vhsmmleku)
|
||||
|
||||
## ⚠️ System Requirements
|
||||
|
||||
> **IMPORTANT: ORLY requires a minimum of 500MB of free memory to operate.**
|
||||
>
|
||||
> The relay uses adaptive PID-controlled rate limiting to manage memory pressure. By default, it will:
|
||||
> - Auto-detect available system memory at startup
|
||||
> - Target 66% of available memory, capped at 1.5GB for optimal performance
|
||||
> - **Fail to start** if less than 500MB is available
|
||||
>
|
||||
> You can override the memory target with `ORLY_RATE_LIMIT_TARGET_MB` (e.g., `ORLY_RATE_LIMIT_TARGET_MB=2000` for 2GB).
|
||||
>
|
||||
> To disable rate limiting (not recommended): `ORLY_RATE_LIMIT_ENABLED=false`
|
||||
|
||||
## About
|
||||
|
||||
ORLY is a nostr relay written from the ground up to be performant, low latency, and built with a number of features designed to make it well suited for:
|
||||
@@ -152,8 +165,8 @@ The relay will:
|
||||
If you're running behind a reverse proxy or tunnel (e.g., Caddy, nginx, Cloudflare Tunnel), the setup is the same. The relay listens locally and your reverse proxy forwards traffic to it:
|
||||
|
||||
```
|
||||
Browser <20> Reverse Proxy <20> ORLY (port 3334) <20> Dev Server (port 8080)
|
||||
<20>
|
||||
Browser <20> Reverse Proxy <20> ORLY (port 3334) <20> Dev Server (port 8080)
|
||||
<20>
|
||||
WebSocket/API
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user