fix: Fix configuration documentation errors for DESTINATIONS_WEBHOOK_HEADER_PREFIX and PORTAL_REFERER_URL (#587)

* fix: Fix documentation incorrect information

* fix: Fix default header

* chore: typo

* docs: generate config docs

---------

Co-authored-by: Alex Luong <[email protected]>

Author: alexbouchardd

docs/pages/features/event-delivery.mdx

@@ -33,7 +33,7 @@ The following environment variables can be used to customize the webhook behavio
 
 | Environment Variable                             | Default Value                                          | Required |
 | ------------------------------------------------ | ------------------------------------------------------ | -------- |
-| `DESTINATIONS_WEBHOOK_HEADER_PREFIX`             | `x-`                                                   | No       |
+| `DESTINATIONS_WEBHOOK_HEADER_PREFIX`             | `x-outpost-`                                                   | No       |
 | `DESTINATIONS_WEBHOOK_DISABLE_EVENT_ID_HEADER`   | `false`                                                | No       |
 | `DESTINATIONS_WEBHOOK_DISABLE_SIGNATURE_HEADER`  | `false`                                                | No       |
 | `DESTINATIONS_WEBHOOK_DISABLE_TIMESTAMP_HEADER`  | `false`                                                | No       |

docs/pages/features/tenant-user-portal.mdx

@@ -18,7 +18,7 @@ The portal is a React SPA that is distributed via the API.
 
 ## Required Config
 
-`PORTAL_REFERER_URL` is used to redirect the user when the JWT token is expired or when the user clicks "back".
+`PORTAL_REFERER_URL` is used to redirect the user when the JWT token is expired or when the user clicks 'back'.
 
 `PORTAL_ORGANIZATION_NAME` is used to display the name of the organization deploying the portal.
 

docs/pages/references/configuration.mdx

@@ -93,7 +93,7 @@ Global configurations are provided through env variables or a YAML file. ConfigM
 | `PORTAL_LOGO_DARK` | URL for the dark-mode logo to be displayed in the Outpost Portal. | `nil` | No |
 | `PORTAL_ORGANIZATION_NAME` | Organization name displayed in the Outpost Portal. | `nil` | No |
 | `PORTAL_PROXY_URL` | URL to proxy the Outpost Portal through. If set, Outpost serves the portal assets, and this URL is used as the base. Must be a valid URL. | `nil` | No |
-| `PORTAL_REFERER_URL` | The expected Referer URL for accessing the portal. This is a security measure. Required if the Outpost Portal is enabled/used. Example: 'https://admin.example.com'. | `nil` | Conditional |
+| `PORTAL_REFERER_URL` | The URL where the user is redirected when the JWT token is expired or when the user clicks 'back'. Required if the Outpost Portal is enabled/used. | `nil` | Conditional |
 | `POSTGRES_URL` | Connection URL for PostgreSQL, used for log storage. Example: 'postgres://user:pass@host:port/dbname?sslmode=disable'. | `nil` | Yes |
 | `PUBLISH_AWS_SQS_ACCESS_KEY_ID` | AWS Access Key ID for the SQS publish queue. Required if AWS SQS is the chosen publish MQ provider. | `nil` | Conditional |
 | `PUBLISH_AWS_SQS_ENDPOINT` | Custom AWS SQS endpoint URL for the publish queue. Optional. | `nil` | No |
@@ -452,7 +452,7 @@ portal:
   # URL to proxy the Outpost Portal through. If set, Outpost serves the portal assets, and this URL is used as the base. Must be a valid URL.
   proxy_url: ""
 
-  # The expected Referer URL for accessing the portal. This is a security measure. Required if the Outpost Portal is enabled/used. Example: 'https://admin.example.com'.
+  # The URL where the user is redirected when the JWT token is expired or when the user clicks 'back'. Required if the Outpost Portal is enabled/used.
   # Required: Conditional
   referer_url: ""
 

examples/demos/dashboard-integration/README.md

@@ -184,7 +184,7 @@ For detailed implementation guidance with code examples, see **[INTEGRATION_DETA
 | `RABBITMQ_SERVER_URL`      | RabbitMQ connection                                   | `amqp://guest:guest@rabbitmq:5672`                 |
 | `TOPICS`                   | Available event topics (comma-separated)             | `user.created,order.completed,payment.processed`   |
 | `PORTAL_ORGANIZATION_NAME` | Portal branding                                       | `API Platform Demo`                                |
-| `PORTAL_REFERER_URL`       | Dashboard URL for "Back to" navigation link in portal | `http://localhost:3000`                            |
+| `PORTAL_REFERER_URL`       | The URL where the user is redirected when the JWT token is expired or when the user clicks 'back'. Required if the Outpost Portal is enabled/used. | `http://localhost:3000`                            |
 
 ## Docker Services
 
@@ -294,4 +294,4 @@ This demo demonstrates several integration patterns:
 - Form validation with user-friendly error messages
 - API error responses with appropriate HTTP status codes
 - Loading states and skeleton screens for data fetching
-- Fallback UI for failed API calls
+- Fallback UI for failed API calls

internal/config/portal.go

@@ -9,7 +9,7 @@ import (
 
 type PortalConfig struct {
 	ProxyURL               string `yaml:"proxy_url" env:"PORTAL_PROXY_URL" desc:"URL to proxy the Outpost Portal through. If set, Outpost serves the portal assets, and this URL is used as the base. Must be a valid URL." required:"N"`
-	RefererURL             string `yaml:"referer_url" env:"PORTAL_REFERER_URL" desc:"The expected Referer URL for accessing the portal. This is a security measure. Required if the Outpost Portal is enabled/used. Example: 'https://admin.example.com'." required:"C"`
+	RefererURL             string `yaml:"referer_url" env:"PORTAL_REFERER_URL" desc:"The URL where the user is redirected when the JWT token is expired or when the user clicks 'back'. Required if the Outpost Portal is enabled/used." required:"C"`
 	FaviconURL             string `yaml:"favicon_url" env:"PORTAL_FAVICON_URL" desc:"URL for the favicon to be used in the Outpost Portal." required:"N"`
 	BrandColor             string `yaml:"brand_color" env:"PORTAL_BRAND_COLOR" desc:"Primary brand color (hex code) for theming the Outpost Portal (e.g., '#6122E7'). Also referred to as Accent Color in some contexts." required:"N"`
 	Logo                   string `yaml:"logo" env:"PORTAL_LOGO" desc:"URL for the light-mode logo to be displayed in the Outpost Portal." required:"N"`