Skip to content

doc: updates to add clarification to all properties configurable via … #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rlabbeptc merged 1 commit into from
Feb 25, 2026
Merged

doc: updates to add clarification to all properties configurable via … #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 13 additions & 3 deletions KepwareSync.Service/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# KepwareSync.Service (Currently in Beta)

[![Build Status](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions/workflows/dotnet.yml/badge.svg)](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions)
[![Build Status](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions/workflows/syncservice-build.yml/badge.svg)](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions)
[![Build Status](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions/workflows/docker-build-and-push.yml/badge.svg)](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions)

## Overview
Expand Down Expand Up @@ -149,6 +149,10 @@ The service also supports environment variables for configuration using `AddEnvi
| `KEPWARE__PRIMARY__HOST` | https://localhost:57512 |
| `KEPWARE__DISABLECERTIFICATEVALIDATION` | true |
| `STORAGE__DIRECTORY` | ExportedYaml |
| `KEPWARE__SECONDARY__0__HOST` | https://localhost:57513 |
| `KEPWARE__SECONDARY__0__USERNAME` | SecondaryUser |
| `KEPWARE__SECONDARY__0__PASSWORD` | SecondaryPassword2025! |
| `SYNC__SYNCMODE` | TwoWay

Set these variables in your system or Docker container to override appsettings.json.

Expand Down Expand Up @@ -178,8 +182,14 @@ The `appsettings.json` file provides an alternative way to configure `KepwareSyn
]
},
"Storage": {
"Directory": "ExportedYaml"
}
"Directory": "ExportedYaml",
// "PersistDefaultValue": true
},
// "Sync": {
// "SyncMode": "OneWay",
// "SyncDirection": "KepwareToDiskAndSecondary",
// "SyncThrottlingMs": 1000
// }
}
```

Expand Down
8 changes: 7 additions & 1 deletion KepwareSync.Service/appsettings.Development.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
]
},
"Storage": {
"Directory": "ExportedYaml"
"Directory": "ExportedYaml",
"PersistDefaultValue": true
},
"Sync": {
"SyncMode": "OneWay",
"SyncDirection": "KepwareToDiskAndSecondary",
"SyncThrottlingMs": 1000
}
}