Homarr
AdvancedDeveloper guides

Workshop development

See the main development guide for repository prerequisites.

Start PocketBase:

cp apps/workshop/.env.example apps/workshop/.env
docker compose --env-file apps/workshop/.env -f apps/workshop/docker-compose.yml up --build workshop

Start Fumadocs in another terminal:

WORKSHOP_API_URL=http://127.0.0.1:8090 pnpm dev:docs

PocketBase runs at http://127.0.0.1:8090; create the first superuser under /_/. Workshop is available at http://127.0.0.1:3003/workshop.

To connect a local Homarr instance, set:

HOMARR_WEBSITE_URL=http://127.0.0.1:3003
WORKSHOP_API_URL=http://127.0.0.1:8090
WORKSHOP_WEB_URL=http://127.0.0.1:3003/workshop

Restart the affected development process after changing these variables. See apps/workshop/README.md for OAuth, moderation, tests, and service maintenance.