##About This project is a webrtc signaling server written in Java. All calls are beeing pipelined and recorded by Kurento Media Server to the configured directory.
##Features
- signaling server written in Java which communicates via websockets to browser, Android and iOS webrtc peers
- implements Kurento-Media-Server API.
- records all calls on server (by default - one file per peer)
- support widget (predefined support can be configured and called by web users)
- screensharing support on firefox and chrome via chrome/firefox extension
- iOS-native App (see github repository: AppRTC-iOS)
- Android-native App (see github repository: AppRTC-Android)
- Kurento Java Tutorial http://doc-kurento.readthedocs.io/en/stable/tutorials/java/tutorial-one2one-adv.html
###Installation:
- Clone this repository to your workstation
git clone https://github.com/<<repository-url>>.git - Change into the 'jWebrtc' directory
cd <<repository-dir>>/jWebrtc - Create war file
mvn package - Deploy war file into your servlet container (e.g. JBoss, Tomcat, Glassfish)
- Configure environment variables of your servlet container. E.g. modify .profile in the home directory of the user who runs the servlet container. We configure the URL of the Kurento-Server (here on localhost), STUN-,TURN-Urls and TURN username and password. Use public IP since its used by the clients not by the server.
export JAVA_OPTS="$JAVA_OPTS -Dkms.url=ws://localhost:8888/kurento -DSTUN_URL=stun:<<stun-ip>>:3478 -DTURN_USERNAME=<<turn-username>> -DTURN_PASSWORD=<<turn-password>> -DTURN_URL=turn:<<turn-ip>>:3478" - configure your servlet container to use SSL if you wanto to use WebRTC outside of localhost (WebRTC only works with HTTPS!)
- Start Servlet Container and Test WebRTC in (e.g. go to:
http://localhost/jWebrtc) - Download, install and configure your Android-WebRTC App( (AppRTC-Android))
- Download, install and configure your iOS-WebRTC App (AppRTC-iOS)
##Configuration:
- Turn-Server:
- config under: /etc/turnserver.conf
- username/password for client auth
- logs under /var/log
- Kurento-Server:
- config under /etc/kurento/kurento.conf.json
- configure modules/kurento/WebRtcEndpoint.conf.ini (stun and turn server)
- configure modules/kurento/UriEndpoint.conf.ini defaultPath = file:///var/kurento/
- logs under /var/log/kurento/
- recorded webrtc video/audio under /var/kurento
- Tomcat
- configure environment variables e.g. in .profile (stun/turn server for clients)
export JAVA_OPTS="$JAVA_OPTS -Dkms.url=ws://localhost:8888/kurento -DSTUN_URL=stun:<<stun-public-ip>>:3478 -DTURN_USERNAME=<<turn-user>> -DTURN_PASSWORD=<<turn-password>> -DTURN_URL=turn:<<stun-public-ip>>:3478"
- configure environment variables e.g. in .profile (stun/turn server for clients)
##Support-Widget for websites
- connect and login with to webrtc with browser, android or ios e.g. with your user ''
- install a support-widget.html on your favourite webserver e.g.
<html>
<head><title>Example Simple Support Widget v0.1</title>
<script src="https://<<your-webrtc-server>>/jWebrtc/js/webrtcStatusWidget_simple_0.1.js"></script>
</head>
<body>
<h1>Example Simple WebRTC Support Widget</h1>
<div
id="webrtc-online-status"
data-peer="<CustomerSupportUser>">
</div>
</body>
</html>
- or connect to working example at: https://<>/jWebrtc/status.html
##Tests
- Browser2Browser in local-LAN and to remote LANs
- Browser2AndroidApp in local-LAN and to remote LANs
- Browser2iOSApp in local-LAN and to remote LANs
- Android2AndroidApp in local-LAN and to remote LANs
- iOS2iOSApp in local-LAN and to remote LANs
- iOS2AndroidApp in local-LAN and to remote LANs
- STUN-Server Test (if clients are behind a firewall or in different networks)
- TURN-Server Relay Test ???
- Screensharing - Tests https://www.webrtc-experiment.com/getScreenId/ https://mozilla.github.io/webrtc-landing/gum_test.html
###Todo/Bugs
-
Websocket clients needs to send heartbeat to server:
- http://django-websocket-redis.readthedocs.io/en/latest/heartbeats.html
- server must constantly check for new heartbeat messages (if a heartbeat is older then x seconds - swith offline)
-
Widget: When a web user hits the call button - it should be possible to hangup.
-
(Bug) IPv6 only networks need to be tested. http://www.brianjcoleman.com/tutorial-how-to-test-your-app-for-ipv6-compatibility/ AlexKMDev/WebRTC#7 http://stackoverflow.com/questions/40078763/has-anyone-managed-to-get-group-calls-working-with-kurento-on-ios-with-ipv6-only
-
add 3 buttons (video, audio, screensharing to status.html (support widget)
###Nice2Haves
- Widget: When a web user is offline - try to wake up the user
- allow both partys to transmit screen same time - (as an extension)
- show splash for microphone, video, microphone permission
- choose audio, video devices in browser https://webrtc.github.io/samples/src/content/devices/input-output/ https://webrtc.github.io/samples/
- display message for non-webrtc-browser instead of displaying call buttons
- display download webrtc-plugin for non-webrtc browsers like safari and internet explorer.
- improve busy messages if somebody starts a call (or wants to call somebody)
- error-message-improvents
- if kurento connection cannot be established create better error message and send it to the client (which can see the detail)
- widget
- enable screen sharing button
- switch kamera button (if more cameras are involved)
- TURN over Port 80/443 for very restrictive corporate firewalls ("everything closed")
- Recording
- merge recorded videos with composite hub http://doc-kurento.readthedocs.io/en/stable/ mastering/kurento_API.html
- Merge recorded videos of call participants into a split screen view
- ffmpeg -i input1.mp4 -i input2.mp4 -filter_complex '[0:v]pad=iw*2:ih[int];[int][1:v]overlay=W/2:0[vid]' -map [vid] -c:v libx264 -crf 23 -preset veryfast output.mp4 (http://superuser.com/a/537482)
- Turn-Config
- change Turn-Authentication with every appConfig call
###Bugs
- (P1) Tomcat does not create nice session IDs for the websockts - use HTTP-SessionId? SecurityProblem?
###Done
-
2016-11-29 - screensharing: fixed stop-screensharing fromboth sides
-
2016-11-29 - screensharing: only one party can do streamsharing - disable button if other party is broadcasting screen
-
2016-11-27 - screensharing now over seperate stream into new window.
-
2016-10-31 - screensharing chrome tries to load a localhost url into iframe - needs to be the current server if possible.
-
2016-10-31 - enable screensharing
-
2016-10-31 - (done) publish own extension on chrome and mozilla store
-
2016-10-31 - check if extension is installed - provide installation button for extension
-
2016-10-31 - firefox https://addons.mozilla.org/en-US/firefox/addon/support-screensharing/
-
2016-10-31 - chrome https://chrome.google.com/webstore/detail/screen-capturing/cpnlknclehfhfldcbmcalmobceenfjfd
-
add screensharing during a running call
-
2016-10-31 - (CR) add 3 buttons (video, audio, screensharing to index.html (user standard icons if possible bootstrap or other sources!)
-
2016-10-31 - if screensharing extension, depending on the browser, is not installed, change button screen-sharing, to button "install screensharing extension"
-
2016-10-21 - screensharing:
- chrome:
- firefox:
- our firefox plugin: plugin-download-url https://addons.mozilla.org/en-US/firefox/addon/support-screensharing/ mozilla.org - developer https://addons.mozilla.org/en-US/developers/
- Distribution, Signing
https://www.webrtc-experiment.com/screen-sharing/#7661404561735988 jpm sign https://blog.mozilla.org/addons/2015/12/18/signing-firefox-add-ons-with-jpm-sign/ https://github.com/opentok/screensharing-extensions/tree/master/firefox https://developer.mozilla.org/en-US/Add-ons/Distribution https://support.mozilla.org/en-US/kb/add-on-signing-in-firefox?as=u&utm_source=inproduct
- stuffs
- Chrome Extension Screensharing ready: http://stackoverflow.com/questions/25763088/google-canary-on-macbook-air-osx-10-9-4-is-giving-error/25765927#25765927
-
2016-10-19 - enable video-mute
-
2016-10-18 - enable audio-mute https://groups.google.com/forum/#!topic/kurento/Jp_yduJmsAY
-
2016-10-18 - enabled hangup button in support widget
-
2016-10-17 - fixed bug: "client sessions not removed when websocket disconnects"
-
2016-10-14 - fixed bug: "Widget does not work from some networks into some networks (not yet clear where exactly)
-
2016-10-14 - fixed stop message which was not send to peer when pipelines where not yet created. Discovered through "incoming call: decision: answer or hangup?" feature implementation on Android
-
2016-10-05 - after stopping a call a user sometimes cannot be called again. Signalling is looking for sessions which do not exist anymore. It's not clear why. If the user who hangsup whants to call again he can't the session of the caller cannot be found anymore. - call-test-sequence c) Chrome2iPhoneHangupChrome --> d) Chrome2iPhoneHangupiPhone did not work
-
2016-09-28 - create JAVA Keystore (.jks) from letsencrypt certificates for glassfish4
- https://maximilian-boehm.com/hp2121/Create-a-Java-Keystore-JKS-from-Let-s-Encrypt-Certificates.htm
- https://docs.oracle.com/cd/E19798-01/821-1751/gepzd/index.html
- http://javarevisited.blogspot.com.es/2012/09/difference-between-truststore-vs-keyStore-Java-SSL.html
- https://borwell.com/2015/01/22/securing-glassfish-4-0-web-applications/
-
2016-09-21 - screensharing information https://groups.google.com/forum/#!topic/kurento/jpis7IbU2Zo https://github.com/muaz-khan/WebRTC-Experiment/tree/master/Chrome-Extensions/desktopCapture https://groups.google.com/forum/#!topic/kurento/s1FrlX_9n4I http://stackoverflow.com/questions/36485558/getting-screencaptureerror-in-chrome-using-kurento-media-server http://doc-kurento.readthedocs.io/en/stable/mastering/kurento_utils_js.html https://www.webrtc-experiment.com/Pluginfree-Screen-Sharing/ https://github.com/muaz-khan/Chrome-Extensions/tree/master/desktopCapture http://doc-kurento.readthedocs.io/en/stable/mastering/kurento_utils_js.html https://bloggeek.me/implement-screen-sharing-webrtc/
-
2016-09-12 - iOS kann nicht in bestimmten Netzen keine PeerConnection aufbauen. - Turn/Stun relaying Probleme - ipv6 Bug?!
-
Probleme mit Anruf zu iOS keine Videoverbindung kommt zustande (Android funktioniert)
-
2016-09-09 - duplicate repository to le-space - https://help.github.com/articles/duplicating-a-repository/ - http://blog.plataformatec.com.br/2013/05/how-to-properly-mirror-a-git-repository/ - first time:
git clone --mirror git@example.com/upstream-repository.git cd upstream-repository git push --mirror git@example.com/mirror-location.git - update remote with:git remote update git push --mirror git@example.com/mirror-location.git ``` -
2016-09-06 support widget generate video divs from javascript to prevent CORS problem (not tested)
-
2016-09-06 widget for browser - replace server url with variable from server - http://shootitlive.com/2012/07/developing-an-embeddable-javascript-widget/ - enable videocall in widget
-
2016-09-03 - fixed missing ice configuration in browser when calling a party
-
2016-09-01 - fixed logging slf4j for maven
-
2016-08-29 - (administration/turnServer) http://stackoverflow.com/questions/28772212/stun-turn-server-connectivity-test https://tools.ietf.org/html/rfc7376 http://rtcquickstart.org/guide/multi/firewall-nat-considerations.html https://www.nomachine.com/AR07N00894
-
2016-08-29 - kurento behind NAT http://builds.kurento.org/release/5.0.3/mastering/advanced_installation_guide.html?highlight=plumberendpoint https://groups.google.com/forum/#!topic/kurento/QkO_ct0QEGE
-
2016-08-21 - (browser) update options.iceServers after appConfig response
-
2016-08-21 - fixed problems with stopping a call. (finish session on both sides)
-
2016-08-19 - wenn closing socket registered user should be deregistered too!
-
2016-08-19 - turnConfig in WebSocketServer.java too much - needs clean up! check ios / android / web client
-
2016-08-17 - change turn server config in server - because it produces wrong format
-
2016-08-14 - create self signed certificate for netbeans glassfish
-
2016-08-14 - add system properties
-
2016-08-13 - config parameter in ressource bundle or property files http://stackoverflow.com/questions/531593/how-to-use-a-property-file-with-glassfish http://stackoverflow.com/questions/1094121/application-configuration-files-for-glassfish-java-ee-5-web-services
-
2016-08-02 - recording
-
2016-08-01 - login user (websocket session id + username) and
-
2016-08-01 - when websocket closes user is not deleted from registry
-
2016-07-09 - get list of logged in users for android, ios and browser
-
2016-07-09 - login user (websocket session id + username) and
-
2016-07-09 - get list of logged in users for android, ios and browser
-
2016-06-28 - implement simple call response within browser use kurento one2one-call example
-
2016-06-28 - android version works on websocket only / port android project