Skip to main content

Community Workshop

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

warning

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.

Workshop deployment​

Workshop is powered by PocketBase. The production image compiles the current Docusaurus site and serves it together with the API from one origin. The deployment lives in apps/workshop/ with a Dockerfile, Compose configuration, version-controlled migrations, hooks, a smoke test, and ACT-local workflow instructions.

Homarr instances use NEXT_PUBLIC_WORKSHOP_API_URL to reach the central API and NEXT_PUBLIC_WORKSHOP_URL for links to the public page. Docusaurus uses WORKSHOP_URL only when its development server runs separately; the combined production image always uses its own origin.