Skip to content

Commit ad802ee

Browse files
authored
feat: Promote Community Apps submission entrypoint (#481)
## Summary Promotes Community Applications to a root-level docs page positioned above Unraid Connect, with redirects from the old nested route and the existing `/go/applications/` and manual applications redirects updated to the new `/community-applications/` path. Updates docs home Community Applications resource links to use `/community-applications/` so users land on the new docs entrypoint before jumping to external app catalog workflows. Updates the Community Applications contribution section to make `https://ca.unraid.net/submit` the canonical submission entrypoint, with a prominent centered CTA button. The detailed submission guidance remains on the CA portal as the single source of truth. Fixes the Community Applications install instructions to tell users to navigate to the **Apps** tab instead of the **Plugins** tab. ## Impact Community Applications is easier to find in the primary docs navigation, existing internal and Go links now point to the new root page, and old nested URLs continue to redirect. ## Validation - `pnpm exec remark docs/community-applications.mdx docs/API/index.mdx docs/API/partials/get-started-pre72.mdx docs/unraid-connect/overview-and-setup.mdx docs/unraid-os/getting-started/explore-the-user-interface/tour-the-web-gui.mdx docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx docs/unraid-os/getting-started/what-is-unraid.mdx docs/unraid-os/system-administration/advanced-tools/command-line-interface.mdx docs/unraid-os/system-administration/secure-your-server/security-fundamentals.mdx docs/unraid-os/system-administration/secure-your-server/tailscale.mdx docs/unraid-os/using-unraid-to/customize-your-experience/plugins.mdx docs/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx docs/unraid-os/using-unraid-to/run-docker-containers/overview.mdx --quiet --frail` - `pnpm exec remark docs/docs-home.mdx docs/community-applications.mdx --quiet --frail` - `node scripts/check-case-sensitivity.js` - `pnpm exec prettier --check docusaurus.config.ts` - `rg -n "community-applications\.mdx|unraid-os/using-unraid-to/run-docker-containers/community-applications|l\.onglet|form\.asana" docs i18n docusaurus.config.ts static || true` Full build intentionally not run per repo guidance.
1 parent 30eeb5c commit ad802ee

76 files changed

Lines changed: 164 additions & 163 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/API/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Starting with Unraid 7.2, the API is integrated directly into the operating syst
3131

3232
For Unraid versions prior to 7.2, or to access newer API features:
3333

34-
1. Install the [Unraid Connect](../unraid-connect/overview-and-setup.mdx) plugin from [Community Applications](../unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx).
34+
1. Install the [Unraid Connect](../unraid-connect/overview-and-setup.mdx) plugin from [Community Applications](/community-applications/).
3535
2. [Configure the plugin](./how-to-use-the-api.mdx#enabling-the-graphql-sandbox).
3636
3. Access API functionality through the %%GraphQL|graphql%% Sandbox.
3737

docs/API/partials/get-started-pre72.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11

22

3-
1. Install the [Unraid Connect](../../unraid-connect/overview-and-setup.mdx) plugin from [Community Applications](../../unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx).
3+
1. Install the [Unraid Connect](../../unraid-connect/overview-and-setup.mdx) plugin from [Community Applications](/community-applications/).
44
2. No Unraid Connect login required for local API access.
55
3. Configure the plugin settings.
66
4. Enable the %%GraphQL|graphql%% Sandbox.

docs/unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx renamed to docs/community-applications.mdx

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
2-
sidebar_position: 2
2+
sidebar_position: 1.5
33
sidebar_label: Community Applications
44
---
55

66
import Tabs from '@theme/Tabs';
77
import TabItem from '@theme/TabItem';
8-
import CommunityAppsInstalling from './partials/community-apps-installing.mdx';
9-
import CommunityAppsRemoving from './partials/community-apps-removing.mdx';
10-
import CommunityAppsReinstalling from './partials/community-apps-reinstalling.mdx';
8+
import CommunityAppsInstalling from './unraid-os/using-unraid-to/run-docker-containers/partials/community-apps-installing.mdx';
9+
import CommunityAppsRemoving from './unraid-os/using-unraid-to/run-docker-containers/partials/community-apps-removing.mdx';
10+
import CommunityAppsReinstalling from './unraid-os/using-unraid-to/run-docker-containers/partials/community-apps-reinstalling.mdx';
1111

1212
# Community Applications
1313

1414
Community Applications provides a curated catalog of over 2,000 free Docker containers and plugins maintained by the Unraid community. Each container or plugin lets your server take on new roles, such as running a media server, dynamic DNS client, or backup solution.
1515

16-
- **Docker containers** are lightweight packages that include everything needed to run an application, keeping it isolated from the rest of your %%array|array%% and %%cache pool|cache-pool%%. Learn more about [array configuration](../manage-storage/array/overview.mdx) and [cache pools](../manage-storage/cache-pools.mdx).
17-
- **Plugins** enhance Unraid OS itself. For more information about plugins, visit the [Plugins](../customize-your-experience/plugins.mdx) page.
16+
- **Docker containers** are lightweight packages that include everything needed to run an application, keeping it isolated from the rest of your %%array|array%% and %%cache pool|cache-pool%%. Learn more about [array configuration](./unraid-os/using-unraid-to/manage-storage/array/overview.mdx) and [cache pools](./unraid-os/using-unraid-to/manage-storage/cache-pools.mdx).
17+
- **Plugins** enhance Unraid OS itself. For more information about plugins, visit the [Plugins](./unraid-os/using-unraid-to/customize-your-experience/plugins.mdx) page.
1818

1919
:::caution
2020

@@ -41,7 +41,7 @@ Clicking on an app provides more details, support links, and installation option
4141

4242
To install the Community Applications plugin:
4343

44-
1. Open the %%WebGUI|web-gui%% and navigate to the **Plugins** tab.
44+
1. Open the %%WebGUI|web-gui%% and navigate to the **Apps** tab.
4545
2. Click on **Install**.
4646

4747
<div style={{ margin: 'auto', maxWidth: '714px', display: 'flex', flexDirection: 'column', alignItems: 'center' }}>
@@ -106,24 +106,23 @@ The **Action Center** is located within the **Apps** tab in the %%WebGUI|web-gui
106106
- **Incompatible applications**: Applications that may not work with your current Unraid version
107107
- **Blacklisted applications**: Applications that have been removed from the catalog for security or compatibility reasons
108108

109-
When you access the Action Center, you'll see alerts for any applications requiring attention. To update an application, click on Actions for the app that needs updating, and then select **Update** to run the update script. Regular updates are essential for maintaining the security, stability, and compatibility of your Unraid installation. See [Updating Unraid](../../updating-unraid/index.mdx) for more information.
109+
When you access the Action Center, you'll see alerts for any applications requiring attention. To update an application, click on Actions for the app that needs updating, and then select **Update** to run the update script. Regular updates are essential for maintaining the security, stability, and compatibility of your Unraid installation. See [Updating Unraid](./unraid-os/updating-unraid/index.mdx) for more information.
110110

111111
---
112112

113113
## Contributing your own applications
114114

115-
The **Community Applications** ecosystem thrives on contributions from the Unraid community. Whether you’re developing applications or plugins, your work can help others enhance their Unraid servers. Below are guidelines for submitting your creations, based on the [official policies](https://forums.unraid.net/topic/87144-ca-application-policies-notes/).
115+
The **Community Applications** ecosystem thrives on contributions from the Unraid community. Whether you’re developing applications or plugins, your work can help others enhance their Unraid servers. The [Community Apps submission portal](https://ca.unraid.net/submit) is the source of truth for submission requirements, repository XML guidance, supported fields, and the current publishing workflow.
116116

117-
### Submission requirements
118-
119-
To ensure quality and maintainability, all submissions must:
120-
121-
- Include a dedicated support thread on the [Unraid forums](https://forums.unraid.net/).
122-
- Provide clear documentation for installation, configuration, and troubleshooting.
123-
- Use open-source licensing unless the application requires proprietary components.
124-
- Avoid conflicts with core Unraid functionality or existing community applications.
125-
126-
Submissions are reviewed by the Community Applications moderation team, which performs basic vetting for security, functionality, and adherence to Unraid’s design principles.
117+
<div style={{ display: 'flex', justifyContent: 'center', margin: '2rem 0' }}>
118+
<a
119+
className="button button--primary button--lg"
120+
href="https://ca.unraid.net/submit"
121+
style={{ fontSize: '1.25rem', padding: '1rem 2rem' }}
122+
>
123+
Submit a Community App
124+
</a>
125+
</div>
127126

128127
### Maintenance expectations
129128

@@ -144,9 +143,7 @@ The moderation team reserves the right to remove applications that become incomp
144143

145144
### Publishing workflow
146145

147-
If you're a developer interested in contributing to the Unraid community by publishing your application, this workflow ensures quality control and provides users with reliable, well-documented applications.
146+
If you're a developer interested in publishing an application, the submission portal guides you through repository preparation, validation, scanning, and review.
148147

149-
1. Prepare your application's template files and documentation.
150-
2. Create a support thread in the [Unraid forums](https://forums.unraid.net/).
151-
3. Submit your application via the [Community Applications submission form](https://form.asana.com/?k=qtIUrf5ydiXvXzPI57BiJw\&d=714739274360802).
152-
4. The moderation team typically reviews submissions within 48 hours.
148+
1. Review the [submission help](https://ca.unraid.net/submit/help).
149+
2. Submit your application at [ca.unraid.net/submit](https://ca.unraid.net/submit).

docs/docs-home.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ The [Unraid Forums](https://forums.unraid.net/) are the heart of the Unraid comm
2929
### Official resources
3030

3131
- **[Unraid homepage](https://unraid.net/)** - Product information, downloads, and licensing
32-
- **[Community Applications](https://unraid.net/community/apps)** - Browse and install plugins and Docker containers
32+
- **[Community Applications](/community-applications/)** - Browse and install plugins and Docker containers
3333
- **[Unraid Connect](https://connect.myunraid.net/)** - Remote management dashboard
3434

3535
### Support options

docs/unraid-connect/overview-and-setup.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ Unraid Connect is more than just an add-on; it's an essential extension of the U
6868

6969
## Installation
7070

71-
Unraid Connect is available as a plugin that requires Unraid OS 6.10 or later. Before you start, make sure your server is connected to the internet and you have the [Community Applications](../unraid-os/using-unraid-to/run-docker-containers/community-applications.mdx) plugin installed.
71+
Unraid Connect is available as a plugin that requires Unraid OS 6.10 or later. Before you start, make sure your server is connected to the internet and you have the [Community Applications](/community-applications/) plugin installed.
7272

7373
To install Unraid Connect:
7474

docs/unraid-os/getting-started/explore-the-user-interface/tour-the-web-gui.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ The %%WebGUI|web-gui%% is the primary interface for managing and configuring you
88

99
## The Navigation Bar
1010

11-
The horizontal navigation bar gives users access to the main functional areas of the Unraid system. You can customize it with plugins to add extra menus and options, available in the [Community Applications section](../../using-unraid-to/run-docker-containers/community-applications.mdx).
11+
The horizontal navigation bar gives users access to the main functional areas of the Unraid system. You can customize it with plugins to add extra menus and options, available in the [Community Applications section](/community-applications/).
1212

1313
![Navigation Bar - Annotated](/img/navbar3.png)
1414

1515
### 1. Dashboard
1616

1717
The **Dashboard** tab provides real-time monitoring of hardware and software components on your Unraid server. It displays various aspects of management - such as system identification, CPU, RAM, storage, network information, Containers, %%VMs|vm%%, users, and shares - in a grid of tiles.
1818
![Dashboard tab](/img/dashboard.png)
19-
You can enhance the Dashboard with plugins from [Community Applications](../../using-unraid-to/run-docker-containers/community-applications.mdx)
19+
You can enhance the Dashboard with plugins from [Community Applications](/community-applications/)
2020

2121
### 2. Main
2222

@@ -55,13 +55,13 @@ The **Plugins** screen shows all the plugins installed on your Unraid server.
5555

5656
:::note
5757

58-
For plugin installation steps, see [Community Applications](../../using-unraid-to/run-docker-containers/community-applications.mdx).
58+
For plugin installation steps, see [Community Applications](/community-applications/).
5959

6060
:::
6161

6262
### 7. Docker
6363

64-
The **Docker** screen displays all containers installed from [Community Applications](../../using-unraid-to/run-docker-containers/community-applications.mdx). You can launch, stop, and configure each container, including their auto-start settings.
64+
The **Docker** screen displays all containers installed from [Community Applications](/community-applications/). You can launch, stop, and configure each container, including their auto-start settings.
6565

6666
:::note
6767

@@ -85,7 +85,7 @@ The **Apps** screen, or "Community Applications," is the official source for Unr
8585

8686
![Apps tab](/img/appstab.png)
8787

88-
It provides community-sourced plugins and Docker containers that enhance Unraid’s functionality beyond a basic NAS. For more details, check the [Community Applications section](../../using-unraid-to/run-docker-containers/community-applications.mdx).
88+
It provides community-sourced plugins and Docker containers that enhance Unraid’s functionality beyond a basic NAS. For more details, check the [Community Applications section](/community-applications/).
8989

9090
### 10. Tools
9191

docs/unraid-os/getting-started/set-up-unraid/customize-unraid-settings.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@ The Scheduler settings page allows you to easily configure the frequency for aut
454454

455455
## User utilities
456456

457-
Third-party plugins are displayed here, enhancing Unraid’s functionality and giving you more control over your server. For example, the [Community Applications plugin](../../using-unraid-to/run-docker-containers/community-applications.mdx) is included. Other plugins offer features for system monitoring, maintenance, storage management, and `appdata` backups.
457+
Third-party plugins are displayed here, enhancing Unraid’s functionality and giving you more control over your server. For example, the [Community Applications plugin](/community-applications/) is included. Other plugins offer features for system monitoring, maintenance, storage management, and `appdata` backups.
458458

459459
---
460460

docs/unraid-os/getting-started/what-is-unraid.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ Unraid features a [user-friendly web interface](./explore-the-user-interface/tou
109109
2. **Image-based Deployment** - Preconfigured application packages allow for one-click installation and complete uninstallation of applications.
110110
3. **Process Isolation** - Containerized applications operate in separate user spaces, preventing any conflicts between software.
111111

112-
Docker containers allow you to run applications in isolated, lightweight environments without the overhead associated with %%virtual machines|vm%%. Unraid simplifies the use of Docker by providing access to thousands of pre-configured apps through [Docker Hub](https://hub.docker.com/) and [Community Applications](../using-unraid-to/run-docker-containers/community-applications.mdx). This containerized approach enables Unraid users to run multiple applications simultaneously without compatibility issues. It also helps keep the system organized by using self-contained application packages and makes it easy to enhance server capabilities through Docker's ecosystem.
112+
Docker containers allow you to run applications in isolated, lightweight environments without the overhead associated with %%virtual machines|vm%%. Unraid simplifies the use of Docker by providing access to thousands of pre-configured apps through [Docker Hub](https://hub.docker.com/) and [Community Applications](/community-applications/). This containerized approach enables Unraid users to run multiple applications simultaneously without compatibility issues. It also helps keep the system organized by using self-contained application packages and makes it easy to enhance server capabilities through Docker's ecosystem.
113113

114114
:::note
115115
For advanced Docker settings, check out [Run Docker Containers](../using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx).

docs/unraid-os/system-administration/advanced-tools/command-line-interface.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ This script allows for comprehensive surface-level performance testing with visu
101101

102102
This used to be a script you would download from the Unraid forums. DiskSpeed is available now in a more refined package:
103103

104-
Install DiskSpeed from [Community Applications](../../using-unraid-to/run-docker-containers/community-applications.mdx) (***Apps tab***) by searching for "DiskSpeed", or visit the [GitHub repository](https://github.com/jbartlett777/DiskSpeed) for manual installation instructions.
104+
Install DiskSpeed from [Community Applications](/community-applications/) (***Apps tab***) by searching for "DiskSpeed", or visit the [GitHub repository](https://github.com/jbartlett777/DiskSpeed) for manual installation instructions.
105105

106106
</details>
107107

docs/unraid-os/system-administration/secure-your-server/security-fundamentals.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ For more details, see [Microsoft's documentation on SMB guest access](https://le
9898
When you first access the %%WebGUI|web-gui%% after install, you are required to set a password for the %%root user|root-user%%. However, Unraid does not enforce password complexity requirements - it's up to you as the user to set the degree of password security for your server.
9999

100100
- Go to the **Users** tab, select the %%root user|root-user%%, and set a password.
101-
- Consider using the **Dynamix Password Validator** plugin from [Community Apps](../../using-unraid-to/run-docker-containers/community-applications.mdx) for real-time strength feedback.
101+
- Consider using the **Dynamix Password Validator** plugin from [Community Apps](/community-applications/) for real-time strength feedback.
102102
- For additional guidance, check out the [Bitwarden password strength tool](https://bitwarden.com/) provided online.
103103

104104
### Review and minimize port forwarding

0 commit comments

Comments
 (0)