164 lines
3.9 KiB
Markdown
164 lines
3.9 KiB
Markdown
# Peer Calls
|
|
|
|
[![Build Status][travis-badge]][travis]
|
|
[![NPM Package][npm-badge]][npm]
|
|
|
|
[travis-badge]: https://travis-ci.org/jeremija/peer-calls.svg?branch=master
|
|
[travis]: https://travis-ci.org/jeremija/peer-calls
|
|
[npm-badge]: https://img.shields.io/npm/v/peer-calls.svg
|
|
[npm]: https://www.npmjs.com/package/peer-calls
|
|
|
|
WebRTC peer to peer calls for everyone. See it live in action at
|
|
[peercalls.com][peer-calls].
|
|
|
|
[peer-calls]: https://peercalls.com
|
|
|
|
Work in progress.
|
|
|
|
# Requirements
|
|
|
|
- [Node.js 8][node], or
|
|
- [Node.js 12][node], or
|
|
- [Docker][docker]
|
|
|
|
[node]: https://nodejs.org
|
|
[docker]: https://www.docker.com/
|
|
|
|
# Stack
|
|
|
|
- Express
|
|
- Socket.IO
|
|
- React
|
|
- Redux
|
|
- TypeScript (since peer-calls `v2.1.0`)
|
|
|
|
# Installation & Running
|
|
|
|
## Using npx (from NPM)
|
|
|
|
```bash
|
|
npx peer-calls
|
|
```
|
|
|
|
## Installing locally
|
|
|
|
```bash
|
|
npm install peer-calls
|
|
./node_modules/.bin/peer-calls
|
|
```
|
|
|
|
## Installing Globally
|
|
|
|
```bash
|
|
npm install --global peer-calls
|
|
peer-calls
|
|
```
|
|
|
|
## Using Docker
|
|
|
|
Use the [`jeremija/peer-calls`][hub] image from Docker Hub:
|
|
|
|
```bash
|
|
docker pull jeremija/peer-calls
|
|
docker run --rm -it -p 3000:3000 jeremija/peer-calls:latest
|
|
```
|
|
|
|
[hub]: https://hub.docker.com/r/jeremija/peer-calls
|
|
|
|
## From Git Source
|
|
|
|
```bash
|
|
git clone https://github.com/jeremija/peer-calls.git
|
|
cd peer-calls
|
|
npm install
|
|
|
|
# for production
|
|
npm run build
|
|
npm start
|
|
|
|
# for development
|
|
npm run start:watch
|
|
```
|
|
|
|
## Building Docker image
|
|
|
|
```bash
|
|
git clone https://github.com/jeremija/peer-calls
|
|
cd peer-calls
|
|
docker build -t peer-calls .
|
|
docker run --rm -it -p 3000:3000 peer-calls:latest
|
|
```
|
|
|
|
# Configuration
|
|
|
|
There has been a breaking change in `v3.0.0`. The default binary provided via
|
|
NPM is now called peer-calls, while it used to be peercalls. This has been made
|
|
to make `npx peer-calls` work.
|
|
|
|
Version 3 also changed the way configuration works. Previously, `config` module
|
|
was used to read config files. To make things simpler, a default STUN
|
|
configuration will now be used by default. Config files can still be provided
|
|
via the `config/` folder in the working directory, but the extension read will
|
|
be `.yaml` instead of `.json`.
|
|
|
|
The config files are read in the following order:
|
|
|
|
- `node_modules/peer-calls/config/default.yaml`
|
|
- `node_modules/peer-calls/config/${NODE_ENV}.yaml`, if `NODE_ENV` is set
|
|
- `node_modules/peer-calls/config/local.yaml`
|
|
- `./config/default.yaml`
|
|
- `./config/${NODE_ENV}.yaml`, if `NODE_ENV` is set
|
|
- `./config/local.yaml`
|
|
|
|
No errors will be thrown if a file is not found, but an error will be thrown
|
|
when the required properties are not found. To debug configuration issues,
|
|
set the `DEBUG` environment variable to `DEBUG=peercalls,peercalls:config`.
|
|
|
|
Additionally, version 3 provides easier configuration via environment
|
|
variables. For example:
|
|
|
|
```bash
|
|
- Set STUN/TURN servers: `PEERCALLS__ICE_SERVERS='[{"url": "stun:stun.l.google.com:19302", "urls": "stun:stun.l.google.com:19302"}]'
|
|
- Change base url: `PEERCALLS__BASE_URL=/test`
|
|
- Enable SSL: `PEERCALLS__SSL='{"cert": "/path/to/cert.pem", "key": "/path/to/cert.key"}'`
|
|
- Enable SSL: `PEERCALLS__SSL=undefined`
|
|
```
|
|
|
|
See [config/default.yaml][config] for sample configuration.
|
|
|
|
[config]: https://raw.githubusercontent.com/jeremija/peer-calls/master/config/default.json
|
|
|
|
By default, the server will start on port `3000`. This can be modified by
|
|
setting the `PORT` environment variable to another number, or to a path for a
|
|
unix domain socket.
|
|
|
|
To access the server, go to http://localhost:3000 (or another port).
|
|
|
|
# Testing
|
|
|
|
```bash
|
|
npm install
|
|
npm test
|
|
```
|
|
|
|
# Browser Support
|
|
|
|
Tested on Firefox and Chrome, including mobile versions.
|
|
|
|
Does not work on iOS 10, but should work on iOS 11 - would appreciate feedback!
|
|
|
|
For more details, see here:
|
|
|
|
- http://caniuse.com/#feat=rtcpeerconnection
|
|
- http://caniuse.com/#search=getUserMedia
|
|
|
|
# Contributing
|
|
|
|
See [Contributing](CONTRIBUTING.md) section.
|
|
|
|
If you encounter a bug, please open a new issue! Thank you ❤️
|
|
|
|
# License
|
|
|
|
[MIT](LICENSE)
|