TrueNAS SCALETrueNAS SCALE Nightly Development Documentation
This content follows experimental early release software. Use the Product and Version selectors above to view content specific to a stable software release.

Using SCALE Catalogs

TrueNAS SCALE comes with a pre-built official catalog of over 50 available iXsystems-approved applications.

Users can configure custom apps catalogs if they choose, but iXsystems does not directly support non-official apps in a custom catalog.

TrueNAS uses outbound ports 80/443 to retrieve the TRUENAS catalog.

Managing Catalogs

Users can manage the catalog from the Catalogs screen. Click Manage Catalogs at the top right side of the Discover screen to open the Catalogs screen.

Applications Discover Screen
Figure 1: Applications Discover Screen

Users can edit, refresh, delete, and view the catalog summary by clicking on a catalog to expand and show the options.

Edit opens the Edit Catalog screen where users can change the name SCALE uses to look up a catalog, add other trains to the catalog, or change the trains from which the UI retrieves available applications for the catalog.

Apps Edit Catalog Screen
Figure 2: Apps Edit Catalog Screen

Refresh pulls the catalog from its repository and refreshes it by applying any updates.

Delete allows users to remove a catalog from the system. Users cannot delete the default TRUENAS catalog.

Summary lists all apps in the catalog and sorts them by train, app, and version.

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

Adding Catalogs

To add a catalog, click Add Catalog at the top right of the Catalogs screen.

A warning dialog opens.

Add Catalog Warning
Figure 3: Add Catalog Warning

Click Continue to open the Add Catalog screen.

Apps Add Catalog Screen
Figure 4: Apps Add Catalog Screen

Fill out the Add Catalog form.

Enter a name in Catalog Name, for example, type mycatalog.

We do not recommend enabling Force Create, since it overrides safety mechanisms that prevent adding a catalog to the system even if some trains are unhealthy.

Select a valid GitHub repository in Repository. For example,

Type the name of the train TrueNAS should use to retrieve available application information from the catalog.

Finally, enter the GitHub repository branch TrueNAS should use for the catalog in Branch. Leave this set to main unless you need to change it.

Click Save.

Adding the Enterprise Train

Go to Apps and click on Discover Apps.

Click on Manage Catalogs at the top of the Discover screen to open the Catalog screen.

Click on the TRUENAS catalog to expand it, then click Edit to open the Edit Catalog screen.

Click in the Preferred Trains field, click on enterprise to add it to the list of trains, and then click Save.