Skip to content

Commit 2fef942

Browse files
committed
add config docs
1 parent 4f249cf commit 2fef942

1 file changed

Lines changed: 28 additions & 0 deletions

File tree

  • vscode-extensions/debug-certificate-manager-vscode-extension

vscode-extensions/debug-certificate-manager-vscode-extension/README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,31 @@ VS Code extension to manage debug TLS certificates and sync them to the VS Code
77
The Debug Certificate Manager extension uses `@rushstack/debug-certificate-manager` to manage TLS certificates. It can also be used to sync certificates when connected to a VS Code remote workspace (WSL, Codespaces, Devcontainers, VS Code Tunnels).
88

99
The extension reads `.vscode/debug-certificate-manager.json` for the certificate store path. When present, the extension will auto-activate and attempt to sync the certificates to the remote workspace.
10+
11+
## Configuration
12+
13+
### VS Code Settings
14+
15+
```json
16+
{
17+
"debugCertificateManager.autoSync": true,
18+
"debugCertificateManager.keyFilename": "private-key.pem",
19+
"debugCertificateManager.certificateFilename": "certificate.pem",
20+
"debugCertificateManager.caCertificateFilename": "ca-certificate.pem",
21+
"debugCertificateManager.storePath.windows": "C:\\path\\to\\store",
22+
"debugCertificateManager.storePath.linux": "/path/to/store",
23+
"debugCertificateManager.storePath.osx": "/path/to/store"
24+
}
25+
```
26+
27+
### Workspace configuration
28+
29+
30+
```json
31+
{
32+
"storePath": "workspace/relative/path",
33+
"keyFilename": "private-key.pem",
34+
"certificateFilename": "certificate.pem",
35+
"caCertificateFilename": "ca-certificate.pem"
36+
}
37+
```

0 commit comments

Comments
 (0)