Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PD-1556 / 25.04 / Pd 1556 revise app tutorial template #3292

Merged
merged 33 commits into from
Jan 24, 2025
Merged
Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
e1f4599
PD-1556 Update Apps Contribution and Tutorial Template
micjohnson777 Nov 26, 2024
416a671
PD-1556 Fix formatting issues
micjohnson777 Nov 26, 2024
f6c63e8
Merge branch 'master' into PD-1556-Revise-App-Tutorial-Template
micjohnson777 Nov 27, 2024
6f821e8
Merge branch 'master' into PD-1556-Revise-App-Tutorial-Template
DjP-iX Dec 2, 2024
d6bf1d9
Merge branch 'master' into PD-1556-Revise-App-Tutorial-Template
DjP-iX Dec 2, 2024
542d901
Update _index.md
DjP-iX Dec 2, 2024
a8783a6
Update AppArticleTemplate.md
DjP-iX Dec 2, 2024
feb9983
Update AppArticleTemplate.md
DjP-iX Dec 3, 2024
8d5d99a
Update AppArticleTemplate.md
micjohnson777 Dec 3, 2024
9df00c5
Update _index.md
micjohnson777 Dec 3, 2024
124539d
Merge branch 'master' into PD-1556-Revise-App-Tutorial-Template
micjohnson777 Dec 5, 2024
d8a143a
Merge branch 'master' into PD-1556-Revise-App-Tutorial-Template
micjohnson777 Dec 6, 2024
136aebd
PD-1556 Update Contributin and Template
micjohnson777 Dec 6, 2024
191fb7d
PD-1556 Updates to the Contributin _index.md file
micjohnson777 Dec 6, 2024
19a9c40
Update AppArticleTemplate.md
micjohnson777 Dec 6, 2024
524a5d7
Update AppArticleTemplate.md
micjohnson777 Dec 10, 2024
8ab6e6c
PD-1556 Add new InstallWizardLabelsConfiguration.md Snippet
micjohnson777 Dec 12, 2024
bd49da0
Merge branch 'master' into PD-1556-Revise-App-Tutorial-Template
micjohnson777 Dec 12, 2024
f6bd203
PS-1556 Add new Labels Configuration Information to the index and tem…
micjohnson777 Dec 12, 2024
6e7d282
Merge branch 'master' into PD-1556-Revise-App-Tutorial-Template
micjohnson777 Dec 13, 2024
49b9607
Update AppArticleTemplate.md
DjP-iX Dec 16, 2024
ccd1ae3
Update AppArticleTemplate.md
DjP-iX Dec 16, 2024
7b7c95f
Update AppArticleTemplate.md
DjP-iX Dec 17, 2024
45e0733
Update AppArticleTemplate.md
DjP-iX Dec 18, 2024
4835aae
Update AppArticleTemplate.md
DjP-iX Dec 19, 2024
f491092
Update AppArticleTemplate.md
DjP-iX Dec 19, 2024
26f94b7
Merge branch 'master' into PD-1556-Revise-App-Tutorial-Template
micjohnson777 Dec 20, 2024
03ec0f7
PD-1556 Adjustments and Style Fixes
micjohnson777 Dec 20, 2024
facd887
Merge branch 'master' into PD-1556-Revise-App-Tutorial-Template
micjohnson777 Jan 22, 2025
a1448f3
PD-1556 Update Template
micjohnson777 Jan 22, 2025
6d0f5db
Merge branch 'master' into PD-1556-Revise-App-Tutorial-Template
DjP-iX Jan 23, 2025
187797b
Merge branch 'master' into PD-1556-Revise-App-Tutorial-Template
DjP-iX Jan 24, 2025
e440164
Update AppArticleTemplate.md
DjP-iX Jan 24, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
PD-1556 Adjustments and Style Fixes
micjohnson777 committed Dec 20, 2024

Verified

This commit was signed with the committer’s verified signature.
ElDavoo Davide Palma
commit 03ec0f76b30fe00165013d4ebcf63c4ec3535c73
22 changes: 12 additions & 10 deletions content/Contributing/Applications/AppArticleTemplate.md
Original file line number Diff line number Diff line change
@@ -118,7 +118,8 @@ Prepare TrueNAS before installing the app by:
{{< include file="/static/includes/apps/BeforeYouBeginStableApps.md" >}}
{{< include file="/static/includes/apps/BeforeYouBeginRunAsUser.md" >}}

<!-- Use the style="margin-left: 33px" tags for this and other indicated elements to indent them in line with the indented snippet text in the rendered article. -->
<!-- Use the style="margin-left: 33px" tags for this and other indicated elements to indent them in line with the indented snippet text in the rendered article.
Replace Markdown tags with html tags as Markdown tags do not render if you use the <div></div> and <p></p> tags. -->
<!-- replace the image path and name
<div style="margin-left: 33px">{{< trueimage src="/images/SCALE/Apps/PlexDetailsScreen.png" alt="Plex App Details Screen" id="Plex App Details Screen" >}}</div>
-->
@@ -132,10 +133,11 @@ NOTE: Include the HTML styling to align the indented paragraph with the bullet l

