Usersecrets in Docker container don't work when USER app set

[penfold]

Description

In .net 7, we didn't need to use USER app in the docker file.

Using the mount documented mount: $(AppData)/Microsoft/UserSecrets:/root/.microsoft/usersecrets:ro

The secrets.json would load for local development debugging.

In .net 8, we add USER app.

Now, the secrets.json isn't loaded. When setting AddUserSecrets(optional: false) we see that get an exception:

System.IO.FileNotFoundException: 'The configuration file 'secrets.json' was not found and is not optional. The expected physical path was '/app/secrets.json'.'

at Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(Boolean reload)
at Microsoft.Extensions.Configuration.ConfigurationManager.AddSource(IConfigurationSource source)
at Microsoft.Extensions.Configuration.ConfigurationManager.Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(IConfigurationSource source)
at XXXXXX.Containers.Helpers.WebAppBuilderExtensions.ConfigureWebAppBuilder(WebApplicationBuilder builder, Boolean isInternal) in XXXXXXXX

If I comment out the USER app line in my docker file, then it loads correctly.

What do I need to set the linux mount path to for this to work? Or does this need a change in the PathHelper?

https://github.com/dotnet/runtime/blob/742039fd508eb451c0048527bf307125e9572b43/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/PathHelper.cs

Reproduction Steps

See above

Expected behavior

See above

Actual behavior

See above

Regression?

No response

Known Workarounds

No response

Configuration

No response

Other information

No response

Tagging subscribers to this area: @dotnet/area-extensions-configuration
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Description

In .net 7, we didn't need to use USER app in the docker file.

Using the mount documented mount: $(AppData)/Microsoft/UserSecrets:/root/.microsoft/usersecrets:ro

The secrets.json would load for local development debugging.

In .net 8, we add USER app.

Now, the documented above, the secrets.json isn't loaded. When setting AddUserSecrets(optional: false) we see that get an exception:

System.IO.FileNotFoundException: 'The configuration file 'secrets.json' was not found and is not optional. The expected physical path was '/app/secrets.json'.'

at Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(Boolean reload)
at Microsoft.Extensions.Configuration.ConfigurationManager.AddSource(IConfigurationSource source)
at Microsoft.Extensions.Configuration.ConfigurationManager.Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(IConfigurationSource source)
at XXXXXX.Containers.Helpers.WebAppBuilderExtensions.ConfigureWebAppBuilder(WebApplicationBuilder builder, Boolean isInternal) in XXXXXXXX

If I comment out the USER app line in my docker file, then it loads correctly.

What do I need to set the linux mount path to for this to work? Or does this need a change in the PathHelper?

https://github.com/dotnet/runtime/blob/742039fd508eb451c0048527bf307125e9572b43/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/PathHelper.cs

Reproduction Steps

See above

Expected behavior

See above

Actual behavior

See above

Regression?

No response

Known Workarounds

No response

Configuration

No response

Other information

No response

Author:	penfold
Assignees:	-
Labels:	untriaged, area-Extensions-Configuration
Milestone:	-

[penfold]

Extra details:

Developing on a Windows 11 PC using Visual Studio 17.8.5 with Docker Desktop using Linux containers.

Looking at the code from PathHelper.cs,

const string userSecretsFallbackDir = "DOTNET_USER_SECRETS_FALLBACK_DIR";
string? appData = Environment.GetEnvironmentVariable("APPDATA");
string? root = appData                                                                  
           ?? Environment.GetEnvironmentVariable("HOME")                             
           ?? Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData)
           ?? Environment.GetFolderPath(Environment.SpecialFolder.UserProfile)
           ?? Environment.GetEnvironmentVariable(userSecretsFallbackDir);

root is being set to /home/app from Environment.GetEnvironmentVariable("HOME")

So setting the mount to:

$(AppData)/Microsoft/UserSecrets:/home/app/.microsoft/usersecrets:ro

Has worked.

Tagging subscribers to this area: @dotnet/area-system-runtime
See info in area-owners.md if you want to be subscribed.

Issue Details

---

Description

In .net 7, we didn't need to use USER app in the docker file.

Using the mount documented mount: $(AppData)/Microsoft/UserSecrets:/root/.microsoft/usersecrets:ro

The secrets.json would load for local development debugging.

In .net 8, we add USER app.

Now, the secrets.json isn't loaded. When setting AddUserSecrets(optional: false) we see that get an exception:

System.IO.FileNotFoundException: 'The configuration file 'secrets.json' was not found and is not optional. The expected physical path was '/app/secrets.json'.'

at Microsoft.Extensions.Configuration.FileConfigurationProvider.Load(Boolean reload)
at Microsoft.Extensions.Configuration.ConfigurationManager.AddSource(IConfigurationSource source)
at Microsoft.Extensions.Configuration.ConfigurationManager.Microsoft.Extensions.Configuration.IConfigurationBuilder.Add(IConfigurationSource source)
at XXXXXX.Containers.Helpers.WebAppBuilderExtensions.ConfigureWebAppBuilder(WebApplicationBuilder builder, Boolean isInternal) in XXXXXXXX

If I comment out the USER app line in my docker file, then it loads correctly.

What do I need to set the linux mount path to for this to work? Or does this need a change in the PathHelper?

https://github.com/dotnet/runtime/blob/742039fd508eb451c0048527bf307125e9572b43/src/libraries/Microsoft.Extensions.Configuration.UserSecrets/src/PathHelper.cs

Reproduction Steps

See above

Expected behavior

See above

Actual behavior

See above

Regression?

No response

Known Workarounds

No response

Configuration

No response

Other information

No response

Author:	penfold
Assignees:	-
Labels:	area-System.Runtime, untriaged
Milestone:	-

[tarekgh]

@penfold do you still need any help here? or we close it?

This issue has been marked needs-author-action and may be missing some important information.

[penfold]

@tarekgh It would be good if this was documented somewhere other than here. Otherwise, I'm happy for you to close the issue.

Thanks, Paul

[tarekgh]

@penfold what exactly the documentation want to see? Do you mean having every docker container document the value of the root? or the environment variable HOME value? By the way, what is the docker image you were using in your case?

CC @richlander

[mplogas]

I stumbled upon this after struggling to build my container under Fedora 40. What is the recommended course of action? Commenting out the User app declaration in the Docker file?