Firebase Update
This commit is contained in:
Lukas Nowy
98
express-server/node_modules/greenlock/README.md
generated
vendored
98
express-server/node_modules/greenlock/README.md
generated
vendored
@ -2,8 +2,7 @@
|
||||
|
||||
|
||||
|
||||
Greenlock™ for node.js
|
||||
=====
|
||||
# [Greenlock](https://git.coolaj86.com/coolaj86/greenlock.js)™ for node.js
|
||||
|
||||
Greenlock provides Free SSL, Free Wildcard SSL, and Fully Automated HTTPS <br>
|
||||
<small>certificates issued by Let's Encrypt v2 via [ACME](https://git.coolaj86.com/coolaj86/acme-v2.js)</small>
|
||||
@ -13,23 +12,24 @@ Greenlock provides Free SSL, Free Wildcard SSL, and Fully Automated HTTPS <br>
|
||||
|
||||
|
||||
|
||||
| Sponsored by [ppl](https://ppl.family) |
|
||||
| A [Root](https://therootcompany.com) Project |
|
||||
Greenlock works
|
||||
in the [Commandline](https://git.coolaj86.com/coolaj86/greenlock-cli.js) (cli),
|
||||
as a [Web Server](https://git.coolaj86.com/coolaj86/greenlock-server.js),
|
||||
in [Web Browsers](https://git.coolaj86.com/coolaj86/greenlock.html) (WebCrypto),
|
||||
as a [Web Server](https://git.coolaj86.com/coolaj86/greenlock-express.js),
|
||||
in [Web Browsers](https://greenlock.domains) (WebCrypto),
|
||||
and with **node.js** ([npm](https://www.npmjs.com/package/greenlock)).
|
||||
|
||||
Features
|
||||
========
|
||||
# Features
|
||||
|
||||
- [x] Actively Maintained and Supported
|
||||
- [x] VanillaJS
|
||||
- [x] Limited Dependencies
|
||||
- [x] Automatic HTTPS
|
||||
- [x] Free SSL
|
||||
- [x] Free Wildcard SSL
|
||||
- [x] Multiple domain support (up to 100 altnames per SAN)
|
||||
- [x] Dynamic Virtual Hosting (vhost)
|
||||
- [x] Automatical renewal (30 to 21 days before expiration)
|
||||
- [x] Automatical renewal (10 to 14 days before expiration)
|
||||
- [x] Great ACME support via [acme.js](https://git.coolaj86.com/coolaj86/acme-v2.js)
|
||||
- [x] "dry run" with self-diagnostics
|
||||
- [x] ACME draft 12
|
||||
@ -39,7 +39,7 @@ Features
|
||||
- [x] Works with `bash`, `fish`, `zsh`, `cmd.exe`, `PowerShell`, and more
|
||||
- [x] [Browser](https://git.coolaj86.com/coolaj86/greenlock.html) Support
|
||||
- [x] Full node.js support, with modules for
|
||||
- [x] [http/https](https://git.coolaj86.com/coolaj86/greenlock-express.js/src/branch/master/examples/https-server.js), [Express.js](https://git.coolaj86.com/coolaj86/greenlock-express.js), [cluster](https://git.coolaj86.com/coolaj86/greenlock-cluster.js), [hapi](https://git.coolaj86.com/coolaj86/greenlock-hapi.js), [Koa](https://git.coolaj86.com/coolaj86/greenlock-koa.js), [rill](https://git.coolaj86.com/coolaj86/greenlock-rill.js), [restify](https://git.coolaj86.com/coolaj86/greenlock-restify.js), spdy, etc
|
||||
- [x] [http/https](https://git.coolaj86.com/coolaj86/greenlock-express.js/src/branch/master/examples), [Express.js](https://git.coolaj86.com/coolaj86/greenlock-express.js), [cluster](https://git.coolaj86.com/coolaj86/greenlock-cluster.js), [hapi](https://git.coolaj86.com/coolaj86/greenlock-hapi.js), [Koa](https://git.coolaj86.com/coolaj86/greenlock-koa.js), [rill](https://git.coolaj86.com/coolaj86/greenlock-rill.js), spdy, etc
|
||||
- [x] Great for securing your Raspberry Pi
|
||||
- [x] Extensible Plugin Support
|
||||
- [x] AWS S3, AWS Route53, Azure, CloudFlare, Consul, Digital Ocean, etcd, Redis
|
||||
@ -48,13 +48,12 @@ Greenlock.js for Middleware
|
||||
------
|
||||
|
||||
Documentation for using Greenlock with
|
||||
[http/https](https://git.coolaj86.com/coolaj86/greenlock-express.js/src/branch/master/examples/https-server.js),
|
||||
[http/https](https://git.coolaj86.com/coolaj86/greenlock-express.js/src/branch/master/examples),
|
||||
[Express.js](https://git.coolaj86.com/coolaj86/greenlock-express.js),
|
||||
[cluster](https://git.coolaj86.com/coolaj86/greenlock-cluster.js),
|
||||
[hapi](https://git.coolaj86.com/coolaj86/greenlock-hapi.js),
|
||||
[Koa](https://git.coolaj86.com/coolaj86/greenlock-koa.js),
|
||||
[rill](https://git.coolaj86.com/coolaj86/greenlock-rill.js).
|
||||
[restify](https://git.coolaj86.com/coolaj86/greenlock-restify.js).
|
||||
|
||||
Table of Contents
|
||||
=================
|
||||
@ -106,7 +105,7 @@ unless you're very clear on what the failure was and how to fix it.
|
||||
|
||||
### QuickStart Screencast
|
||||
|
||||
Watch the QuickStart demonstration: [https://youtu.be/e8vaR4CEZ5s](https://youtu.be/e8vaR4CEZ5s&list=PLZaEVINf2Bq_lrS-OOzTUJB4q3HxarlXk)
|
||||
Watch the QuickStart demonstration: [https://youtu.be/e8vaR4CEZ5s](https://youtu.be/e8vaR4CEZ5s)
|
||||
|
||||
<a href="https://www.youtube.com/watch?v=e8vaR4CEZ5s&list=PLZaEVINf2Bq_lrS-OOzTUJB4q3HxarlXk"><img src="https://i.imgur.com/Y8ix6Ts.png" title="QuickStart Video" alt="YouTube Video Preview" /></a>
|
||||
|
||||
@ -155,39 +154,15 @@ Great when
|
||||
////////////////////
|
||||
|
||||
var greenlock = require('greenlock').create({
|
||||
|
||||
version: 'draft-12'
|
||||
, server: 'https://acme-v02.api.letsencrypt.org/directory'
|
||||
, configDir: '~/.config/acme'
|
||||
|
||||
, email: 'user@example.com' // IMPORTANT: Change email and domains
|
||||
email: 'user@example.com' // IMPORTANT: Change email and domains
|
||||
, agreeTos: true // Accept Let's Encrypt v2 Agreement
|
||||
, configDir: '~/.config/acme' // A writable folder (a non-fs plugin)
|
||||
|
||||
, communityMember: true // Get (rare) non-mandatory updates about cool greenlock-related stuff (default false)
|
||||
, securityUpdates: true // Important and mandatory notices related to security or breaking API changes (default true)
|
||||
|
||||
, approveDomains: approveDomains
|
||||
});
|
||||
```
|
||||
|
||||
```js
|
||||
/////////////////////
|
||||
// APPROVE DOMAINS //
|
||||
/////////////////////
|
||||
|
||||
|
||||
function approveDomains(opts, certs, cb) {
|
||||
|
||||
// check for domains you want to receive certificates for
|
||||
if ('example.com' === opts.domain) {
|
||||
cb(null, { options: opts, certs: certs });
|
||||
return;
|
||||
}
|
||||
|
||||
// return error otherwise
|
||||
cb(new Error("bad domain"));
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
////////////////////
|
||||
// CREATE SERVERS //
|
||||
@ -226,9 +201,13 @@ var greenlock = Greenlock.create({
|
||||
version: 'draft-12'
|
||||
, server: 'https://acme-v02.api.letsencrypt.org/directory'
|
||||
|
||||
// approve a growing list of domains
|
||||
// Use the approveDomains callback to set per-domain config
|
||||
// (default: approve any domain that passes self-test of built-in challenges)
|
||||
, approveDomains: approveDomains
|
||||
|
||||
// the default servername to use when the client doesn't specify
|
||||
, servername: 'example.com'
|
||||
|
||||
// If you wish to replace the default account and domain key storage plugin
|
||||
, store: require('le-store-certbot').create({
|
||||
configDir: path.join(os.homedir(), 'acme/etc')
|
||||
@ -254,13 +233,10 @@ function approveDomains(opts, certs, cb) {
|
||||
|
||||
// The domains being approved for the first time are listed in opts.domains
|
||||
// Certs being renewed are listed in certs.altnames
|
||||
if (certs) {
|
||||
opts.domains = certs.altnames;
|
||||
}
|
||||
else {
|
||||
opts.email = 'john.doe@example.com';
|
||||
opts.agreeTos = true;
|
||||
}
|
||||
// certs.domains;
|
||||
// certs.altnames;
|
||||
opts.email = 'john.doe@example.com';
|
||||
opts.agreeTos = true;
|
||||
|
||||
// NOTE: you can also change other options such as `challengeType` and `challenge`
|
||||
// opts.challengeType = 'http-01';
|
||||
@ -394,8 +370,8 @@ greenlock = Greenlock.create({
|
||||
//, sni: require('le-sni-auto').create({}) // handles sni callback
|
||||
|
||||
// renewals happen at a random time within this window
|
||||
, renewWithin: 30 * 24 * 60 * 60 * 1000 // certificate renewal may begin at this time
|
||||
, renewBy: 21 * 24 * 60 * 60 * 1000 // certificate renewal should happen by this time
|
||||
, renewWithin: 14 * 24 * 60 * 60 * 1000 // certificate renewal may begin at this time
|
||||
, renewBy: 10 * 24 * 60 * 60 * 1000 // certificate renewal should happen by this time
|
||||
|
||||
, debug: false
|
||||
//, log: function (debug) {console.log.apply(console, args);} // handles debug outputs
|
||||
@ -529,8 +505,14 @@ See https://git.coolaj86.com/coolaj86/le-challenge-fs.js
|
||||
* `.get(opts, domain, key, cb);` // opts will be retrieved by domain/key
|
||||
* `.remove(opts, domain, key, cb);` // opts will be retrieved by domain/key
|
||||
|
||||
Change History
|
||||
==============
|
||||
# Change History
|
||||
|
||||
* v2.6
|
||||
* better defaults, fewer explicit options
|
||||
* better pre-flight self-tests, explicit domains not required
|
||||
* v2.5
|
||||
* bugfix JWK (update rsa-compat)
|
||||
* eliminate all external non-optional dependencies
|
||||
* v2.4
|
||||
* v2.4.3 - add security updates (default true) independent of community updates (default false)
|
||||
* v2.2 - Let's Encrypt v2 Support
|
||||
@ -540,7 +522,7 @@ Change History
|
||||
* v2.2.7 - bugfix for wildcard support
|
||||
* v2.2.5 - node v6.x compat
|
||||
* v2.2.4 - don't promisify all of `dns`
|
||||
* v2.2.3 - `renewWithin` default to 30 days
|
||||
* v2.2.3 - `renewWithin` default to 14 days
|
||||
* v2.2.2 - replace git dependency with npm
|
||||
* v2.2.1 - April 2018 **Let's Encrypt v2** support
|
||||
* v2.1.17 - Nov 5th 2017 migrate back to personal repo
|
||||
@ -557,11 +539,11 @@ Change History
|
||||
* v1.0.2 Works with node-letsencrypt-python
|
||||
* v1.0.0 Thar be dragons
|
||||
|
||||
LICENSE
|
||||
=======
|
||||
# Legal
|
||||
|
||||
Dual-licensed MIT and Apache-2.0
|
||||
Greenlock™ is a [trademark](https://greenlock.domains/legal/#trademark) of AJ ONeal
|
||||
|
||||
See LICENSE
|
||||
|
||||
Greenlock™ is a trademark of AJ ONeal
|
||||
[greenlock.js](https://git.coolaj86.com/coolaj86/greenlock.js) |
|
||||
MPL-2.0 |
|
||||
[Terms of Use](https://therootcompany.com/legal/#terms) |
|
||||
[Privacy Policy](https://therootcompany.com/legal/#privacy)
|
||||
|
||||
Reference in New Issue
Block a user