Phase 3 Task 9. docker-dev rig: central-1/2 carry ConfigServe (:4055 h2c + committed dev key) and stay Direct; the four site nodes carry ConfigSource (both central endpoints + matching key) defaulting to Direct. Flip only the site nodes with OTOPCUA_CONFIG_MODE=FetchAndCache at 'docker compose up' — central keeps SQL and models the target topology. Binding :4055 activates the dedicated-h2c Kestrel takeover on central (re-binds :9000 too). Docs: new docs/Configuration.md ConfigSource/ConfigServe section; docs/Redundancy.md 'config bytes travel out-of-band' note; the program plan Phase 3 section + tracking row flipped to CODE-COMPLETE; a CLAUDE.md 'Config source' section. Claude-Session: https://claude.ai/code/session_01GASWkNEi68FSCtvr6rLoEW
28 KiB
Configuration Reference
v3 in progress (Batch 1 landed — schema + RawPath identity). The config DB schema was replaced by the greenfield v3 model: a driver-centric Raw tree (
Cluster → RawFolder → DriverInstance → Device → TagGroup → Tag) plus a reference-only UNS projection (UnsTagReference). A tag's identity is now its RawPath (<Folder/…>/<Driver>/<Device>/<TagGroup/…>/<Tag>), not aTagConfig.FullNameblob; theNamespace/NamespaceKind/EquipmentImportBatchentities are retired, and connection endpoints moved fromDriverConfiginto eachDevice'sDeviceConfig. The two OPC UA namespaces (ns=Raw/ns=UNS) and the/rawauthoring UI arrive in later v3 batches; Batch 1 leaves the address space deliberately dark (drivers connect, but no tag variables materialize yet). Theappsettings*.jsonsurface below is unchanged. Full design:docs/plans/2026-07-15-raw-uns-two-subtree-v3-design.md.
This is the live configuration reference for the OtOpcUa Host (src/Server/ZB.MOM.WW.OtOpcUa.Host/). It enumerates the appsettings*.json sections, the bound Options classes, and the OTOPCUA_* / sim-endpoint environment variables — every entry grounded in source.
Two related concerns get their own dedicated pages and are only summarised + linked here, not duplicated:
- Transport security, OPC UA authentication, LDAP, data-/control-plane authorization →
security.md - Redundancy + the
Clustersection →Redundancy.md
How configuration is layered
The Host (Program.cs) loads appsettings.json, then overlays a per-role file chosen from the cluster roles:
- A single role →
appsettings.{role}.json(e.g.appsettings.driver.json,appsettings.admin.json). - Both roles →
appsettings.admin-driver.json(roles joined with-, ordinal-sorted). appsettings.{ASPNETCORE_ENVIRONMENT}.json(e.g.appsettings.Development.json) is layered on by the host builder.
All role overlays are optional — the base appsettings.json plus the Options-class C# defaults are enough to boot. The roles themselves come from the OTOPCUA_ROLES env var (see ServiceHosting.md and the table below).
The checked-in appsettings*.json files are deliberately thin: they carry only Serilog and the Security:Ldap overlay. Everything else (OpcUa, Cluster, ConnectionStrings/ConfigDb) binds from the Options-class defaults documented below unless an operator adds the section explicitly or supplies the corresponding environment variable.
appsettings sections
Serilog
- Purpose: logging. Console + rolling daily file sink, layered with the shared
ZB.MOM.WW.Telemetryenrichers (AddZbSeriloginProgram.cs). - Where bound:
builder.AddZbSerilog(...)readsSerilogfrom configuration (ReadFrom.Configuration). - Checked-in shape (
appsettings.json):Using=[ "Serilog.Sinks.Console", "Serilog.Sinks.File" ],WriteTo= aConsolesink and aFilesink (path: logs/otopcua-.log,rollingInterval: Day). Role overlays addMinimumLevel/Overrideblocks (e.g.Opc.Ua: Debug,Akka: Information).
OpcUa
- Purpose: the OPC UA server endpoint identity, listening port, PKI, transport-security profiles, and redundancy peer advertising.
- Options class:
OpcUaApplicationHostOptions—src/Server/ZB.MOM.WW.OtOpcUa.OpcUaServer/OpcUaApplicationHost.cs. - Bound by:
AddValidatedOptions<OpcUaApplicationHostOptions, OpcUaApplicationHostOptionsValidator>(config, "OpcUa")inProgram.cs(driver-role only). Validated fail-fast at startup byOpcUaApplicationHostOptionsValidator(src/Server/ZB.MOM.WW.OtOpcUa.Host/Configuration/OpcUaApplicationHostOptionsValidator.cs).
| Key | Type | Default | Meaning |
|---|---|---|---|
ApplicationName |
string | OtOpcUa |
Server application name. Required (validated). |
ApplicationUri |
string | urn:OtOpcUa |
Server application URI. Must be unique per redundancy node. Required. |
ProductUri |
string | https://zb.com/otopcua |
Product URI. Not validated. |
OpcUaPort |
int | 4840 |
Binary endpoint listen port. Validated as a port. |
PublicHostname |
string | 0.0.0.0 |
Hostname/IP advertised in endpoint descriptions. Required. |
ApplicationConfigPath |
string? | null |
Optional path to an application config XML; loaded instead of building from defaults. |
PkiStoreRoot |
string | pki |
Root of the PKI hierarchy (own/issuer/trusted/rejected substores created under it). Required. See security.md. |
EnabledSecurityProfiles |
list of OpcUaSecurityProfile |
[None, Basic256Sha256Sign, Basic256Sha256SignAndEncrypt] |
Transport-security profiles, one endpoint per entry. Must contain ≥1. Profile detail in security.md. |
AutoAcceptUntrustedClientCertificates |
bool | false |
Auto-trust unknown client certs on first connect (dev convenience). Not validated. See security.md. |
PeerApplicationUris |
list of string | [] (empty) |
Partner node ApplicationUris published in Server.ServerArray for redundancy discovery. See Redundancy.md. |
Transport security profiles (the values in
EnabledSecurityProfiles—None,Basic256Sha256Sign,Basic256Sha256SignAndEncrypt) and the PKI trust flow are documented in full insecurity.md. This page does not duplicate them.
Security
- Purpose: Admin-UI and OPC UA authentication. Three subsections, each its own Options class:
| Subsection | Options class (SectionName) |
Purpose |
|---|---|---|
Security:Ldap |
LdapOptions — src/Server/ZB.MOM.WW.OtOpcUa.Security/Ldap/LdapOptions.cs |
LDAP bind for Admin cookie login + OPC UA UserName tokens. Bound by AddValidatedOptions<LdapOptions, LdapOptionsValidator> in Program.cs. |
Security:Jwt |
JwtOptions — src/Server/ZB.MOM.WW.OtOpcUa.Security/Jwt/JwtOptions.cs |
Signing config for the JWT minted at /auth/token for external consumers (OPC UA clients / automation). |
Security:Cookie |
OtOpcUaCookieOptions — src/Server/ZB.MOM.WW.OtOpcUa.Security/CookieOptions.cs |
The Admin-UI auth cookie (AddOtOpcUaAuth copies these onto CookieAuthenticationOptions). |
Security:Ldap — see security.md for the full field-by-field reference and bind-flow. The checked-in role overlays set only DevStubMode and Transport; the remaining LdapOptions fields (Enabled, Server, Port, AllowInsecure, SearchBase, ServiceAccountDn, ServiceAccountPassword, GroupAttribute, DisplayNameAttribute, UserNameAttribute, GroupToRole) are covered there.
Security:Jwt key fields (JwtOptions):
| Key | Type | Default | Meaning |
|---|---|---|---|
SigningKey |
string | "" |
HS256 signing key; must be ≥32 bytes UTF-8. Set from your secret store — never commit a value. |
Issuer |
string | otopcua |
JWT issuer. |
Audience |
string | otopcua |
JWT audience. |
ExpiryMinutes |
int | 15 |
Token lifetime. |
Security:Cookie key fields (OtOpcUaCookieOptions):
| Key | Type | Default | Meaning |
|---|---|---|---|
Name |
string | ZB.MOM.WW.OtOpcUa.Auth |
Auth cookie name. Changing it invalidates existing sessions on next deploy. |
ExpiryMinutes |
int | 30 |
Idle sliding-window length. |
RequireHttpsCookie |
bool | true |
SecurePolicy = Always. Set false only for plain-HTTP local dev (emits a startup Warning). |
Authentication, data-plane authorization (
NodeAcl/PermissionTrie), and control-plane Admin roles are all insecurity.md.
Cluster
- Purpose: Akka.NET cluster identity, transport, and roles — the backbone of redundancy.
- Options class:
AkkaClusterOptions(SectionName = "Cluster") —src/Core/ZB.MOM.WW.OtOpcUa.Cluster/AkkaClusterOptions.cs. Bound byAddOtOpcUaCluster(config)inProgram.cs.
| Key | Type | Default | Meaning |
|---|---|---|---|
SystemName |
string | otopcua |
Akka actor-system name. |
Hostname |
string | 0.0.0.0 |
Bind hostname. |
Port |
int | 4053 |
Cluster transport port. Duplicated as ClusterNode.AkkaPort in the Config DB — see the note below. |
PublicHostname |
string | 127.0.0.1 |
Hostname advertised in cluster gossip; must be reachable by peers. Duplicated as ClusterNode.Host — see the note below. |
SeedNodes |
string[] | [] |
Seed nodes for bootstrapping. Ordered: a node that appears in its own list must be entry 0 (only seed-nodes[0] can form a new cluster), or the host refuses to start — see Redundancy.md § Bootstrap: self-first seed ordering. |
Roles |
string[] | [] |
Cluster roles for this node. When empty, falls back to OTOPCUA_ROLES. Allowed values: admin, driver, dev. |
The full redundancy model (ServiceLevel tiers, split-brain, peer discovery) is in
Redundancy.md. The OPC UA peer-URI advertising lives in theOpcUa:PeerApplicationUriskey above.
Port/PublicHostnameare stored twice. The node binds from these keys; the fleet'sClusterNoderow records the same address asAkkaPort/Hostso that central can dial the node without sharing a gossip ring with it — which is what per-cluster mesh Phase 2 needs. Nothing in the schema makes the two agree, soClusterNodeAddressReconcilerActor(admin-role singleton) compares them against live membership and logs an Error on mismatch. If you changeCluster:PortorCluster:PublicHostnameon a node, update itsClusterNoderow too — a node binding 4054 with a row saying 4053 still gossips fine today, and fails silently in Phase 2. The row'sNodeIdishost:portand is also the deploy path's ack identity, so a drifted node's deployment acks stop matching as well. Seeconfig-db-schema.md§ClusterNode.
MeshTransport (central↔node command transport)
- Purpose: selects how central's three command channels (
deployments,driver-control,alarm-commands) and the node'sdeployment-acksreply reach the other side — over the mesh-wide DistributedPubSub, or over an AkkaClusterClientthat does not require central and the node to share a gossip ring. The second option is what per-cluster mesh Phase 6 needs once the meshes split. - Options class:
MeshTransportOptions(SectionName = "MeshTransport") —src/Core/ZB.MOM.WW.OtOpcUa.Cluster/MeshTransportOptions.cs. Bound and validated byAddOtOpcUaCluster(config);MeshTransportOptionsValidatorruns atValidateOnStart.
| Key | Type | Default | Meaning |
|---|---|---|---|
Mode |
string | Dps |
Dps = DistributedPubSub (the transport this repo has always used). ClusterClient = the mesh boundary. Any other value refuses to start. |
CentralContactPoints |
string[] | [] |
Node-side only: central node addresses (akka.tcp://<system>@<host>:<port>). Required under ClusterClient, ignored under Dps. |
ContactRefreshSeconds |
int | 60 |
Central-side only: how often central rebuilds its ClusterClient contact set from the ClusterNode rows. |
Addresses only — no actor-path suffix. /system/receptionist is appended at construction time; a contact carrying /user/ or /system/ is rejected at startup, because a doubled suffix produces a path that resolves to nothing and drops every command in silence.
It is a dark switch, and both sides are always wired. The comm actors are spawned and registered with the ClusterClientReceptionist on every node in both modes, so flipping Mode is a config change rather than a redeploy. Under Dps the registration is simply idle.
Central's contact set comes from the enabled, non-maintenance ClusterNode rows — the same source Phase 1 gave the deploy ack set. A node in MaintenanceMode is not dialled, but note that the contact set does not scope delivery: a receptionist serves its whole cluster, so SendToAll still reaches every registered node exactly as today's DPS broadcast does. The filter is about which receptionists are worth dialling, not about who receives.
Buffering is off by design (akka.cluster.client.buffer-size = 0, set in the shipped akka.conf). If no receptionist is known, the command is dropped rather than queued. Akka's default of 1000 would replay a DispatchDeployment on reconnect — silently, on the client's own timer, at an unbounded remove from the dispatch. Do not "fix" it back to quiet a flaky test.
What this does not buy you. It does not guarantee a node never applies a deployment the DB records as
TimedOut. A node that missed a dispatch keeps the orphanApplyingrow the coordinator pre-created, andDriverHostActor.Bootstrap()replays that row on the node's next restart — live-observed applying a deployment 44 s after it was sealedTimedOut(see the Phase 2 live gate, finding B). The boot replay is the better-behaved of the two — deliberate, Warning-logged, and bounded to a restart — but it is still a replay.buffer-size = 0removes the silent, timer-driven one only.
On the docker-dev rig every node carries these keys already; flip the whole rig with OTOPCUA_MESH_MODE=ClusterClient at docker compose up.
ConfigSource / ConfigServe (config fetch-and-cache)
- Purpose: per-cluster mesh Phase 3.
ConfigSource:Modeselects where a driver node reads its deployed configuration:Direct(readDeployment.ArtifactBlobfrom central SQL, today's behaviour) orFetchAndCache(fetch the artifact bytes from central over a gRPC stream, verify SHA-256, cache in LocalDb, and read only the cache — no central-SQL config read).ConfigServeis the central (admin-role) serve side that aFetchAndCachenode dials. - Options classes:
ConfigSourceOptions(SectionName = "ConfigSource") +ConfigServeOptions(SectionName = "ConfigServe"), both insrc/Core/ZB.MOM.WW.OtOpcUa.Cluster/. Bound byAddOtOpcUaCluster(config);ConfigSourceOptionsValidatorruns atValidateOnStart.
ConfigSource (driver-side fetch):
| Key | Type | Default | Meaning |
|---|---|---|---|
Mode |
string | Direct |
Direct = read central SQL (unchanged). FetchAndCache = fetch from central over gRPC, read the LocalDb cache. Any other value refuses to start. |
CentralFetchEndpoints |
string[] | [] |
Central artifact-gRPC base addresses, e.g. http://central-1:4055 (h2c ⇒ the http scheme). Tried in order for failover. Required under FetchAndCache. |
ApiKey |
string | "" |
Shared bearer key; must equal central's ConfigServe:ApiKey. Supply via env ConfigSource__ApiKey — never commit. Required under FetchAndCache. |
FetchTimeoutSeconds |
int | 30 |
Per-fetch deadline. Must be positive under FetchAndCache. |
ConfigServe (central serve):
| Key | Type | Default | Meaning |
|---|---|---|---|
GrpcListenPort |
int | 0 |
Dedicated h2c-only Kestrel port for the artifact gRPC service. 0 = disabled (nothing bound). Must differ from the main HTTP port and from LocalDb:SyncListenPort (h2c cannot share a cleartext HTTP/1 port). Mapped only on admin-role nodes. |
ApiKey |
string | "" |
Shared bearer key the serve-side interceptor checks (constant-time, fail-closed: an unset key rejects every call). Supply via env ConfigServe__ApiKey — never commit. |
It is a dark switch; the serve side is always wired. Central maps the DeploymentArtifactService behind the ConfigServeAuthInterceptor (path-scoped, FixedTimeEquals, fail-closed) whenever ConfigServe:GrpcListenPort > 0, in both modes — so flipping a node to FetchAndCache is a config change, not a redeploy. A FetchAndCache node that cannot fetch (all endpoints down, NotFound, SHA mismatch) fails the apply and keeps last-known-good — a null fetch is "no answer," never an empty configuration (the #485 contract). At boot it restores served state from the LocalDb pointer with no SQL read; an empty or unreadable cache lands Steady-with-no-revision (the first dispatch fetches), never Stale.
The listener is dedicated h2c and coexists with the LocalDb-sync listener. A fused admin+driver node with both ConfigServe:GrpcListenPort and LocalDb:SyncListenPort set re-binds its existing HTTP surface exactly once and adds both dedicated HTTP/2-only ports on top — see the same Kestrel-takeover caveat under LocalDb.
RevisionHash == SHA-256(artifact bytes) is load-bearing. ConfigComposer computes the deployment's revision hash as the lowercase-hex SHA-256 of the exact artifact bytes, so the node verifies a fetch against the RevisionHash the dispatch already carries — no hash rides in the proto. If a future change makes the revision hash anything else, every fetch fails verification.
On the docker-dev rig the central pair carries ConfigServe (port 4055, dev key) and stays Direct; the four site nodes carry ConfigSource (endpoints + matching key) defaulting to Direct. Flip only the site nodes with OTOPCUA_CONFIG_MODE=FetchAndCache at docker compose up — central keeps SQL and models the target topology.
ConnectionStrings → ConfigDb
- Purpose: the central Config DB connection string. Required for every role —
Program.cscallsAddOtOpcUaConfigDbunconditionally. - Bound by:
AddOtOpcUaConfigDb(config)(src/Core/ZB.MOM.WW.OtOpcUa.Configuration/ServiceCollectionExtensions.cs). The connection-string name constant isConnectionStringName = "ConfigDb", read viaconfiguration.GetConnectionString("ConfigDb"). If absent, startup throws with a message pointing to eitherappsettings.jsonor theOTOPCUA_CONFIG_CONNECTIONenv var. - Shape: standard
ConnectionStrings:ConfigDbSQL Server connection string. There is no checked-in default in the thinappsettings*.json— supply it per environment.
The Config DB itself (the EF Core OtOpcUaConfigDbContext, entities, draft/publish generations, NodeAcl, LdapGroupRoleMapping, migrations) is the durable home for the fleet's drivers, UNS hierarchy, ACLs, and audit log. For the full schema see docs/v2/config-db-schema.md. This page does not duplicate it.
Galaxy / MxAccess driver config (DriverConfig JSON, not appsettings)
The Galaxy/MxAccess connection settings are not an appsettings section. They are driver-instance options stored in the DriverConfig JSON column of the Config DB (edited via the Admin UI), bound to GalaxyDriverOptions (src/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Galaxy.Contracts/GalaxyDriverOptions.cs, namespace ...Driver.Galaxy.Config). It decomposes into nested records:
| Record | Key fields (default) | Meaning |
|---|---|---|
GalaxyGatewayOptions (Gateway) |
Endpoint; ApiKeySecretRef; UseTls (true); CaCertificatePath (null); ConnectTimeoutSeconds (10); DefaultCallTimeoutSeconds (30); StreamTimeoutSeconds (0 = unlimited) |
mxaccessgw gateway connection. ApiKeySecretRef supports env:NAME / file:PATH / dev:KEY / literal forms (resolved at InitializeAsync); prefer env:/file: in production. Never store a cleartext key. |
GalaxyMxAccessOptions (MxAccess) |
ClientName; PublishingIntervalMs (1000); WriteUserId (0 = anonymous); EventPumpChannelCapacity (50000) |
MXAccess client identity + tuning. ClientName must be unique per OtOpcUa instance (redundancy pairs enforce this). |
GalaxyRepositoryOptions (Repository) |
DiscoverPageSize (5000); WatchDeployEvents (true) |
Galaxy Repository browse paging + deploy-event watching. |
GalaxyReconnectOptions (Reconnect) |
InitialBackoffMs (500); MaxBackoffMs (30000); ReplayOnSessionLost (true) |
In-driver reconnect-supervisor backoff. |
| (top-level) | ProbeTimeoutSeconds (30, range 1–60) |
AdminUI Test-Connect probe timeout. |
The
OTOPCUA_GALAXY_*environment variables that v1's in-processGalaxy.Hostconsumed no longer live in this repo — they moved into the separately-installed mxaccessgw gateway's own config (see the v1 archive pointer indocs/README.mdand the Galaxy overview atdocs/drivers/Galaxy.md). The only Galaxy connection secret this repo touches is the gateway API key viaApiKeySecretRefabove.
Historian config (HistorianGateway)
The historian backend is the external ZB.MOM.WW.HistorianGateway sidecar, consumed as the
ZB.MOM.WW.HistorianGateway.Client gRPC package (the retired Wonderware TCP sidecar is documented at
docs/drivers/Historian.Wonderware.md). The OtOpcUa host reads three
appsettings sections — ServerHistorian (read path + gateway connection), ContinuousHistorization
(FasterLog outbox + recorder draining to WriteLiveValues), and AlarmHistorian (the store-and-forward
alarm sink draining to SendEvent; its buffer lives in the node's LocalDb:Path database, not a
file of its own). The gateway connection (endpoint / key / TLS) lives only in
ServerHistorian; the other two sections source it from there.
The gateway API key is supplied via the environment variable ServerHistorian__ApiKey — never committed
to config. The target gateway must run RuntimeDb:Enabled=true + RuntimeDb:EventReadsEnabled=true, and the
key must carry the scopes historian:read, historian:write, historian:tags:write. See
docs/Historian.md for the full key reference, the migration note (old Wonderware keys →
gateway keys), and the deployment prerequisites.
LocalDb (pair-local config cache — driver role only)
Driver-role nodes keep a consolidated ZB.MOM.WW.LocalDb SQLite database that caches the deployed
configuration artifact (chunked) so the node can boot from cache when central SQL is unreachable. The
section is bound by AddOtOpcUaLocalDb (Host/Configuration/LocalDbRegistration.cs) inside the hasDriver
branch — admin-only nodes never register it, and never require LocalDb:Path. Storage is unconditional;
replication stays inert until the sync port + peer are set.
| Key | Default | Meaning |
|---|---|---|
LocalDb:Path |
./data/otopcua-localdb.db |
SQLite file path. ValidateOnStart-required once AddZbLocalDb runs (driver nodes only). In containers put it on a durable volume. |
LocalDb:SyncListenPort |
0 |
0 = replication off (no sync listener). A non-zero port binds a dedicated h2c sync listener; set the same port on both pair nodes. Setting it makes the Host add an explicit Kestrel Listen* and re-bind the primary HTTP port (an explicit Listen* otherwise discards ASPNETCORE_URLS). |
LocalDb:Replication:PeerAddress |
"" |
The peer this node dials (http://<peer>:<port>). Set on the initiator only; leave empty on the passive node. The stream is bidirectional. |
LocalDb:Replication:ApiKey |
"" |
Bearer token for the sync stream. Fail-closed: no key ⇒ the passive endpoint refuses everything; a mismatch ⇒ the pair silently stops converging. Must be byte-identical on both nodes. Supply via ${secret:...} / env — never a cleartext literal in production. |
LocalDb:Replication:MaxBatchSize |
(library default) | Rows per replication batch — row-count-only against gRPC's 4 MB cap. 16 for the artifact cache (chunk rows ≈171 KB, so 16 × 171 KB ≈ 2.7 MB). |
Replication is default-OFF across the fleet; it is enabled per-pair as an opt-in. See
docs/operations/2026-07-20-localdb-pair-replication.md
for the enablement runbook (ApiKey handling, stop/start-together rule, tombstone-retention window, and the
never-sqlite3-a-live-WAL-DB inspection rules) and the "pair-local config cache" section of
docs/Redundancy.md for what boot-from-cache does and does not cover.
Environment variables
All names are read in this repo's source via Environment.GetEnvironmentVariable(...) unless noted otherwise. Defaults shown are the in-source fallbacks.
Host / cluster / Config DB
| Variable | Read by | Effect / default |
|---|---|---|
OTOPCUA_ROLES |
src/Server/ZB.MOM.WW.OtOpcUa.Host/Program.cs (RoleParser.Parse) |
Comma-separated cluster roles for the node (admin, driver, dev). Drives the conditional wiring and the per-role appsettings overlay. Used when Cluster:Roles is empty. |
OTOPCUA_CONFIG_CONNECTION |
src/Core/ZB.MOM.WW.OtOpcUa.Configuration/DesignTimeDbContextFactory.cs (design-time / dotnet ef only) |
Read at design time by DesignTimeDbContextFactory.cs for dotnet ef migrations. At runtime the server resolves the connection string from ConnectionStrings:ConfigDb (env form: ConnectionStrings__ConfigDb) via configuration.GetConnectionString("ConfigDb") in ServiceCollectionExtensions.cs — OTOPCUA_CONFIG_CONNECTION appears there only as a hint in an error message, not via GetEnvironmentVariable. No credential is embedded in source. |
ASPNETCORE_ENVIRONMENT |
ASP.NET host builder (framework) | Selects appsettings.{Environment}.json (e.g. Development). |
Historian (ServerHistorian__ApiKey)
The retired Wonderware sidecar's OTOPCUA_HISTORIAN_* environment variables are gone — no source reads
them anymore. The historian backend is now the external HistorianGateway, configured through the
ServerHistorian / ContinuousHistorization / AlarmHistorian appsettings sections (above). The single
historian secret this repo reads from the environment is the gateway API key:
| Variable | Effect / default |
|---|---|
ServerHistorian__ApiKey |
The HistorianGateway peppered-HMAC key (histgw_<id>_<secret>) sent as Authorization: Bearer. Supply via environment — never commit. Required when ServerHistorian:Enabled=true. |
Driver integration-test / fixture sim endpoints
These are consumed by the driver integration-test fixtures (under tests/Drivers/...IntegrationTests/), not by the production server. Each overrides the simulator endpoint a fixture TCP-probes; defaults point at the shared Docker host 10.100.0.35 (see CLAUDE.md Docker Workflow).
| Variable | Read by (fixture) | Default |
|---|---|---|
MODBUS_SIM_ENDPOINT |
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.Modbus.IntegrationTests/ModbusSimulatorFixture.cs |
10.100.0.35:5020 |
AB_SERVER_ENDPOINT |
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.AbCip.IntegrationTests/AbServerFixture.cs |
10.100.0.35:44818 |
S7_SIM_ENDPOINT |
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.S7.IntegrationTests/Snap7ServerFixture.cs |
10.100.0.35:1102 (non-privileged; not S7-standard 102) |
OPCUA_SIM_ENDPOINT |
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.OpcUaClient.IntegrationTests/OpcPlcFixture.cs |
opc.tcp://10.100.0.35:50000 |
OTOPCUA_FOCAS_SIM_ENDPOINT |
tests/Drivers/ZB.MOM.WW.OtOpcUa.Driver.FOCAS.IntegrationTests/FocasSimFixture.cs |
localhost:8193 |
Additional harness/parity/soak env vars (
OTOPCUA_FOCAS_*,OTOPCUA_PARITY_*,OTOPCUA_SOAK_*,OTOPCUA_HARNESS_USE_SQL) exist only in the test/parity/soak harnesses, not in production source, and are out of scope for this reference.
See also
security.md— transport security, OPC UA authentication, LDAP (Security:Ldap), data-plane ACLs, control-plane roles.Redundancy.md— theClustersection in the context of warm/hot redundancy, ServiceLevel, peer discovery.ServiceHosting.md— role-based host wiring andOTOPCUA_ROLES.docs/drivers/Galaxy.md— Galaxy/MxAccess driver overview.docs/v2/config-db-schema.md— the full Config DB schema.