diff --git a/doc/ADMIN.md b/doc/ADMIN.md new file mode 100644 index 0000000..f06d32d --- /dev/null +++ b/doc/ADMIN.md @@ -0,0 +1,20 @@ +### Login to Conduit + +[Integration into the YunoHost user database is not ready, yet.](https://github.com/YunoHost-Apps/conduit_ynh/issues/12) You need to **enable registration** in the apps configuration tab and then use a client to register an account. Afterwards you can disable registration again if you do not want allow anybody to register. + +Using the newly created account you should be able to login. + +### Coturn configuration + +To be able to take advantage of audio and video call functionalities, a Coturn server is often required. It is possible to [install a Coturn server in YunoHost (https://github.com/YunoHost-Apps/coturn-ynh/blob/master/README-en.md). +It is then necessary to fill in the information provided by the Coturn server in the file 'conduit.toml' such as: + +``` +turn_uris = ["turns:your.turn.url:5349?transport=udp", "turns:your.turn.url:5349?transport=tcp"] +turn_username = "" +turn_password = "" +``` +If your Coturn (not YunoHost's one) does not use TLS, you might need to change a little bit like: +``` +turn_uris = ["turn:your.turn.url:5349?transport=udp", "turn:your.turn.url:5349?transport=tcp"] +``