Skip to content

Commit 6ae83d7

Browse files
committed
[edit] readme according to v2
1 parent 45091e0 commit 6ae83d7

File tree

2 files changed

+18
-29
lines changed

2 files changed

+18
-29
lines changed

README.md

Lines changed: 17 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -25,35 +25,24 @@ Etcd based configuration provider for Microsoft.Extensions.Configuration.
2525
var myKeyValue = mySection["MyKeyName"];
2626
```
2727

28-
### HTTPS with certificate in environment variables
28+
### HTTPS
2929

30-
1. Add `ETCD_CLIENT_CA_FILE` environment variable with path to etcd CA file (shoule be provided by etcd administrator), for example: `C:\etcd\cert\EtcdCa.crt`
30+
When using HTTPS, *.crt CA certificate (should be provided by etcd administrator) should be placed in well known system certificate store (depending on OS).
3131

32-
```csharp
33-
var config = new ConfigurationBuilder()
34-
.AddEtcd(
35-
new Credentials("MyEtcdUserName", "passw"),
36-
new EtcdSettings("https://serveraddress:2379"))
37-
.Build();
38-
39-
var mySection = config.GetSection("MySection");
40-
var myKeyValue = mySection["MyKeyName"];
41-
```
32+
* For Windows it is `Trusted Root Certification Authority`.
33+
* For Linux, at least for Arch/Manjaro Linux it should be placed in : `/etc/ca-certificates/trust-source/anchors/` followed by `sudo trust extract-compat` command
4234

4335
### HTTPS with settings from local JSON file
4436

4537
appsettings.json
4638

4739
```json
4840
{
49-
"EtcdSettings":
50-
{
51-
"ConnectionString":, "https://serveraddress:2379",
52-
"CertificateData":, "-----BEGIN CERTIFICATE----- 1234321 -----END CERTIFICATE-----
53-
",
54-
}
41+
"EtcdSettings":
42+
{
43+
"ConnectionString": "https://serveraddress:2379"
44+
}
5545
}
56-
5746
```
5847

5948
```csharp
@@ -71,20 +60,20 @@ var mySection = config.GetSection("MySection");
7160
var myKeyValue = mySection["MyKeyName"];
7261
```
7362

74-
Settings can be mixed from different locations, for example, you can set only CA file in environment variable and only connection string in JSON file.
63+
Settings can be mixed from different locations.
7564

7665
## Contributing
7766

7867
There are many ways in which you can participate in the project. Like most open-source software projects, contributing code is just one of many outlets where you can help improve. Some of the things that you could help out with are:
7968

80-
- Documentation (both code and features)
81-
- Bug reports
82-
- Bug fixes
83-
- Feature requests
84-
- Feature implementations
85-
- Test coverage
86-
- Code quality
87-
- Sample applications
69+
* Documentation (both code and features)
70+
* Bug reports
71+
* Bug fixes
72+
* Feature requests
73+
* Feature implementations
74+
* Test coverage
75+
* Code quality
76+
* Sample applications
8877

8978
## License
9079

src/Etcd.Microsoft.Extensions.Configuration/CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
## [2.0.0] - 2022-06-01
3+
## [2.0.0] - 2022-06-04
44

55
### Removed
66

0 commit comments

Comments
 (0)