Thomas
6ea7a6ff09
* Add Homarr provider proxy foundation * Complete Homarr provider integration * Harden Homarr provider integration * Address Homarr provider review feedback * Address CodeRabbit provider feedback * Localize provider errors * Handle provider activity load failures * docs: improve workshop and homepage * Harden Homarr provider limits * fix: harden the Homarr provider * fix: address provider review feedback * fix: clarify provider request accounting * feat: complete the Homarr provider endpoint * fix: terminate invalid provider streams
54 lines
1.9 KiB
Plaintext
54 lines
1.9 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
|
|
|
|
1. Sign in to the Workshop with GitHub.
|
|
2. Select **Share yours**.
|
|
3. Choose **Custom Widget** or **Custom CSS**.
|
|
4. Add the source, a short description, screenshots, and a changelog.
|
|
5. Review and publish the submission.
|
|
|
|
Export Custom Widget JSON from **Management → Custom Widgets → Export**. You can edit a submission later without
|
|
changing 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).
|