Register for the iXsystems Community to get an ad-free experience and exclusive discounts in our eBay Store.

HOWTO: Adding custom application repositories to SCALE 21.02 and beyond!

ornias

Neophyte Sage
Joined
Mar 6, 2020
Messages
1,016
1. Which storage pool I am targeting in the "dataset" field. I would assume it is the dataset which is selected for Apps.
You can't edit the field anyway and actually, thinking about it... it should even be hidden. As it's iX_volumes storage

2. Is it possible to select a dataset on another pool? Below is what my Plex config looks like, I am not sure how I would do this with the TrueChart version.
You select your storage pool for all docker data (including ix_volumes as explained in the wiki) when setting up the apps section in TrueNAS.
If you want different locations, you need to select hostPath as explained in the docs.

This is not the same page I found via search, interestingly enough. I’ll see if I replicate that and see if I can find this page as well.
Yeah, I recently combined both the wiki and the website. So there might be some weirdness here and there with caching. I'll tell cloudflare to trash the cache!


@StavrosMadK Lets forward people to the docs directory instead shall we, when it comes to the staging branch ;-)
 

StavrosMadK

Member
Joined
Dec 26, 2020
Messages
50
1615814505220.png

If you check the Enable Host Path you will presented with the same folder structure as on Plex you posted.
If you can select different pool on Plex you should be able too here also.
 

Nate W

Member
Joined
Jul 10, 2014
Messages
29
You can't edit the field anyway and actually, thinking about it... it should even be hidden. As it's iX_volumes storage


You select your storage pool for all docker data (including ix_volumes as explained in the wiki) when setting up the apps section in TrueNAS.
If you want different locations, you need to select hostPath as explained in the docs.


Yeah, I recently combined both the wiki and the website. So there might be some weirdness here and there with caching. I'll tell cloudflare to trash the cache!


@StavrosMadK Lets forward people to the docs directory instead shall we, when it comes to the staging branch ;-)
That all makes sense. hostPath is exactly what I wanted for the media mount, with the config data really being an implementation detail most people won’t care much about. I do agree if it cannot be changed, perhaps it should be hidden or locked to key the user in to that.

I’ll dig in to this after work today and give everything a go. Work getting in the way of fun and all that :D
 

ornias

Neophyte Sage
Joined
Mar 6, 2020
Messages
1,016
I do agree if it cannot be changed, perhaps it should be hidden or locked to key the user in to that.
The dataset name is already locked, but come my latest PR it's also hidden :)
Thanks for your feedback!
 

Nate W

Member
Joined
Jul 10, 2014
Messages
29
So far, every one I've tried has worked perfectly. Host Networking "just works".

For "Enable Web Reverse Proxy", is the intent that one must have a Traefik deployment up and then use that for the proxy? I also see "forward authentication url" which implies you could use middleware to handle auth. I'm curious what the setup you had in mind was for the Web Proxy.

Also, huge props for having LE in mind from the beginning :) This is going to blow jails out of the water.

This has greatly simplified doing k3os from scratch already. Great work.
 

ornias

Neophyte Sage
Joined
Mar 6, 2020
Messages
1,016
So far, every one I've tried has worked perfectly. Host Networking "just works".
Why use host networking? Only 2 or 3 of the Apps use or need it... The rest use just as fine with nodePort...


For "Enable Web Reverse Proxy", is the intent that one must have a Traefik deployment up and then use that for the proxy?
Yes, we just amended the docs to make that more clear.

I also see "forward authentication url" which implies you could use middleware to handle auth. I'm curious what the setup you had in mind was for the Web Proxy.
How do you mean "what setup"?
Just enter the URL you want to use for ForwardAuth and the middleware gets setup for you!

Also, huge props for having LE in mind from the beginning :) This is going to blow jails out of the water.
Keep in mind staging does drops cert-manager support. We are moving to native TrueNAS SCALE Certificates, which also include support for (at least, currently) 2 DNS-providers for setting up lets-encrypt.
A guide on how to set that feature up on TrueNAS SCALE is in the works and i'm complaining like a madman to iX on how unworkable their certificate UI is.
 

Nate W

Member
Joined
Jul 10, 2014
Messages
29
Why use host networking? Only 2 or 3 of the Apps use or need it... The rest use just as fine with nodePort...
The default was ClusterIP, which had no ingress that I saw (maybe I missed it). I'll give nodePort a try as well.

How do you mean "what setup"?
Just enter the URL you want to use for ForwardAuth and the middleware gets setup for you!
Maybe out of scope for the Wiki, but an example middleware setup that isn't foobarbaz would be super helpful for people to conceptualize how to use the middleware. I've seen it done with Docker + Traefik, but now sure how that maps to this setup.

