table of contents
other versions
- jessie 4.2.1.2-1
- jessie-backports 4.5.0.2-3~bpo8+1
- stretch 4.5.0.5-1+b1
- testing 4.5.1.0-1
- stretch-backports 4.5.1.0-1~bpo9+1
- unstable 4.5.1.1-1
conflicting packages
TURN(1) | TURN(1) |
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 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 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 - because data for multiple realms can be stored in the same database. =====================================
NAME¶
turnadmin - a TURN relay administration tool.SYNOPSIS¶
$ turnadmin [command] [options] $ turnadmin [ -h | --help]DESCRIPTION¶
- Commands:
- -k, --key
- Generate key for a long-term credentials mechanism user.
- -a, --add
- Add or update a long-term user.
- -A, --add-st
- Add or update a short-term credentials mechanism user.
- -d, --delete
- Delete a long-term user.
- -D, --delete-st
- Delete a short-term user.
- -l, --list
- List long-term users in the database.
- -L, --list-st
- List short-term users in the database.
- -S, --show-secret
- Show stored shared secrets for TURN REST API
- --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.
- -I, --list-origins
- List origin-to-realm relations.
- -g, --set-realm-option
- Set realm params: max-bps, total-quota, user-quota.
- -G, --list-realm-options
- List realm params.
- Options with required values:
- -b, --userdb
- File-based user database file name (default - turnuserdb.conf). See the --userdb option in the turnserver section.
- -e, --psql-userdb
- PostgreSQL user database connection string. See the --psql-userdb option in the turnserver section.
- -M, --mysql-userdb
- MySQL user database connection string. See the --mysql-userdb option in the turnserver section.
- -J, --mongo-userdb
- MongoDB user database connection string. See the --mysql-mongo option in the turnserver section.
- -N, --redis-userdb
- Redis user database connection string. See the --redis-userdb option in the turnserver section.
- -u, --user
- User name.
- -r, --realm
- Realm, for long-term credentials mechanism only.
- -p, --password
- Password.
- -o, --origin
- Origin
- -H, --sha256
- Use SHA256 as the keys hash function (a non-standard feature). By default, MD5 is used for the key storage encryption (as required by the current STUN/TURNstandards).
- --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.
- -h, --help
- Help.
- Generate a key:
- Help:
DOCS¶
After installation, run the command: $ man turnadmin or in the project root directory: $ man -M man turnadmin to see the man page. =====================================FILES¶
/etc/turnserver.conf /etc/turnuserdb.conf /usr/local/etc/turnserver.conf /usr/local/etc/turnuserdb.conf =====================================DIRECTORIES¶
/usr/local/share/ turnserver /usr/local/share/doc/ turnserver /usr/local/share/examples/ turnserver ======================================SEE ALSO¶
turnserver, turnutils ======================================WEB RESOURCES¶
project page: http://code.google.com/p/coturn/ Wiki page: http://code.google.com/p/coturn/wiki/Readme forum: https://groups.google.com/forum/?fromgroups=#!forum/turn-server-project-rfc5766-turn-server/ ======================================AUTHORS¶
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@crocodilertc.net> Mutsutoshi Yoshimoto <mutsutoshi.yoshimoto@mixi.co.jp> Federico Pinna <fpinna@vivocha.com> Bradley T. Hughes <bradleythughes@fastmail.fm>28 September 2014 |