瀏覽代碼

docs updates

mom040267 10 年之前
父節點
當前提交
10f880c975
共有 5 個文件被更改,包括 51 次插入8 次删除
  1. 15 3
      INSTALL
  2. 17 1
      README.turnserver
  3. 1 1
      man/man1/turnadmin.1
  4. 17 2
      man/man1/turnserver.1
  5. 1 1
      man/man1/turnutils.1

+ 15 - 3
INSTALL

@@ -1146,7 +1146,19 @@ Read the project wiki pages: http://code.google.com/p/coturn/w/list
 Also, check the project from page links to the TURN/WebRTC configuration examples.
 It may give you an idea how it can be done.
 
-XXII. Management interface
+XXII. HTTPS Management Interface
+
+The turnserver process provides an HTTPS Web access as statistics and basic management
+interface. The turnserver listens to incoming HTTPS admin connections on the same ports
+as the main TURN/STUN listener. The Web admin pages are basic and self-explanatory.
+
+To make the HTTPS interface active, the database table admin_user must be
+populated with the admin user account(s). An admin user can be a superuser
+(if not assigned to a particular realm) or a restricted user (if assigned to
+a realm). The restricted admin users can perform only limited actions, within
+their corresponding realms.
+
+XXIII. Telnet CLI management interface
 
 You have a telnet interface (enabled by default) to access the turnserver process, 
 to view its state, to gather some statistical information, and to make some changes 
@@ -1154,7 +1166,7 @@ on-the-fly.
 
 You can access that CLI interface with telnet or putty program (in telnet mode). 
 The process by default listens to port 5766 on IP address 127.0.0.1 for the telnet
-connections. 
+connections.
 
 WARNING: all telnet communications are going unencrypted over the network. For
 security reasons, we advise using the loopback IP addresses for CLI (127.0.0.1 
@@ -1163,7 +1175,7 @@ transferred over the network unencrypted, too. So sticking to the local system
 CLI access, and accessing the turnserver system terminal with ssh only, would 
 be a wise decision.
 
-XXIII. ALPN support.
+XXIV. ALPN support.
 
 Starting with version 4.3.2.1, the TURN server supports the ALPN STUN 
 specifications (http://tools.ietf.org/html/draft-ietf-tram-alpn-08).

+ 17 - 1
README.turnserver

@@ -822,7 +822,23 @@ in the following directories:
 If all efforts failed (due to the system permission settings) then all 
 log messages are sent only to the standard output of the process.
 
-This behavior can be controlled by --log-file, --syslog and --no-stdout-log options.
+This behavior can be controlled by --log-file, --syslog and --no-stdout-log
+options.
+
+=================================
+
+HTTPS MANAGEMENT INTERFACE
+
+The turnserver process provides an HTTPS Web access as statistics and basic
+management interface. The turnserver listens to incoming HTTPS admin 
+connections on the same ports as the main TURN/STUN listener. The Web admin
+pages are basic and self-explanatory.
+
+To make the HTTPS interface active, the database table admin_user must be
+populated with the admin user account(s). An admin user can be a superuser
+(if not assigned to a particular realm) or a restricted user (if assigned to
+a realm). The restricted admin users can perform only limited actions, within
+their corresponding realms.
 
 =================================
 

+ 1 - 1
man/man1/turnadmin.1

@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH TURN 1 "20 January 2015" "" ""
+.TH TURN 1 "24 January 2015" "" ""
 .SH GENERAL INFORMATION
 
 \fIturnadmin\fP is a TURN administration tool. This tool can be used to manage 

+ 17 - 2
man/man1/turnserver.1

@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH TURN 1 "20 January 2015" "" ""
+.TH TURN 1 "24 January 2015" "" ""
 .SH GENERAL INFORMATION
 
 The \fBTURN Server\fP project contains the source code of a TURN server and TURN client 
@@ -1075,7 +1075,22 @@ current directory
 If all efforts failed (due to the system permission settings) then all 
 log messages are sent only to the standard output of the process.
 .PP
-This behavior can be controlled by \fB\-\-log\-file\fP, \fB\-\-syslog\fP and \fB\-\-no\-stdout\-log\fP \fIoptions\fP.
+This behavior can be controlled by \fB\-\-log\-file\fP, \fB\-\-syslog\fP and \fB\-\-no\-stdout\-log\fP
+\fIoptions\fP.
+.PP
+=================================
+.SH HTTPS MANAGEMENT INTERFACE
+
+The \fIturnserver\fP process provides an HTTPS Web access as statistics and basic
+management interface. The \fIturnserver\fP listens to incoming HTTPS admin 
+connections on the same ports as the main TURN/STUN listener. The Web admin
+pages are basic and self\-explanatory.
+.PP
+To make the HTTPS interface active, the database table admin_user must be
+populated with the admin user \fBaccount\fP(s). An admin user can be a superuser
+(if not assigned to a particular realm) or a restricted user (if assigned to
+a realm). The restricted admin users can perform only limited actions, within
+their corresponding realms.
 .PP
 =================================
 .SH TELNET CLI

+ 1 - 1
man/man1/turnutils.1

@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH TURN 1 "20 January 2015" "" ""
+.TH TURN 1 "24 January 2015" "" ""
 .SH GENERAL INFORMATION
 
 A set of turnutils_* programs provides some utility functionality to be used