52 lines
2.1 KiB
Plaintext
52 lines
2.1 KiB
Plaintext
---
|
|
title: Community Workshop
|
|
sidebar_label: Overview
|
|
tags:
|
|
- Workshop
|
|
- Custom Widgets
|
|
- Custom CSS
|
|
---
|
|
|
|
# Community Workshop
|
|
|
|
The [Community Workshop](pathname:///workshop) is where Homarr users share Custom Widgets and dashboard CSS.
|
|
|
|
:::warning Experimental
|
|
|
|
Workshop content is made by the community. Review it before installation and back up your Homarr instance.
|
|
|
|
:::
|
|
|
|
## Find and install content
|
|
|
|
Browse the Workshop by type, date, popularity, or recent activity. Each submission includes its source, screenshots,
|
|
author, revision, comments, and reports.
|
|
|
|
Administrators can install content without leaving Homarr:
|
|
|
|
- **Custom Widgets:** open **Management → Custom Widgets**, then select **Import from Workshop**.
|
|
- **Custom CSS:** open a board's **Settings → Custom CSS**, then select **Import from Workshop**.
|
|
|
|
Homarr shows the complete source and required permissions before installation. Widget credentials are entered in your
|
|
Homarr instance and are never included in a Workshop submission.
|
|
|
|
## Share your work
|
|
|
|
For a saved Custom Widget, open **Management → Custom Widgets**, use its action menu, and select **Publish to
|
|
Workshop**. Review the public listing details and source URLs, then publish the credential-free export. Custom CSS and
|
|
manual submissions can be shared directly from the Workshop website with **Share yours**.
|
|
|
|
Publishing creates the listing immediately. To update or delete it, review reports, or mark it outdated, open the
|
|
Workshop website, sign in, and select **Yours**. Editing a submission does not change its Workshop URL.
|
|
|
|
## Voting, comments, and reports
|
|
|
|
Signed-in users can vote, comment, and report submissions. Authors can edit their own comments and submissions.
|
|
Workshop moderators can review reports, remove comments, and delete unsafe content. Reports do not remove a submission
|
|
automatically.
|
|
|
|
A Workshop moderator manages the public community. This is separate from the administrator role on a Homarr instance.
|
|
|
|
Deployment and server configuration are in the [Workshop operator guide](./operator). Local setup is in
|
|
[Workshop development](./development).
|