11Spreed WebRTC
22===================
33
4- The latest version of Spreed WebRTC can be found on GitHub:
4+ Spreed WebRTC implements a WebRTC audio/video call and conferencing server
5+ and web client.
56
6- https://github.com/strukturag/spreed-webrtc
7+ The latest version of Spreed WebRTC can be found on GitHub:
8+ https://github.com/strukturag/spreed-webrtc
79
810
911## Build prerequisites
@@ -16,119 +18,124 @@ The latest version of Spreed WebRTC can be found on GitHub:
1618
1719## Runtime dependencies
1820
19- Spreed WebRTC compiles directly to native code and has no
20- external runtime dependencies. See http://golang.org/doc/faq#How_is_the_run_time_support_implemented for details.
21+ Spreed WebRTC compiles directly to native code and has no
22+ external runtime dependencies. See [ here] ( http://golang.org/doc/faq#How_is_the_run_time_support_implemented )
23+ for details.
2124
2225
2326## Building
2427
25- [ ![ Build Status] ( https://travis-ci.org/strukturag/spreed-webrtc.png?branch=master )] ( https://travis-ci.org/strukturag/spreed-webrtc )
28+ [ ![ Build Status] ( https://travis-ci.org/strukturag/spreed-webrtc.png?branch=master )] ( https://travis-ci.org/strukturag/spreed-webrtc )
2629
27- If you got spreed-webrtc from the git repository, you will first need
28- to run the included ` autogen.sh ` script to generate the ` configure `
29- script.
30+ If you got spreed-webrtc from the git repository, you will first need
31+ to run the included ` autogen.sh ` script to generate the ` configure `
32+ script.
3033
31- Configure does try to find all the tools on your system at the standard
32- locations. If the dependencies are somewhere else, add the corresponding
33- parameters to the ./configure call.
34+ Configure does try to find all the tools on your system at the standard
35+ locations. If the dependencies are somewhere else, add the corresponding
36+ parameters to the ./configure call.
3437
35- ``` bash
36- $ ./configure
37- $ make
38+ ``` bash
39+ $ ./configure
40+ $ make
3841 ```
3942
4043
4144## Build seperately
4245
43- Get Go external dependencies first with `` make get `` .
46+ Get Go external dependencies first with `` make get `` .
4447
45- ``` bash
46- $ make assets
47- $ make binary
48- ```
48+ ``` bash
49+ $ make assets
50+ $ make binary
51+ ```
4952
5053
5154## Server startup
5255
53- ``` bash
54- spreed-webrtc-server [OPTIONS]
55- ```
56+ ``` bash
57+ spreed-webrtc-server [OPTIONS]
58+ ```
5659
57- Options
60+ ### Options
5861
59- -c="./server.conf": Configuration file.
60- -cpuprofile="": Write cpu profile to file.
61- -h=false: Show this usage information and exit.
62- -l="": Log file, defaults to stderr.
63- -memprofile="": Write memory profile to this file.
64- -v=false: Display version number and exit.
62+ ```
63+ -c="./server.conf": Configuration file.
64+ -cpuprofile="": Write cpu profile to file.
65+ -h=false: Show this usage information and exit.
66+ -l="": Log file, defaults to stderr.
67+ -memprofile="": Write memory profile to this file.
68+ -v=false: Display version number and exit.
69+ ```
6570
66- An example configuration file can be found in server.conf.in.
71+ An example configuration file can be found in server.conf.in.
6772
6873
6974## Usage
7075
71- Connect to the server URL and port with a web browser and the
72- web client will launch.
76+ Connect to the server URL and port with a web browser and the
77+ web client will launch.
7378
7479
7580## Development
7681
77- To build styles and translations, further dependencies are required.
78- The source tree contains already built styles and translations, so
79- these are only required if you want to make changes.
82+ To build styles and translations, further dependencies are required.
83+ The source tree contains already built styles and translations, so
84+ these are only required if you want to make changes.
8085
8186 - [ NodeJS] ( http://nodejs.org/ ) >= 0.10.0
8287 - [ Compass] ( http://compass-style.org/ ) >= 1.0.0
8388 - [ Sass] ( http://sass-lang.com/ ) >= 3.3.0
8489 - [ Babel] ( http://babel.pocoo.org/ )
8590
86- The following Node.js modules are required, these may be installed
87- locally by running ` npm install ` from the project root. Consult the
88- ` package.json ` file for more details.
91+ The following Node.js modules are required, these may be installed
92+ locally by running ` npm install ` from the project root. Consult the
93+ ` package.json ` file for more details.
8994
90- - [ JSHint] ( http://www.jshint.com/ ) >= 2.0.0
9195 - [ autoprefixer] ( https://www.npmjs.org/package/autoprefixer ) >= 1.1
9296 - [ po2json] ( https://github.com/mikeedwards/po2json )
97+ - [ JSHint] ( http://www.jshint.com/ ) >= 2.0.0
98+ - [ scss-lint] ( https://github.com/causes/scss-lint ) >= 0.33.0
9399
94- Styles can be found in src/styles. Translations are found in src/i18n.
95- Each folder has its own Makefile to build the corresponding files.
100+ Styles can be found in src/styles. Translations are found in src/i18n.
101+ Each folder has its own Makefile to build the corresponding files. Check the
102+ Makefile.am templates for available make targets.
96103
97104
98105## Running server for development
99106
100- Copy the server.conf.in to server.conf.
107+ Copy the server.conf.in to server.conf.
101108
102- Build styles, javascript and binary using make. Then run
103- `` ./spreed-webrtc-server ``
109+ Build styles, javascript and binary using make. Then run
110+ `` ./spreed-webrtc-server ``
104111
105- The server runs on http://localhost:8080/ per default.
112+ The server runs on http://localhost:8080/ per default.
106113
107- HTML changes and Go rebuilds need a server restart. Javascript
108- and CSS reload directly.
114+ HTML changes and Go rebuilds need a server restart. Javascript
115+ and CSS reload directly.
109116
110117
111118## Running for production
112119
113- Spreed WebRTC should be run through a SSL frontend proxy with
114- support for Websockets. Example configuration for Nginx can be
115- found in ` doc/NGINX.txt ` .
120+ Spreed WebRTC should be run through a SSL frontend proxy with
121+ support for Websockets. Example configuration for Nginx can be
122+ found in ` doc/NGINX.txt ` .
116123
117- In addion for real work use one also needs a STUN/TURN server
118- configured with shared secret support.
124+ In addion for real work use one also needs a STUN/TURN server
125+ configured with shared secret support.
119126
120- See https://code.google.com/p/rfc5766-turn-server/ for a free
121- open source TURN server implementation. Make sure to use a recent
122- version (We recommend 3.2). Versions below 2.5 are not supported.
127+ See https://code.google.com/p/rfc5766-turn-server/ for a free
128+ open source TURN server implementation. Make sure to use a recent
129+ version (We recommend 3.2). Versions below 2.5 are not supported.
123130
124131
125132## Contributing
126133
127- 1 . "Fork".
128- 2 . Make a feature branch.
134+ 1 . "Fork" develop branch .
135+ 2 . Create a feature branch.
1291363 . Make changes.
1301374 . Do your commits (run `` make fmt `` and `` make jshint `` before commit).
131- 5 . Send "pull request".
138+ 5 . Send "pull request" for develop branch .
132139
133140
134141## License
0 commit comments