(408) 943-4100               V   Commercial Support Toggle between Light and Dark mode

Using SCALE Catalogs

  2 minute read.

Last Modified 2021-07-02 09:02 EDT

TrueNAS SCALE comes with a pre-built official catalog of iXsystems-approved Docker apps that includes Plex, MinIO, Nextcloud, Chia, and IPFS.

Users can also configure custom apps catalogs, although iXsystems will not directly support any non-official apps in a custom catalog.

Manage Catalogs

To manage and add catalogs, click the Manage Catalogs tab in the Applications screen.

AppsCatalog

Users can edit, refresh, delete, and view the summary of a catalog by clicking the button next to the intended catalog.

Edit: The edit option allows users to respecify the name TrueNAS will use to look up the catalog, as well as the trains from which UI should retrieve available applications for the catalog.

EditCatalogSCALE

Refresh: The Refresh option re-pulls the catalog from its repository and applies any updates.

Delete: The Delete option allows users to remove a catalog from the system. Users cannot delete the default Official catalog.

Summary: The Summary option lists all of the apps in the catalog and sorts them Train, App, and Version.

Users may filter the list by Train type (All, charts, or test), and by Status (All, Healthy, or Unhealthy).

CatalogSummarySCALE

Adding Catalogs

To add a catalog, click the Add Catalog button in the Manage Catalogs tab and fill out the form. As an example, fill out the form using the data below to add the Truecharts catalog to SCALE.

FieldDescriptionTruecharts
Catalog NameThe name the TrueNAS will use to look up the catalog.truecharts
Force CreateSet to add the catalog to the system even if some trains are unhealthy.Unchecked
RepositoryThe valid git repository URL.https://github.com/truecharts/catalog
Preferred TrainsThe trains TrueNAS will use to retrieve available applications for the catalog.stable (and optionally: incubator)
BranchThe git repository branch TrueNAS will use for the catalog.main

Displaying Catalogs

Users can select which catalogs they want to view in the Available Applications tab by clicking the Catalogs drop-down menu and checking the catalogs they want to see.

SelectCatalogsSCALE