Update the example config file: use-auth-secret overrides lt-cred-mech. #262
Conversation
|
If you use use-auth-secret then internally lt-cred-mech is automatically turned on. The problem is that I found earlier very confusing how these two configs behaves, use-auth-secret depends on lt-cred-mech, but if set then it overrides and does not allow to use the lt-cred-mech credentials anymore. Sorry if I caused confusion with my warning in PR #160. I am now confused about your fix / PR . |
|
(thanks for the quick review!) If I understand your comment here correctly you're saying that the implementation of use-auth-secret in fact depends on the lt-cred mechanism internally. However I think that from a user's perspective that doesn't matter: according to PR #160, it is an error to specify both use-auth-secret and lt-cred-mech in a config file, because you can only have one of the two turned on in a usable way. That's why i sent this PR, to clear up the confusion about what goes in a correct config file; once this is through I can send PRs to other sample coturn configs (e.g. https://github.com/matrix-org/synapse/blob/master/docs/turn-howto.rst on the matrix project, which is what led me to coturn) to turn off lt-cred-mech in their sample configs too. |
See coturn/coturn#262 for more context. Also clean up some minor formatting issues while I'm here.
* Remove mention of lt-cred-mech in the sample coturn config. See coturn/coturn#262 for more context. Also clean up some minor formatting issues while I'm here. * Add changelog. Signed-off-by: Krithin Sitaram <krithin@gmail.com>
The comment before the TURN REST API flag was confusing: it seemed to imply that
use-auth-secretrequired the use oflt-cred-mech, but I've since learnt from PR #160 that in fact you're not supposed to use both of them together.(I suspect that this was why lots of sample coturn config files you can find on the internet have both of those flags set.)