Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/API/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Starting with Unraid 7.2, the API is integrated directly into the operating syst

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

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).
1. Install the [Unraid Connect](../unraid-connect/overview-and-setup.mdx) plugin from [Community Applications](/community-applications/).
2. [Configure the plugin](./how-to-use-the-api.mdx#enabling-the-graphql-sandbox).
3. Access API functionality through the %%GraphQL|graphql%% Sandbox.

Expand Down
2 changes: 1 addition & 1 deletion docs/API/partials/get-started-pre72.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@


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).
1. Install the [Unraid Connect](../../unraid-connect/overview-and-setup.mdx) plugin from [Community Applications](/community-applications/).
2. No Unraid Connect login required for local API access.
3. Configure the plugin settings.
4. Enable the %%GraphQL|graphql%% Sandbox.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
sidebar_position: 2
sidebar_position: 1.5
sidebar_label: Community Applications
---

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

# Community Applications

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.

- **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).
- **Plugins** enhance Unraid OS itself. For more information about plugins, visit the [Plugins](../customize-your-experience/plugins.mdx) page.
- **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).
- **Plugins** enhance Unraid OS itself. For more information about plugins, visit the [Plugins](./unraid-os/using-unraid-to/customize-your-experience/plugins.mdx) page.

:::caution

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

To install the Community Applications plugin:

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

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

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.
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.

---

## Contributing your own applications

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/).
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.

### Submission requirements

To ensure quality and maintainability, all submissions must:

