Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/open-easyrtc/open-easyrtc

Open-EasyRTC - EasyRTC Free of Priologic
https://github.com/open-easyrtc/open-easyrtc

Last synced: about 2 months ago
JSON representation

Open-EasyRTC - EasyRTC Free of Priologic

Host: GitHub
URL: https://github.com/open-easyrtc/open-easyrtc
Owner: open-easyrtc
License: bsd-2-clause
Created: 2019-08-12T22:43:31.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-01-09T18:39:01.000Z (12 months ago)
Last Synced: 2024-04-14T06:15:04.878Z (8 months ago)
Language: JavaScript
Homepage: https://open-easyrtc-server-demo.glitch.me/
Size: 9.88 MB
Stars: 351
Watchers: 20
Forks: 103
Open Issues: 14
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md

Awesome Lists containing this project

awesome-networked-media - EasyRTC - WebRTC based implementation, originally forked from [priologic](https://github.com/priologic/). (Uncategorized / Uncategorized)

README

Open-EasyRTC
=======

[![npm version](https://img.shields.io/npm/v/open-easyrtc.svg?style=flat)](https://www.npmjs.com/package/open-easyrtc)
[![Build Status](https://github.com/open-easyrtc/open-easyrtc/actions/workflows/main.yaml/badge.svg)](https://github.com/open-easyrtc/open-easyrtc/actions/workflows/main.yaml)

[![NPM](https://nodei.co/npm/open-easyrtc.png)](https://npmjs.org/package/open-easyrtc)

Open-EasyRTC is a Fork of Priologic's EasyRTC, include an EasyRTC server and client API, HTML5 and JavaScript demos under a BSD 2 license.

Original Source and Fork intent
--------------------

This NodeJS `open-easyrtc` module version is a fork of `easyrtc` hosted on Github originally made by `Priologic Software Inc.` and available here: https://github.com/priologic/easyrtc

This fork of `easyrtc` module named `open-easyrtc` starts at version `2.0.0` in case previous the repository decides to pick up work again on version `1.x.x`.

Try a Live Demo Here:
--------

[![Remix on Glitch](https://cdn.glitch.com/2703baf2-b643-4da7-ab91-7ee2a2d00b5b%2Fremix-button.svg)](https://glitch.com/~open-easyrtc-server-demo)

Features
--------
* Install EasyRTC's WebRTC Server on your own Linux, Windows, or Mac server in minutes not days.
* Use our EasyRTC API and sample application code to build and deploy your WebRTC app in hours not weeks.
* EasyRTC is completely free and open source under a BSD 2 license. No usage costs or other hidden fees.

Installation In A Nutshell
--------------------------
1. Install [Node.js](http://nodejs.org)
2. Download the EasyRTC distribution from github (https://github.com/open-easyrtc/open-easyrtc.git)
3. Run `npm install` in the easyrtc directory.
4. Enter the easyrtc/server_example directory by executing `cd server_example`
5. Run `npm install` in the server_example directory.
4. Start EasyRTC by running `node server.js` while in the server_example directory.
5. Browse the examples using a WebRTC enabled browser. *(defaults to port `8080`)*

Important note: Chrome will not grant access to local microphones or cameras for a page served using http except for the localhost case. See the docs/easyrtc_server_ssl.md file for instructions on serving files using https.

Step by step instructions including additional setup options can be found in `/docs/easyrtc_server_install.md`

Note: there is no corresponding need to install the client files specifically; they were installed as part of EasyRTC in step 3.

Documentation
-------------
All documentation can be found within [the docs folder](./docs/).

**EasyRTC Server**

* [Install instructions for Ubuntu, Windows, and Mac](./docs/easyrtc_server_install.md)
* `/docs/easyrtc_server_install.md`
* [Configuration options](./docs/easyrtc_server_configuration.md)
* `/docs/easyrtc_server_configuration.md`
* [Using Server Events](./docs/easyrtc_server_events.md)
* `/docs/easyrtc_server_events.md`
* [Server API](https://open-easyrtc.github.io/open-easyrtc/server/)
* `https://open-easyrtc.github.io/open-easyrtc/server/`

**EasyRTC Client**
* [Client API tutorial](./docs/easyrtc_client_tutorial.md)
* `/docs/easyrtc_client_tutorial.md`
* [Client API](https://open-easyrtc.github.io/open-easyrtc/client/Easyrtc.html)
* `https://open-easyrtc.github.io/open-easyrtc/client/Easyrtc.html`
* [Client File Transfer API](https://open-easyrtc.github.io/open-easyrtc/client/Easyrtc_ft.html)
* `https://open-easyrtc.github.io/open-easyrtc/client/Easyrtc_ft.html`
* [Client App API](https://open-easyrtc.github.io/open-easyrtc/client/Easyrtc_App.html)
* `https://open-easyrtc.github.io/open-easyrtc/client/Easyrtc_App.html`

**General Development**
* [Frequently asked questions](./docs/easyrtc_faq.md)
* `/docs/easyrtc_faq.md`
* [Authentication](./docs/easyrtc_authentication.md/)
* `/docs/easyrtc_authentication.md`
* [ICE, TURN, STUN Configuration](./docs/easyrtc_server_ice.md)
* `/docs/easyrtc_server_ice.md`
* [Using Rooms](./docs/easyrtc_rooms.md)
* `/docs/easyrtc_rooms.md`
* [Serving with SSL](./docs/easyrtc_server_ssl.md)
* `/docs/easyrtc_server_ssl.md`
* [Serving next to IIS or Apache](./docs/easyrtc_with_other_servers.md)
* `/docs/easyrtc_with_other_servers.md`
* [Upcoming features](./docs/easyrtc_upcoming_features.md)
* `/docs/easyrtc_upcoming_features.md`
* [Common WebRTC problems](./docs/easyrtc_webrtc_problems.md)
* `/docs/easyrtc_webrtc_problems.md`
* [Common EasyRTC problems (and solutions)](./docs/easyrtc_common_problems.md)
* `/docs/easyrtc_common_problems.md`
* [Debugging WebRTC](./docs/webrtc_debugging.md)
* `/docs/webrtc_debugging.md`
* [Server/Client Message Types](./docs/easyrtc_server_msgtypes.md)
* `/docs/easyrtc_changelog.md`
* [Changelog](./docs/easyrtc_changelog.md)
* `/docs/easyrtc_changelog.md`

Folder Structure
----------------

* / (root)
* Licenses and package information
* /api/
* Client API files including easyrtc.js
* /demos/
* EasyRTC live demos and example code
* /docs/
* Documentation for using the API and running the server
* /lib/
* Required libraries
* /node_modules/
* Required node.js modules
* This folder will be created during the install
* /server_example/
* A simple server example

Included Demos
--------------

EasyRTC comes with a number of demo's which work immediately after installation.

* Video and/or Audio connections
* Multi-party video chat
* Text Messaging with or without Data Channels
* Screen and tab sharing
* File transfer
* Client side video recording

License
-------

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the below copyright notice,
this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the below copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

```
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
```