TrueNAS Apps: TutorialsApplication maintenance is independent from TrueNAS version release cycles.
App versions, features, options, and installation behavior at time of access might vary from documented tutorials and UI reference.
MinIO Enterprise
15 minute read.
This article applies to the TrueNAS MinIO application in the enterprise train. This smaller version of MinIO is tested and polished for a safe and supportable experience for TrueNAS Enterprise customers. The enterprise MinIO application is tested and verified as an immutable target for Veeam Backup and Replication.
Community members can add and use the MinIO Enterprise app or the default community version.
Go to Apps, click on Configuration at the top of the Installed applications screen, and select Settings to open the train Settings screen.
You can also access the Installed scren from the Discover screen by clicking on Manage Installed Apps at the top of the screen.
Select enterprise to add it to the list of trains, and then click Save.
After changing train settings, return to the Discover screen and click Refresh Catalog.
To install the MinIO enterprise train app, do the following:
Create a self-signed certificate for the app. The Certificates setting is not required for a basic configuration but is required when setting up multi-mode configurations and when using MinIO as an immutable target for Veeam Backup and Replication.
Set a pool for applications to use if not already assigned.
(Optional) Create a new TrueNAS user to serve as the administrator for the app. You can use the default user or add a new user. When you create a new user select Create New Primary Group, and select the appropriate group in the Auxiliary Group for the type of user you want to create. Make note of the UID for the new user to add in the installation wizard.
Create the required dataset(s).
Go to Datasets and select the pool or dataset where you want to place the MinIO dataset. For example, /tank/apps/minio or /tank/minio. You can use either an existing pool or create a new one.
Create the data dataset(s) before beginning the app installation process. You can organize the dataset(s) under a parent dataset for MinIO to keep the storage datasets separated from the dataset for other potential applications. For example, create the minio dataset and nest data under it.
After creating the dataset, create the directory where MinIO stores information the application uses.
To create a directory, open the Linux CLI and enter
mkdir path="/path/to/directory"
or if you have a share created on your system with access to the dataset use it to create a directory.MinIO uses both the default /export and the /data mount points during storage configuration. The MinIO enterprise app creates the /export mount point for you but you must add this in the stable MinIO app. Create the /data mount point in both the enterprise and stable versions of the MinIO app.
If you want to also mount other storage volumes inside the container pod using the host path option, create the dataset(s) before using the app installation wizard.
If your system has active sharing configurations (SMB, NFS, iSCSI), disable them in System > Services before adding and configuring the MinIO application. Start any sharing services after MinIO completes the installation and starts.
This basic procedure covers the required MinIO enterprise app settings. For optional settings, see Understanding MinIO Wizard Settings.
You can have multiple deployments of the same app (for example, two or more from the stable or enterprise trains, or a combination of the stable and enterprise trains).
Each deployment of the same app requires a unique name. App names can include numbers, dashes, or underscores (for example, syncthing2, syncthing-test, syncthing_1, minio2, etc.).
Use a consistent file-naming convention to avoid conflict situations where data does not or cannot synchronize because of file name conflicts. Path and file names in apps are case-sensitive. For example, a file named MyData.txt is not the same as the mydata.txt file in Syncthing.
To install the Minio Enterprise app, go to Apps, click on Discover Apps and then either scroll down to locate the enterprise train version of the Minio widget, or search for it by typing MinIO in the search field to show the app widget.
Click on the MinIO Official Enterprise widget to open the MinIO information screen.
Click Install to open the Install MinIO configuration screen.
Accept the defaults in Application Name or enter a name for your MinIO application deployment.
Accept the default in Version, which populates with the current MinIO version. TrueNAS displays update information on the Installed application screen when an update becomes available.
If setting up a cluster configuration, see Multi-Mode Configuration below for more information on settings.
Scroll down to or click on Storage Configuration on the list of wizard sections.
Select the storage type you want to use.
To use an existing dataset, select Host Path (Path that already exists on the system) which is the recommended option for MinIO. Mount Path populates with the default /data1. Select Enable ACL to show the mount path and host path fields. Enter the path or browse to and click on the data1 dataset location to populate Host Path.
Click Add to the right of ACE Entries.
Set the ACE Entry user to the default user 568 or enter the UID for the user created in TrueNAS to serve as the MinIO app administrator, and set the permissions to FULL_CONTROL.
The following section provides more detailed explanations of the settings in each section of the Install MinIO configuration wizard.
Accept the default value or enter a name in Application Name field. In most cases use the default name, but if adding a second deployment of the application you must change this name.
Accept the default version number in Version. When a new version becomes available, the application shows an update badge and the Application Info widget on the Installed applications screen shows the Update button.
MinIO credentials establish the login credentials for the MinIO web portal and the MinIO administration user.
Enter existing MinIO credentials if you already have a MinIO account, or create new login credentials for the first time you log into MinIO. The Root User is the equivalent of the MinIO access key. The Root Password is the login password for that user or the MinIO secret key.
A username for the root user (MinIO access key), entered in Root User, is limited to five to 20 characters long. For example admin or admin1.
The root user password (MinIO secret key), entered in Root Password, is limited to eight to 40 random characters. For example, MySecr3tPa$$w0d4Min10.
To configure a multi-mode deployment, select Enabled. MinIO recommends using MNMD for enterprise-grade performance and scalability. See the related MinIO articles listed below for SNMD and MNMD configuration tutorials.
Select Quiet to disable startup information and not show it in the logs.
Select Anonymous to hide sensitive information and not show it in the logs.
(Optional) Click Add to the right of Additional Environment Variables to show the fields to enter the variable. The installation wizard configures all required environment variables, so only use this option to further customize your MinIO deployment. Refer to MinIO documentation for more information on environment variables they allow and use.
If creating a multi-disk (SNMD) or MNMD cluster, create four datasets, data1, data2, data3 and data4 on each system (node) in the cluster configuration.
Multi-mode installs the app in either a MinIO Single-Node Multi-Drive (SNMD) or Multi-Node Multi-Drive (MNMD) cluster. MinIO recommends using MNMD for enterprise-grade performance and scalability.
Click Enabled under Multi Mode (SNMD or MNMD) Configuration to enable multi-mode and show the Multi Mode (SNMD or MNMD) and Add option.
For more information see:
Some TrueNAS apps have predefined run-as user and group IDs. These assignments vary based on the app train and other variables such as installing but not running as the root user.
Default user and group IDs are:
- 473 for apps in the stable train.
- 568 for some community apps and all apps in the enterprise train
- 999 for postgres storage volumes
Accept the default user and group ID in the User and Group Configuration section or enter the user ID for a new TrueNAS user created to serve as the administrator for this app.
Create any app administrator user before installing the application, and take note of the UID. Enter this user ID when configuring the user for the app and as the user when setting up storage volume permissions.
Accept the default port numbers in API Port and Console Port (Web UI), which are the port numbers MinIO uses to communicate with the app and web portal.
Enter the system IP address in URL format followed by the port number for the API separated by a colon in Server URL. For example, https://10.123.12.123:30000.
Enter the system IP address in URL format followed by the port number for the web portal separated by a colon in Console URL. For example, https://10.123.12.123:30001.
MNMD MinIO installations require HTTPS for both Server URL and Console URL to verify the integrity of each node. Standard or SNMD MinIO installations do not require HTTPS.
Do not select Host Network.
MinIO does not require a certificate for a basic configuration and installation of MinIO Enterprise, but if installing and configuring multi-mode SNMD or MNMD, you must create a self-signed certificate.
A SNMD configuration can use the same self-signed certificate created for MNMD, but a MNMD configuration cannot use the certificate created for a SNMD configuration because that certificate only includes the IP address for one system. Create this same self-signed certificate for the MNMD cluster on each system (node) in the cluster!
To use a certificate, best practice is to create the self-signed certificate before you begin using the app installation wizard. If you did not create a certificate before starting the installation wizard you can select the default TrueNAS certificate and edit the certificate after deploying the application.
Select the certificate created in TrueNAS for the app from the Certificate dropdown list.
MinIO storage settings include the option to add storage volumes to use inside the container (pod). To allow TrueNAS to create a storage volume, leave Type set to the default ixVolume *(Dataset created automatically by the system). This adds a storage volume for the application that can be found nested under the hidden ix-apps dataset. To see this, create a recursive snapshot of the ix-apps dataset.
To use the data existing dataset, select Host Path (Path that already exists on the system) from the Type dropdown list. The Mount Path field populates with /data1 as the first storage volume for a basic installation. Enter the path or browse to select the data1 dataset and populate the Host Path field.
Click Add to the right of Data Directories to add the datasets created and representing drives in for multi-mode configurations. Click Add for each dataset (data1, data2, data3, and data4).
If configuring either MNMD or SNMD, you must all all four datasets to each system in the cluster. These datasets represent the disk in the multi-disk configurations.
Change the Mount Path to correspond to the dataset path entered or selected in Host Path. Additional mount points are /data2, /data3, or /data4.
You can select Enable ACL to modify dataset permissions and add ACL entries.
Select Enable ACL to show the ACL and ACE Entries options.
Enter or browse to select the dataset path.
Next click Add to the right of ACL Entries to show the permissions settings. Set ID Type to Entry is for a USER. Enter the UID as one of the following:
- The default apps user which is either 473 for apps in the stable train or 568 for apps in the enterprise or community train.
- The new user ID for the TrueNAS user created to serve as the app administrator.
If setting up postgres storage volumes, the default user id for these volumes is 999.
If there is run-as option defined in the wizard, enter this run-as UID when adding the user ACE entry. If not show in the UI, to find the run-as user ID, refer to the questions.yaml file in the GitHub repository for the application.
Select the permissions level from the Access dropdown list. Enter the UID for the app administration user, and set the level to FULL CONTROL.
Select Force to apply the ACL even if the path has existing data.
The TrueNAS MinIO app includes the option to mount an SMB share inside the container pod.
Accept the default values in Resources Configuration or enter new CPU and memory values. By default, this application is limited to use no more than 2 CPU cores and 4096 Megabytes available memory. The application might use considerably less system resources.
To customize the CPU and memory allocated to the container (pod) the app uses, enter new CPU values as a plain integer value (letter suffix is not required). The default is 4096.
Accept the default value 8 (Gb) allocated memory or enter a new limit in bytes. Enter a plain integer without the measurement suffix, for example, 129 not 129M or 123MiB.