Browse Source

letsencrypt to greenlock

greenlock
Drew Warren 7 years ago
parent
commit
3023c99877
  1. 24
      README.md

24
README.md

@ -13,16 +13,16 @@ Tired of serving the Empire? Come join the Rebel Alliance:
<!-- BANNER_TPL_END -->
# greenlock-koa (letsencrypt-koa)
# greenlock-koa (greenlock-koa)
[![Join the chat at https://gitter.im/Daplie/letsencrypt-express](https://badges.gitter.im/Daplie/letsencrypt-express.svg)](https://gitter.im/Daplie/letsencrypt-express?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
| [letsencrypt (lib)](https://git.daplie.com/Daplie/node-greenlock)
| [letsencrypt-cli](https://git.daplie.com/Daplie/greenlock-cli)
| [letsencrypt-express](https://git.daplie.com/Daplie/greenlock-express)
| [letsencrypt-cluster](https://git.daplie.com/Daplie/greenlock-cluster)
| **letsencrypt-koa**
| [letsencrypt-hapi](https://git.daplie.com/Daplie/greenlock-hapi)
| [greenlock (lib)](https://git.daplie.com/Daplie/node-greenlock)
| [greenlock-cli](https://git.daplie.com/Daplie/greenlock-cli)
| [greenlock-express](https://git.daplie.com/Daplie/greenlock-express)
| [greenlock-cluster](https://git.daplie.com/Daplie/greenlock-cluster)
| **greenlock-koa**
| [greenlock-hapi](https://git.daplie.com/Daplie/greenlock-hapi)
|
Free SSL and Automatic HTTPS for node.js with KOA and other middleware systems via Let's Encrypt
@ -38,17 +38,17 @@ All you have to do is start the webserver and then visit it at it's domain name.
## Install
```
npm install --save letsencrypt-express@2.x
npm install --save greenlock-express@2.x
```
*Pay no attention to the man behind the curtain.* (just ignore that the name of the module is letsencrypt-express)
*Pay no attention to the man behind the curtain.* (just ignore that the name of the module is greenlock-express)
### Part 1: Setup
```javascript
'use strict';
var le = require('letsencrypt-express').create({
var le = require('greenlock-express').create({
server: 'staging' // in production use 'https://acme-v01.api.letsencrypt.org/directory'
, configDir: require('os').homedir() + '/letsencrypt/etc'
@ -68,9 +68,9 @@ var le = require('letsencrypt-express').create({
WARNING: If you don't do any checks and simply complete `approveRegistration` callback, an attacker will spoof SNI packets with bad hostnames and that will cause you to be rate-limited and or blocked from the ACME server. Alternatively, You can run registration *manually*:
```bash
npm install -g letsencrypt-cli
npm install -g greenlock-cli
letsencrypt certonly --standalone \
greenlock certonly --standalone \
--server 'https://acme-v01.api.letsencrypt.org/directory' \
--config-dir ~/letsencrypt/etc \
--agree-tos --domains example.com --email user@example.com

Loading…
Cancel
Save