Web Call Server - Admin Guide

166 Pages·2017·16.37 MB·English

Web Call Server 5 - Admin Guide
© 2017 Flashphoner, LLC
2 Web Call Server 5 - Admin Guide
Contents
0
Part I Architecture 6
1 Server. .C..o..r..e.. .(.W...C..S.. .C...o..r.e..)....................................................................................................... 7
2 Admin.i.s.t.r..a..t.i.v.e.. .M...o..d..u..l.e.. .(.W...C...S.. .M...a..n..a..g..e..r.)................................................................................ 9
Part II Installation and testing 11
1 Prepa..r.i.n..g.. .f.o..r. .i.n..s..t.a..l.l.a..t.i.o..n..................................................................................................... 11
Preparation o.f. .t..h..e.. .s...e..r..v..e..r.. ................................................................................................................................... 11
JDK installatio..n.. ...................................................................................................................................................... 12
2 Serve..r. .i.n..s.t.a..l.l.a..t.i.o..n................................................................................................................ 13
Downloading .......................................................................................................................................................... 13
Installation .......................................................................................................................................................... 13
Discoverin.g.. .I.P.. .a..d..d..r.e..s..s...................................................................................................................................... 14
Installation. .p..r.o..c..e..s..s............................................................................................................................................ 15
3 Gettin..g.. .l.i.c..e..n..s.e.. .a..n..d.. .a..c..t.i.v..a..t.i.o..n............................................................................................. 16
4 Firew.a..l.l. .a..n..d.. .N...A..T.. .c..o..n..f.i.g..u..r.a..t.i.o..n........................................................................................... 17
5 Firew.a..l.l. .t.r..a..v.e..r..s.a..l................................................................................................................ 18
HAProxy .......................................................................................................................................................... 18
TURN server .......................................................................................................................................................... 22
6 Serve..r. .s.h..u..t.d..o..w...n.. .a..n..d.. .s..t.a..r.t.u..p............................................................................................... 23
7 Serve..r. .u..p..d..a..t.e...................................................................................................................... 25
8 Startu..p.. .o..p..t.i.o..n..s.................................................................................................................... 25
9 Exam.p..l.e..s............................................................................................................................. 26
Webphone .......................................................................................................................................................... 28
Authentica.t.i.o..n.................................................................................................................................................... 28
Outgoing c.a..l.l..................................................................................................................................................... 30
Video call......................................................................................................................................................... 31
Text chat ......................................................................................................................................................... 32
Call holding.. .a..n..d.. .t.r.a..n..s..f..e..r.r.i.n..g.............................................................................................................................. 33
More ......................................................................................................................................................... 34
Webphone wi.t..h..o..u...t. .S..I.P... .s..e..r..v..e..r.. ........................................................................................................................... 34
Live Video .......................................................................................................................................................... 36
Stream pub..l.i.s..h..in..g............................................................................................................................................... 36
Microphon.e.. .a..c..c..e..s..s.. .r.e..q..u..e..s..t............................................................................................................................. 38
Stream bei.n..g.. .p..u..b..l.is..h..e..d...................................................................................................................................... 39
Connecting.. .t.o.. .a.. .s..t.r.e..a..m....................................................................................................................................... 40
Stream is p..l.a..y..in..g.. .b..a..c..k.. .f.r..o..m.. .a..n..o..t.h..e..r.. .b..r.o..w...s..e..r.. .w...i.n..d..o..w..................................................................................... 41
More ......................................................................................................................................................... 42
IP Cam Video. ......................................................................................................................................................... 42
10 Load .t.e..s..t.i.n..g......................................................................................................................... 44
Load testing u...s..i.n..g... .s..e..r..v..e..r..-.s...i.d..e.. .a..p...p..l.i.c..a..t.i.o...n.. .................................................................................................... 44
SIP calls ......................................................................................................................................................... 45
Streaming......................................................................................................................................................... 47
Tests specifie...d.. .w...i.t..h.. .s..e...r.v..e...r. .s...e..t.t..i.n..g..s... .............................................................................................................. 49
© 2017 Flashphoner, LLC
11 Load .t.e..s..t.i.n..g.. .u..s.i.n..g.. .a.. .d..i.f.f.e..r..e..n..t. .s.e..r.v..e..r................................................................................... 50
12 Backw...a..r.d.. .c..o..m...p..a..t.i.b..i.l.i.t.y....................................................................................................... 52
Part III Settings 54
1 WCS .C..o..r..e.. .S..e..t.t.i.n..g..s.............................................................................................................. 54
The conf dire.c..t.o..r..y.. ................................................................................................................................................ 54
server.pro.p..e..r.t.i.e..s.. .c..o..n..f.i.g.................................................................................................................................... 55
flashphone..r...p..r..o..p..e..r.t.i.e..s.. .c..o..n..f.i.g........................................................................................................................... 58
loadbalanc.i.n..g....x..m...l .c..o..n..f..ig.................................................................................................................................... 81
accounts.x..m...l.................................................................................................................................................... 82
log4j.prope..r.t.i.e..s.. .c..o..n..f.i.g....................................................................................................................................... 83
watchdog..p..r..o..p..e..r.t.i.e..s......................................................................................................................................... 83
watchdog..l.o..g..4..j...p..r.o..p..e..r.t.i.e..s................................................................................................................................. 85
rtsp.auth c.o..n..f..ig.................................................................................................................................................. 85
wss.jks ke.y.. .s..t.o..r..a..g..e.......................................................................................................................................... 85
flashphone..r...s..e..r..v..e..r.i.d.. .f.i.le.................................................................................................................................... 85
myflashph.o..n..e..r.-.c..a.. .c..e..r..t.if..ic..a..t.e............................................................................................................................. 85
WCS.versi.o..n...................................................................................................................................................... 85
2 WCS .M...a..n..a..g..e..r. .S..e..t.t.i.n..g..s........................................................................................................ 85
application.pr.o..p...e..r..t.i.e..s... .c..o..n..f..i.g.. ............................................................................................................................. 86
log4j.properti.e..s... .c..o..n..f..i.g.. ........................................................................................................................................ 87
WCS Manager.. .d..a..t.a..b...a..s..e.. ....................................................................................................................................... 87
Part IV Monitoring 90
1 SSH t.u..n..n..e..l. .u..s..a..g..e................................................................................................................ 90
2 Conn.e..c.t.i.o..n.. .f.r..o..m... .J.C...o..n..s.o..l.e................................................................................................... 94
3 Conn.e..c.t.i.o..n.. .f.r..o..m... .V..i.s.u..a..l. .V...M.................................................................................................. 96
4 Watch..d..o..g.. .s..u..b..s.y..s..t.e..m... .o..f. .s.e..r.v..e..r. .a..v..a..i.l.a..b..i.l.i.t.y.. .c..o..n..t.r.o..l............................................................. 98
5 Stati.s..t.i.c..s. .o..n.. .l.o..a..d.. .a..n..d.. .r.e..s..o..u..r.c..e..s........................................................................................ 100
6 Infor.m...a..t.i.o..n.. .o..n.. .e..r..r.o..r.s.. .a..n..d.. .c.o..n..f.i.g..u..r..a..t.i.o..n.. .p..a..r.a..m...e..t.e..r.s......................................................... 102
Part V Command Line Interface 105
1 Acce..s.s.. .t.o.. .c..o..m...m...a..n..d.. .l.i.n..e.. .a..n..d.. .i.t.s. .u..s..a..g..e.............................................................................. 106
2 User.s.. .m...a..n..a..g..e..m...e..n..t........................................................................................................... 108
Users and gr..o..u...p..s.. ............................................................................................................................................... 108
Permissions.. .t.o... .p..e..r..f.o...r.m....i.n..g... .o..p..e...r.a..t..i.o..n..s... ........................................................................................................ 110
Examples .......................................................................................................................................................... 111
3 Appl.i.c..a..t.i.o..n.. .m...a..n..a..g..e..m...e..n..t.................................................................................................. 112
Examples .......................................................................................................................................................... 115
4 Serv.e..r.. .s.h..u..t.d..o..w...n.. .a..n..d.. .s.t.a..r..t.u..p............................................................................................. 115
Part VI Security 117
1 SSL.-.c.e..r..t.i.f.i.c.a..t.e..s.. .m...a..n..a..g..e..m...e..n..t........................................................................................... 117
Websocket S..S...L.. ................................................................................................................................................... 117
Settings ......................................................................................................................................................... 117
Generate.d.. .a..n..d.. .v..a..l.id.. .c..e..r..t.if..ic..a..t.e..s...................................................................................................................... 117
SSL certi.f.i.c..a..t.e.. .im...p..o..r.t...................................................................................................................................... 118
© 2017 Flashphoner, LLC
3
4 Web Call Server 5 - Admin Guide
REST HTTPS .......................................................................................................................................................... 119
Settings ......................................................................................................................................................... 120
Incoming .H..T..T..P..S................................................................................................................................................ 120
Outgoing .H...T..T..P..S............................................................................................................................................... 121
Part VII Logging 123
1 WCS.. .C..o..r.e........................................................................................................................... 123
Client logs .......................................................................................................................................................... 125
Server logs .......................................................................................................................................................... 127
CDR logs .......................................................................................................................................................... 129
MDR logs .......................................................................................................................................................... 130
SDR logs .......................................................................................................................................................... 131
2 WCS.. .M...a..n..a..g..e..r................................................................................................................... 132
3 Watc..h..d..o..g........................................................................................................................... 133
Part VIII Loadbalancing 135
1 Bala.n..c..e..r. .a..r..c.h..i.t.e..c..t.u..r.e......................................................................................................... 135
2 Bala.n..c..e..r. .s..e..t.t.i.n..g..s. .a..n..d.. .s..t.a..r.t.u..p............................................................................................. 136
Part IX Troubleshooting 138
1 Netw..o..r.k.. .t.r.a..f.f.i.c.. .a..n..a..l.y..s.i.s...................................................................................................... 138
Websocket .......................................................................................................................................................... 140
REST / HTTP .......................................................................................................................................................... 142
SIP .......................................................................................................................................................... 144
WebRTC .......................................................................................................................................................... 147
ICE ......................................................................................................................................................... 148
DTLS ......................................................................................................................................................... 148
SRTP ......................................................................................................................................................... 149
RTMFP .......................................................................................................................................................... 153
RTP .......................................................................................................................................................... 154
RTSP / RTP .......................................................................................................................................................... 156
2 Bug .r..e..p..o..r.t.i.n..g..................................................................................................................... 158
3 Trou.b..l.e..s..h..o..o..t.i.n..g................................................................................................................. 159
Part X Additional tools 163
1 Port.s. .r.o..u..t.i.n..g.. .c..h..e..c..k............................................................................................................ 163
2 Jstac..k.. .U..t.i.l.i.t.y....................................................................................................................... 163
0
© 2017 Flashphoner, LLC
Part
I
6 Web Call Server 5 - Admin Guide Architecture 6
1 Architecture
© 2017 Flashphoner, LLC
Architecture 7
WCS works under Linux x86_64 operating system. Network architecture is presented in the figure above
and has two main modules:
WCS Core - Server Core.
WCS Manager - Administrative Module.
The purpose of the Core is in direct operation with signaling and streaming data, interaction with browser
clients and SIP-servers. Administrative Module is responsible for interaction with developer's Web-server.
It provides command line interface for server administration. Modules are realized as two interrelated
processes and intercommunicate locally using RMI interface.
The simplified architectural scheme looks like this:
1.1 Server Core (WCS Core)
Server Core includes the set of subsystems, that allow to communicate with browsers and SIP servers:
Submodule Ports Layout Protocol Description
Websocket 8080, 8443 Websocket frames, TCP HTML5 Websocket and
Server JSON Secure Websocket support
SIP Server 30000- SIP TCP, UDP SIP support for the work with
30999 SIP PBX and SIP Proxy
servers
RTMFP Server 1935 AMF3 UDP RTMFP Protocol support for
work with Flash Player
HTTP Server 8081, 8444 HTTP, JSON TCP HTTP and HTTPS Protocols
support for statistics delivery
and load balancing
RTP Module 31000- Opus, G.711, Speex, UDP RTP and SRTP Protocols
© 2017 Flashphoner, LLC
8 Web Call Server 5 - Admin Guide Architecture 8
Submodule Ports Layout Protocol Description
31999 G.729 audio codecs support for browser client's
and H.264, VP8 video audio and video traffic
codecs exchange using WebRTC /
SRTP technology and with SIP
media servers using RTP.
RTSP Client 32000- RTSP-packets TCP Taking a stream from another
32999 server using RTSP protocol
with further RTP ports opening
for traffic reception and
playback operation in browser
ICE, DTLS, 31000- ICE packets, DTLS UDP The WebRTC support of ICE
RTCP 31999 packets, RTCP and DTLS technologies for
packets connection setup with web-
browser, and RTCP
technology support for RTP/
AVP, RTP/SAVPF profiles
support for exchanging control
information both with SIP-
devices and web-browsers.
JMX Server 50999 JMX TCP Server process monitoring
using JMX- or Visual VM
Console.
Node RMI 1098 RMI invocations TCP Local RMI-interface for data
exchange with the
Administrative Module
process.
MSRP Server 2855 MSRP messages TCP Is used for MSRP Protocol
messages receiving with
further their conversion to
Websockets.
Here is the simplified scheme of Core work presented:
© 2017 Flashphoner, LLC
Architecture 9
1.2 Administrative Module (WCS Manager)
WCS Manager Administrative Module is a subsystem that performs 3 main tasks:
1) Interaction with developer's Web-server
2) Server management via command line interface
3) Applications' settings storage
WCS Manager uses integrated database as storage. Other than integrated arbitrary database can be
used, which has JDBC-driver such as MySQL.
Here is the simplified scheme of Administrative Module work presented:
WCS Manager Submodules
Submodule Ports Layout Protocol Description
Manager HTTP / 9091, 8888 JSON TCP WCS RESTful API between
HTTPS WCS and web-server.
Incoming REST/HTTP
requests processing.
9091 - HTTP
8888 - HTTPS
Manager RMI 1099 RMI invocations TCP Internal data exchange with
WCS Core
CLI SSH 2000 SSH TCP WCS-server command line
interface over SSH.
© 2017 Flashphoner, LLC
Part
II