Skip to content

A modern and easy to use dashboard. 80+ integrations. 20K+ icons built in. Authentication out of the box. No YAML, drag and drop configuration.

chore(workshop): align image tags with main and dev

ajnartb093382d40c2
diff --git a/.github/workflows/workshop.yml b/.github/workflows/workshop.yml
index aff27071c..a3b010b5f 100644
--- a/.github/workflows/workshop.yml
+++ b/.github/workflows/workshop.yml
@@ -25,7 +25,7 @@ on:
- "bunfig.toml"
- "turbo.json"
push:
- branches: [dev, v2, release/v2, main]
+ branches: [dev, main]
paths:
- ".github/workflows/workshop.yml"
- "tooling/github/**"
@@ -49,11 +49,13 @@ on:
- "bunfig.toml"
- "turbo.json"
+ workflow_dispatch:
+
permissions:
contents: read
concurrency:
- group: ${{ github.workflow }}-${{ (github.ref_name == 'v2' || github.ref_name == 'release/v2') && 'v2-preview' || github.ref }}
+ group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
@@ -121,7 +123,7 @@ jobs:
- run: docker compose --env-file apps/workshop/.env.staging.example -f apps/workshop/docker-compose.staging.yml config --quiet
publish-amd64:
- if: github.event_name == 'push' && (github.ref_name == 'v2' || github.ref_name == 'release/v2' || github.ref_name == 'main')
+ if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && (github.ref_name == 'dev' || github.ref_name == 'main')
needs: validate
runs-on: ubuntu-24.04
timeout-minutes: 20
@@ -156,7 +158,7 @@ jobs:
TURBO_REMOTE_CACHE_SIGNATURE_KEY=${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
publish-arm64:
- if: github.event_name == 'push' && (github.ref_name == 'v2' || github.ref_name == 'release/v2' || github.ref_name == 'main')
+ if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && (github.ref_name == 'dev' || github.ref_name == 'main')
needs: validate
runs-on: ubuntu-24.04-arm
timeout-minutes: 20
@@ -191,7 +193,7 @@ jobs:
TURBO_REMOTE_CACHE_SIGNATURE_KEY=${{ secrets.TURBO_REMOTE_CACHE_SIGNATURE_KEY }}
publish:
- if: github.event_name == 'push' && (github.ref_name == 'v2' || github.ref_name == 'release/v2' || github.ref_name == 'main')
+ if: (github.event_name == 'push' || github.event_name == 'workflow_dispatch') && (github.ref_name == 'dev' || github.ref_name == 'main')
needs: [publish-amd64, publish-arm64]
runs-on: ubuntu-24.04
timeout-minutes: 5
@@ -226,11 +228,11 @@ jobs:
ARM64_DIGEST: ${{ needs.publish-arm64.outputs.digest }}
run: |
tags=(-t "${WORKSHOP_IMAGE}:sha-${GITHUB_SHA}")
- if [[ "${GITHUB_REF_NAME}" == "v2" || "${GITHUB_REF_NAME}" == "release/v2" ]]; then
- tags+=(-t "${WORKSHOP_IMAGE}:v2")
+ if [[ "${GITHUB_REF_NAME}" == "dev" ]]; then
+ tags+=(-t "${WORKSHOP_IMAGE}:dev")
fi
if [[ "${GITHUB_REF_NAME}" == "main" ]]; then
- tags+=(-t "${WORKSHOP_IMAGE}:latest")
+ tags+=(-t "${WORKSHOP_IMAGE}:latest" -t "${WORKSHOP_IMAGE}:v2")
fi
docker buildx imagetools create "${tags[@]}" \
"${WORKSHOP_IMAGE}@${AMD64_DIGEST}" \
diff --git a/apps/docs/docs/advanced/development/workshop-operator.mdx b/apps/docs/docs/advanced/development/workshop-operator.mdx
index b36ba4ce6..f0075b730 100644
--- a/apps/docs/docs/advanced/development/workshop-operator.mdx
+++ b/apps/docs/docs/advanced/development/workshop-operator.mdx
@@ -80,8 +80,9 @@ fees can still apply to BYOK requests. Streaming responses include upstream toke
## Deployment
-The v2 image is `ghcr.io/homarr-labs/workshop:v2`; immutable `sha-<commit>` tags are preferable for promotion. The
-service listens on port 8090.
+The Workshop image includes the documentation site. Use `ghcr.io/homarr-labs/workshop:latest` for stable builds from
+`main`, or `:dev` for development builds from `dev`. The `:v2` tag is a compatibility alias for stable builds.
+Immutable `sha-<commit>` tags are preferable for promotion. The service listens on port 8090.
When using a reverse proxy, forward the complete hostname, including `/api`, `/_/`, and
`/workshop-runtime-config.js`. Use a dedicated hostname when Homarr already occupies the intended origin.
diff --git a/apps/docs/docs/advanced/environment-variables/index.mdx b/apps/docs/docs/advanced/environment-variables/index.mdx
index 0474ef6c1..f88e5fae7 100644
--- a/apps/docs/docs/advanced/environment-variables/index.mdx
+++ b/apps/docs/docs/advanced/environment-variables/index.mdx
@@ -53,21 +53,21 @@ Workshop service operators can find its server-only configuration in the
These variables configure the separate Workshop service, not the Homarr application container.
-| Environment Variable | Description | Default |
-| ------------------------------------------- | ------------------------------------------------------------------------- | --------------------------------- |
-| `WORKSHOP_PUBLIC_ORIGIN` | Public origin used in PocketBase links and email | Required in production |
-| `PB_ALLOWED_ORIGINS` | Browser origins allowed to call PocketBase | `*` for the public community |
-| `WORKSHOP_IMAGE` | Workshop image used by the staging Compose file | `ghcr.io/homarr-labs/workshop:v2` |
-| `WORKSHOP_EXPOSE_PORT` | Host port for the combined staging service | `8090` |
-| `PB_EXPOSE_PORT` | Host port for local PocketBase development | `8090` |
-| `DOCS_EXPOSE_PORT` | Host port for local documentation development | `3003` |
-| `GITHUB_CLIENT_ID` / `GITHUB_CLIENT_SECRET` | Optional GitHub OAuth application credentials | - |
-| `OPENROUTER_API_KEY` | Server-only upstream key that enables the Homarr Assistant provider | Provider disabled |
-| `HOMARR_AI_DAILY_REQUEST_LIMIT` | Daily Assistant request units per user | `50` |
-| `HOMARR_AI_GLOBAL_DAILY_REQUEST_LIMIT` | Daily Assistant request units shared by all users | `10000` |
-| `HOMARR_AI_OPENROUTER_BASE_URL` | OpenRouter-compatible provider endpoint | `https://openrouter.ai/api/v1` |
-| `HOMARR_AI_OPENROUTER_MODEL` | OpenRouter model exposed through `homarr/model` | `openai/gpt-6-luna` |
-| `HOMARR_AI_ALLOW_INSECURE_UPSTREAM` | Allows an HTTP upstream for local provider tests; never use in production | `false` |
+| Environment Variable | Description | Default |
+| ------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------- |
+| `WORKSHOP_PUBLIC_ORIGIN` | Public origin used in PocketBase links and email | Required in production |
+| `PB_ALLOWED_ORIGINS` | Browser origins allowed to call PocketBase | `*` for the public community |
+| `WORKSHOP_IMAGE` | Workshop image used by the staging Compose file | `ghcr.io/homarr-labs/workshop:latest` |
+| `WORKSHOP_EXPOSE_PORT` | Host port for the combined staging service | `8090` |
+| `PB_EXPOSE_PORT` | Host port for local PocketBase development | `8090` |
+| `DOCS_EXPOSE_PORT` | Host port for local documentation development | `3003` |
+| `GITHUB_CLIENT_ID` / `GITHUB_CLIENT_SECRET` | Optional GitHub OAuth application credentials | - |
+| `OPENROUTER_API_KEY` | Server-only upstream key that enables the Homarr Assistant provider | Provider disabled |
+| `HOMARR_AI_DAILY_REQUEST_LIMIT` | Daily Assistant request units per user | `50` |
+| `HOMARR_AI_GLOBAL_DAILY_REQUEST_LIMIT` | Daily Assistant request units shared by all users | `10000` |
+| `HOMARR_AI_OPENROUTER_BASE_URL` | OpenRouter-compatible provider endpoint | `https://openrouter.ai/api/v1` |
+| `HOMARR_AI_OPENROUTER_MODEL` | OpenRouter model exposed through `homarr/model` | `openai/gpt-6-luna` |
+| `HOMARR_AI_ALLOW_INSECURE_UPSTREAM` | Allows an HTTP upstream for local provider tests; never use in production | `false` |
## Authentication
diff --git a/apps/workshop/.env.staging.example b/apps/workshop/.env.staging.example
index 552c9bcf4..0f4c7268c 100644
--- a/apps/workshop/.env.staging.example
+++ b/apps/workshop/.env.staging.example
@@ -1,4 +1,4 @@
-WORKSHOP_IMAGE=ghcr.io/homarr-labs/workshop:v2
+WORKSHOP_IMAGE=ghcr.io/homarr-labs/workshop:latest
WORKSHOP_EXPOSE_PORT=8090
HOMARR_WEBSITE_URL=https://v2.preview.homarr.dev
diff --git a/apps/workshop/docker-compose.staging.yml b/apps/workshop/docker-compose.staging.yml
index 4620fdfb7..4a4dd1966 100644
--- a/apps/workshop/docker-compose.staging.yml
+++ b/apps/workshop/docker-compose.staging.yml
@@ -2,7 +2,7 @@ name: homarr-workshop-staging
services:
workshop:
- image: ${WORKSHOP_IMAGE:-ghcr.io/homarr-labs/workshop:v2}
+ image: ${WORKSHOP_IMAGE:-ghcr.io/homarr-labs/workshop:latest}
restart: unless-stopped
environment:
HOMARR_WEBSITE_URL: ${HOMARR_WEBSITE_URL:?Set HOMARR_WEBSITE_URL in the Workshop environment file}