Keep in mind staging does drops cert-manager support. We are moving to native TrueNAS SCALE Certificates, which also include support for (at least, currently) 2 DNS-providers for setting up lets-encrypt.
A guide on how to set that feature up on TrueNAS SCALE is in the works and i'm complaining like a madman to iX on how unworkable their certificate UI is.
Truly exciting times :)
 

ornias

Neophyte Sage
Joined
Mar 6, 2020
Messages
1,016
The default was ClusterIP, which had no ingress that I saw (maybe I missed it). I'll give nodePort a try as well.
Ingress is called "Reverse Proxy" because that's what most people understand.

(and you don't actually get any Ingress specific settings anyway, just basic Reverse Proxy questions and ingress gets setup by magic(tm))

Maybe out of scope for the Wiki, but an example middleware setup that isn't foobarbaz would be super helpful for people to conceptualize how to use the middleware. I've seen it done with Docker + Traefik, but now sure how that maps to this setup.
Thats not for me to explain, because every App that has this functionality (Authelia, Organizr etc) does this differently. But all give you a single link in the end and it's pretty clear where that link needs to go ;-)
 

Nate W

Member
Joined
Jul 10, 2014
Messages
29
As for the Web Proxy documents that got updated, which page was updated to show this? I found the following as well as the search on the main wiki as shown in attachments.


Also cut a PR for updating the FAQ link on the main readme.
 

Attachments

Nate W

Member
Joined
Jul 10, 2014
Messages
29
Also, should we discuss this on the github issue tracker as stuff comes up? What is your preference?
 

ornias

Neophyte Sage
Joined
Mar 6, 2020
Messages
1,016
As for the Web Proxy documents that got updated, which page was updated to show this? I found the following as well as the search on the main wiki as shown in attachments.
As both I and @StavrosMadK said before: All new content is on the staging branch, this includes documentation.
The staging branch is NOT released yet, hence is not part of the wiki (yet).


Also, should we discuss this on the github issue tracker as stuff comes up? What is your preference?
Interesting question...
I think currently making issues is rather useless, as Staging is in an active review phase and no issues about master are accepted.

This means if you have an issue on staging, it should be reported on the staging PR here (instead of an issue):

Sorry for all the confusion, but the staging PR is 30.000+ changes, so we need to be a bit strict to prevent huge mistakes and people putting double work in things that are already done ;-)
 

Nate W

Member
Joined
Jul 10, 2014
Messages
29
As both I and @StavrosMadK said before: All new content is on the staging branch, this includes documentation.
The staging branch is NOT released yet, hence is not part of the wiki (yet).



Interesting question...
I think currently making issues is rather useless, as Staging is in an active review phase and no issues about master are accepted.

This means if you have an issue on staging, it should be reported on the staging PR here (instead of an issue):

Sorry for all the confusion, but the staging PR is 30.000+ changes, so we need to be a bit strict to prevent huge mistakes and people putting double work in things that are already done ;-)
No worries. I didn't realize staging *included* the entire wiki itself. I'll go poke through staging and see what I can find. Thanks for your patience!
 

ornias

Neophyte Sage
Joined
Mar 6, 2020
Messages
1,016
No worries. I didn't realize staging *included* the entire wiki itself. I'll go poke through staging and see what I can find. Thanks for your patience!
We work as much mono-repo as is reasonably possible, so all documentation sits with the Apps themselves, so their respective maintainer have one folder to be king-of-the-castle for. :)
 

oumpa31

Member
Joined
Apr 7, 2015
Messages
137
@ornias did truecharts die on the nightly. i just went to check something after updateing it and nothing was there from the charts. on TrueNAS-SCALE-21.04-MASTER-20210413-112918
 

ornias

Neophyte Sage
Joined
Mar 6, 2020
Messages
1,016
@ornias did truecharts die on the nightly. i just went to check something after updateing it and nothing was there from the charts. on TrueNAS-SCALE-21.04-MASTER-20210413-112918
I think you missed recent anouncement and are on the wrong train or branch... Thats the most likely cause of what you describe.
 

ornias

Neophyte Sage
Joined
Mar 6, 2020
Messages
1,016
Note: The current description of the App on the TrueNAS Forum is outdated. I'll try to update it before 21.04.
 

oumpa31

Member
Joined
Apr 7, 2015
Messages
137
I think you missed recent anouncement and are on the wrong train or branch... Thats the most likely cause of what you describe.
I did miss that. But I found the newest version to do it. :smile:
Everything works so far. Looks like you guys have been busy adding stuff which is awesome.
 
Top