Ubuntu Manpages

GENERAL INFORMATION

turnadmin - a TURN relay administration tool. 

$ turnadmin [command] [options]
$ turnadmin [ -h | --help]

Commands:

Generate and print to the standard output an encrypted form of a password (for web admin user or CLI). The value then can be used as a safe key for the password storage on disk or in the database. Every invocation for the same password produces a different result. The format of the encrypted password is: $5$<...salt...>$<...sha256(salt+password)...>. Salt is 16 characters, the sha256 output is 64 characters. Character 5 is the algorithm id (sha256). Only sha256 is supported as the hash function.
Generate key for a long-term credentials mechanism user.
Add or update a long-term user.
Add or update an admin user.
Delete a long-term user.
Delete an admin user.
List long-term users in the database.
List admin users in the database.

-s, --set-secret=<value> Add shared secret for TURN REST API

Show stored shared secrets for TURN REST API

-X, --delete-secret=<value> Delete a shared secret.

Delete all shared secrets for REST API.
Add origin-to-realm relation.
Delete origin-to-realm relation.
List origin-to-realm relations.
Set realm params: max-bps, total-quota, user-quota.
List realm params.
Generate and print to the standard output an encrypted form of password with AES-128

Options with required values:

SQLite user database file name (default - /var/db/turndb or /usr/local/var/db/turndb or /var/lib/turn/turndb). See the same option in the turnserver section.
PostgreSQL user database connection string. See the --psql-userdb option in the turnserver section.
MySQL user database connection string. See the --mysql-userdb option in the turnserver section.
MongoDB user database connection string. See the --mysql-mongo option in the turnserver section.
Redis user database connection string. See the --redis-userdb option in the turnserver section.
User name.
Realm.
Password.
Generates a 128 bit key into the given path.
Contains a 128 bit key in the given path.
Verify a given base64 encrypted type password.
Origin
Set value of realm's max-bps parameter.
Set value of realm's total-quota parameter.
Set value of realm's user-quota parameter.
Help.

Command examples:

Generate an encrypted form of a password:

$ 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>

List all long-term users in MySQL database:

$ turnadmin -l --mysql-userdb="<db-connection-string>" -r <realm>

List all admin users in Redis database:

$ turnadmin -L --redis-userdb="<db-connection-string>"

Set secret in MySQL database:

$ turnadmin -s <secret> --mysql-userdb="<db-connection-string>" -r <realm>

Show secret stored in PostgreSQL database:

$ turnadmin -S --psql-userdb="<db-connection-string>" -r <realm>

Set origin-to-realm relation in MySQL database:

$ turnadmin --mysql-userdb="<db-connection-string>" -r <realm> -o <origin>

Delete origin-to-realm relation from Redis DB:

$ turnadmin --redis-userdb="<db-connection-string>" -o <origin>

List all origin-to-realm relations in Redis DB:

$ turnadmin --redis-userdb="<db-connection-string>" -I

List the origin-to-realm relations in PostgreSQL DB for a single realm:

$ turnadmin --psql-userdb="<db-connection-string>" -I -r <realm>

Create new key file for mysql password encryption:

$ turnadmin -E --key-path <key-file>

Create encrypted mysql password:

$ turnadmin -E --file-key-path <key-file> -p <secret>

Verify/decrypt encrypted password:

$ turnadmin --file-key-path <key-file> -v <encrypted>

Help:

$ turnadmin -h

After installation, run the command:

$ man turnadmin

or in the project root directory:

$ man -M man turnadmin

to see the man page.

/etc/turnserver.conf

/var/db/turndb

/usr/local/var/db/turndb

/var/lib/turn/turndb

/usr/local/etc/turnserver.conf

/usr/local/share/turnserver

/usr/local/share/doc/turnserver

/usr/local/share/examples/turnserver

turnserver, turnutils

project page:

https://github.com/coturn/coturn/

Wiki page:

https://github.com/coturn/coturn/wiki

forum:

https://groups.google.com/forum/?fromgroups=#!forum/turn-server-project-rfc5766-turn-server/

Oleg Moskalenko <mom040267@gmail.com>

Gabor Kovesdan http://kovesdan.org/

Daniel Pocock http://danielpocock.com/

John Selbie (jselbie@gmail.com)

Lee Sylvester <lee@designrealm.co.uk>

Erik Johnston <erikj@openmarket.com>

Roman Lisagor <roman@demonware.net>

Vladimir Tsanev <tsachev@gmail.com>

Po-sheng Lin <personlin118@gmail.com>

Peter Dunkley <peter.dunkley@acision.com>

Mutsutoshi Yoshimoto <mutsutoshi.yoshimoto@mixi.co.jp>

Federico Pinna <fpinna@vivocha.com>

Bradley T. Hughes <bradleythughes@fastmail.fm>

Mihály Mészáros <misi@majd.eu>

Mihály Mészáros <misi@majd.eu>