Skip to content

Docs: wider prose and a configuration table that fits #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thebuilder merged 2 commits into from
Oct 15, 2026
Merged

Docs: wider prose and a configuration table that fits #66

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
edf7f8e
docs: widen the prose column to 48rem
claude Oct 15, 2026
d70f13c
docs: give provider keys their own table in the configuration reference
claude Oct 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions apps/docs/docs/reference/configuration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Each Umbraco application instance keeps its own in-memory report cache. Restart

Bootstrap connections this way when deployment automation has to create them. Keep access tokens out of this file.

```json
```json appsettings.json
{
"WebAnalytics": {
"Enabled": true,
Expand Down Expand Up @@ -49,17 +49,28 @@ For Plausible, use `"Provider": "Plausible"` and set `SiteId` instead of `Projec

## Package settings

All keys live under the `WebAnalytics` configuration section.

| Key | Default | Description |
| --- | --- | --- |
| `Enabled` | `true` | Enables the Analytics section and configured document workspace views. |
| `EnableMockConnections` | `false` | Turns on deterministic development-only connection presets. Never enable in production. |
| `DefaultRangeDays` | `30` | Initial reporting range, in days. Valid values are 1 to 730. |
| `CacheDuration` | `00:05:00` | Per-instance in-memory cache duration. Valid from zero to one hour. |
| `Connections` | `[]` | Provider connection definitions. The first becomes the initial default. |
| `ConnectionAccessTokens` | Empty | Optional connection-specific credential overrides, keyed by connection GUID. An override takes precedence over the shared provider credential. Set one with `WebAnalytics__ConnectionAccessTokens__{connection-guid}`. |
| `Providers:Vercel:AccessToken` | Empty | Shared Vercel access token. |
| `Providers:Plausible:AccessToken` | Empty | Shared Plausible Stats API key. |
| `Providers:Plausible:BaseUrl` | `https://plausible.io/` | Public base URL of the Plausible Cloud or self-hosted instance. It must expose `/api/v2/query`. |
| `ConnectionAccessTokens` | Empty | Optional connection-specific credential overrides, keyed by connection GUID. An override takes precedence over the shared provider credential. |

Set a connection override with `WebAnalytics__ConnectionAccessTokens__{connection-guid}`.

### Provider settings

These keys live under `WebAnalytics:Providers`.

| Key | Default | Description |
| --- | --- | --- |
| `Vercel:AccessToken` | Empty | Shared Vercel access token. |
| `Plausible:AccessToken` | Empty | Shared Plausible Stats API key. |
| `Plausible:BaseUrl` | `https://plausible.io/` | Public base URL of the Plausible Cloud or self-hosted instance. It must expose `/api/v2/query`. |

## Connection settings

Expand Down
4 changes: 4 additions & 0 deletions apps/docs/theme.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/* The docs family's prose column, a little wider than Blume's 42rem so pages sit better on wide screens. */
:root {
--blume-content-width: 48rem;
}
Loading