From 266d1299f7c5b8f0558adcf9d2c6202f768c7015 Mon Sep 17 00:00:00 2001 From: Daniel Schmidt Date: Fri, 31 Jul 2026 10:26:05 +0200 Subject: [PATCH 1/2] docs: use code group for provider secrets --- apps/docs/docs/getting-started.mdx | 44 ++++++++++++++---------------- 1 file changed, 21 insertions(+), 23 deletions(-) diff --git a/apps/docs/docs/getting-started.mdx b/apps/docs/docs/getting-started.mdx index 4709c40..087d255 100644 --- a/apps/docs/docs/getting-started.mdx +++ b/apps/docs/docs/getting-started.mdx @@ -19,29 +19,27 @@ The package registers its services and backoffice extensions automatically. Buil Create a read-only credential with access to the provider account or site being connected. Add it to the application's secret configuration—not `appsettings.json` and never source control. Restart every Umbraco application instance after adding or rotating the credential. - - - Create a Vercel access token with read access to the project. Configure it as `WebAnalytics__Providers__Vercel__AccessToken`, then use the project's ID as the connection identifier in Umbraco. Add the team ID only when the project belongs to a Vercel team. - - For local development, use either a shell environment variable or .NET user secrets: - - ```sh - dotnet user-secrets init --project path/to/Your.Umbraco.Web.csproj - dotnet user-secrets set "WebAnalytics:Providers:Vercel:AccessToken" "your_token" --project path/to/Your.Umbraco.Web.csproj - ``` - - - Create a Plausible Stats API key with access to the site. Configure it as `WebAnalytics__Providers__Plausible__AccessToken`, then use the site's exact domain as the connection identifier in Umbraco. For a self-hosted instance, also configure `WebAnalytics__Providers__Plausible__BaseUrl` with its public base URL. The instance must expose `/api/v2/query`. - - For local development, use either a shell environment variable or .NET user secrets: - - ```sh - dotnet user-secrets init --project path/to/Your.Umbraco.Web.csproj - dotnet user-secrets set "WebAnalytics:Providers:Plausible:AccessToken" "your_stats_api_key" --project path/to/Your.Umbraco.Web.csproj - dotnet user-secrets set "WebAnalytics:Providers:Plausible:BaseUrl" "https://analytics.example.com/" --project path/to/Your.Umbraco.Web.csproj - ``` - - +Choose the provider that already collects your site analytics: + +- **Vercel** — Create an access token with read access to the project. Configure it as `WebAnalytics__Providers__Vercel__AccessToken`, then use the project's ID as the connection identifier in Umbraco. Add the team ID only when the project belongs to a Vercel team. +- **Plausible** — Create a Stats API key with access to the site. Configure it as `WebAnalytics__Providers__Plausible__AccessToken`, then use the site's exact domain as the connection identifier in Umbraco. For a self-hosted instance, also configure `WebAnalytics__Providers__Plausible__BaseUrl` with its public base URL. The instance must expose `/api/v2/query`. + +For local development, use either a shell environment variable or .NET user secrets: + + + +```sh Vercel +dotnet user-secrets init --project path/to/Your.Umbraco.Web.csproj +dotnet user-secrets set "WebAnalytics:Providers:Vercel:AccessToken" "your_token" --project path/to/Your.Umbraco.Web.csproj +``` + +```sh Plausible +dotnet user-secrets init --project path/to/Your.Umbraco.Web.csproj +dotnet user-secrets set "WebAnalytics:Providers:Plausible:AccessToken" "your_stats_api_key" --project path/to/Your.Umbraco.Web.csproj +dotnet user-secrets set "WebAnalytics:Providers:Plausible:BaseUrl" "https://analytics.example.com/" --project path/to/Your.Umbraco.Web.csproj +``` + + Use the equivalent secret or app-setting facility in your hosting platform. From 23d49e5dad58bc9bbd814676aece0f5a83b04e04 Mon Sep 17 00:00:00 2001 From: Daniel Schmidt Date: Fri, 31 Jul 2026 10:37:40 +0200 Subject: [PATCH 2/2] docs: simplify provider setup intro --- apps/docs/docs/getting-started.mdx | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/apps/docs/docs/getting-started.mdx b/apps/docs/docs/getting-started.mdx index 087d255..df264be 100644 --- a/apps/docs/docs/getting-started.mdx +++ b/apps/docs/docs/getting-started.mdx @@ -19,10 +19,7 @@ The package registers its services and backoffice extensions automatically. Buil Create a read-only credential with access to the provider account or site being connected. Add it to the application's secret configuration—not `appsettings.json` and never source control. Restart every Umbraco application instance after adding or rotating the credential. -Choose the provider that already collects your site analytics: - -- **Vercel** — Create an access token with read access to the project. Configure it as `WebAnalytics__Providers__Vercel__AccessToken`, then use the project's ID as the connection identifier in Umbraco. Add the team ID only when the project belongs to a Vercel team. -- **Plausible** — Create a Stats API key with access to the site. Configure it as `WebAnalytics__Providers__Plausible__AccessToken`, then use the site's exact domain as the connection identifier in Umbraco. For a self-hosted instance, also configure `WebAnalytics__Providers__Plausible__BaseUrl` with its public base URL. The instance must expose `/api/v2/query`. +Choose the provider that already collects your site analytics. Use the [Vercel](/providers/vercel) or [Plausible](/providers/plausible) guide for its credential, connection identifier, and any provider-specific setup. For local development, use either a shell environment variable or .NET user secrets: