|
|
@@ -1,51 +1,51 @@
|
|
|
GENERAL INFORMATION
|
|
|
|
|
|
-turnadmin is a TURN administration tool. This tool can be used to manage
|
|
|
-the user accounts (add/remove users, generate
|
|
|
-TURN keys for the users). For security reasons, we do not recommend
|
|
|
-storing passwords openly. The better option is to use pre-processed "keys"
|
|
|
-which are then used for authentication. These keys are generated by turnadmin.
|
|
|
-Turnadmin is a link to turnserver binary, but turnadmin performs different
|
|
|
+turnadmin is a TURN administration tool. This tool can be used to manage
|
|
|
+the user accounts (add/remove users, generate
|
|
|
+TURN keys for the users). For security reasons, we do not recommend
|
|
|
+storing passwords openly. The better option is to use pre-processed "keys"
|
|
|
+which are then used for authentication. These keys are generated by turnadmin.
|
|
|
+Turnadmin is a link to turnserver binary, but turnadmin performs different
|
|
|
functions.
|
|
|
|
|
|
Options note: turnadmin has long and short option names, for most options.
|
|
|
-Some options have only long form, some options have only short form. Their syntax
|
|
|
+Some options have only long form, some options have only short form. Their syntax
|
|
|
somewhat different, if an argument is required:
|
|
|
|
|
|
The short form must be used as this (for example):
|
|
|
|
|
|
$ turnadmin -u <username> ...
|
|
|
-
|
|
|
+
|
|
|
The long form equivalent must use the "=" character:
|
|
|
|
|
|
$ turnadmin --user=<username> ...
|
|
|
-
|
|
|
+
|
|
|
If this is a flag option (no argument required) then their usage are the same, for example:
|
|
|
|
|
|
$ turnadmin -k ...
|
|
|
-
|
|
|
+
|
|
|
is equivalent to:
|
|
|
|
|
|
$ turnadmin --key ...
|
|
|
|
|
|
-You have always the use the -r <realm> option with commands for long term credentials -
|
|
|
+You have always the use the -r <realm> option with commands for long term credentials -
|
|
|
because data for multiple realms can be stored in the same database.
|
|
|
-
|
|
|
+
|
|
|
=====================================
|
|
|
|
|
|
NAME
|
|
|
|
|
|
-turnadmin - a TURN relay administration tool.
|
|
|
-
|
|
|
- SYNOPSIS
|
|
|
+turnadmin - a TURN relay administration tool.
|
|
|
+
|
|
|
+ SYNOPSIS
|
|
|
|
|
|
$ turnadmin [command] [options]
|
|
|
|
|
|
$ turnadmin [ -h | --help]
|
|
|
|
|
|
DESCRIPTION
|
|
|
-
|
|
|
-Commands:
|
|
|
+
|
|
|
+Commands:
|
|
|
|
|
|
-P, --generate-encrypted-password Generate and print to the standard
|
|
|
output an encrypted form of a password (for web admin user or CLI).
|
|
|
@@ -76,7 +76,7 @@ Only sha256 is supported as the hash function.
|
|
|
|
|
|
-X, --delete-secret=<value> Delete a shared secret.
|
|
|
--delete-all_secrets Delete all shared secrets for REST API.
|
|
|
-
|
|
|
+
|
|
|
-O, --add-origin Add origin-to-realm relation.
|
|
|
|
|
|
-R, --del-origin Delete origin-to-realm relation.
|
|
|
@@ -86,10 +86,10 @@ Only sha256 is supported as the hash function.
|
|
|
-g, --set-realm-option Set realm params: max-bps, total-quota, user-quota.
|
|
|
|
|
|
-G, --list-realm-options List realm params.
|
|
|
--E, --generate-encrypted-password-aes Generate and print to the standard output
|
|
|
+-E, --generate-encrypted-password-aes Generate and print to the standard output
|
|
|
an encrypted form of password with AES-128
|
|
|
-
|
|
|
-Options with required values:
|
|
|
+
|
|
|
+Options with required values:
|
|
|
|
|
|
-b, --db, --userdb SQLite user database file name (default - /var/db/turndb or
|
|
|
/usr/local/var/db/turndb or /var/lib/turn/turndb).
|
|
|
@@ -111,10 +111,10 @@ Options with required values:
|
|
|
-o, --origin Origin
|
|
|
--max-bps Set value of realm's max-bps parameter.
|
|
|
--total-quota Set value of realm's total-quota parameter.
|
|
|
---user-quota Set value of realm's user-quota parameter.
|
|
|
+--user-quota Set value of realm's user-quota parameter.
|
|
|
-h, --help Help.
|
|
|
|
|
|
-Command examples:
|
|
|
+Command examples:
|
|
|
|
|
|
Generate an encrypted form of a password:
|
|
|
|
|
|
@@ -123,11 +123,11 @@ $ turnadmin -P -p <password>
|
|
|
Generate a key:
|
|
|
|
|
|
$ turnadmin -k -u <username> -r <realm> -p <password>
|
|
|
-
|
|
|
+
|
|
|
Add/update a user in the in the database:
|
|
|
|
|
|
$ turnadmin -a [-b <userdb-file> | -e <db-connection-string> | -M <db-connection-string> | -N <db-connection-string> ] -u <username> -r <realm> -p <password>
|
|
|
-
|
|
|
+
|
|
|
Delete a user from the database:
|
|
|
|
|
|
$ turnadmin -d [-b <userdb-file> | -e <db-connection-string> | -M <db-connection-string> | -N <db-connection-string> ] -u <username> -r <realm>
|
|
|
@@ -176,13 +176,13 @@ Verify/decrypt encrypted password:
|
|
|
|
|
|
$ turnadmin --file-key-path <key-file> -v <encrypted>
|
|
|
|
|
|
-
|
|
|
-Help:
|
|
|
+
|
|
|
+Help:
|
|
|
|
|
|
$ turnadmin -h
|
|
|
|
|
|
=======================================
|
|
|
-
|
|
|
+
|
|
|
DOCS
|
|
|
|
|
|
After installation, run the command:
|
|
|
@@ -258,13 +258,13 @@ to see the man page.
|
|
|
Erik Johnston <[email protected]>
|
|
|
|
|
|
Roman Lisagor <[email protected]>
|
|
|
-
|
|
|
+
|
|
|
Vladimir Tsanev <[email protected]>
|
|
|
-
|
|
|
+
|
|
|
Po-sheng Lin <[email protected]>
|
|
|
-
|
|
|
+
|
|
|
Peter Dunkley <[email protected]>
|
|
|
-
|
|
|
+
|
|
|
Mutsutoshi Yoshimoto <[email protected]>
|
|
|
|
|
|
Federico Pinna <[email protected]>
|