Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -59,14 +59,12 @@ To enable Nexus in your deployment:
```

2. Set the required dynamic configuration
1. **Prior to version 1.30.X**, you must enable Nexus through dynamic config, set the public callback URL, and set the allowed callback addresses.
1. **Prior to version 1.30.X**, you must set the public callback URL and the allowed callback addresses.

**NOTE**: the callback endpoint template and allowed addresses should be set when using the experimental
"external" endpoint targets.

```yaml
system.enableNexus:
- value: true
component.nexusoperations.callback.endpoint.template:
# The URL must be publicly accessible if the callback is meant to be called by external services.
# When using Nexus for cross namespace calls, the URL's host is irrelevant as the address is resolved using
Expand Down
2 changes: 1 addition & 1 deletion docs/references/dynamic-configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ For more detailed explanation of these configs see the [in-repo Nexus architectu

| Dynamic configuration key | Type | Description | Default value |
| ------------------------------------------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------- |
| `system.enableNexus` | Boolean | Enables Nexus Features | `true` (since 1.27) |
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or do we keep these around for older versions?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keep this please.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But mention that the config is deleted in 1.31.0.

| `system.enableNexus` | Boolean | Enables Nexus Features. Removed in 1.31.0 (Nexus is always enabled). | `true` (since 1.27) |
| `component.nexusoperations.useSystemCallbackURL` | String | Controls whether to use temporal://system as the callback URL generated by the server. (Server 1.30 or newer) | `false` |
| `component.nexusoperations.callback.endpoint.template` | String | Defines the URL template used to construct Nexus callback URLs. (Only required for the experimental external endpoint target feature or servers older than 1.30.) | unset |
| `component.callbacks.allowedAddresses` | Object | Defines the security allow-list of callback URL patterns that the server will accept; used to restrict what callback endpoints can be invoked. (Only required for the experimental external endpoint target feature or servers older than 1.30.) | unset |
Loading