View YAML from installed apps without turning them into custom apps

Feature Requests
,
1

Problem/Justification

Currently, TrueNAS SCALE does not provide a way for users to view the generated YAML configuration of installed apps from the Apps UI. This limits transparency and makes it difficult to troubleshoot issues or understand how app settings are applied in the backend.

For example, I was trying to configure OAuth2 credentials for n8n to integrate with Webflow, and it took me two days to figure out the correct port mappings and environment variables. Since I couldn’t access the YAML directly, I had to convert the app into a custom app, which introduced new challenges—like not knowing how to update it properly in the future. If YAML access had been available from the beginning, I could have avoided the extra work and delays.

Impact

Providing the ability to view the YAML configuration would help all TrueNAS users, especially those managing more advanced or customized apps, by:

  • Allowing them to understand how app settings (like ports, volumes, and environment variables) are structured and applied.
  • Simplifying troubleshooting, especially for integrations like OAuth2 or API-based apps.
  • Reducing the need for custom app conversions, which can create maintenance headaches.This feature would improve the overall user experience, confidence, and efficiency without introducing disadvantages—access would be optional and read-only.

User Story

As a TrueNAS user, I want to view the generated YAML configuration of an installed app directly from the Apps UI, so I can understand how my app settings are mapped and troubleshoot configuration issues effectively—without needing to convert apps into custom deployments.

For example:

  1. I go to the Apps UI and select an installed app.
  2. I click a “View YAML” button in the app details or actions menu.
  3. I see the full generated YAML configuration of the app, including port mappings, environment variables, and volumes.
  4. I use this information to adjust settings, troubleshoot issues like OAuth2 misconfigurations, or prepare for updates—without needing to rebuild the app as a custom deployment.
2

cat /mnt/.ix-apps/user_config.yaml

1 Like
3

That goes into the request I made here;:

4

One solution I tested, due to problems with what I thought might have been the Frigate ix-app, is to extract the docker compose file created by the ix-app and use it verbatim in ix-dockge. I tried it and it worked first time.

/mnt/.ix-apps/app_configs/frigate/<version>/templates/rendered/docker-compose.yaml

which I presume would work for other apps.

1 Like
5

Oh man, I’ve used up all my votes for now, but I’d like to vote for this one. Because I just torched a Home Assistant install by turning it into a custom app so I could look for an issue in the config YAML and it turned out that the feature I was hoping to turn on was already turned on. Doh. This feature request would have told me that before I did that.

1 Like