- Joined
- Nov 12, 2015
- Messages
- 1,471
SCALE Fans,
Just in time for the upcoming TrueNAS SCALE 21.02 release, support for multiple Catalog repositories has landed. This allows app developers to easily build, test and ship new 3rd party applications for SCALE. In order to help folks get started, I'll be writing down some of the steps you can take here, and eventually we'll turn this into a full-fledged article on the docs site.
To get started, you'll want to fork our official iX Catalog repository to some new location, as I did to my personal repo.
Next you'll want to create a chart which can be used to install your application. Checkout the catalog README for more information on how TrueNAS uses Helm charts + some additional files to function in a fully UI-driven environment such as TrueNAS SCALE.
In this example, I created a new chart for IPFS, mostly for my own amusement and to experiment with the helm chart creation process.
With the new chart pushed to my local repository, we can now proceed to adding this repository to TrueNAS. For this we'll go ahead and use the snazzy new CLI which just recently landed in SCALE nightly images as well.
In the example above, you can see that adding a new repository is just a one-liner in the CLI. Replace my URL and label with your own of course.
After the CLI command finished, I went ahead and brought up the Apps page of the UI, and sure enough, my new IPFS application was listed and ready for installation.
As you can see, apart from the time spent creating the chart, adding a new repository of applications was pretty quick and straightforward. Before anybody asks, yes we intend to add a GUI method to do this as well, which will land in the near future. As always we really do appreciate testers and their feedback in this process. Very much looking forward to seeing what applications others come up with.
Just in time for the upcoming TrueNAS SCALE 21.02 release, support for multiple Catalog repositories has landed. This allows app developers to easily build, test and ship new 3rd party applications for SCALE. In order to help folks get started, I'll be writing down some of the steps you can take here, and eventually we'll turn this into a full-fledged article on the docs site.
To get started, you'll want to fork our official iX Catalog repository to some new location, as I did to my personal repo.
Next you'll want to create a chart which can be used to install your application. Checkout the catalog README for more information on how TrueNAS uses Helm charts + some additional files to function in a fully UI-driven environment such as TrueNAS SCALE.
In this example, I created a new chart for IPFS, mostly for my own amusement and to experiment with the helm chart creation process.
With the new chart pushed to my local repository, we can now proceed to adding this repository to TrueNAS. For this we'll go ahead and use the snazzy new CLI which just recently landed in SCALE nightly images as well.
In the example above, you can see that adding a new repository is just a one-liner in the CLI. Replace my URL and label with your own of course.
After the CLI command finished, I went ahead and brought up the Apps page of the UI, and sure enough, my new IPFS application was listed and ready for installation.
As you can see, apart from the time spent creating the chart, adding a new repository of applications was pretty quick and straightforward. Before anybody asks, yes we intend to add a GUI method to do this as well, which will land in the near future. As always we really do appreciate testers and their feedback in this process. Very much looking forward to seeing what applications others come up with.