OS Manuals

/usr/bin/turnadmin

TURN and STUN server for VoIP and WebRTC

From coturn 4.18.0-r6 (enterprise-packages), captured 2026-11-08 by running turnadmin --help (exit 0). permalink

Usage: turnadmin [command] [options]

Commands:

	-P, --generate-encrypted-password	Generate and print to the standard
					output an encrypted form of a password
					(for web admin user or CLI). See wiki, README or man
					pages for more detailed description.
	-k, --key			generate long-term credential mechanism key for a user
	-a, --add			add/update a long-term mechanism user
	-A, --add-admin			add/update a web admin user
	-d, --delete			delete a long-term mechanism user
	-D, --delete-admin		delete an admin user
	-l, --list			list all long-term mechanism users
	-L, --list-admin		list all admin users
	-s, --set-secret=<value>	Add shared secret for TURN REST API
	-S, --show-secret		Show stored shared secrets for TURN REST API
	-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.
	-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.
	-E, --generate-encrypted-password-aes	Generate and print to the standard
					output an encrypted form of password with AES-128

Options with mandatory values:

	-b, --db, --userdb		SQLite database file, default value is /var/db/turndb or
					  /usr/local/var/db/turndb or /var/lib/turn/turndb.
	-e, --psql-userdb, --sql-userdb	PostgreSQL user database connection string, if PostgreSQL DB is used.
	-M, --mysql-userdb		MySQL user database connection string, if MySQL DB is used.
	-N, --redis-userdb		Redis user database connection string, if Redis DB is used.
	-u, --user			Username
	-r, --realm			Realm
	-p, --password			Password
	-x, --key-path			Generates a 128 bit key into the given path.
	-f, --file-key-path		Contains a 128 bit key in the given path.
	-v, --verify			Verify a given base64 encrypted type password.
	-o, --origin			Origin
	--max-bps			Set value of realm's max-bps parameter.
					Setting to zero value means removal of the option.
	--total-quota			Set value of realm's total-quota parameter.
					Setting to zero value means removal of the option.
	--user-quota			Set value of realm's user-quota parameter.
					Setting to zero value means removal of the option.
	-h, --help			Help
Options (33)
OptionDescriptionSource
-P, --generate-encrypted-passwordGenerate and print to the standard output an encrypted form of a password (for web admin user or CLI).help
-k, --keygenerate long-term credential mechanism key for a userhelp
-a, --addadd/update a long-term mechanism userhelp
-A, --add-adminadd/update a web admin userhelp
-d, --deletedelete a long-term mechanism userhelp
-D, --delete-admindelete an admin userhelp
-l, --listlist all long-term mechanism usershelp
-L, --list-adminlist all admin usershelp
-s, --set-secret valueAdd shared secret for TURN REST APIhelp
-S, --show-secretShow stored shared secrets for TURN REST APIhelp
-X, --delete-secret valueDelete a shared secrethelp
--delete-all-secretsDelete all shared secrets for REST APIhelp
-O, --add-originAdd origin-to-realm relation.help
-R, --del-originDelete origin-to-realm relation.help
-I, --list-originsList origin-to-realm relations.help
-g, --set-realm-optionSet realm params: max-bps, total-quota, user-quota.help
-G, --list-realm-optionsList realm params.help
-E, --generate-encrypted-password-aesGenerate and print to the standard output an encrypted form of password with AES-128help
-b, --db, --userdbSQLite database file, default value is /var/db/turndb or /usr/local/var/db/turndb or /var/lib/turn/turndb.help
-e, --psql-userdb, --sql-userdbPostgreSQL user database connection string, if PostgreSQL DB is used.help
-M, --mysql-userdbMySQL user database connection string, if MySQL DB is used.help
-N, --redis-userdbRedis user database connection string, if Redis DB is used.help
-u, --userUsernamehelp
-r, --realmRealmhelp
-p, --passwordPasswordhelp
-x, --key-pathGenerates a 128 bit key into the given path.help
-f, --file-key-pathContains a 128 bit key in the given path.help
-v, --verifyVerify a given base64 encrypted type password.help
-o, --originOriginhelp
--max-bpsSet value of realm's max-bps parameter.help
--total-quotaSet value of realm's total-quota parameter.help
--user-quotaSet value of realm's user-quota parameter.help
-h, --helpHelphelp

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.