Skip to content

Commit

Permalink
README: Add warning that SSL is required
Browse files Browse the repository at this point in the history
Also add LiveKit Cloud as a service option
  • Loading branch information
bekriebel committed Aug 16, 2024
1 parent cb67837 commit da4ac01
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,18 @@

A replacement for the native SimplePeer / EasyRTC A/V client in FoundryVTT. The module uses [LiveKit](https://livekit.io/) platform to provide Audio & Video communication between players.

**Note:** _At the moment there are no public LiveKit servers. You must configure a custom signalling server under Audio/Video communication or use one of the following options:_
> :warning: **SSL is still required**
>
> The LiveKit AVClient does not remove the need for SSL (https) on your Foundry server. Even if you use one of the hosted solutions below, all modern browsers require that the page that A/V is viewed on be secured. You can follow the following guide to set up SSL on your Foundry server: [Foundry VTT - SSL & HTTPS](https://foundryvtt.com/article/ssl/)
**Note:** _At the moment there are no free public LiveKit servers. You must configure a custom signalling server under Audio/Video communication or use one of the following options:_

[At the Tavern](https://tavern.at) is providing access to a multi-region LiveKit server cluster that we maintain to anyone who subscribes to our [Patreon](https://www.patreon.com/bekit) at at least a $5 USD per month level. The fee is used to cover the cost of the server cluster and contribute toward further development of this module.

[Forge](https://forge-vtt.com/) users can make use of the Forge's LiveKit servers with no additional configuration required.

[LiveKit Cloud](https://livekit.io/) provides a free tier, for a limited number of minutes/bandwidth per month. It may not be suitable for larger games or frequent use.

## Installation

You can install this module by using the following manifest URL: https://github.com/bekriebel/fvtt-module-avclient-livekit/releases/latest/download/module.json
Expand Down

0 comments on commit da4ac01

Please sign in to comment.