Skip to content

Commit

Permalink
PD-1755 / 25.10 / Pd 1755 create placeholders (#3522)
Browse files Browse the repository at this point in the history
* Create generate_app_docs.py

* Update generate_app_docs.py

* Update generate_app_docs.py

* Update generate_app_docs.py

* rename asigra

* rename remote assist

* Update Syncthing.md

* Update generate_app_docs.py

* Update CreatePool.md

* Update generate_app_docs.py

* rename storj

* rename syncthing stable

* rename prometheus

* Update Photoprism.md

* rename wg easy

* rename home assistant

* rename elastic search

* rename plex

* rename diskoverdata

* Update Collabora.md

* rename emby

* rename pi-hole

* rename netdata

* rename nextcloud

* rename tftp server

* Update WebDAV.md

* Update Rsyncd.md

* fix nextcloud links

* generate article placeholders

---------

Co-authored-by: tonyriv3 <[email protected]>
  • Loading branch information
DjP-iX and tonyriv3 authored Feb 20, 2025
1 parent 8bc8bde commit 830d981
Show file tree
Hide file tree
Showing 58 changed files with 1,069 additions and 73 deletions.
2 changes: 1 addition & 1 deletion content/Solutions/Integrations/Nextcloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases:
[Nextcloud](https://nextcloud.com/) is a suite of client-server software for creating and using file hosting services.

TrueNAS offers one deployment option for setting up Nextcloud, a Linux Debian-based TrueNAS version application available in TrueNAS releases 24.10 and later.
For the Linux Debian-based app instructions, see [Nextcloud]({{< relref "/content/TruenasApps/StableApps/InstallNextCloudMedia.md" >}}).
For the Linux Debian-based app instructions, see [Nextcloud]({{< relref "/truenasapps/stableapps/nextcloud.md" >}}).

TrueNAS offered a FreeBSD-based TrueNAS Nextcloud plugin in releases 13.0 and earlier, and 13.3, but it is no longer available in TrueNAS 13.0 because of changes in FreeBSD, and it is soon to be unavailable in 13.3.
Refer to release notes for more information on upcoming and current changes.
Expand Down
2 changes: 1 addition & 1 deletion content/TruenasApps/AppSecurity/CloudflareTunnel.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ Click **Save** and deploy the application.

### Nextcloud Configuration

Install the [Nextcloud]({{< relref "installnextcloudmedia.md" >}}) **stable** application.
Install the [Nextcloud]({{< relref "/truenasapps/stableapps/nextcloud.md" >}}) **stable** application.

The first application deployment could take a while, and starts and stops multiple times.
This is normal behavior.
Expand Down
6 changes: 3 additions & 3 deletions content/TruenasApps/CommunityApps/Rsyncd.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,14 +136,14 @@ Use **Hosts Allow** and **Hosts Deny** to specify IP addresses for client system
Enter multiple IP addresses separated by a comma and space between entries in the field.
Leave blank to allow all or deny hosts.

Use the **Auxiliary Parameters** to enter parameters and their values to further custiize the module.
Use the **Auxiliary Parameters** to enter parameters and their values to further customize the module.
Do not enter parameters already available as the settings included in this section.
You can specify rsync [global or module parameters](https://www.samba.org/ftp/rsync/rsyncd.conf.html) using the module **Auxiliary Parameters** fields.

### Authentication

By default, the rsync daemon will allow access to everything within the dataset that has been specified for each module, without authentication.
In order to set up password authentication you needs to add two auxilary parameters for the module:
In order to set up password authentication you needs to add two auxiliary parameters for the module:

Parameter: "auth users"
Value: comma separated list of usernames, [more details can be found here.](https://www.samba.org/ftp/rsync/rsyncd.conf.html#auth_users)
Expand All @@ -167,4 +167,4 @@ The application might use considerably less system resources.

{{< trueimage src="/images/SCALE/Apps/RsyncdResourceConfig.png" alt="Resources Configuration" id="Resources Configuration" >}}

Tune these limits as needed to prevent the application from overconsuming system resources and introducing performance issues.
Tune these limits as needed to prevent the application from over-consuming system resources and introducing performance issues.
12 changes: 9 additions & 3 deletions content/TruenasApps/CommunityApps/WebDAV.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,10 +80,12 @@ After the installation completes, the application displays on the **Installed**
The WebDAV widget on the **Discover** and **WebDAV** information screens includes the **Installed** badge.

### Application Name Settings

Accept the default values in **Application Name** and **Version**.
If you want to change the application name, enter a new name.

### WebDAV Configuration Settings

WebDAV configuration settings include the type of share authentication to use, none or basic.
**No Authentication** means any system can discover TrueNAS and access the data shared by the WebDAV application share, so this is not recommended.
**Basic Authentication** adds the **Username** and **Password** fields and provides some basic security.
Expand All @@ -99,16 +101,18 @@ You can use the Docker container environment variables listed in the table below
|----------|-------------|
| WEBDRIVE_URL | Use to specify a URL where you find the WebDAV resource other than the default. The default URL is http://*webdav-ip*:*webdav-port*/share1 where *webdav-ip* is the IP address for the TrueNAS system and *webdav-port* is 30034. If enabling HTTPS the URL is https://*webdav-ip*:*webdav-port*/share1 where the *webdav-ip* is the IP address for the TrueNAS system and *webdav-port* is 30035. |
| WEBDRIVE_PASSWORD_FILE | Use to specify a file that contains the password instead of using the **Password** field. Use when **Authentication Type** is set to **Basic Authorization**. |
| WEBDRIVE_MOUNT | Use to specify the location within the container where to mount the WebDAV resource (drive) into the container. This defaults to /mnt/webdrive and is not meant to be changed. |
| WEBDRIVE_MOUNT | Use to specify the location within the container where to mount the WebDAV resource (drive) into the container. This defaults to `/mnt/webdrive` and is not meant to be changed. |
{{< /truetable >}}
{{< /expand >}}

### User and Group Configuration Settings

The default user and group for WebDAV is 666. To specify a different user, create the user and group before installing the application, then enter the user ID (UID) and group ID (GID) in the fields for these settings.

{{< trueimage src="/images/SCALE/Apps/InstallWebDAVUserAndGroupConfig.png" alt="User And Group Configuration" id="User And Group Configuration" >}}

### Network Configuration Settings

The container for the WebDAV app has **Enable HTTP** selected by default. The port for HTTP is 30034.

{{< trueimage src="/images/SCALE/Apps/InstallWebDAVAppNetworkConfig.png" alt="WebDAV Network Configuration for HTTP" id="WebDAV Network Configuration for HTTP" >}}
Expand All @@ -121,6 +125,7 @@ This changes the default port in **HTTPS Port** to 30035, and adds a system **Ce
The default certificate is 0. You can use the default as the **Certificate** if no other specific certificate is available.

### Storage Configuration Settings

Create one or more shares in the **Storage Configuration** section. For the application to work, create at least one share.
Click **Add** for each share you want to create.
Each share must have a unique name.
Expand Down Expand Up @@ -153,12 +158,13 @@ It is recommended to only share newly created datasets that have the **Share Typ
{{< /hint >}}

### Resources Configuration Settings

By default, this application is limited to use no more than **4** CPU cores and **8** Gibibytes available memory.
The application might use considerably less system resources.

{{< trueimage src="/images/SCALE/Apps/InstallWebDAVResourcesConfig.png" alt="WebDAV Resource Configuration" id="WebDAV Resource Configuration" >}}

Tune these limits as needed to prevent the application from overconsuming system resources and introducing performance issues.
Tune these limits as needed to prevent the application from over-consuming system resources and introducing performance issues.

## Testing the Share

Expand All @@ -171,4 +177,4 @@ When authentication is set to something other than **No Authentication**, a prom
Enter the saved **Username** and **Password** entered in the webdav application form to access the shared data.

To change files shared with the WebDAV protocol, use client software such as WinSCP to connect to the share and make changes.
The WebDAV share and dataset permissions must be configured so that the **User ID** and **Group ID** can modify shared files.
The WebDAV share and dataset permissions must be configured so that the **User ID** and **Group ID** can modify shared files.
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/calibre-web.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Calibre Web"
description: "Provides installation instructions for the Calibre Web application in TrueNAS."
weight:
aliases:
tags:
- calibre-web
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://github.com/janeczku/calibre-web">Calibre Web</a> is a web app for browsing, reading and downloading eBooks stored in a Calibre database

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/calibre.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Calibre"
description: "Provides installation instructions for the Calibre application in TrueNAS."
weight:
aliases:
tags:
- calibre
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://calibre-ebook.com/">Calibre</a> is the one stop solution for all your e-book needs.

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/dozzle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Dozzle"
description: "Provides installation instructions for the Dozzle application in TrueNAS."
weight:
aliases:
tags:
- dozzle
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://dozzle.dev">Dozzle</a> - Realtime log viewer for docker containers.

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/duplicati.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Duplicati"
description: "Provides installation instructions for the Duplicati application in TrueNAS."
weight:
aliases:
tags:
- duplicati
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://duplicati.com">Duplicati</a> is a backup client that securely stores encrypted backups in the cloud!

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/eclipse-mosquitto.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Eclipse Mosquitto"
description: "Provides installation instructions for the Eclipse Mosquitto application in TrueNAS."
weight:
aliases:
tags:
- eclipse-mosquitto
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://mosquitto.org/">Eclipse Mosquitto</a> is an open source MQTT broker

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/esphome.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "ESPHome"
description: "Provides installation instructions for the ESPHome application in TrueNAS."
weight:
aliases:
tags:
- esphome
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://github.com/esphome/esphome">ESPHome</a> is a system to control your microcontrollers by simple yet powerful configuration files and control them remotely through Home Automation systems.

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/filestash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Filestash"
description: "Provides installation instructions for the Filestash application in TrueNAS."
weight:
aliases:
tags:
- filestash
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://github.com/mickael-kerjean/filestash">Filestash</a> - a file manager / web client

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/gaseous-server.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Gaseous Server"
description: "Provides installation instructions for the Gaseous Server application in TrueNAS."
weight:
aliases:
tags:
- gaseous-server
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://github.com/gaseous-project/gaseous-server">Gaseous-Server</a> - Host your ROMS library and emulate them in-browser.

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/gitea-act-runner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Gitea Act Runner"
description: "Provides installation instructions for the Gitea Act Runner application in TrueNAS."
weight:
aliases:
tags:
- gitea-act-runner
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://gitea.com/gitea/act_runner">Gitea Act Runner</a> is a runner for Gitea based on <a href="https://github.com/nektos/act">act</a>.

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/glances.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Glances"
description: "Provides installation instructions for the Glances application in TrueNAS."
weight:
aliases:
tags:
- glances
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://nicolargo.github.io/glances/">Glances</a> is a cross-platform system monitoring tool.

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/handbrake-web.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Handbrake Web"
description: "Provides installation instructions for the Handbrake Web application in TrueNAS."
weight:
aliases:
tags:
- handbrake-web
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://github.com/TheNickOfTime/handbrake-web">Handbrake Web</a> is a self-hosted platform to use <a href="https://handbrake.fr/">HandBrake</a> on your headless devices via a bespoke web interface.

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/heimdall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Heimdall"
description: "Provides installation instructions for the Heimdall application in TrueNAS."
weight:
aliases:
tags:
- heimdall
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://heimdall.site">Heimdall</a> is an Application dashboard and launcher.

{{< include file="/static/includes/ProposeArticleChange.md" >}}
21 changes: 21 additions & 0 deletions content/TruenasApps/CommunityApps/iconik-storage-gateway.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: "Iconik Storage Gateway"
description: "Provides installation instructions for the Iconik Storage Gateway application in TrueNAS."
weight:
aliases:
tags:
- iconik-storage-gateway
- apps
keywords:
- community storage
- software solutions
- data management
---

{{< include file="/static/includes/apps/CommunityApp.md" >}}

{{< include file="/static/includes/apps/CommunityPleaseExpand.md" >}}

<a href="https://iconik.io">Iconik Storage Gateway</a> is a cloud-native storage gateway for your on-premise storage.

{{< include file="/static/includes/ProposeArticleChange.md" >}}
Loading

0 comments on commit 830d981

Please sign in to comment.