Add load balancing configuration and minimum system requirements documentation
This commit is contained in:
26
README.md
26
README.md
@@ -106,6 +106,9 @@ SUPABASE_KEY=your_supabase_anon_key
|
||||
SERVER_ID=unique_server_identifier
|
||||
EXTERNAL_PORT=3000
|
||||
|
||||
# Load Balancing Configuration
|
||||
MAX_CAPACITY=1000
|
||||
|
||||
# Optional: Geographic Information
|
||||
SERVER_COUNTRY=United Kingdom
|
||||
SERVER_CITY=London
|
||||
@@ -113,6 +116,29 @@ SERVER_COORDS_LAT=51.5074
|
||||
SERVER_COORDS_LON=-0.1278
|
||||
```
|
||||
|
||||
## Configuration Details
|
||||
|
||||
### Load Balancing
|
||||
|
||||
**MAX_CAPACITY** (integer, default: 1000)
|
||||
- Soft capacity limit for the server
|
||||
- When reached, the load balancer will prioritize other servers
|
||||
- Does not prevent new connections, just influences routing decisions
|
||||
- Range: 1-32,767 (int2)
|
||||
- Used by the Supabase Edge Function `connection-request` for optimal server selection
|
||||
|
||||
### Server Registration
|
||||
|
||||
**SERVER_ID** (string, required)
|
||||
- Unique identifier for the server in the Waylume network
|
||||
- Used for rolling codes authentication and session tracking
|
||||
- Should be URL-safe (alphanumeric with hyphens/underscores)
|
||||
|
||||
**Geographic Information** (optional but recommended)
|
||||
- Enables location-based server selection for premium users
|
||||
- Improves load distribution across regions
|
||||
- Required for the location selection feature in the client app
|
||||
|
||||
## Quick Deployment
|
||||
|
||||
### Using Docker Compose (Recommended)
|
||||
|
||||
Reference in New Issue
Block a user