forked from meetecho/janus-gateway
-
Notifications
You must be signed in to change notification settings - Fork 0
/
janus.1
156 lines (156 loc) · 6.46 KB
/
janus.1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
.TH JANUS 1
.SH NAME
janus \- WebRTC server/gateway
.SH SYNOPSIS
.B janus
[options]
.SH DESCRIPTION
.B janus
is a WebRTC server/gateway developed by Meetecho conceived to be a general purpose one. As such, it doesn't provide any functionality per se other than implementing the means to set up a WebRTC media communication with a browser or application, exchanging JSON messages with it over different transports, and relaying RTP/RTCP and messages between clients and the server-side application logic they're attached to. Any specific feature/application is provided by server side plugins, that browsers can then contact via the server to take advantage of the functionality they provide. Example of such plugins can be implementations of applications like echo tests, conference bridges, media recorders, SIP gateways and the like.
.TP
The reason for this is simple: we wanted something that would have a small footprint (hence a C implementation) and that we could only equip with what was really needed (hence pluggable modules). That is, something that would allow us to deploy either a full-fledged WebRTC server on the cloud, or a small nettop/box to handle a specific use case.
.SH OPTIONS
.TP
.BR \-h ", " \-\-help
Print help and exit
.TP
.BR \-V ", " \-\-version
Print version and exit
.TP
.BR \-b ", " \-\-daemon
Launch Janus in background as a daemon (default=off)
.TP
.BR \-p ", " \-\-pid-file=\fIpath\fR
Open the specified PID file when starting Janus (default=none)
.TP
.BR \-N ", " \-\-disable-stdout
Disable stdout based logging (default=off)
.TP
.BR \-L ", " \-\-log-file=\fIpath\fR
Log to the specified file (default=stdout only)
.TP
.BR \-H ", " \-\-cwd-path=\fIpath\fR
Working directory for Janus daemon process (default=/)
.TP
.BR \-i ", " \-\-interface=\fIipaddress\fR
Interface to use (will be the public IP)
.TP
.BR \-P ", " \-\-plugins-folder=\fIpath\fR
Plugins folder (default=./plugins)
.TP
.BR \-C ", " \-\-config=\fIfilename\fR
Configuration file to use
.TP
.BR \-F ", " \-\-configs-folder=\fIpath\fR
Configuration files folder (default=./conf)
.TP
.BR \-c ", " \-\-cert-pem=\fIfilename\fR
DTLS certificate
.TP
.BR \-k ", " \-\-cert-key=\fIfilename\fR
DTLS certificate key
.TP
.BR \-K ", " \-\-cert-pwd=\fItext\fR
DTLS certificate key passphrase (if needed)
.TP
.BR \-S ", " \-\-stun-server=\fIip:port\fR
STUN server(:port) to use, if needed (e.g., Janus behind NAT, default=none)
.TP
.BR \-1 ", " \-\-nat-1-1=\fIips\fR
Comma-separated list of public IPs to put in all host candidates, assuming a 1:1 NAT is in place (e.g., Amazon EC2 instances, default=none)
.TP
.BR \-2 ", " \-\-keep-private-host
When nat-1-1 is used (e.g., Amazon EC2 instances), don't remove the private host, but keep both to simulate STUN (default=off)
.TP
.BR \-E ", " \-\-ice-enforce-list=\fIlist\fR
Comma-separated list of the only interfaces to use for ICE gathering; partial strings are supported (e.g., eth0 or eno1,wlan0, default=none)
.TP
.BR \-X ", " \-\-ice-ignore-list=\fIlist\fR
Comma-separated list of interfaces or IP addresses to ignore for ICE gathering; partial strings are supported (e.g., vmnet8,192.168.0.1,10.0.0.1 or vmnet,192.168., default=vmnet)
.TP
.BR \-6 ", " \-\-ipv6-candidates
Whether to enable IPv6 candidates or not (experimental) (default=off)
.TP
.BR \-l ", " \-\-libnice-debug
Whether to enable libnice debugging or not (default=off)
.TP
.BR \-f ", " \-\-full-trickle
Do full-trickle instead of half-trickle (default=off)
.TP
.BR \-I ", " \-\-ice-lite
Whether to enable the ICE Lite mode or not (default=off)
.TP
.BR \-T ", " \-\-ice-tcp
Whether to enable ICE-TCP or not (warning: only works with ICE Lite) (default=off)
.TP
.BR \-Q ", " \-\-min-nack-queue=\fInumber\fR
Minimum size of the NACK queue (in ms) per user for retransmissions, no matter the RTT
.TP
.BR \-t ", " \-\-no-media-timer=\fInumber\fR
Time (in s) that should pass with no media (audio or video) being received before Janus notifies you about this
.TP
.BR \-W ", " \-\-slowlink-threshold=\fInumber\fR
Number of lost packets (per s) that should trigger a 'slowlink' Janus API event to users
.TP
.BR \-r ", " \-\-rtp-port-range=\fImin\-max\fR
Port range to use for RTP/RTCP
.TP
.BR \-B ", " \-\-twcc-period=\fInumber\fR
How often (in ms) to send TWCC feedback back to senders, if negotiated (default=200ms)
.TP
.BR \-n ", " \-\-server-name=\fIname\fR
Public name of this Janus instance (default=MyJanusInstance)
.TP
.BR \-s ", " \-\-session-timeout=\fInumber\fR
Session timeout value, in seconds (default=60)
.TP
.BR \-m ", " \-\-reclaim-session-timeout=\fInumber\fR
Reclaim session timeout value, in seconds (default=0)
.TP
.BR \-d ", " \-\-debug-level=\fI1\-7\fR
Debug/logging level (0=disable debugging, 7=maximum debug level; default=4)
.TP
.BR \-D ", " \-\-debug-timestamps
Enable debug/logging timestamps (default=off)
.TP
.BR \-o ", " \-\-disable-colors
Disable color in the logging (default=off)
.TP
.BR \-M ", " \-\-debug-locks
Enable debugging of locks/mutexes (very verbose! default=off)
.TP
.BR \-a ", " \-\-apisecret=\fIrandomstring\fR
API secret all requests need to pass in order to be accepted by Janus (useful when wrapping Janus API requests in a server, none by default)
.TP
.BR \-A ", " \-\-token-auth
Enable token-based authentication for all requests (default=off)
.TP
.BR \-e ", " \-\-event-handlers
Enable event handlers (default=off)
.TP
.BR \-w ", " \-\-no-webrtc-encryption
Disable WebRTC encryption, so no DTLS or SRTP (only for debugging!) (default=off)
.SH EXAMPLES
\fBjanus\fR \- Launch Janus with all options from configurations files
.TP
\fBjanus \-b \-L /tmp/januslog\fR \- Launch Janus as a daemon and log to the specified file
.TP
\fBjanus \-6\fR \- Launch Janus with IPv6 support enabled
.TP
\fBjanus \-f\fR \- Launch Janus with full-trickle enabled
.SH BUGS
.TP
If you think you found a bug or want to contribute a feature, you can issue or a pull request on https://github.com/meetecho/janus-gateway/issues.
.TP
Anyway, before doing that make sure you read the documentation at http://janus.conf.meetecho.com/docs/ and that it has not been discussed already at https://groups.google.com/forum/#!forum/meetecho-janus. We only use Github for code issues, and \fBNOT\fR for configuration or usage issues: use the group for that.
.SH SEE ALSO
.TP
https://github.com/meetecho/janus-gateway \- Official repository
.TP
https://janus.conf.meetecho.com \- Demos and documentation
.TP
https://groups.google.com/forum/#!forum/meetecho-janus \- Community
.TP
http://www.meetecho.com/blog/ \- Tutorials and blog posts on Janus
.SH AUTHORS
Lorenzo Miniero (lorenzo@meetecho.com)