[mirotalksfu] - add host.auth_user

README.md

@@ -35,6 +35,7 @@
 -   Unlimited conference rooms with no time limitations.
 -   Translated into 133 languages.
 -   Host protection to prevent unauthorized access.
+-   User auth to prevent unauthorized access.
 -   Room password protection.
 -   Compatible with desktop and mobile devices.
 -   Optimized mobile room URL sharing.
@@ -79,26 +80,76 @@
 <br/>
 
 -   You can `directly join a room` by using link like:
--   https://sfu.mirotalk.com/join?room=test&password=0&name=mirotalksfu&audio=0&video=0&screen=0&notify=0
+-   https://sfu.mirotalk.com/join?room=test&roomPassword=0&name=mirotalksfu&audio=0&video=0&screen=0&notify=0
 
-    | Params   | Type           | Description     |
-    | -------- | -------------- | --------------- |
-    | room     | string         | Room Id         |
-    | password | string/boolean | Room password   |
-    | name     | string         | User name       |
-    | audio    | boolean        | Audio stream    |
-    | video    | boolean        | Video stream    |
-    | screen   | boolean        | Screen stream   |
-    | notify   | boolean        | Welcome message |
+    | Params       | Type           | Description     |
+    | ------------ | -------------- | --------------- |
+    | room         | string         | Room Id         |
+    | roomPassword | string/boolean | Room password   |
+    | name         | string         | User name       |
+    | audio        | boolean        | Audio stream    |
+    | video        | boolean        | Video stream    |
+    | screen       | boolean        | Screen stream   |
+    | notify       | boolean        | Welcome message |
+    | username     | string         | auth username   |
+    | password     | string         | auth password   |
 
 > **Note**
 >
-> When [host protection is enabled](https://github.com/miroslavpejic85/mirotalksfu/commit/ab21686e9ad4b75e14c3ee020141d61b33111dde#commitcomment-62398736) the host needs to provide a valid username and password as specified in the `app/src/config.js`.
->
-> After host authentication, participants can join the room using any of the following URL formats:
->
-> -   https://sfu.mirotalk.com/join/test (URL path)
-> -   https://sfu.mirotalk.com/join/?room=test&password=0&name=mirotalksfu&audio=0&video=0&screen=0&notify=0 (URL with query parameters for direct join)
+> The `username` and `password` parameters are required when either `host.protected` or `host.user_auth` is set to `true` in the `app/src/config.js` file. The valid list of users is defined in the `host.users` configuration.
+
+</details>
+
+<details>
+<summary>Host Protection Configuration</summary>
+
+<br/>
+
+When [host.protected](https://github.com/miroslavpejic85/mirotalksfu/commit/ab21686e9ad4b75e14c3ee020141d61b33111dde#commitcomment-62398736) or `host.user_auth` is enabled, the host/users must provide a valid username and password as specified in the `app/src/config.js` file.
+
+| Params           | Value                                                                            | Description                                                                            |
+| ---------------- | -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
+| `host.protected` | `true` if protection is enabled, `false` if not (default false)                  | Requires the host to provide a valid username and password during room initialization. |
+| `host.user_auth` | `true` if user authentication is required, `false` if not (default false).       | Determines whether host authentication is required.                                    |
+| `host.users`     | JSON array with user objects: `{"username": "username", "password": "password"}` | List of valid host users with their credentials.                                       |
+
+Example:
+
+```js
+    host: {
+        protected: true,
+        user_auth: true,
+        users: [
+            {
+                username: 'username',
+                password: 'password',
+            },
+            {
+                username: 'username2',
+                password: 'password2',
+            },
+            //...
+        ],
+    },
+```
+
+### Room Initialization
+
+To bypass the login page, join the room with URL parameters:
+
+-   [https://sfu.mirotalk.com/join/?room=test&username=username&password=password](https://sfu.mirotalk.com/join/?room=test&username=username&password=password)
+
+### Participant Room Entry
+
+If `host.protected` is enabled, participants can join after host authentication using:
+
+-   [https://sfu.mirotalk.com/join/test](https://sfu.mirotalk.com/join/test) (URL path)
+-   [https://sfu.mirotalk.com/join/?room=test&roomPassword=0&name=mirotalksfu&audio=0&video=0&screen=0&notify=0](https://sfu.mirotalk.com/join/?room=test&roomPassword=0&name=mirotalksfu&audio=0&video=0&screen=0&notify=0) (URL with query parameters)
+
+If `host.user_auth` is enabled, participants can join with mandatory credentials:
+
+-   [https://sfu.mirotalk.com/join/?room=test&username=username&password=password](https://sfu.mirotalk.com/join/?room=test&username=username&password=password) (URL path)
+-   [https://sfu.mirotalk.com/join/?room=test&name=mirotalk&audio=0&video=0&screen=0&notify=0&username=username&password=password](https://sfu.mirotalk.com/join/?room=test&name=mirotalk&audio=0&video=0&screen=0&&notify=0&username=username&password=password) (URL with query parameters)
 
 </details>