<div style="margin-left: 33px">{{< include file="/static/includes/apps/BeforeYouBeginAddAppDatasetsProcedure.md" >}}</div>

<!-- Include this snippet and a modified version of the indented text if the app requires setting up a certificate.
<!-- Include this snippet and a modified version of the indented text if the app requires setting up a certificate.
If the Install wizard does not include the certificate field, do not include this snippet or content. -->
{{< include file="/static/includes/apps/BeforeYouBeginAddAppCertificate.md" >}}

<p style="margin-left: 33px">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.</p> -->
<p style="margin-left: 33px">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.</p>

<!-- Include this snippet if the app requires setting up a new TrueNAS user account before installing the app in TrueNAS, if not remove the snippet. -->
{{< include file="/static/includes/apps/BeforeYouBeginAddNewAppUser.md" >}}
@@ -168,16 +170,16 @@ Accept the default values in both **User and Group Configuration** and **Network
(Optional) If you created a new user to administer apps, enter that user ID in the user and group fields.
See [User and Group Configuration](#user-and-group-configuration) and [Network Configuration](#network-configuration) for more details.

Leave **Host Network** unselected.-->
Do not select **Host Network** if it is not selected. If checkmarked, select to clear it.-->

Add your **Storage Configuration** settings.

Set **Host Path (Path that already exists on the system)** in **Type** for ***Data Storage***.
Select **Enable ACL**, and then enter or browse to and select the **data** dataset to populate the **Host Path** field.
Select **Enable ACL**, and then enter or browse to select the ***data*** dataset to populate the **Host Path** field.
<!-- replace image with the path to the image you want to add:
{{< trueimage src="/images/SCALE/Apps/InstallPlexStorageConfigDataACLandACE.png" alt="Add Plex Data Storage" id="Add Plex Data Storage" >}}-->

Select **Add** to the right of **ACL Entries** for each user or group entry you want to add.
Click **Add** to the right of **ACL Entries** for each user or group entry you want to add.
For example, add the **568** user and **0**, and give each **FULL_CONTROL Access**.

Select **Force Flag**.
@@ -262,12 +264,12 @@ You can add extra storage volumes at the time of installation or edit the applic
You can configure ACL permissions for the required dataset in the **Install Netdata** wizard, or from the **Datasets** screen any time after adding the datasets.

{{< include file="/static/includes/apps/InstallWizardStorageACLConfig.md" >}}
<!-- replace the UIDs in the section below with the user IDs or run as user ID -->
<!-- replace the UIDs in the section below with the user IDs or run as user ID. Include any other app specific user information.This might become a snippet. -->
{{< expand "Adding ACL Permissions from the Datasets Screen" "v">}}
First select the dataset row, and scroll down to the **Permissions** widget, and then click **Edit** to open the **Edit ACL** screen.
First, select the dataset row, then scroll down to the **Permissions** widget, and then click **Edit** to open the **Edit ACL** screen.
Change the **@owner** and **@group** values from **root** to the administrative user for your TrueNAS system, and click apply for each.
Next, add an ACL entry for the run-as user.
For Netdata, the run-as users is **0** for **root**. Add a user entry for this user.
For *Netdata*, the run-as users is **0** for **root**. Add a user entry for this user.
Save the ACL before leaving the screen.
{{< /expand >}}

@@ -293,4 +295,4 @@ TrueNAS **Additional Storage** options include the ability to mount an SMB share
## Troubleshooting Tips
<!-- include this section if you want to include tips to resolve known deployment issues -->

<!-- /END TEMPLATE -->
<!-- /END TEMPLATE -->
2 changes: 1 addition & 1 deletion content/Contributing/Applications/_index.md
Original file line number Diff line number Diff line change
@@ -166,7 +166,7 @@ Open and read snippet files to determine where to use them in your tutorial.
| Additional Storage SMB Option | InstallWizardStorageSMBOption.md | Details on the Additional Storage volume SMB share option. |
| Storage Temporary and tmpfs directories | InstallWizardStorageTemporaryAndTmpfs.md | Details on the **Temporary** and **Tmpfs** directory storage options that are available as primary and/or additional storage volume types, and when to use each. |
| Users and Groups | InstallWizardUserAndGroupConfig.md | Details user and group setting options. |
| Labels Configuration | InstallWizardLabelsConfiguration.md | Details on using label-based configuration. |
| Labels Configuration | InstallWizardLabelsConfiguration.md | Details on using Docker label-based configuration. |
| Resource Configuration | InstallWizardResourceConfig.md | Details CPU and memory setting options for all apps. If the app includes GPU passthrough, use with the InstallWizardGPUPassthrough.md snippet. |
| GPU Passthrough | InstallWizardGPUPassthrough.md | Details information on GPU settings if the app includes the GPU passthrough settings. Not present if the app does not detect a GPU device. |
{{< /truetable >}}