How to use:

1. Install rust!

2. From the repo dir just run cargo build --release.

3. A standalone executable for your platform will be generated in ./target/release/

4. Enjoy!

Notes:

It uses port 3000 TCP (for the web interface) but can be changed by specifying the PORT env variable to a different value.

TURN Configuration:

RustRooms requires a TURN server for WebRTC connections to work properly, especially when users are behind restrictive NATs or firewalls. You can configure a third-party TURN server using the following environment variables:

• TURN_URL: The TURN server URL (e.g., turn:your-turn-server.com:3478)
• TURN_USERNAME: The TURN server username
• TURN_CREDENTIAL: The TURN server password/credential

For self-hosted TURN servers, you can use coturn or use a hosted service like metered.ca.

Security:

For a production deployment, it is highly recommended to set the following environment variable:

• ROOM_CREATION_PASSWORD: Set this to a strong password to prevent unauthorized room creation. If this is not set, anyone can create rooms.