62 lines
2.7 KiB
Plaintext
62 lines
2.7 KiB
Plaintext
---
|
|
tags:
|
|
- Workshop
|
|
- Custom Widgets
|
|
- Custom CSS
|
|
---
|
|
|
|
# Community Workshop
|
|
|
|
The [Community Workshop](pathname:///workshop) is where Homarr users share and discover
|
|
**custom CSS themes** and **custom widgets**. You can browse submissions, upvote the ones
|
|
you like, report abuse, and install entries directly into your own Homarr instance.
|
|
|
|
:::warn
|
|
|
|
The workshop contains community-made content. Widgets may contain unwanted or malicious content and it is your duty to check & verify safety of the content. While we try to remove malicious content as best as we can, we take no responsibility. Always review the widget JSON and all CSS before installing it on your instance and take frequent backups as prevention measures.
|
|
|
|
:::
|
|
|
|
## Browsing and voting
|
|
|
|
- Filter by **Widgets** or **CSS**, and sort by **Top rated** or **Newest**.
|
|
- Sign in with **GitHub** to upvote/downvote, submit your own creations, or report a submission.
|
|
- Each submission shows its title, description, author, version, an optional screenshot, and the full content.
|
|
|
|
## Submitting
|
|
|
|
1. Sign in with GitHub.
|
|
2. Click **Submit** and choose the type:
|
|
- **Custom widget** — paste the JSON exported from **Manage → Custom Widgets → Export**.
|
|
It must match the `homarr-custom-widget-v2` schema (validated before submission).
|
|
- **Custom CSS** — paste your stylesheet (max 16384 characters).
|
|
3. Add a title, description, optional screenshot, and changelog, then submit.
|
|
|
|
Submissions are published immediately. Reported entries are reviewed and may be removed.
|
|
|
|
## Submission guidelines
|
|
|
|
Submissions must be useful to Homarr users and safe to install. Do not submit content that is
|
|
malicious, deceptive, illegal, hateful, sexually explicit, gore, gambling-focused, spam, or content
|
|
that primarily promotes unrelated products or services.
|
|
|
|
## Installing into Homarr
|
|
|
|
You can install workshop entries without leaving Homarr:
|
|
|
|
- **Custom widgets** — go to **Manage → Custom Widgets**, click **Install from Workshop**, pick an
|
|
entry, and it is imported (secrets such as API keys must be re-entered afterwards).
|
|
- **Custom CSS** — open a board's **Settings → Custom CSS**, click **Install from Workshop**, and
|
|
pick a theme to load it into the editor before saving.
|
|
|
|
Alternatively, use **Copy** (or **Download** for widgets) on any submission and import it
|
|
manually.
|
|
|
|
## Self-hosting the workshop backend
|
|
|
|
The workshop is powered by a [PocketBase](https://pocketbase.io) instance (GitHub OAuth, database,
|
|
file uploads, and an admin moderation dashboard). The deployment lives in `apps/store/` with a
|
|
`docker-compose.yml`, version-controlled collection migrations, and vote-counter hooks. See the
|
|
app's `README.md` for GitHub OAuth setup and the `STORE_URL` / `NEXT_PUBLIC_WIDGET_STORE_URL`
|
|
configuration.
|