- Include a dedicated support thread on the [Unraid forums](https://forums.unraid.net/).
- Provide clear documentation for installation, configuration, and troubleshooting.
- Use open-source licensing unless the application requires proprietary components.
- Avoid conflicts with core Unraid functionality or existing community applications.

Submissions are reviewed by the Community Applications moderation team, which performs basic vetting for security, functionality, and adherence to Unraid’s design principles.
<div style={{ display: 'flex', justifyContent: 'center', margin: '2rem 0' }}>
<a
className="button button--primary button--lg"
href="https://ca.unraid.net/submit"
style={{ fontSize: '1.25rem', padding: '1rem 2rem' }}
>
Submit a Community App
</a>
</div>

### Maintenance expectations

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

### Publishing workflow

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.
If you're a developer interested in publishing an application, the submission portal guides you through repository preparation, validation, scanning, and review.

1. Prepare your application's template files and documentation.
2. Create a support thread in the [Unraid forums](https://forums.unraid.net/).
3. Submit your application via the [Community Applications submission form](https://form.asana.com/?k=qtIUrf5ydiXvXzPI57BiJw\&d=714739274360802).
4. The moderation team typically reviews submissions within 48 hours.
1. Review the [submission help](https://ca.unraid.net/submit/help).
2. Submit your application at [ca.unraid.net/submit](https://ca.unraid.net/submit).
2 changes: 1 addition & 1 deletion docs/docs-home.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The [Unraid Forums](https://forums.unraid.net/) are the heart of the Unraid comm
### Official resources

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

### Support options
Expand Down
2 changes: 1 addition & 1 deletion docs/unraid-connect/overview-and-setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Unraid Connect is more than just an add-on; it's an essential extension of the U

## Installation

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.
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.

To install Unraid Connect:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ The %%WebGUI|web-gui%% is the primary interface for managing and configuring you

## The Navigation Bar

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).
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/).

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

### 1. Dashboard

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.
![Dashboard tab](/img/dashboard.png)
You can enhance the Dashboard with plugins from [Community Applications](../../using-unraid-to/run-docker-containers/community-applications.mdx)
You can enhance the Dashboard with plugins from [Community Applications](/community-applications/)

### 2. Main

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

:::note

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

:::

### 7. Docker

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.
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.

:::note

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

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

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).
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/).

### 10. Tools

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ The Scheduler settings page allows you to easily configure the frequency for aut

## User utilities

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.
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.

---

Expand Down
2 changes: 1 addition & 1 deletion docs/unraid-os/getting-started/what-is-unraid.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Unraid features a [user-friendly web interface](./explore-the-user-interface/tou
2. **Image-based Deployment** - Preconfigured application packages allow for one-click installation and complete uninstallation of applications.
3. **Process Isolation** - Containerized applications operate in separate user spaces, preventing any conflicts between software.

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.
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.

:::note
For advanced Docker settings, check out [Run Docker Containers](../using-unraid-to/run-docker-containers/managing-and-customizing-containers.mdx).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ This script allows for comprehensive surface-level performance testing with visu

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

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.
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.

</details>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ For more details, see [Microsoft's documentation on SMB guest access](https://le
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.

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

### Review and minimize port forwarding
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Machine names in HTTPS certificates are public. Use names you’re comfortable s
The following steps are current and accurate for Unraid 7 and later:

1. Review your Tailscale account settings as described above.
2. In Unraid, search the [**Community Apps**](../../using-unraid-to/run-docker-containers/community-applications.mdx) tab for the official %%Tailscale|tailscale%% plugin and install it.
2. In Unraid, search the [**Community Apps**](/community-applications/) tab for the official %%Tailscale|tailscale%% plugin and install it.
3. Open ***Settings → Tailscale*** and click Reauthenticate. Sign in with your %%Tailscale|tailscale%% account.
4. Click **Connect** to add your Unraid server to your %%Tailnet|tailnet%%.
5. Visit ***Settings → Management Access*** to see your %%Tailscale|tailscale%% URLs for the %%WebGUI|web-gui%%.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Before you install a plugin, think about these aspects:

You can manage plugins from the **Plugins** tab in the Unraid **%%WebGUI|web-gui%%**.

If a plugin is available in **[Community Applications](../run-docker-containers/community-applications.mdx)**, installing it from the **Apps** tab is recommended for extra vetting and compatibility checks.
If a plugin is available in **[Community Applications](/community-applications/)**, installing it from the **Apps** tab is recommended for extra vetting and compatibility checks.

:::note

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This page is written to help users of all skill levels make the most out of Dock

:::

Before customizing a Docker container in Unraid, it’s helpful to understand the basic configuration options. Each [container template](./community-applications.mdx) provides a user-friendly interface for setting up networking, storage, and environment variables, allowing you to tailor the container's behavior to your needs without using complex command-line tools.
Before customizing a Docker container in Unraid, it’s helpful to understand the basic configuration options. Each [container template](/community-applications/) provides a user-friendly interface for setting up networking, storage, and environment variables, allowing you to tailor the container's behavior to your needs without using complex command-line tools.

<Tabs>
<TabItem value="network-type" label="Network type" default>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Unraid’s Docker integration is designed to be user-friendly for everyone. Each

The Community Applications plugin is the easiest and most popular way to discover, install, and manage both Docker containers and plugins on your Unraid server. It provides an app store-like experience directly in the Unraid %%WebGUI|web-gui%%, making it simple to browse and deploy a wide range of community-maintained applications.

For a complete guide to installing and using the Community Applications plugin, including advanced features and troubleshooting, check out [Community Applications](./community-applications.mdx).
For a complete guide to installing and using the Community Applications plugin, including advanced features and troubleshooting, check out [Community Applications](/community-applications/).

:::note[Notes and Support]

Expand Down
8 changes: 6 additions & 2 deletions docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,11 @@ const config: Config = {
},
{
from: "/unraid-os/manual/applications/",
to: "/unraid-os/using-unraid-to/run-docker-containers/community-applications/",
to: "/community-applications/",
},
{
from: "/unraid-os/using-unraid-to/run-docker-containers/community-applications/",
to: "/community-applications/",
},
{
from: "/unraid-os/manual/changing-the-flash-device/",
Expand Down Expand Up @@ -776,7 +780,7 @@ const config: Config = {
},
{
from: "/go/applications/",
to: "/unraid-os/using-unraid-to/run-docker-containers/community-applications/",
to: "/community-applications/",
},
{
from: "/go/backing-up-your-flash-drive/",
Expand Down
Loading