Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

A quick doc update for certs for developers #42

Merged
merged 1 commit into from
Apr 29, 2020
Merged

A quick doc update for certs for developers #42

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ WebRTC based audio/video chat for your documents.
This plugin creates an audio/video chat with all
active users of the pad using WebRTC.

# installing
# Installing

to get current version:

Expand All @@ -19,7 +19,7 @@ active users of the pad using WebRTC.

You should use a STUN/TURN server to ensure consistant connecivty between clients. See STUN/TURN in settings.

# settings
# Settings

To disable the chat by default, append this to your settings.json:

Expand Down Expand Up @@ -67,8 +67,26 @@ To set an element or class to listen for an init event set `ep_webrtc.listenClas

To enable webrtc with a URL parameter append the following to your pad URL ``?av=YES``

# developing and contributing
# Developing and contributing

On your browser, you should use `localhost` instead of `0.0.0.0`. This is because webrtc generally requires a secure connection (https), but [an exception is made](https://w3c.github.io/webappsec-secure-contexts/#localhost) specifically for localhost and domains that end in `.localhost`.
## Basic

If you're just working on the interface and don't need to test connections to other computers, you can point your browser to `localhost` instead of `0.0.0.0`. Webrtc generally requires a secure connection (https), but [an exception is made](https://w3c.github.io/webappsec-secure-contexts/#localhost) specifically for localhost and domains that end in `.localhost`.

## Developing / Testing Communications

If you need to test communication, you may get away with opening two browser windows to the same URL on `localhost`. However this may be of limited utility, especially if you're confirming that sound works appropriately. In order to test on two computers, you'll need your dev computer to serve on an IP address accessible from the other computer, at which point you will no longer get away with using `localhost`. You will need SSL certs, though for dev purposes they can be self-signed.

[Generate your certificate](https://serverfault.com/a/224127), which will give you your cert and key files. In `settings.js`, set the full path to them on your file system:

"ssl" : {
"key" : "/path-to-your/epl-server.key",
"cert" : "/path-to-your/epl-server.crt"
// "ca" - not needed for dev purposes
}

Point your browser to your outward facing IP address, preceeded by `https://`, and accept the security warning (since this is a self-signed cert).

## Bug Reports

Please submit bug reports or patches at https://github.com/ether/ep_webrtc/issues