xtr.dev/rondevu-server
1
0
Fork 0
mirror of https://github.com/xtr-dev/rondevu-server.git synced 2025-12-10 02:43:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update README with offer/answer terminology

Browse Source 
- Update API documentation to reflect POST /offer, POST /answer endpoints
- Update environment variables (OFFER_TIMEOUT, VERSION)
- Clarify direct peer-to-peer connections via offer/answer exchange
- Align documentation with WebRTC standard terminology

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Bas van den Aakster
2025-11-12 23:29:05 +01:00
parent 28ef5eb1d1
commit cdc66ad1d7
1 changed files with 16 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -1,8 +1,8 @@
# Rondevu
🎯 **Simple WebRTC peer signaling and discovery**
🎯 **Simple WebRTC peer signaling**
Meet peers by topic, by peer ID, or by connection ID.
Direct peer-to-peer connections via offer/answer exchange.
**Related repositories:**
- [rondevu-client](https://github.com/xtr-dev/rondevu-client) - TypeScript client library
@@ -12,7 +12,7 @@ Meet peers by topic, by peer ID, or by connection ID.
## Rondevu Server
HTTP signaling server for WebRTC peer discovery and connection establishment. Supports SQLite (Node.js/Docker) and Cloudflare D1 (Workers) storage backends.
HTTP signaling server for WebRTC peer connection establishment. Supports SQLite (Node.js/Docker) and Cloudflare D1 (Workers) storage backends.
### Quick Start
@@ -35,19 +35,20 @@ npx wrangler deploy
```bash
# Create offer
POST /:topic/offer {"peerId":"alice","offer":"..."}
POST /offer {"peerId":"alice","offer":"...","code":"my-room"}
# List sessions
GET /:topic/sessions
# Send answer
POST /answer {"code":"...","answer":"..."}
# Send answer/candidates
POST /answer {"code":"my-room","answer":"...","side":"answerer"}
# Poll for updates
POST /poll {"code":"...","side":"offerer|answerer"}
```
POST /poll {"code":"my-room","side":"offerer"}
See [API.md](./API.md) for details.
# Health check with version
GET /health
# Version info
GET /
```
### Configuration
@@ -56,9 +57,10 @@ Environment variables:
| Variable | Default | Description |
|----------|---------|-------------|
| `PORT` | `3000` | Server port (Node.js/Docker) |
| `SESSION_TIMEOUT` | `300000` | Session timeout in milliseconds |
| `OFFER_TIMEOUT` | `60000` | Offer timeout in milliseconds (1 minute) |
| `CORS_ORIGINS` | `*` | Comma-separated allowed origins |
| `STORAGE_PATH` | `./sessions.db` | SQLite database path (use `:memory:` for in-memory) |
| `STORAGE_PATH` | `./offers.db` | SQLite database path (use `:memory:` for in-memory) |
| `VERSION` | `0.0.1` | Server version (semver) |
### License