OneCX Service Smart Redirect

Configuration

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

onecx.redirect.host-forward-rules."host-forward-rules".host-pattern

Regex matched against the incoming request host.

Environment variable: ONECX_REDIRECT_HOST_FORWARD_RULES__HOST_FORWARD_RULES__HOST_PATTERN

string

required

onecx.redirect.host-forward-rules."host-forward-rules".host-replace-pattern

Replacement pattern for the host regex match. Supports capture groups: use ($groupName) or $1, $2, etc. for group replacement. Example: if hostPattern is "(.*)\\.old-domain\\.com" and hostReplacePattern is "$1.new-domain.com", a request to "api.old-domain.com" redirects to "api.new-domain.com".

Environment variable: ONECX_REDIRECT_HOST_FORWARD_RULES__HOST_FORWARD_RULES__HOST_REPLACE_PATTERN

string

required

onecx.redirect.host-forward-rules."host-forward-rules".protocol-replace-pattern

Optional replacement pattern for the target protocol (e.g. "https"). If not provided, the original request protocol is used.

Environment variable: ONECX_REDIRECT_HOST_FORWARD_RULES__HOST_FORWARD_RULES__PROTOCOL_REPLACE_PATTERN

string

onecx.redirect.rules.mode

combined: host forwarding and path rewrite are applied in one flow. separate: host forwarding and path rewrite are evaluated independently.

Environment variable: ONECX_REDIRECT_RULES_MODE

combined, separate

combined

onecx.redirect.rules.redirect-wait-seconds

Redirect wait time in seconds.

Environment variable: ONECX_REDIRECT_RULES_REDIRECT_WAIT_SECONDS

int

10

onecx.redirect.url-rewrite-rules."url-rewrite-rules".pattern

Regex pattern tested against window.location.href (including fragment) in the browser.

Environment variable: ONECX_REDIRECT_URL_REWRITE_RULES__URL_REWRITE_RULES__PATTERN

string

required

onecx.redirect.url-rewrite-rules."url-rewrite-rules".replace-pattern

Replace-pattern to rewrite the URL. Use ($groupName) to reference named capture groups.

Environment variable: ONECX_REDIRECT_URL_REWRITE_RULES__URL_REWRITE_RULES__REPLACE_PATTERN

string

required

onecx.redirect.custom-redirect-template-path

File path to custom redirect template

Environment variable: ONECX_REDIRECT_CUSTOM_REDIRECT_TEMPLATE_PATH

string

onecx.redirect.bundled-redirect-template-name

Bundled redirect template name loaded from classpath templates. Example: redirectWaitTemplate.html.

Environment variable: ONECX_REDIRECT_BUNDLED_REDIRECT_TEMPLATE_NAME

string

onecx.redirect.custom-fallback-template-path

File path to custom fallback template

Environment variable: ONECX_REDIRECT_CUSTOM_FALLBACK_TEMPLATE_PATH

string

Link to Docker registry

Default properties

src/main/resources/application.properties 
tkit.security-dynamic-test.openapi.enabled=false

Extensions

Extensions List

Extensions

Documentation

Configuration

Version

quarkus-rest

Link

Link

3.33.1

quarkus-rest-jackson

Link

3.33.1

tkit-quarkus-log-cdi

Link

Link

5.1.0

tkit-quarkus-log-rs

Link

Link

5.1.0

tkit-quarkus-log-json

Link

Link

5.1.0

tkit-quarkus-rest

Link

Link

5.1.0

tkit-quarkus-rest-context

Link

Link

5.1.0

quarkus-smallrye-health

Link

Link

3.33.1

quarkus-opentelemetry

Link

Link

3.33.1

quarkus-micrometer-registry-prometheus

Link

Link

3.33.1

tkit-quarkus-security

Link

Link

5.1.0

onecx-core

Link

3.0.0

quarkus-arc

Link

Link

3.33.1

quarkus-container-image-docker

Link

Link

3.33.1

quarkus-qute

3.33.1

Helm

Link to Helm registry

Default values in src/main/helm/values.yaml
app:
  name: svc
  image:
    repository: "onecx/onecx-service-redirect"