From 40a8ec4c9649c856db8fc65a539801f54fd48405 Mon Sep 17 00:00:00 2001 From: MicJ <92740932+micjohnson777@users.noreply.github.com> Date: Mon, 2 Dec 2024 09:57:16 -0500 Subject: [PATCH] PD-1555 / 25.04 / PD-1555 Rename App Snippets and Updates (#3280) * PD-1555 Rename App Snippets and Updates This commit renames app Install Wizard snippets and modifies the paths in app articles. It also modifies the content in a few snippets. * Update InstallWizardSettingsOverview.md * Update SyncthingStable.md --------- Co-authored-by: tonyriv3 <75626853+tonyriv3@users.noreply.github.com> --- content/TruenasApps/CommunityApps/Chia.md | 2 +- content/TruenasApps/CommunityApps/Immich.md | 2 +- content/TruenasApps/CommunityApps/_index.md | 2 +- .../TruenasApps/CommunityApps/ddns-updater.md | 2 +- content/TruenasApps/CommunityApps/jellyfin.md | 2 +- .../MinIO/ConfigMinioEnterpriseMNMD.md | 10 +++---- .../MinIO/ConfigMinioEnterpriseSNMD.md | 10 +++---- .../EnterpriseApps/MinIO/_index.md | 16 +++++----- .../TruenasApps/EnterpriseApps/Syncthing.md | 12 ++++---- content/TruenasApps/EnterpriseApps/_index.md | 2 +- .../StableApps/InstallNetdataApp.md | 2 +- .../StableApps/InstallNextCloudMedia.md | 26 ++++++++--------- .../StableApps/InstallWGEasyApp.md | 2 +- .../StableApps/MinIOApp/MinIOClustering.md | 2 +- .../TruenasApps/StableApps/MinIOApp/_index.md | 12 ++++---- content/TruenasApps/StableApps/PlexApp.md | 22 +++++++------- .../TruenasApps/StableApps/PrometheusApp.md | 2 +- .../TruenasApps/StableApps/SyncthingStable.md | 14 ++++----- content/TruenasApps/StableApps/_index.md | 2 +- content/TruenasApps/_index.md | 2 +- ...Certificate.md => AddingAppCertificate.md} | 0 static/includes/apps/AppUserAndGroupConfig.md | 4 --- ....md => BeforeYouBeginAddAppCertificate.md} | 0 ...User.md => BeforeYouBeginAddNewAppUser.md} | 0 ...gin.md => BeforeYouBeginEnterpriseApps.md} | 0 ...ouBegin.md => BeforeYouBeginStableApps.md} | 0 ...md => InstallWizardAdvancedDNSSettings.md} | 0 ...n.md => InstallWizardAppNameAndVersion.md} | 0 ...md => InstallWizardCertificateSettings.md} | 0 ...tPorts.md => InstallWizardDefaultPorts.md} | 0 ... InstallWizardEnvironVariablesSettings.md} | 0 ...ough.md => InstallWizardGPUPassthrough.md} | 0 ...md => InstallWizardHostNetworkSettings.md} | 0 ...nfig.md => InstallWizardResourceConfig.md} | 0 ...gs.md => InstallWizardSettingsOverview.md} | 29 ++++++++++++------- ...on.md => InstallWizardStorageACLConfig.md} | 14 +++++---- ...on.md => InstallWizardStorageSMBOption.md} | 0 ... InstallWizardStorageTemporaryAndTmpfs.md} | 0 ...ing.md => InstallWizardTimezoneSetting.md} | 0 ....md => InstallWizardUserAndGroupConfig.md} | 0 ...ng.md => MultipleAppInstancesAndNaming.md} | 0 41 files changed, 101 insertions(+), 92 deletions(-) rename static/includes/apps/{AddAppCertificate.md => AddingAppCertificate.md} (100%) delete mode 100644 static/includes/apps/AppUserAndGroupConfig.md rename static/includes/apps/{AppsBeforeYouBeginCertificate.md => BeforeYouBeginAddAppCertificate.md} (100%) rename static/includes/apps/{AppBeforeYouBeginNewUser.md => BeforeYouBeginAddNewAppUser.md} (100%) rename static/includes/apps/{AppsEnterprieseBeforeYouBegin.md => BeforeYouBeginEnterpriseApps.md} (100%) rename static/includes/apps/{AppsStableBeforeYouBegin.md => BeforeYouBeginStableApps.md} (100%) rename static/includes/apps/{AppInstallWizardAdvancedDNSSettings.md => InstallWizardAdvancedDNSSettings.md} (100%) rename static/includes/apps/{AppsWizardAppNameAndVersion.md => InstallWizardAppNameAndVersion.md} (100%) rename static/includes/apps/{AppInstallWizardCertificateSettings.md => InstallWizardCertificateSettings.md} (100%) rename static/includes/apps/{AppsInstallWizardDefaultPorts.md => InstallWizardDefaultPorts.md} (100%) rename static/includes/apps/{AppInstallWizardEnvironVariablesSettings.md => InstallWizardEnvironVariablesSettings.md} (100%) rename static/includes/apps/{AppsInstallWizardGPUPassthrough.md => InstallWizardGPUPassthrough.md} (100%) rename static/includes/apps/{AppInstallWizardNetworkConfig.md => InstallWizardHostNetworkSettings.md} (100%) rename static/includes/apps/{AppInstallWizardResourceConfig.md => InstallWizardResourceConfig.md} (100%) rename static/includes/apps/{AppsInstallWizardSettings.md => InstallWizardSettingsOverview.md} (77%) rename static/includes/apps/{AppInstallWizardACLConfiguration.md => InstallWizardStorageACLConfig.md} (68%) rename static/includes/apps/{AppWizardStorageSMBOption.md => InstallWizardStorageSMBOption.md} (100%) rename static/includes/apps/{AppInstallWizardTemporaryAndTmpfsDirectories.md => InstallWizardStorageTemporaryAndTmpfs.md} (100%) rename static/includes/apps/{AppsInstallWizardTimezoneSetting.md => InstallWizardTimezoneSetting.md} (100%) rename static/includes/apps/{AppInstallWizardUserAndGroupConfig.md => InstallWizardUserAndGroupConfig.md} (100%) rename static/includes/apps/{AddMultipleAppInstancesAndNaming.md => MultipleAppInstancesAndNaming.md} (100%) diff --git a/content/TruenasApps/CommunityApps/Chia.md b/content/TruenasApps/CommunityApps/Chia.md index ac7170eb48..ca6e8c8eb9 100644 --- a/content/TruenasApps/CommunityApps/Chia.md +++ b/content/TruenasApps/CommunityApps/Chia.md @@ -175,7 +175,7 @@ The following sections provide more details on the settings found in each sectio ### Application Name Settings -{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}} ### Chia Configuration The **Chia Configuration** section includes four settings: **Timezone**, **Chia Service Node**, **Full Node Peer**, and **Additional Environments**. diff --git a/content/TruenasApps/CommunityApps/Immich.md b/content/TruenasApps/CommunityApps/Immich.md index b2229600d9..bc0f06cb4f 100644 --- a/content/TruenasApps/CommunityApps/Immich.md +++ b/content/TruenasApps/CommunityApps/Immich.md @@ -99,7 +99,7 @@ The following sections provide more detailed explanations of the settings found ### Application Name Settings -{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}} ### Immich Configuration Settings diff --git a/content/TruenasApps/CommunityApps/_index.md b/content/TruenasApps/CommunityApps/_index.md index 27761c9a83..04201b6442 100644 --- a/content/TruenasApps/CommunityApps/_index.md +++ b/content/TruenasApps/CommunityApps/_index.md @@ -39,7 +39,7 @@ Some apps in this section replace deprecated services or functionality previousl ## Understanding App Install Wizard Settings -{{< include file="/static/includes/apps/AppsInstallWizardSettings.md" >}} +{{< include file="/static/includes/apps/InstallWizardSettingsOverview.md" >}}
diff --git a/content/TruenasApps/CommunityApps/ddns-updater.md b/content/TruenasApps/CommunityApps/ddns-updater.md index 7e52a6632f..1b94baebfb 100644 --- a/content/TruenasApps/CommunityApps/ddns-updater.md +++ b/content/TruenasApps/CommunityApps/ddns-updater.md @@ -97,7 +97,7 @@ Find specific fields or skip to a particular section with the navigation box in ### Application Name -{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}} ### DDNS Updater Configuration diff --git a/content/TruenasApps/CommunityApps/jellyfin.md b/content/TruenasApps/CommunityApps/jellyfin.md index d1630cc8cf..ce853c2d9e 100644 --- a/content/TruenasApps/CommunityApps/jellyfin.md +++ b/content/TruenasApps/CommunityApps/jellyfin.md @@ -116,7 +116,7 @@ The following sections provide more detailed explanations of the settings found ### Application Name Settings -{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}} ### Jellyfin Configuration Settings diff --git a/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseMNMD.md b/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseMNMD.md index 8ae667b3cd..b2efc95ea6 100644 --- a/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseMNMD.md +++ b/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseMNMD.md @@ -34,7 +34,7 @@ Community members can add and use the MinIO Enterprise app or the default commun ## Before You Begin To install the MinIO **enterprise** train app, do the following: -{{< include file="/static/includes/apps/AppsEnterprieseBeforeYouBegin.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginEnterpriseApps.md" >}} {{< include file="/static/includes/MinIOEnterpriseMultiModeBeforeYouBegin.md" >}} @@ -48,7 +48,7 @@ This basic procedure covers the required MinIO enterprise app settings. For optional settings, see [Understanding MinIO Wizard Settings](#understanding-minio-wizard-settings). {{< /hint >}} -{{< include file="/static/includes/apps/AddMultipleAppInstancesAndNaming.md" >}} +{{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}} {{< include file="/static/includes/apps/MinIoEnterpriseConfig1.md" >}} @@ -101,7 +101,7 @@ The following section provides more detailed explanations of the settings in eac ### Application Name Settings -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} ### MinIO Configuration Settings @@ -115,7 +115,7 @@ Click **Enabled** under **Multi Mode (SNMD or MNMD) Configuration** to enable mu ### User and Group Configuration -{{< include file="/static/includes/apps/AppUserAndGroupConfig.md" >}} +{{< include file="/static/includes/apps/InstallWizardUserAndGroupConfig.md" >}} ### Network Configuration @@ -135,7 +135,7 @@ Specify the default user UID **568** or the UID for the new user created in True {{< trueimage src="/images/SCALE/Apps/InstallMinIOEnterpriseData1ACLandACESettings.png" alt="MinIO Enterprise ACL and ACE Settings" id="MinIO Enterprise ACL and ACE Setting" >}} -{{< include file="/static/includes/apps/AppInstallWizardACLConfiguration.md" >}} +{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}} Set ACL permissions for each dataset in the configuration, and on each system in the cluster. diff --git a/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseSNMD.md b/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseSNMD.md index 72c8c17c36..125eb1c5f8 100644 --- a/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseSNMD.md +++ b/content/TruenasApps/EnterpriseApps/MinIO/ConfigMinioEnterpriseSNMD.md @@ -32,7 +32,7 @@ Community members can add and use the MinIO Enterprise app or the default commun ## Before You Begin To install the MinIO **enterprise** train app, do the following: -{{< include file="/static/includes/apps/AppsEnterprieseBeforeYouBegin.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginEnterpriseApps.md" >}} {{< include file="/static/includes/MinIOEnterpriseMultiModeBeforeYouBegin.md" >}} @@ -46,7 +46,7 @@ This basic procedure covers the required MinIO enterprise app settings. For optional settings, see [Understanding MinIO Wizard Settings](#understanding-minio-wizard-settings). {{< /hint >}} -{{< include file="/static/includes/apps/AddMultipleAppInstancesAndNaming.md" >}} +{{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}} {{< include file="/static/includes/apps/MinIoEnterpriseConfig1.md" >}} @@ -87,7 +87,7 @@ The following section provides more detailed explanations of the settings in eac ### Application Name Settings -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} ### MinIO Configuration Settings @@ -101,7 +101,7 @@ Click **Enabled** under **Multi Mode (SNMD or MNMD) Configuration** to enable mu ### User and Group Configuration -{{< include file="/static/includes/apps/AppUserAndGroupConfig.md" >}} +{{< include file="/static/includes/apps/InstallWizardUserAndGroupConfig.md" >}} ### Network Configuration @@ -121,7 +121,7 @@ Specify the default user UID **568** or the UID for the new user created in True {{< trueimage src="/images/SCALE/Apps/InstallMinIOEnterpriseData1ACLandACESettings.png" alt="MinIO Enterprise ACL and ACE Settings" id="MinIO Enterprise ACL and ACE Setting" >}} -{{< include file="/static/includes/apps/AppInstallWizardACLConfiguration.md" >}} +{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}} Set ACL permissions for each dataset in the configuration. diff --git a/content/TruenasApps/EnterpriseApps/MinIO/_index.md b/content/TruenasApps/EnterpriseApps/MinIO/_index.md index 31182ff00c..2da75965e5 100644 --- a/content/TruenasApps/EnterpriseApps/MinIO/_index.md +++ b/content/TruenasApps/EnterpriseApps/MinIO/_index.md @@ -30,7 +30,7 @@ Community members can add and use the MinIO Enterprise app or the default commun ## Before You Begin To install the MinIO **enterprise** train app, do the following: -{{< include file="/static/includes/apps/AppsEnterprieseBeforeYouBegin.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginEnterpriseApps.md" >}} {{< include file="/static/includes/apps/MinIODatasetRequirements.md" >}} @@ -43,7 +43,7 @@ This basic procedure covers the required MinIO enterprise app settings. For optional settings, see [Understanding MinIO Wizard Settings](#understanding-minio-wizard-settings). {{< /hint >}} -{{< include file="/static/includes/apps/AddMultipleAppInstancesAndNaming.md" >}} +{{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}} {{< include file="/static/includes/apps/MinIoEnterpriseConfig1.md" >}} @@ -77,7 +77,7 @@ The following section provides more detailed explanations of the settings in eac ### Application Name Settings -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} ### MinIO Configuration Settings @@ -99,13 +99,13 @@ For more information see: ### User and Group Configuration -{{< include file="/static/includes/apps/AppInstallWizardUserAndGroupConfig.md" >}} +{{< include file="/static/includes/apps/InstallWizardUserAndGroupConfig.md" >}} ### Network Configuration {{< include file="/static/includes/apps/MinIOEnterpriseNetworkConfig.md" >}} -{{< include file="/static/includes/apps/AppInstallWizardCertificateSettings.md" >}} +{{< include file="/static/includes/apps/InstallWizardCertificateSettings.md" >}} ### Storage Configuration @@ -115,19 +115,19 @@ For more information see: {{< trueimage src="/images/SCALE/Apps/InstallMinIOEnterpriseData1ACLandACESettings.png" alt="Home and Data1 Host Path ACL and ACE Settings" id="Home and Data1 Host Path ACL and ACE Settings" >}} -{{< include file="/static/includes/apps/AppInstallWizardACLConfiguration.md" >}} +{{< include file="/static/includes/InstallWizardStorageACLConfig.md" >}} #### Mounting an SMB Share The TrueNAS MinIO app includes the option to mount an SMB share inside the container pod. -{{< include file="/static/includes/AppWizardStorageSMBOption.md" >}} +{{< include file="/static/includes/InstallWizardStorageSMBOption.md" >}} ### Resource Configuration {{< trueimage src="/images/SCALE/Apps/InstallMinIOEnterpriseResourcesConfig.png" alt="MinIO Enterprise Resource Limits" id="MinIO Enterprise Resource Limits" >}} -{{< include file="/static/includes/apps/AppInstallWizardResourceConfig.md" >}} +{{< include file="/static/includes/apps/InstallWizardResourceConfig.md" >}}
diff --git a/content/TruenasApps/EnterpriseApps/Syncthing.md b/content/TruenasApps/EnterpriseApps/Syncthing.md index 0387503555..b94b1bcf38 100644 --- a/content/TruenasApps/EnterpriseApps/Syncthing.md +++ b/content/TruenasApps/EnterpriseApps/Syncthing.md @@ -35,7 +35,7 @@ Community users can access enterprise versions of apps by adding the **enterpris Before launching the app installation wizard, do the following: * Create a self-signed certificate for the Syncthing enterprise app. - {{< include file="/static/includes/apps/AddAppCertificate.md" >}} + {{< include file="/static/includes/apps/AddingAppCertificate.md" >}} * Create the required datasets, **home** and **data1**. @@ -49,11 +49,11 @@ Before launching the app installation wizard, do the following: {{< trueimage src="/images/SCALE/Apps/InstallSyncthingEnterpriseScreen.png" alt="Install Syncthing Enterprise Screen" id="Install Syncthing Enterprise Screen" >}} -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} Next, enter the **Syncthing Configuration** settings. -{{< include file="/static/includes/apps/AppsInstallWizardTimezoneSetting.md" >}} +{{< include file="/static/includes/apps/InstallWizardTimezoneSetting.md" >}} Accept the default user and group IDs or enter the UID for any new TrueNAS user created to serve as the administrator for this app. See [User and Group Settings](#user-and-group-settings) below for more information. @@ -94,10 +94,10 @@ The following sections provide detailed explanations of the settings found in ea ### Application Name Settings -{{< include file="/static/includes/Apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/Apps/InstallWizardAppNameAndVersion.md" >}} ### Configuration Setting -{{< include file="/static/includes/apps/AppsInstallWizardTimezoneSetting.md" >}} +{{< include file="/static/includes/apps/InstallWizardTimezoneSetting.md" >}} {{< include file="/static/includes/apps/AppInstallWizardEnvironVariablesSettings.md" >}} @@ -133,7 +133,7 @@ Selecting **Migrate Data** forces a read-only mount regardless of the **Read Onl The SMB mount options are set to **vers=3.0**, **cifsacl**, and **noperm**. ACL preservation is not guaranteed if in a non-AD environment, or if the ACL or remote server contains local users. -{{< include file="/static/includes/apps/AppWizardStorageSMBOption.md" >}} +{{< include file="/static/includes/apps/InstallWizardStorageSMBOption.md" >}} ### Resource Configuration Settings diff --git a/content/TruenasApps/EnterpriseApps/_index.md b/content/TruenasApps/EnterpriseApps/_index.md index fff05fb2d4..c418338ebe 100644 --- a/content/TruenasApps/EnterpriseApps/_index.md +++ b/content/TruenasApps/EnterpriseApps/_index.md @@ -31,7 +31,7 @@ For more information on configuring general application functions and installati ## Understanding App Install Wizard Settings -{{< include file="/static/includes/apps/AppsInstallWizardSettings.md" >}} +{{< include file="/static/includes/apps/InstallWizardSettingsOverview.md" >}} For information on adding to or changing the train for the apps catalog, see [Managing App Trains]({{< relref "UsingTrains.md" >}}). diff --git a/content/TruenasApps/StableApps/InstallNetdataApp.md b/content/TruenasApps/StableApps/InstallNetdataApp.md index d2ac91145d..cf91ba59cf 100644 --- a/content/TruenasApps/StableApps/InstallNetdataApp.md +++ b/content/TruenasApps/StableApps/InstallNetdataApp.md @@ -84,7 +84,7 @@ The following sections provide more detail explanations of the settings found in ### Application Name Settings -{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}} ### Netdata Configuration Settings You can accept the defaults in the **Netdata Configuration** settings or enter the settings you want to use. diff --git a/content/TruenasApps/StableApps/InstallNextCloudMedia.md b/content/TruenasApps/StableApps/InstallNextCloudMedia.md index d4c4708164..e74b57160b 100644 --- a/content/TruenasApps/StableApps/InstallNextCloudMedia.md +++ b/content/TruenasApps/StableApps/InstallNextCloudMedia.md @@ -26,9 +26,9 @@ The instructions in this article apply to TrueNAS 22.10.0 and later. ## Before You Begin Before you install the Nextcloud app: -{{< include file="/static/includes/apps/AppsStableBeforeYouBegin.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginStableApps.md" >}} -{{< include file="/static/includes/apps/AppsBeforeYouBeginCertificate.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginAddAppCertificate.md" >}}

Adding a certificate is optional but if you want to use a certificate for this application, either create a new self-signed CA and certificate or import an existing CA and create the certificate for Nextcloud. A certificate is not required to deploy the application.

@@ -75,7 +75,7 @@ Before you install the Nextcloud app: {{< /expand >}} -{{< include file="/static/includes/apps/AppBeforeYouBeginNewUser.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginAddNewAppUser.md" >}} * Set up a Nextcloud account. If you have an existing Nextcloud account, you enter the credentials for that users in the installation wizard. @@ -87,13 +87,13 @@ This basic procedure covers the required Nextcloud app settings. For optional settings, see [Understanding App Installation Wizard Settings](#understanding-app-installation-wizard-settings). {{< /hint >}} -{{< include file="/static/includes/apps/AddMultipleAppInstancesAndNaming.md" >}} +{{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}} {{< include file="/static/includes/apps/LocateAndOpenInstallWizard.md" >}} {{< trueimage src="/images/SCALE/Apps/InstallNextcloudScreen.png" alt="Install Nextcloud Screen" id="Install Nextcloud Screen" >}} -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} Next, enter the **Nextcloud Configuration** settings. {{< expand "Entering Nextcloud Configuration Settings" "v" >}} @@ -174,7 +174,7 @@ The following section provides more detailed explanations of the settings in eac ### Application Name Settings -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} ### Nextcloud Configuration Settings Nextcloud configuration settings include setting up credentials, APT packages (previously referred to as the commands), the host IP and port, data directory path, upload limits, execution times, memory limits and cache memory consumption, adding a cron job with schedule, and adding additional environment variables. @@ -226,9 +226,9 @@ Refer to Nextcloud documentation for more information on environment variables. ### Network Configuration The default web port for Nextcloud is **30027**. -{{< include file="/static/includes/apps/AppsInstallWizardDefaultPorts.md" >}} -{{< include file="/static/includes/apps/AppsInstallWizardAdvancedDNSSettings.md" >}} -{{< include file="/static/includes/apps/AppInstallWizardCertificateSettings.md" >}} +{{< include file="/static/includes/apps/InstallWizardDefaultPorts.md" >}} +{{< include file="/static/includes/apps/InstallWizardAdvancedDNSSettings.md" >}} +{{< include file="/static/includes/apps/InstallWizardCertificateSettings.md" >}} **Nginx Configuration** setting, **Proxy Timeout**, applies the time out (in seconds) to proxy connection, and proxy send and receive. The default value is **60** with a minimum of 30 seconds. @@ -289,19 +289,19 @@ When finished you should have the **nextcloud** parent dataset with three child #### ACL and ACE Settings -{{< include file="/static/includes/apps/AppInstallWizardACLConfiguration.md" >}} +{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}} #### Mounting an SMB Share TrueNAS **Additional Storage** options include the ability to mount an SMB share inside the container pod. -{{< include file="/static/includes/apps/AppWizardStorageSMBOption.md" >}} +{{< include file="/static/includes/apps/InstallWizardStorageSMBOption.md" >}} ### Resource Configuration {{< trueimage src="/images/SCALE/Apps/InstallNextcloudResourcesConfig.png" alt="Resources Configuration Settings" id="Resources Configuration Settings" >}} -{{< include file="/static/includes/apps/AppInstallWizardResourceConfig.md" >}} -{{< include file="/static/includes/apps/AppsInstallWizardGPUPassthrough.md" >}} +{{< include file="/static/includes/apps/InstallWizardResourceConfig.md" >}} +{{< include file="/static/includes/apps/InstallWizardGPUPassthrough.md" >}} ## Troubleshooting Tips diff --git a/content/TruenasApps/StableApps/InstallWGEasyApp.md b/content/TruenasApps/StableApps/InstallWGEasyApp.md index 94c2e84175..e9abf8982f 100644 --- a/content/TruenasApps/StableApps/InstallWGEasyApp.md +++ b/content/TruenasApps/StableApps/InstallWGEasyApp.md @@ -53,7 +53,7 @@ The following sections provide more detail explanations of the settings found in ### Application Name Settings -{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}} ### Configuration Settings You can accept the defaults in the **Configuration** settings, or enter the configuration settings you want to use. diff --git a/content/TruenasApps/StableApps/MinIOApp/MinIOClustering.md b/content/TruenasApps/StableApps/MinIOApp/MinIOClustering.md index c987414c58..a9581ab6a8 100644 --- a/content/TruenasApps/StableApps/MinIOApp/MinIOClustering.md +++ b/content/TruenasApps/StableApps/MinIOApp/MinIOClustering.md @@ -57,7 +57,7 @@ Begin on the first node (system) in your cluster. {{< trueimage src="/images/SCALE/Apps/InstallMinioS3Screen.png" alt="MinIO Install Wizard Screen" id="MinIO Install Wizard Screen" >}} -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} Next, enter the **MinIO Configuration** settings. diff --git a/content/TruenasApps/StableApps/MinIOApp/_index.md b/content/TruenasApps/StableApps/MinIOApp/_index.md index dc8d5a0563..e346a445fb 100644 --- a/content/TruenasApps/StableApps/MinIOApp/_index.md +++ b/content/TruenasApps/StableApps/MinIOApp/_index.md @@ -51,7 +51,7 @@ Enterprise MinIO]({{< relref "/content/TruenasApps/EnterpriseApps/_index.md" >}} ### Before You Begin Before you install the **stable** version of the MinIO app: -{{< include file="/static/includes/apps/AppsStableBeforeYouBegin.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginStableApps.md" >}} {{< include file="/static/includes/apps/MinIODatasetRequirements.md" >}} @@ -68,9 +68,9 @@ For optional settings, see [Understanding MinIO Wizard Settings](#understanding- {{< trueimage src="/images/SCALE/Apps/InstallMinioS3Screen.png" alt="MinIO Install Wizard Screen" id="MinIO Install Wizard Screen" >}} -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} -{{< include file="/static/includes/apps/AddMultipleAppInstancesAndNaming.md" >}} +{{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}} Next, enter the **MinIO Configuration** settings. @@ -95,7 +95,7 @@ The following section provide more detailed explanations of the settings found i ### Application Name -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} ### MinIO Configuration MinIO credentials establish the login credentials for the MinIO web portal and the MinIO administration user, and to enter extra arguments, or environment variables to the deployment. @@ -131,7 +131,7 @@ Before changing ports, refer to [Default Ports](https://www.truenas.com/docs/ref The **Certificates** setting is not required for a basic configuration but is required when setting up multi-mode configurations with the Enterprise version of the MinIO app and when using MinIO as an immutable target for Veeam Backup and Replication. -{{< include file="/static/includes/apps/AddAppCertificate.md" >}} +{{< include file="/static/includes/apps/AddingAppCertificate.md" >}} To add advanced DNS settings click **Add** to the right of **DNS Options**. @@ -148,7 +148,7 @@ Storage configuration uses both the default **/export** and **/data** mount path #### Mounting an SMB Share The TrueNAS MinIO app includes the option to mount an SMB share inside the container pod. -{{< include file="/static/includes/AppWizardStorageSMBOption.md" >}} +{{< include file="/static/includes/InstallWizardStorageSMBOption.md" >}} ### Resource Configuration diff --git a/content/TruenasApps/StableApps/PlexApp.md b/content/TruenasApps/StableApps/PlexApp.md index ba42923860..963158545b 100644 --- a/content/TruenasApps/StableApps/PlexApp.md +++ b/content/TruenasApps/StableApps/PlexApp.md @@ -24,7 +24,7 @@ Before you install the Plex app: After installing the Plex app and logging into Plex through the **Web Portal** button in TrueNAS, if you have not already configured your Plex account media server, Plex shows the configuration screens to set up the media server, add libraries, and customize your Plex account. -{{< include file="/static/includes/apps/AppsStableBeforeYouBegin.md" >}} +{{< include file="/static/includes/apps/BeforeYouBeginStableApps.md" >}} * Go to **Datasets**, and select the pool or dataset where you want to add the Plex datasets. For example, */tank/apps/plex* or */tank/plex*. @@ -47,18 +47,18 @@ This basic procedure covers the required Plex app settings. For optional settings, see [Understanding App Installation Wizard Settings](#understanding-app-installation-wizard-settings). {{< /hint >}} -{{< include file="/static/includes/apps/AddMultipleAppInstancesAndNaming.md" >}} +{{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}} {{< include file="/static/includes/apps/LocateAndOpenInstallWizard.md" >}} {{< trueimage src="/images/SCALE/Apps/InstallPlexScreen.png" alt="Install Plex Screen" id="Install Plex Screen" >}} -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} Next, enter the **Plex Configuration** settings. For a basic installation, you can accept the default values. -{{< include file="/static/includes/apps/AppsInstallWizardTimezoneSetting.md" >}} +{{< include file="/static/includes/apps/InstallWizardTimezoneSetting.md" >}} While logged into your Plex account, go to the [Plex **Claim Code** web page](https://www.plex.tv/claim/) to copy the **Claim Code** string provided by Plex, and then paste it into the TrueNAS **Install Plex** wizard **Claim Token** field. This authentication token provides TrueNAS access to your Plex account. @@ -110,14 +110,14 @@ The following section provides more detailed explanations of the settings in eac ### Application Name Settings -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} ### Plex Configuration Settings Plex configuration settings include setting up the server timezone, authentication to the Plex account, location of the Plex container image, local network settings, and adding devices or additional environment variables to apply to the container. {{< trueimage src="/images/SCALE/Apps/InstallPlexConfig1.png" alt="Install Plex Configuration Settings" id="Install Plex Configuration Settings" >}} -{{< include file="/static/includes/apps/AppsInstallWizardTimezoneSetting.md" >}} +{{< include file="/static/includes/apps/InstallWizardTimezoneSetting.md" >}} TrueNAS authenticates to the Plex account using a [Plex claim token](https://www.plex.tv/claim/). While signed into your Plex account, copy the token provided by Plex into the **Claim Token** field. @@ -167,7 +167,7 @@ The default web port for Plex is **32400**. {{< include file="/static/includes/apps/AppInstallWizardNetworkConfig.md" >}} -{{< include file="/static/includes/apps/AppsInstallWizardAdvancedDNSSettings.md" >}} +{{< include file="/static/includes/apps/InstallWizardAdvancedDNSSettings.md" >}} ### Storage Configuration TrueNAS provides options for data and configuration storage volumes: ixVolumes and host paths. @@ -222,19 +222,19 @@ When finished you should have the **plex** parent dataset with the child dataset #### ACL and ACE Settings -{{< include file="/static/includes/apps/AppInstallWizardACLConfiguration.md" >}} +{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}} #### Mounting an SMB Share TrueNAS **Additional Storage** options include the ability to mount an SMB share inside the container pod. -{{< include file="/static/includes/apps/AppWizardStorageSMBOption.md" >}} +{{< include file="/static/includes/apps/InstallWizardStorageSMBOption.md" >}} ### Resource Configuration {{< trueimage src="/images/SCALE/Apps/InstallPlexResourcesConfiguration.png" alt="Resources Configuration Settings" id="Resources Configuration Settings" >}} -{{< include file="/static/includes/apps/AppInstallWizardResourceConfig.md" >}} -{{< include file="/static/includes/apps/AppsInstallWizardGPUPassthrough.md" >}} +{{< include file="/static/includes/apps/InstallWizardResourceConfig.md" >}} +{{< include file="/static/includes/apps/InstallWizardGPUPassthrough.md" >}} ## Troubleshooting Tips Before editing Plex app settings, first stop the app, and then edit settings. After saving changes, restart the app. diff --git a/content/TruenasApps/StableApps/PrometheusApp.md b/content/TruenasApps/StableApps/PrometheusApp.md index 8d25a8d01e..86d862806b 100644 --- a/content/TruenasApps/StableApps/PrometheusApp.md +++ b/content/TruenasApps/StableApps/PrometheusApp.md @@ -93,7 +93,7 @@ The following sections provide more detailed explanations of the settings found ### Application Name Settings -{{< include file="/static/includes/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/InstallWizardAppNameAndVersion.md" >}} ### Prometheus Configuration Settings You can accept the defaults in the **Prometheus Configuration** settings, or enter the settings you want to use. diff --git a/content/TruenasApps/StableApps/SyncthingStable.md b/content/TruenasApps/StableApps/SyncthingStable.md index 93d006ea5c..9180c22097 100644 --- a/content/TruenasApps/StableApps/SyncthingStable.md +++ b/content/TruenasApps/StableApps/SyncthingStable.md @@ -45,9 +45,9 @@ For optional settings, see [Understanding Syncthing Wizard Settings](#understand {{< trueimage src="/images/SCALE/Apps/InstallSyncthingEnterpriseScreen.png" alt="Install Syncthing Enterprise Screen" id="Install Syncthing Enterprise Screen" >}} -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} -{{< include file="/static/includes/apps/AddMultipleAppInstancesAndNaming.md" >}} +{{< include file="/static/includes/apps/MultipleAppInstancesAndNaming.md" >}} Accept the default user and group ID settings (**568**). If you created a user for this app, change these settings to the UID/GID for that new user. @@ -63,7 +63,7 @@ An additional storage volumes such as a *data* or *data1* dataset can store data {{< trueimage src="/images/SCALE/Apps/InstallSyncthingConfigAndData1ACLandACESettings.png" alt="Syncthing Storage and ACL Settings" id="Syncthing Storage and ACL Settings" >}} -{{< include file="/static/includes/apps/AppInstallWizardACLConfiguration.md" >}} +{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}} See [**Storage Settings**](#storage-settings) below for more information. @@ -84,7 +84,7 @@ The following sections provide more detail explanations of the settings found in ### Application Name Settings -{{< include file="/static/includes/apps/AppsWizardAppNameAndVersion.md" >}} +{{< include file="/static/includes/apps/InstallWizardAppNameAndVersion.md" >}} ### Configuration Settings The Syncthing app wizard is configured with all settings required to deploy the container, but you can add additional settings if you want to further customize the app in TrueNAS. @@ -100,7 +100,7 @@ The default value for **User Id** and **Group ID** is **568**. {{< include file="/static/includes/apps/AppInstallWizardUserAndGroupConfig.md" >}} ### Networking Settings -Accept the default port numbers in **Web Port for Syncthing**, **TCP Port for Syncthing** and **UDP Port for Syncthing**. +Accept the default port numbers in **Web Port for Syncthing**, **TCP Port for Syncthing**, and **UDP Port for Syncthing**. The TrueNAS Syncthing stable app listens on port **20910**. The default TCP port is **20978** and the default UDP port is **20979**. @@ -114,7 +114,7 @@ Clearing the **Host Network** checkbox shows the TCP and UDP port numbers, and t {{< trueimage src="/images/SCALE/Apps/InstallSyncthingChartsAddAdvanceDNSOptions.png" alt="Syncthing Add Advanced DNS Options" id="Syncthing Add Advanced DNS Options" >}} -{{< include file="/static/includes/apps/AppInstallWizardAdvancedDNSSettings.md" >}} +{{< include file="/static/includes/apps/InstallWizardAdvancedDNSSettings.md" >}} ### Storage Settings The Syncthing **stable** train app requires one storage volume/dataset to store configuration data and you can use a second dataset for app data storage. Create one named **config** and the other dataset named **data1**. @@ -126,7 +126,7 @@ The Syncthing **stable** train app requires one storage volume/dataset to store #### Mounting an SMB Share The TrueNAS Syncthing app includes the option to mount an SMB share inside the container pod. -{{< include file="/static/includes/apps/AppWizardStorageSMBOption.md" >}} +{{< include file="/static/includes/apps/InstallWizardStorageSMBOption.md" >}} ### Resource Configuration Settings diff --git a/content/TruenasApps/StableApps/_index.md b/content/TruenasApps/StableApps/_index.md index c6e965b023..11f5517206 100644 --- a/content/TruenasApps/StableApps/_index.md +++ b/content/TruenasApps/StableApps/_index.md @@ -30,7 +30,7 @@ For information on adding to or changing the train for the apps catalog, see [Ma ## Understanding App Install Wizard Settings -{{< include file="/static/includes/apps/AppsInstallWizardSettings.md" >}} +{{< include file="/static/includes/apps/InstallWizardSettingsOverview.md" >}}
diff --git a/content/TruenasApps/_index.md b/content/TruenasApps/_index.md index d9c66d8d4c..2263cb4011 100644 --- a/content/TruenasApps/_index.md +++ b/content/TruenasApps/_index.md @@ -190,7 +190,7 @@ Apps submitted and maintained by community members using the **Custom App** opti Refer to tutorials created and maintained by the community for more information on deploying and using these applications. {{< /hint >}} -{{< include file="/static/includes/apps/AppsInstallWizardSettings.md" >}} +{{< include file="/static/includes/apps/InstallWizardSettingsOverview.md" >}} After clicking **Install** on an application wizard screen, the **Installed** applications screen opens showing the application in the **Deploying** state before changing to **Running**. diff --git a/static/includes/apps/AddAppCertificate.md b/static/includes/apps/AddingAppCertificate.md similarity index 100% rename from static/includes/apps/AddAppCertificate.md rename to static/includes/apps/AddingAppCertificate.md diff --git a/static/includes/apps/AppUserAndGroupConfig.md b/static/includes/apps/AppUserAndGroupConfig.md deleted file mode 100644 index 21e4a50abc..0000000000 --- a/static/includes/apps/AppUserAndGroupConfig.md +++ /dev/null @@ -1,4 +0,0 @@ - - -Accept the default values in **User and Group Configuration**. -If you configured TrueNAS with a new administration user for the app, enter the UID and GID in these fields. \ No newline at end of file diff --git a/static/includes/apps/AppsBeforeYouBeginCertificate.md b/static/includes/apps/BeforeYouBeginAddAppCertificate.md similarity index 100% rename from static/includes/apps/AppsBeforeYouBeginCertificate.md rename to static/includes/apps/BeforeYouBeginAddAppCertificate.md diff --git a/static/includes/apps/AppBeforeYouBeginNewUser.md b/static/includes/apps/BeforeYouBeginAddNewAppUser.md similarity index 100% rename from static/includes/apps/AppBeforeYouBeginNewUser.md rename to static/includes/apps/BeforeYouBeginAddNewAppUser.md diff --git a/static/includes/apps/AppsEnterprieseBeforeYouBegin.md b/static/includes/apps/BeforeYouBeginEnterpriseApps.md similarity index 100% rename from static/includes/apps/AppsEnterprieseBeforeYouBegin.md rename to static/includes/apps/BeforeYouBeginEnterpriseApps.md diff --git a/static/includes/apps/AppsStableBeforeYouBegin.md b/static/includes/apps/BeforeYouBeginStableApps.md similarity index 100% rename from static/includes/apps/AppsStableBeforeYouBegin.md rename to static/includes/apps/BeforeYouBeginStableApps.md diff --git a/static/includes/apps/AppInstallWizardAdvancedDNSSettings.md b/static/includes/apps/InstallWizardAdvancedDNSSettings.md similarity index 100% rename from static/includes/apps/AppInstallWizardAdvancedDNSSettings.md rename to static/includes/apps/InstallWizardAdvancedDNSSettings.md diff --git a/static/includes/apps/AppsWizardAppNameAndVersion.md b/static/includes/apps/InstallWizardAppNameAndVersion.md similarity index 100% rename from static/includes/apps/AppsWizardAppNameAndVersion.md rename to static/includes/apps/InstallWizardAppNameAndVersion.md diff --git a/static/includes/apps/AppInstallWizardCertificateSettings.md b/static/includes/apps/InstallWizardCertificateSettings.md similarity index 100% rename from static/includes/apps/AppInstallWizardCertificateSettings.md rename to static/includes/apps/InstallWizardCertificateSettings.md diff --git a/static/includes/apps/AppsInstallWizardDefaultPorts.md b/static/includes/apps/InstallWizardDefaultPorts.md similarity index 100% rename from static/includes/apps/AppsInstallWizardDefaultPorts.md rename to static/includes/apps/InstallWizardDefaultPorts.md diff --git a/static/includes/apps/AppInstallWizardEnvironVariablesSettings.md b/static/includes/apps/InstallWizardEnvironVariablesSettings.md similarity index 100% rename from static/includes/apps/AppInstallWizardEnvironVariablesSettings.md rename to static/includes/apps/InstallWizardEnvironVariablesSettings.md diff --git a/static/includes/apps/AppsInstallWizardGPUPassthrough.md b/static/includes/apps/InstallWizardGPUPassthrough.md similarity index 100% rename from static/includes/apps/AppsInstallWizardGPUPassthrough.md rename to static/includes/apps/InstallWizardGPUPassthrough.md diff --git a/static/includes/apps/AppInstallWizardNetworkConfig.md b/static/includes/apps/InstallWizardHostNetworkSettings.md similarity index 100% rename from static/includes/apps/AppInstallWizardNetworkConfig.md rename to static/includes/apps/InstallWizardHostNetworkSettings.md diff --git a/static/includes/apps/AppInstallWizardResourceConfig.md b/static/includes/apps/InstallWizardResourceConfig.md similarity index 100% rename from static/includes/apps/AppInstallWizardResourceConfig.md rename to static/includes/apps/InstallWizardResourceConfig.md diff --git a/static/includes/apps/AppsInstallWizardSettings.md b/static/includes/apps/InstallWizardSettingsOverview.md similarity index 77% rename from static/includes/apps/AppsInstallWizardSettings.md rename to static/includes/apps/InstallWizardSettingsOverview.md index 9de6be3f5e..8945513d7c 100644 --- a/static/includes/apps/AppsInstallWizardSettings.md +++ b/static/includes/apps/InstallWizardSettingsOverview.md @@ -2,7 +2,7 @@ The installation wizard configuration sections vary by application, with some including more configuration areas than others. Click **Install** to review settings ahead of time to check for required settings. -Click **Discover** on the breadcrumb at the top of the installation wizard to exiting the screen without saving and until you are ready return and configure the app settings. +Click **Discover** on the breadcrumb at the top of the installation wizard to exit the screen without saving and until you are ready return and configure the app settings. All apps in the **stable** train, some **community** train apps, and all apps in the **enterprise** train generally include these basic setting sections: @@ -12,10 +12,10 @@ All apps in the **stable** train, some **community** train apps, and all apps in Do not change the **Version** number for official apps or those included in a TrueNAS catalog. When a new version becomes available, the **Installed** application screen shows an update alert, and the **Application Info** widget shows an **Update** button. - Updating the app changes the version to the currently-available release. + Updating the app changes the version to the currently available release. * ***Application* Configuration** shows required and optional settings for the app. - Typical settings include user credentials, environment variables, additional argument settings, name of the node, or even sizing parameters. + Typical settings include user credentials, environment variables, additional argument settings, the name of the node, or even sizing parameters. * **User and Group Configuration** shows the user and group ID for the default user assigned to the app. If not using a default user and group provided, add a new user to manage the application before using the installation wizard, then enter the UID in both the user and group fields. @@ -32,22 +32,31 @@ All apps in the **stable** train, some **community** train apps, and all apps in Storage configuration can include the primary data mount volume, a configuration volume, postgres volumes, and an option to add additional storage volumes. The primary mount volumes have two options: * **ixVolume** creates a storage volume inside the hidden **ix-apps** dataset. This is the default setting. - * **Host Path** allows you to select an existing dataset created for the application. Shows additional fields to select the path to the dataset and add the mount point. + * **Host Path** allows you to select an existing dataset created for the application. It shows additional fields for selecting the path to the dataset and adding the mount point. - ixVolumes are not recommended for permanent storage volumes, they are intended for use as rapid storage for a test deployment of the container. + ixVolumes are not recommended for permanent storage volumes, they are intended for rapid storage for a test deployment of the container. We recommend adding datasets and configuring the container storage volumes with the host path option. Host paths add existing dataset(s) as the storage volumes. You must configure the datasets before beginning the app installation using the wizard. + {{< hint type="note" title="ix-apps Dataset" >}} + The **ix-apps** dataset is for internal use only. + + TrueNAS systems with applications deployed that upgrade from earlier releases to 24.10 continue to see the **ix-Applications** dataset on the pool chosen for applications to use. + New installs or systems upgrading where applications are not deployed and a pool is not chosen for apps use the hidden **ix-apps** dataset. + Choosing the pool for apps to use, creates this dataset to store all container-related data. + To expose storage volumes found in the ix-applications dataset, take a recursive snapshot. + {{< /hint >}} + Some applications require specific storage volumes for configuration and other data. - Apps with these requirements might indicate this in the wizard UI but refer to tutorials for specifics. - After configuring required storage volumes you can add additional storage volumes if needed. - Click **Add** to select the type of storage and configure additional storage volumes for the application. + Apps with these requirements might indicate this in the wizard UI but refer to tutorials for specifics. + After configuring required storage volumes you can add storage volumes. + To configure additional storage volumes for the application, click **Add** to select the type of storage to configure. The three storage options are: * **ixVolume** * **Host path** - * **SMB share** that allows you to mount an SMB share as a Docker storage volume. + * **SMB share** An SMB share option allows you to mount an SMB share as a Docker volume for the application to use. If the application requires specific datasets or you want to allow SMB share access, configure the dataset(s) and SMB share before using the installation wizard. @@ -63,7 +72,7 @@ All apps in the **stable** train, some **community** train apps, and all apps in A user or group ID does not need to exist locally on TrueNAS or match the name configured in the container to grant an ACE. Failing to configure host path ACLs prevents the app from deploying! - Select **Force Flag** in **ACL Options**. + Select **Force Flag** to allow TrueNAS to update the application to the next version. This allows TrueNAS to write ACL entries to the storage volume if it has existing data in it. **Force Flag** is required to edit or update an existing application. diff --git a/static/includes/apps/AppInstallWizardACLConfiguration.md b/static/includes/apps/InstallWizardStorageACLConfig.md similarity index 68% rename from static/includes/apps/AppInstallWizardACLConfiguration.md rename to static/includes/apps/InstallWizardStorageACLConfig.md index a6f670dbf3..d085677433 100644 --- a/static/includes/apps/AppInstallWizardACLConfiguration.md +++ b/static/includes/apps/InstallWizardStorageACLConfig.md @@ -12,15 +12,18 @@ Set **ID Type** to **Entry is for a USER** or **Entry is for a GROUP**. If you configured a group in TrueNAS that you want to give access to instead of a single user, set the ID to the group option and enter the GID for that group. Enter the UID as one of the following: -* The default apps user, which is **473** for MinIO app in the stable train, **568** for apps in all trains if the app can run as any non-root user, **999** for postgres storage volumes, or **0** if running as root. +* The default apps user, which are: + * **568** for apps in all trains if the app can run as any non-root user. + * **999** for all postgres storage volumes. + * **0** if running as root. + * **473** for MinIO app in the stable train. * The run-as-user UID set as a default for the app. + The run-as user shows on the details screen in the **Run As Content** widget, and on the **Installed** application screen after the app is deployed. + You can also refer to the tutorial for the app, or look in the questions.yaml file in the GitHub repository for the application to find this UID/GID. * The new user UID for a TrueNAS user created to serve as the app administrator. If the app shows **User and Group Configuration** settings, the default UID shows on the screen. If not, choose the run-as UID. -The run-as user shows on the details screen in the **Run As Content** widget, and also on the **Installed** application screen after the app is deployed. -You can also refer to the tutorial for the app, or look in the questions.yaml file in the GitHub repository for the application to find this UID/GID. - All postgres storage volumes use the default user ID **999**, not as the run-as user. If you create a new user to serve as the app administration user, enter the UID for this user in addition to the run-as user ID. @@ -28,4 +31,5 @@ Always add the run-as user with full control permissions except for postgres sto Select the ID type from the dropdown list, enter the UID (or GID if you select the group ID type) for the app administration user, and then set the **Access** permissions level to **FULL CONTROL**. {{< /expand >}} -Select **Force** to apply the ACL even if the path has existing data. This allows you to update the app when an update is available. \ No newline at end of file + +Select **Force Flag** to apply the ACL even if the path has existing data. This allows you to update the app when an update is available. \ No newline at end of file diff --git a/static/includes/apps/AppWizardStorageSMBOption.md b/static/includes/apps/InstallWizardStorageSMBOption.md similarity index 100% rename from static/includes/apps/AppWizardStorageSMBOption.md rename to static/includes/apps/InstallWizardStorageSMBOption.md diff --git a/static/includes/apps/AppInstallWizardTemporaryAndTmpfsDirectories.md b/static/includes/apps/InstallWizardStorageTemporaryAndTmpfs.md similarity index 100% rename from static/includes/apps/AppInstallWizardTemporaryAndTmpfsDirectories.md rename to static/includes/apps/InstallWizardStorageTemporaryAndTmpfs.md diff --git a/static/includes/apps/AppsInstallWizardTimezoneSetting.md b/static/includes/apps/InstallWizardTimezoneSetting.md similarity index 100% rename from static/includes/apps/AppsInstallWizardTimezoneSetting.md rename to static/includes/apps/InstallWizardTimezoneSetting.md diff --git a/static/includes/apps/AppInstallWizardUserAndGroupConfig.md b/static/includes/apps/InstallWizardUserAndGroupConfig.md similarity index 100% rename from static/includes/apps/AppInstallWizardUserAndGroupConfig.md rename to static/includes/apps/InstallWizardUserAndGroupConfig.md diff --git a/static/includes/apps/AddMultipleAppInstancesAndNaming.md b/static/includes/apps/MultipleAppInstancesAndNaming.md similarity index 100% rename from static/includes/apps/AddMultipleAppInstancesAndNaming.md rename to static/includes/apps/MultipleAppInstancesAndNaming.md