Skip to content

Commit

Permalink
Updated readme to introduce the release tab
Browse files Browse the repository at this point in the history
  • Loading branch information
Jijie Chen committed Aug 8, 2017
1 parent afb9a87 commit 98808f9
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,21 +9,22 @@ LetsEncryptCentral(**lec.exe**) is a utility that helps apply domain validation
LetsEncryptCentral can be used to apply certificates for non-webserver service endpoints, it also can be used as a centralized certificate management tool for requesting and renewing Let's Encrypt certificates.

## Usage
This project is in early development, hence not ready for production usage. Use at your own risk.
This tool currently only supports Windows operating systems, including server systems. You can set it as a regular task every 80 days in the Windows Task Scheduler to keep your certificates updated.

1. Clone this project, run the `.\Build.bat` to compile;
1. Run the **lec.exe** from the `release` output directory;
1. Download the latest binaries from the [releases](https://github.com/jijiechen/LetsEncryptCentral/releases);
1. Create a new registration profile if this is your first running;
1. Apply a certificate using your registration profile (Currently, DnsPod dynamic DNS service and Azure DNS service are supported, more DNS service providers are on the way).
1. Apply a certificate using your registration profile (Currently, Azure DNS service and DnsPod DNS service are supported, more DNS service providers are on the way. You can also implement your own DNSProvider type.).

Here are the sample commands:

```powershell
cd release
.\lec.exe reg --accept-tos --contact user@example.com --out-reg C:\Users\MyUserName\Desktop\reg.json --out-signer C:\Users\MyUserName\Desktop\signer.key
.\lec.exe apply name.ciznx.com -out C:\Users\MyUserName\Desktop\cert.pfx --out-type pfx --reg C:\Users\MyUserName\Desktop\reg.json --signer C:\Users\MyUserName\Desktop\signer.key --dns DnsPod --dns-conf "token_id=1234;token=822321668afcefe;domain=example.com"
.\lec.exe reg --accept-tos --contact user@domain.com --out-reg reg.json --out-signer signer.key
.\lec.exe apply some.domain.com --out cert.pem --out-type pem --reg reg.json --signer signer.key --dns Azure --dns-conf "client_id=1234;client_secret=822321668a;subscription_id=9837549;zone_name=domain.com"
```

## Development plan
Possible plans are web API/UI and Linux compatibility. Push requests to these features are warmly welcome.

## Contributing and license
Pull requests are welcome. The next step is to support more dynamic DNS providers, AWS Router and Google DNS services. The future plan is wrap the core as a web service to provide out-of-box centralized certificate manageability.

Expand Down

0 comments on commit 98808f9

Please sign in to comment.