Beginner Apps question - app-specific documentation?

Thanks for any help in advance.
trying to figure out if there is any TrueNAS-specific documentation for apps found in the Discover catalog. (I’ve successfully installed several, but largely relied on forum posts or youtube for setup guides.)

most apps i’m looking at have links to GitHub, but documentation there is for the main github project itself. I’m not seeing anything in the way of tutorials/documentation for the trueNAS install settings for any of these apps.

The closest I could find was this, and it links back to this forum. I would have expected a page specific to submitting these apps to the discover catalog?

thanks in advance for any help!

I believe https://apps.truenas.com/ is pretty much brand new, so it will very likely improve with time.

As for documentation, there is some that can be found in the apps catalog. For example, for Plex:

I assume priority for creating / maintaining these will be based around popularity.

For the most part though apps are pretty simple to deploy considering the help tooltips often offer decent pointers. Are there any specific apps you had trouble with?

1 Like
2 Likes

As @essinghigh says, the Apps Market site is new and we’re hoping it gets more filled out with app-specific resources over time.

Since we’re a small team, we focus our documentation efforts on Enterprise apps and a few others. That’s why we’ve designed the site to make it easy for community members to share their knowledge and help grow app-specific content across the catalog.

Some resources, like the Plex deployment guide, are hosted directly on the site. In other cases we also welcome linking and/or embedding external resources, such as upstream project docs (see Immich | TrueNAS Apps Market), external blogs, community social posts from places like the forum or Reddit (see qBittorrent | TrueNAS Apps Market), or even embedded videos (see Syncthing (Stable) | TrueNAS Apps Market).

We have a Contributing to Apps | TrueNAS Apps Market guide for anyone who wants to submit docs on any individual app or add a resource card that links to existing content (for example, if someone like @dan maybe has any existing app guides to share :wink:).

You’ve probably already seen these since you’ve been to the site, but just in case: there are also general Getting Started with Apps | TrueNAS Apps Market and Managing Apps | TrueNAS Apps Market resources available.

2 Likes

@DjP-iX , @dan , @essinghigh thank you very much for the help.
useful stuff here.

@DjP-iX I think I might be confused on how the Apps catalog works, especially since the deprecation of TrueCharts (which I never used bc I only started using TrueNAS last year)

Wasn’t sure if just anyone can package an app in docker and submit it, if the IX team does both official and community packaging, or a mix. Looking through the apps page, it looks like they are divided up into ‘Trains’, and what i’m seeing are : stable, community, and enterprise. Will look through the links you’ve provided and that might help clarify.

@dan much appreciated! i’ll keep an eye on this Wiki going forward.

@essinghigh this tracks with what I’ve seen - some documentation right there, but most of it pointing to github pages. what motivated me to post this was trying to configure Ollama storage properly, and not knowing what the “additional storage” option did vs the default storage.

but when I installed wg-easy for VPN, it was very complex, and I relied on a guide from the old trueNAS forum, from a user who doesn’t appear to have migrated here.

You can, however the contribution process is a bit complex (see: the apps repo and it’s contributors guide).

On the other hand, you can also run whatever you want via standard docker compose yaml, so if it’s not available directly as an app there’s no problem whatsoever rolling your own.


I agree the help tooltip for additional storage could probably be improved upon, even if it’s just a link to documentation.

It is a wiki, so anyone can join and add or edit content (hint, hint). I’m not planning on comprehensive documentation of apps; it’s intended to be a beginner’s guide, so I’m hoping to cover the most-common apps, and probably some discussion of the value of using straight Compose vs. the prepackaged apps. But of course I’ll welcome any contributions.

I’m thinking the next app up will be Nextcloud, but it may be a while before I get to it.

1 Like