|
|
@@ -1,5 +1,5 @@
|
|
|
.\" Text automatically generated by txt2man
|
|
|
-.TH TURN 1 "25 June 2014" "" ""
|
|
|
+.TH TURN 1 "11 July 2014" "" ""
|
|
|
.SH GENERAL INFORMATION
|
|
|
|
|
|
The \fBTURN Server\fP project contains the source code of a TURN server and TURN client
|
|
|
@@ -87,7 +87,7 @@ is equivalent to:
|
|
|
.nf
|
|
|
.fam C
|
|
|
|
|
|
-$ \fIturnserver\fP [\fB\-n\fP | \fB\-c\fP <config\-file> ] [\fIflags\fP] [ \fB\-\-userdb\fP=<userdb\-file> | \fB\-\-psql\-userdb\fP=<db\-conn\-string> | \fB\-\-mysql\-userdb\fP=<db\-conn\-string> | \fB\-\-redis\-userdb\fP=<db\-conn\-string> ] [\fB\-z\fP | \fB\-\-no\-auth\fP | \fB\-a\fP | \fB\-\-lt\-cred\-mech\fP ] [\fIoptions\fP]
|
|
|
+$ \fIturnserver\fP [\fB\-n\fP | \fB\-c\fP <config\-file> ] [\fIflags\fP] [ \fB\-\-userdb\fP=<userdb\-file> | \fB\-\-psql\-userdb\fP=<db\-conn\-string> | \fB\-\-mysql\-userdb\fP=<db\-conn\-string> | \fB\-\-mongo\-userdb\fP=<db\-conn\-string> | \fB\-\-redis\-userdb\fP=<db\-conn\-string> ] [\fB\-z\fP | \fB\-\-no\-auth\fP | \fB\-a\fP | \fB\-\-lt\-cred\-mech\fP ] [\fIoptions\fP]
|
|
|
$ \fIturnserver\fP \fB\-h\fP
|
|
|
|
|
|
.fam T
|
|
|
@@ -173,6 +173,21 @@ for full MySQL documentation.
|
|
|
.RE
|
|
|
.TP
|
|
|
.B
|
|
|
+\fB\-J\fP, \fB\-\-mongo\-userdb\fP
|
|
|
+User database connection string for MongoDB.
|
|
|
+This database can be used for long\-term and short\-term credentials mechanisms,
|
|
|
+and it can store the secret value for secret\-based timed authentication in TURN RESP API.
|
|
|
+The connection string format is like that:
|
|
|
+.RS
|
|
|
+.PP
|
|
|
+"mongodb://[username:password@]host1[:port1][,host2[:port2],\.\.\.[,hostN[:portN]]][/[database][?\fIoptions\fP]]"
|
|
|
+See the INSTALL file for more explanations and examples.
|
|
|
+.PP
|
|
|
+Also, see http://docs.mongodb.org/manual/
|
|
|
+for full MongoDB documentation.
|
|
|
+.RE
|
|
|
+.TP
|
|
|
+.B
|
|
|
\fB\-N\fP, \fB\-\-redis\-userdb\fP
|
|
|
User database connection string for Redis.
|
|
|
This database can be used for long\-term and short\-term credentials mechanisms,
|
|
|
@@ -212,12 +227,12 @@ per\-server setting.
|
|
|
\fB\-a\fP, \fB\-\-lt\-cred\-mech\fP
|
|
|
Use long\-term credentials mechanism (this one you need for WebRTC usage).
|
|
|
This option can be used with either flat file user database or
|
|
|
-PostgreSQL DB or MySQL DB or Redis for user keys storage.
|
|
|
+PostgreSQL DB or MySQL DB or MongoDB or Redis for user keys storage.
|
|
|
.TP
|
|
|
.B
|
|
|
\fB\-A\fP, \fB\-\-st\-cred\-mech\fP
|
|
|
Use the short\-term credentials mechanism. This option requires
|
|
|
-a PostgreSQL or MySQL or Redis DB for short term passwords storage.
|
|
|
+a PostgreSQL or MySQL or MongoDB or Redis DB for short term passwords storage.
|
|
|
.TP
|
|
|
.B
|
|
|
\fB\-z\fP, \fB\-\-no\-auth\fP
|
|
|
@@ -667,7 +682,7 @@ Redis status and statistics database connection string, if used (default \- empt
|
|
|
no Redis stats DB used). This database keeps allocations status information, and it can
|
|
|
be also used for publishing and delivering traffic and allocation event notifications.
|
|
|
This database option can be used independently of \fB\-\-redis\-userdb\fP option,
|
|
|
-and actually Redis can be used for status/statistics and MySQL or PostgreSQL can
|
|
|
+and actually Redis can be used for status/statistics and MySQL or MongoDB or PostgreSQL can
|
|
|
be used for the user database.
|
|
|
The connection string has the same parameters as redis\-userdb connection string.
|
|
|
.TP
|
|
|
@@ -762,7 +777,7 @@ for that you have a number of \fIoptions\fP:
|
|
|
|
|
|
b) userdb config file.
|
|
|
|
|
|
- c) a database table (PostgreSQL or MySQL). You will have to set keys with
|
|
|
+ c) a database table (PostgreSQL or MySQL or MongoDB). You will have to set keys with
|
|
|
turnadmin utility (see docs and wiki for turnadmin). You cannot use open passwords
|
|
|
in the database.
|
|
|
|
|
|
@@ -963,6 +978,8 @@ If a database is used, then users can be divided into multiple independent realm
|
|
|
can be administered separately, and each realm can have its own set of users and its own
|
|
|
performance \fIoptions\fP (max\-bps, user\-quota, total\-quota).
|
|
|
.IP 7) 4
|
|
|
+If you use MongoDB, the database will be setup for you automatically.
|
|
|
+.IP 8) 4
|
|
|
Of course, the \fIturnserver\fP can be used in non\-secure mode, when users are allowed to establish
|
|
|
sessions anonymously. But in most cases (like WebRTC) that will not work.
|
|
|
.PP
|
|
|
@@ -1135,3 +1152,5 @@ Po\-sheng Lin <[email protected]>
|
|
|
Peter Dunkley <[email protected]>
|
|
|
.PP
|
|
|
Mutsutoshi Yoshimoto <[email protected]>
|
|
|
+.PP
|
|
|
+Federico Pinna <[email protected]>
|
mom040267