github melosso/portway v0.13.0

42 minutes ago

Caution

Evaluate before upgrading production. This release requires .NET 11 GA and removes deprecated configuration names.

Portway v0.13.0 adds a secret store for environments and signed webhooks from common providers. Clients receive current data after a write.

Before you upgrade

  1. Portway requires the .NET 11 runtime (GA). Docker images and Linux packages include the runtime. Portway v0.12.0 targets .NET 11 RC3.
  2. The API and the console listen on separate ports. The API port is 8080 (PORTWAY_PORT_API, Hosting:ApiPort). The console port is 8081 (PORTWAY_PORT_CONSOLE, Hosting:ConsolePort). On the API port, /_/* and /index.html return 404 and / redirects to /docs. The console port serves every path. Portway ignores --urls, ASPNETCORE_URLS and ASPNETCORE_HTTP_PORTS.
  3. The API and the console can share one port. Set PORTWAY_PORT_API and PORTWAY_PORT_CONSOLE to the same value. On IIS, the site binding sets the port.
  4. An unreachable backend returns 503. An unreachable database, proxy upstream or webhook database returns 503 with Database unavailable or Upstream unavailable and a traceId. Clients and monitors that match on 500 for an outage require an update.
  5. A failed composite step returns the Portway error description. details contains the Portway description of the failure, for example Upstream returned HTTP 400. Portway writes the upstream body to the Debug log. Clients that read the upstream error from details require an update.
  6. Endpoint saves refuse files the gateway cannot load. A console or API save returns 400 with every error, for example a proxy without Url, an invalid namespace or webhook verification that rejects every delivery.
  7. Portway ignores removed configuration names. Startup logs one error per former name, with the current name. Mcp:RequireAuthentication and Mcp:AppsEnabled have no replacement. See removed keys.
  8. Environment variables use one naming pattern. The section prefix is first, and switches end in _ENABLED, for example PORTWAY_CONSOLE_ENABLED. Portway reads the former names and logs one deprecation warning per name. If both names are set: the current name applies. See environment variables.
  9. Webhook endpoints require AllowedColumns. A webhook endpoint without AllowedColumns does not load.
  10. Environment authentication methods without AllowedEndpoints have access to every endpoint of the environment. Startup logs a warning for each of these methods. AllowedEndpoints limits a method to specific endpoints.
  11. Back up settings.json before a downgrade. Portway v0.12.0 deletes the Secrets section on save.

Changes

  • Security: Dependencies are updated.
  • Security: The traffic log excludes webhook payloads.
  • Security: Requests with a secret follow redirects to the same host. Portway returns redirects to other hosts to the client.
  • Security: Basic and Bearer environment authentication refuse an empty configured value.
  • Security: The console sign-in form rejects a resubmitted request.
  • Security: A token that repeatedly exceeds its rate limit is blocked for longer each time, up to 1 hour.
  • Security: The console requires a per-request nonce for inline scripts.
  • Security: Proxy endpoints drop client query parameters with an encoded reserved or credential name.
  • Feature: Environments store secrets, encrypted on disk. ${secret:NAME} references a secret in connection strings, headers, authentication, proxy URLs and composite templates. The console sets and deletes secrets and displays no values. Azure Key Vault values take precedence when configured.
  • Feature: Webhook endpoints verify deliveries from GitHub, Stripe, Slack, Shopify, Jira, Mollie and ShipHero, and from any sender that uses HMAC, a shared secret or Standard Webhooks. Slack URL verification requires no extra setup.
  • Feature: Deduplicate stores each webhook delivery once. A sender retry returns 200 and creates no extra row.
  • Feature: The console displays the latest 50 webhook deliveries per environment to administrators, under Endpoints.
  • Feature: Webhooks accept JSON subtypes, such as application/cloudevents+json, and form posts with AcceptForm.
  • Feature: Headers in a proxy entity.json add or replace upstream headers for one endpoint. Composite steps send these headers.
  • Feature: The SQL endpoint editor has a Caching section. CacheInvalidatedBy contains the tables that invalidate the cached reads of a view or procedure.
  • Feature: Prometheus and OpenTelemetry count stored, duplicate and refused webhook deliveries.
  • Feature: The console webhook form edits each webhook ID with its verification mode. Presets display the signature header and delivery ID of each provider.
  • Feature: The Secrets page displays every secret name per environment, the endpoints that reference each secret, and references without a value.
  • Feature: Clients receive current data after a write. Unchanged data returns 304 Not Modified.
  • Feature: The console endpoint editor opens with the main settings of the endpoint. Lifecycle and empty metadata are collapsed. The URL contains the selected endpoint: back, reload and links open that endpoint. On phones, the list and the editor are separate screens.
  • Feature: Console endpoint forms mark invalid fields inline. Environments are chosen from the allowed list.
  • Feature: Endpoint saves display a warning for each referenced secret without a value.
  • Feature: Startup warns when the response cache is in memory. Use Redis for more than one instance.
  • Feature: Startup logs the API and console URLs.
  • Feature: Endpoint saves display a warning for a misconfigured table write mode.
  • Feature: The console endpoint form contains the write mode and proxy security settings.
  • Feature: The console Tokens page filters tokens by status.
  • Feature: The console uses IBM Plex. Sign-in, landing page and console share one theme setting.
  • Fix: SQL writes return 400 for a value that does not match the column type. PostgreSQL date and time columns accept date strings.
  • Fix: A webhook delivery now returns 201 with Webhook stored.
  • Fix: A webhook URL with extra path segments or a quoted ID returns 404.
  • Fix: Filtering or sorting on a related table (Category/Name) returns 400. Use $expand for related rows.
  • Fix: If Azure Key Vault is unreachable, Portway uses the last value it read, for up to 1 hour.
  • Fix: An empty or malformed JSON body returns 400 on SQL and webhook endpoints.
  • Fix: SQL writes clear cached reads of the same table for every endpoint.
  • Fix: Startup connects only to databases of allowed environments.
  • Fix: Requests to an environment with an unreadable settings.json or a missing secret return 500.
  • Fix: The API reference at /docs uses Scalar 1.77.0 with corrected styling.
  • Fix: The Landing page switch applies. / opens the landing page for local browsers and /docs for other browsers.
  • Fix: With OpenApi:Enabled set to false, / returns 404.
  • Fix: Console endpoint saves preserve formatting, documentation fields, MERGE and DeprecatedSince. A save the gateway cannot load returns 400.
  • Fix: The Expose in MCP switch sets Mcp.Exposed. Saving an endpoint removes the unused IsMcpExposed key.
  • Fix: The console composite form contains the required URL field. A composite created in the console loads.
  • Fix: The console endpoint editor saves to the selected endpoint after a fast switch, and closes the rename field on a switch. The settings page asks before a refresh discards unsaved changes.
  • Fix: A webhook endpoint stays available while its file is being saved.
  • Fix: Console form controls have accessible names. The Delete button meets the contrast minimum.
  • Fix: Environment tooltips in the console display on hover. The sidebar displays the signed-in account on every page.
  • Fix: Proxy requests send the correct method and body on every redirect.
  • Fix: If a secret of an environment authentication method has no value: Portway tries the next method.
  • Fix: SQL writes to float and real columns parse values at the column precision.
  • Fix: Console session cookies are unique per instance. Instances on one host have separate sign-ins. The upgrade signs out every console user.
  • Fix: The console will now refuse to deactivate the currently signed-in account.
  • Fix: Token history and the console audit log include rotated and archived tokens.
  • Fix: The console requests confirmation for sign-out and navigation with unsaved changes.
  • Fix: Console script and style URLs change with each file version. Browsers load no outdated console files.
  • Fix: The 404 page and setup guide links apply the route prefix.

Setup guide: documentation.

Full changelog: v0.12.0...v0.13.0

Don't miss a new portway release

NewReleases is sending notifications on new releases.