This documentation is for Speckle Enterprise customers only.:Please note that these configuration are not yet supported in all connectors.
Please contact your Speckle representative for more information.:
Please contact your Speckle representative for more information.:
Disable Update Notifications
When an update is available, users will see a notification in the connector’s UI, prompting them to update. For IT managed environments where the end-user is not empowered to update connectors via our exe installers, then these notifications can be disabled by writing a registry key in eitherHKEY_CURRENT_USER\Software\Speckle\Connector Config\Global or HKEY_LOCAL_MACHINE\Software\Speckle\Connector Config\Global, or as an environment variable.
- Value name:
SPECKLE_IS_UPDATE_NOTIFICATION_DISABLED - Value type:
REG_SZ - Value data:
True
Self-hosting Speckle Server
Configures the default Speckle server URL when authenticating a connector. This will default to ourhttps://app.speckle.systems unless configured otherwise.
Regardless of configuration users are able to authenticate any account with any compatible Speckle Server.
This configuration can be written to either HKEY_CURRENT_USER\Software\Speckle\Connector Config\Global or HKEY_LOCAL_MACHINE\Software\Speckle\Connector Config\Global, or as an environment variable.
- Value name:
SPECKLE_DEFAULT_SPECKLE_SERVER_URL - Value type:
REG_SZ - Value data:
https://speckle.myenterprise.example(replace with the url of your speckle server deployment)
Self-hosting Desktop UI
Connectors will load our official UI deploymenthttps://dui.speckle.systems unless configured otherwise.
For enterprise customers who are licenced to self host Desktop UI,
this configuration can be written to either HKEY_CURRENT_USER\Software\Speckle\Connector Config\Global or HKEY_LOCAL_MACHINE\Software\Speckle\Connector Config\Global, or as an environment variable.
- Value name:
SPECKLE_DUI_URL - Value type:
REG_SZ - Value data:
https://dui.myenterprise.example(replace with url of your ui deployment)
Self-hosting OpenTelemetry Collector / ClickStack
Connectors by default will send telemetry to Speckle’s internal OpenTelemetry collector. For enterprise customers who are self hosting their server and Desktop UI, you may prefer for connector telemetry to go to your own collector. This configuration can be written to eitherHKEY_CURRENT_USER\Software\Speckle\Connector Config\Global or HKEY_LOCAL_MACHINE\Software\Speckle\Connector Config\Global, or as an environment variable.
- Value name:
SPECKLE_OTEL_EXPORTER_OTLP_ENDPOINT - Value type:
REG_SZ - Value data:
https://collector.speckle.myenterprise.example(replace with URL of your OTel collector or ClickStack deployment) - Value name:
SPECKLE_OTEL_EXPORTER_OTLP_HEADERS - Value type:
REG_SZ - Value data:
authorization=asdfasdfasdfasdfasdf(replace with your OTel ingestion token)
SPECKLE_OTEL_EXPORTER_OTLP_LOGS_ENDPOINT and SPECKLE_OTEL_EXPORTER_OTLP_TRACES_ENDPOINT,
and SPECKLE_OTEL_EXPORTER_OTLP_TRACES_HEADERS and SPECKLE_OTEL_EXPORTER_OTLP_LOGS_HEADERS individually.
SPECKLE_OTEL_ENABLED can be set to false to disable OTel entirely.
Please note these configurations only affect logs/traces from
.NET connectors (speckle-sharp-connectors).
Independently, Desktop UI also produces OTel telemetry,
your Desktop UI instance should be configured separately in order to send OTel telemetry to the same collector.