WebRTC audio/video call and conferencing server.

Simon Eisenmann 19cc75c0fe Implemented server sessions lookup.		11 years ago
build	Fix build error from semicolon.	11 years ago
debian	Prepare for 0.18.1 release.	11 years ago
doc	Implemented server sessions lookup.	11 years ago
html	Implemented experimental ajax crawling support to get better social integration with open graph tags.	11 years ago
m4	Use autoconf macro to compare versions.	11 years ago
src	Implemented server sessions lookup.	11 years ago
static	Added service to build requestAnimationFrame calls.	11 years ago
.gitignore	Ignore automake autoconf generated files.	11 years ago
.gitmodules	Get rid of submodule and directly added sleepy milestone1.	11 years ago
.jshint	Store contact buddy image as data url.	11 years ago
.travis.yml	Added autoconf/automake support.	11 years ago
AUTHORS	Added Evan to AUTHORS.	11 years ago
COPYING	Added autoconf/automake support.	11 years ago
ChangeLog	Added autoconf/automake support.	11 years ago
LICENSE	Initial public release.	12 years ago
Makefile.am	Use autoconf macro to compare versions.	11 years ago
NEWS	Added autoconf/automake support.	11 years ago
README	Added autoconf/automake support.	11 years ago
README.md	Added hints about autoconf automake.	11 years ago
autogen.sh	Added autoconf/automake support.	11 years ago
configure.ac	Improved check for compass inside sass.	11 years ago
server.conf.in	Added encryption to sessions and contact tokens to protect data.	11 years ago
spreed-webrtc-server	Changed name of project to Spreed WebRTC.	11 years ago

README.md

Spreed WebRTC

The latest version of Spreed WebRTC can be found on GitHub:

https://github.com/strukturag/spreed-webrtc

Build prerequisites

Go >= 1.1.0
NodeJS >= 0.8.0
Sass >= 3.2.0
Compass
Babel
po2json
autoprefixer
autoconf
automake

Building

If you got spreed-webrtc from the git repository, you will first need to run the included autogen.sh script to generate the configure script.

Configure does try to find all the tools on your system at the standard locations. If the dependencies are somewhere else, add the corresponding parameters to the ./configure call.

$ ./configure
$ make

Build seperately

Get Go external dependencies first with make get.

$ make styles
$ make javascript
$ make binary

Server startup

spreed-webrtc-server [OPTIONS]

Options

-c="./server.conf": Configuration file.
-cpuprofile="": Write cpu profile to file.
-h=false: Show this usage information and exit.
-l="": Log file, defaults to stderr.
-memprofile="": Write memory profile to this file.
-v=false: Display version number and exit.

An example configuration file can be found in server.conf.in.

Usage

Connect to the server URL and port with a web browser and the web client will launch.

In place start for development

Copy the server.conf.in to server.conf.

Build styles, javascript and binary using make. Then run ./spreed-webrtc-server

The server runs on http://localhost:8080/ per default.

HTML changes and Go rebuilds need a server restart. Javascript and CSS reload directly.

Production use

Spreed WebRTC should be run through a SSL frontend proxy with support for Websockets. Example configuration for Nginx can be found in doc/NGINX.txt.

In addion for real work use one also needs a STUN/TURN server configured with shared secret support.

See https://code.google.com/p/rfc5766-turn-server/ for a free open source TURN server implementation. Make sure to use a recent version (We recommend 3.2). Versions below 2.5 are not supported.

Contributing

"Fork".
Make a feature branch.
Make changes.
Do your commits (run make fmt before commit).
Send "pull request".

License

Spreed WebRTC uses the AGPL license, see our LICENSE file.