Email as default username since update to new config set-up is NOT great :)
-
I can confirm this seems to have no impact.
Added the following lines to/app/data/env
OIDC_FORCE_USERNAME=false OIDC_EMAIL_AS_USERNAME=false OIDC_NAME_AS_USERNAME=true
Cloudron writes this to
/run/mirotalksfu/env
and/run/mirotalksfu/env
is symlinked to/app/code/.env
.
So everything in that/app/data/env
=>/run/mirotalksfu/env
=>/app/code/.env
is loaded, otherwise all the other settings would be missing.But now when checking the
/app/code/app/src/config.js
I see:peer_name: { force: process.env.OIDC_USERNAME_FORCE !== 'false', // Require identity provider authentication email: process.env.OIDC_USERNAME_AS_EMAIL !== 'false', // Request email claim name: process.env.OIDC_USERNAME_AS_NAME === 'true', // Don't require full name }
So from that I can conclude the env vars should be:
OIDC_USERNAME_FORCE=false OIDC_USERNAME_AS_EMAIL=false OIDC_USERNAME_AS_NAME=true
This now had the desired effect.
I assume what @mirotalk-57bab571 wrote https://forum.cloudron.io/post/107999 was simply a typo or first draft of that variable names.
Solution
Use the following variables in
/app/data/env
OIDC_USERNAME_FORCE=false OIDC_USERNAME_AS_EMAIL=false OIDC_USERNAME_AS_NAME=true
-
I can confirm this seems to have no impact.
Added the following lines to/app/data/env
OIDC_FORCE_USERNAME=false OIDC_EMAIL_AS_USERNAME=false OIDC_NAME_AS_USERNAME=true
Cloudron writes this to
/run/mirotalksfu/env
and/run/mirotalksfu/env
is symlinked to/app/code/.env
.
So everything in that/app/data/env
=>/run/mirotalksfu/env
=>/app/code/.env
is loaded, otherwise all the other settings would be missing.But now when checking the
/app/code/app/src/config.js
I see:peer_name: { force: process.env.OIDC_USERNAME_FORCE !== 'false', // Require identity provider authentication email: process.env.OIDC_USERNAME_AS_EMAIL !== 'false', // Request email claim name: process.env.OIDC_USERNAME_AS_NAME === 'true', // Don't require full name }
So from that I can conclude the env vars should be:
OIDC_USERNAME_FORCE=false OIDC_USERNAME_AS_EMAIL=false OIDC_USERNAME_AS_NAME=true
This now had the desired effect.
I assume what @mirotalk-57bab571 wrote https://forum.cloudron.io/post/107999 was simply a typo or first draft of that variable names.
Solution
Use the following variables in
/app/data/env
OIDC_USERNAME_FORCE=false OIDC_USERNAME_AS_EMAIL=false OIDC_USERNAME_AS_NAME=true
@james Brilliant, thank you looking into this, for explaining the logic and for finding the fix!
Gauthier
-
@james Do you think in the future it would make sense:
- for the behaviour described here re display name to become the default on the Cloudron package?
- for users to also have a way to modify the config.js file as it seems like not all options can be changed via the env file?
-
I can confirm this seems to have no impact.
Added the following lines to/app/data/env
OIDC_FORCE_USERNAME=false OIDC_EMAIL_AS_USERNAME=false OIDC_NAME_AS_USERNAME=true
Cloudron writes this to
/run/mirotalksfu/env
and/run/mirotalksfu/env
is symlinked to/app/code/.env
.
So everything in that/app/data/env
=>/run/mirotalksfu/env
=>/app/code/.env
is loaded, otherwise all the other settings would be missing.But now when checking the
/app/code/app/src/config.js
I see:peer_name: { force: process.env.OIDC_USERNAME_FORCE !== 'false', // Require identity provider authentication email: process.env.OIDC_USERNAME_AS_EMAIL !== 'false', // Request email claim name: process.env.OIDC_USERNAME_AS_NAME === 'true', // Don't require full name }
So from that I can conclude the env vars should be:
OIDC_USERNAME_FORCE=false OIDC_USERNAME_AS_EMAIL=false OIDC_USERNAME_AS_NAME=true
This now had the desired effect.
I assume what @mirotalk-57bab571 wrote https://forum.cloudron.io/post/107999 was simply a typo or first draft of that variable names.
Solution
Use the following variables in
/app/data/env
OIDC_USERNAME_FORCE=false OIDC_USERNAME_AS_EMAIL=false OIDC_USERNAME_AS_NAME=true
@james said in Email as default username since update to new config set-up is NOT great
:
But now when checking the /app/code/app/src/config.js
Also sorry, I feel I should know this by now, but where are the the app code directories? I can't seem to find them when I ssh on the server. In that case how can I would like to view the content of this file.
-
I can confirm this seems to have no impact.
Added the following lines to/app/data/env
OIDC_FORCE_USERNAME=false OIDC_EMAIL_AS_USERNAME=false OIDC_NAME_AS_USERNAME=true
Cloudron writes this to
/run/mirotalksfu/env
and/run/mirotalksfu/env
is symlinked to/app/code/.env
.
So everything in that/app/data/env
=>/run/mirotalksfu/env
=>/app/code/.env
is loaded, otherwise all the other settings would be missing.But now when checking the
/app/code/app/src/config.js
I see:peer_name: { force: process.env.OIDC_USERNAME_FORCE !== 'false', // Require identity provider authentication email: process.env.OIDC_USERNAME_AS_EMAIL !== 'false', // Request email claim name: process.env.OIDC_USERNAME_AS_NAME === 'true', // Don't require full name }
So from that I can conclude the env vars should be:
OIDC_USERNAME_FORCE=false OIDC_USERNAME_AS_EMAIL=false OIDC_USERNAME_AS_NAME=true
This now had the desired effect.
I assume what @mirotalk-57bab571 wrote https://forum.cloudron.io/post/107999 was simply a typo or first draft of that variable names.
Solution
Use the following variables in
/app/data/env
OIDC_USERNAME_FORCE=false OIDC_USERNAME_AS_EMAIL=false OIDC_USERNAME_AS_NAME=true
@james said in Email as default username since update to new config set-up is NOT great
:
I assume what @mirotalk-57bab571 wrote https://forum.cloudron.io/post/107999 was simply a typo or first draft of that variable names.
Yes, you're absolutely right β the way you explained it is correct. I actually updated it in my last commit to make it more readable.
OIDC_USERNAME_FORCE=false OIDC_USERNAME_AS_EMAIL=false OIDC_USERNAME_AS_NAME=true
And hereβs a quick explanation of each
default setup
:OIDC_USERNAME_FORCE=true # Forces the username to match the OIDC email or name. # If true, the user won't be able to change their name when joining a room. OIDC_USERNAME_AS_EMAIL=true # Uses the OIDC email as the username. OIDC_USERNAME_AS_NAME=false # Uses the OIDC name as the username.
These options give you full control over how usernames are assigned during OIDC authentication for the meeting.
Note
By default
, theemail
is used as theusername when OIDC is enabled
. This helpsmaintain user identity and trust
, and also ensures that the correct Gravatar is displayed in the room (especially if the camera is off).In this default setup, the username
cannot be edited
by the user when joining a room.However, since MiroTalk SFU is designed to be flexible, this behavior is fully configurable. You can choose whether to use the email, the name, or allow users to set their own name β depending on your needs...
-
@james said in Email as default username since update to new config set-up is NOT great
:
But now when checking the /app/code/app/src/config.js
Also sorry, I feel I should know this by now, but where are the the app code directories? I can't seem to find them when I ssh on the server. In that case how can I would like to view the content of this file.
@avatar1024 said in Email as default username since update to new config set-up is NOT great
:
Also sorry, I feel I should know this by now, but where are the the app code directories? I can't seem to find them when I ssh on the server. In that case how can I would like to view the content of this file.
That is in the app itself.
You can view that via the web terminal of the app itself. -
@avatar1024 said in Email as default username since update to new config set-up is NOT great
:
Also sorry, I feel I should know this by now, but where are the the app code directories? I can't seem to find them when I ssh on the server. In that case how can I would like to view the content of this file.
That is in the app itself.
You can view that via the web terminal of the app itself.@james said in Email as default username since update to new config set-up is NOT great
:
That is in the app itself.
You can view that via the web terminal of the app itself.Oh yes of course, thanks!
-
Is it possible on the forum for a user to mark a post as the solution / mark a topic as solved?
-
-
-
Is it possible on the forum for a user to mark a post as the solution / mark a topic as solved?
@avatar1024 said in Email as default username since update to new config set-up is NOT great
:
Is it possible on the forum for a user to mark a post as the solution / mark a topic as solved?
Yes. First you have to edit the OP to make it a question. Then you have to mark the solution post as the answer.
-
For info the variables have changed again since today's update to 1.7.58. It is now:
OIDC_FORCE_USERNAME=false # Force the username to match OIDC email or name (true|false) OIDC_EMAIL_AS_USERNAME=false # Set username as email from OIDC (true|false) OIDC_NAME_AS_USERNAME=true # Set username as name from OIDC (true|false)
-
For info the variables have changed again since today's update to 1.7.58. It is now:
OIDC_FORCE_USERNAME=false # Force the username to match OIDC email or name (true|false) OIDC_EMAIL_AS_USERNAME=false # Set username as email from OIDC (true|false) OIDC_NAME_AS_USERNAME=true # Set username as name from OIDC (true|false)
@avatar1024 said in Email as default username since update to new config set-up is NOT great
:
For info the variables have changed again since today's update to 1.7.58. It is now:
Oops, my mistake β it's been fixed in
v1.7.59
.OIDC_USERNAME_FORCE=false OIDC_USERNAME_AS_EMAIL=false OIDC_USERNAME_AS_NAME=true
-
Is this something which makes sense to include directly in the package or should be left to the user? Can't quite make out what the best default behavior would be
@nebulon said in Email as default username since update to new config set-up is NOT great
:
Is this something which makes sense to include directly in the package or should be left to the user? Can't quite make out what the best default behavior would be
To me it feels like these settings should indeed be included by default in the package. Reasons are:
- letting users choosing their display name for a meeting is always best, so
OIDC_FORCE_USERNAME=false
by default in the package seems like a no-brainer. - having your email as your username/display name in a meeting seems very weird (though if at least you can change it that's less of a problem > 1.)
- having your actual name as the default display name seems more logical (though still with the ability to change it > 1.)
What do other people think?
@MiroTalk said in Email as default username since update to new config set-up is NOT great
:
By default, the email is used as the username when OIDC is enabled. This helps maintain user identity and trust, and also ensures that the correct Gravatar is displayed in the room (especially if the camera is off).
Maintaining user identity and trust, and using the correct Gravatar should be dealt with differently by MiroTalk as using email as the username brings a very sub-optimal UX.
- letting users choosing their display name for a meeting is always best, so
-
Agree: false/false/true would be the best default but configurable in the env