Compare commits
4 Commits
1a9f1d2a34
...
8ff17a0939
Author | SHA1 | Date |
---|---|---|
AJ ONeal | 8ff17a0939 | |
AJ ONeal | d3eee4308d | |
AJ ONeal | bfeb5f29f8 | |
AJ ONeal | 2fae624669 |
30
README.md
30
README.md
|
@ -1,4 +1,4 @@
|
||||||
# New Documentation & [v2/v3 Migration Guide](https://git.rootprojects.org/root/greenlock.js/src/branch/v3/MIGRATION_GUIDE_V2_V3.md)
|
# New Documentation & [v2/v3 Migration Guide](https://git.rootprojects.orggreenlock.js/src/branch/v3/MIGRATION_GUIDE_V2_V3.md)
|
||||||
|
|
||||||
Greenlock v3 was just released from private beta **today** (Nov 1st, 2019).
|
Greenlock v3 was just released from private beta **today** (Nov 1st, 2019).
|
||||||
|
|
||||||
|
@ -6,19 +6,19 @@ We're still working on the full documentation for this new version,
|
||||||
so please be patient.
|
so please be patient.
|
||||||
|
|
||||||
To start, check out the
|
To start, check out the
|
||||||
[Migration Guide](https://git.rootprojects.org/root/greenlock.js/src/branch/v3/MIGRATION_GUIDE_V2_V3.md).
|
[Migration Guide](https://git.rootprojects.orggreenlock.js/src/branch/v3/MIGRATION_GUIDE_V2_V3.md).
|
||||||
|
|
||||||
!["Greenlock Logo"](https://git.rootprojects.org/root/greenlock.js/raw/branch/master/logo/greenlock-1063x250.png 'Greenlock lock logo and work mark')
|
!["Greenlock Logo"](https://git.rootprojects.orggreenlock.js/raw/branch/master/logo/greenlock-1063x250.png 'Greenlock lock logo and work mark')
|
||||||
|
|
||||||
!["Greenlock Function"](https://git.rootprojects.org/root/greenlock.js/raw/branch/master/logo/from-not-secure-to-secure-url-bar.png 'from url bar showing not secure to url bar showing secure')
|
!["Greenlock Function"](https://git.rootprojects.orggreenlock.js/raw/branch/master/logo/from-not-secure-to-secure-url-bar.png 'from url bar showing not secure to url bar showing secure')
|
||||||
|
|
||||||
# [Greenlock](https://git.rootprojects.org/root/greenlock.js) is Let's Encrypt for JavaScript
|
# [Greenlock](https://git.rootprojects.orggreenlock.js) is Let's Encrypt for JavaScript
|
||||||
|
|
||||||
| Built by [Root](https://rootprojects.org) for [Hub](https://rootprojects.org/hub/)
|
| Built by [Root](https://rootprojects.org) for [Hub](https://rootprojects.org/hub/)
|
||||||
|
|
||||||
Greenlock™ is an Automated Certificate Management Environement 🔐.
|
Greenlock™ is an Automated Certificate Management Environement 🔐.
|
||||||
|
|
||||||
| **Greenlock** | [Greenlock Express](https://git.rootprojects.org/root/greenlock-express.js) | [ACME.js](https://git.rootprojects.org/root/acme.js) |
|
| **Greenlock** | [Greenlock Express](https://git.rootprojects.orggreenlock-express.js) | [ACME.js](https://git.rootprojects.org/root/acme.js) |
|
||||||
|
|
||||||
It uses **Let's Encrypt** to generate Free SSL Certificates, including **Wildcard** SSL.
|
It uses **Let's Encrypt** to generate Free SSL Certificates, including **Wildcard** SSL.
|
||||||
It supports **Automated Renewal** of certs for Fully Automated HTTPS.
|
It supports **Automated Renewal** of certs for Fully Automated HTTPS.
|
||||||
|
@ -289,7 +289,7 @@ gl.add({
|
||||||
## Greenlock#get()
|
## Greenlock#get()
|
||||||
|
|
||||||
**Disclaimer**: This is only intended for testing, demos, and SNICallback
|
**Disclaimer**: This is only intended for testing, demos, and SNICallback
|
||||||
(in [Greenlock Express](https://git.rootprojects.org/root/greenlock-express.js)).
|
(in [Greenlock Express](https://git.rootprojects.orggreenlock-express.js)).
|
||||||
|
|
||||||
Greenlock is intended to be left running to allow it to fetech and renew certifictates automatically.
|
Greenlock is intended to be left running to allow it to fetech and renew certifictates automatically.
|
||||||
|
|
||||||
|
@ -297,7 +297,7 @@ It is intended that you use the `store` callbacks to new certificates instantly
|
||||||
This also protects you from accidentally stampeding the Let's Encrypt API with hundreds (or thousands)
|
This also protects you from accidentally stampeding the Let's Encrypt API with hundreds (or thousands)
|
||||||
of certificate requests.
|
of certificate requests.
|
||||||
|
|
||||||
- [Store Callback Documentation](https://git.rootprojects.org/root/greenlock-store-test.js)
|
- [Store Callback Documentation](https://git.rootprojects.orggreenlock-store-test.js)
|
||||||
|
|
||||||
```js
|
```js
|
||||||
return greenlock.get({ servername }).then(function(site) {
|
return greenlock.get({ servername }).then(function(site) {
|
||||||
|
@ -402,7 +402,7 @@ Greenlock comes with reasonable defaults but when you install it,
|
||||||
you should also install any plugins that you need.
|
you should also install any plugins that you need.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install --save @root/greenlock
|
npm install --save greenlock
|
||||||
npm install --save greenlock-manager-fs
|
npm install --save greenlock-manager-fs
|
||||||
npm install --save greenlock-store-fs
|
npm install --save greenlock-store-fs
|
||||||
npm install --save acme-http-01-standalone
|
npm install --save acme-http-01-standalone
|
||||||
|
@ -420,7 +420,7 @@ TODO
|
||||||
```js
|
```js
|
||||||
'use strict';
|
'use strict';
|
||||||
|
|
||||||
var Greenlock = require(@root/greenlock-express);
|
var Greenlock = require(greenlock-express);
|
||||||
|
|
||||||
var greenlock = Greenlock.create({
|
var greenlock = Greenlock.create({
|
||||||
// for security and critical bug notices
|
// for security and critical bug notices
|
||||||
|
@ -450,7 +450,7 @@ TODO
|
||||||
<!-- greenlock-manager-test => greenlock-manager-custom -->
|
<!-- greenlock-manager-test => greenlock-manager-custom -->
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
- [greenlock.js/examples/](https://git.rootprojects.org/root/greenlock.js/src/branch/master/examples)
|
- [greenlock.js/examples/](https://git.rootprojects.orggreenlock.js/src/branch/master/examples)
|
||||||
-->
|
-->
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
|
@ -458,7 +458,7 @@ TODO
|
||||||
|
|
||||||
## SSL Certificate & Domain Management
|
## SSL Certificate & Domain Management
|
||||||
|
|
||||||
Full Docs: https://git.rootprojects.org/root/greenlock-manager-test.js
|
Full Docs: https://git.rootprojects.orggreenlock-manager-test.js
|
||||||
|
|
||||||
This is what keeps the mapping of domains <-> certificates.
|
This is what keeps the mapping of domains <-> certificates.
|
||||||
In many cases it will interact with the same database as the Key & Cert Store, and probably the code as well.
|
In many cases it will interact with the same database as the Key & Cert Store, and probably the code as well.
|
||||||
|
@ -507,7 +507,7 @@ In many cases it will interact with the same database as the Key & Cert Store, a
|
||||||
|
|
||||||
## Key and Certificate Store
|
## Key and Certificate Store
|
||||||
|
|
||||||
Full Docs: https://git.rootprojects.org/root/greenlock-store-test.js
|
Full Docs: https://git.rootprojects.orggreenlock-store-test.js
|
||||||
|
|
||||||
This set of callbacks update your service with new certificates and keypairs.
|
This set of callbacks update your service with new certificates and keypairs.
|
||||||
|
|
||||||
|
@ -655,12 +655,12 @@ Greenlock™ is a [trademark](https://rootprojects.org/legal/#trademark) of
|
||||||
|
|
||||||
The rule of thumb is "attribute, but don't confuse". For example:
|
The rule of thumb is "attribute, but don't confuse". For example:
|
||||||
|
|
||||||
> Built with [Greenlock Express](https://git.rootprojects.org/root/greenlock.js) (a [Root](https://rootprojects.org) project).
|
> Built with [Greenlock Express](https://git.rootprojects.orggreenlock.js) (a [Root](https://rootprojects.org) project).
|
||||||
|
|
||||||
Please [contact us](mailto:aj@therootcompany.com) if you have any questions in regards to our trademark,
|
Please [contact us](mailto:aj@therootcompany.com) if you have any questions in regards to our trademark,
|
||||||
attribution, and/or visible source policies. We want to build great software and a great community.
|
attribution, and/or visible source policies. We want to build great software and a great community.
|
||||||
|
|
||||||
[Greenlock™](https://git.rootprojects.org/root/greenlock.js) |
|
[Greenlock™](https://git.rootprojects.orggreenlock.js) |
|
||||||
MPL-2.0 |
|
MPL-2.0 |
|
||||||
[Terms of Use](https://therootcompany.com/legal/#terms) |
|
[Terms of Use](https://therootcompany.com/legal/#terms) |
|
||||||
[Privacy Policy](https://therootcompany.com/legal/#privacy)
|
[Privacy Policy](https://therootcompany.com/legal/#privacy)
|
||||||
|
|
|
@ -1,9 +1,28 @@
|
||||||
{
|
{
|
||||||
"name": "greenlock",
|
"name": "greenlock",
|
||||||
"version": "3.0.25",
|
"version": "3.1.0-wip",
|
||||||
"lockfileVersion": 1,
|
"lockfileVersion": 1,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
"@greenlock/manager": {
|
||||||
|
"version": "3.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/@greenlock/manager/-/manager-3.0.0.tgz",
|
||||||
|
"integrity": "sha512-ijgJrFdzJPmzrDk8aKXYoYR8LNfG3hXd9/s54ZY7IgxTulyPQ/qOPgl7sWgCxxLhZBzSY1xI6eC/6Y5TQ01agg==",
|
||||||
|
"requires": {
|
||||||
|
"greenlock-manager-fs": "^3.0.5"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"greenlock-manager-fs": {
|
||||||
|
"version": "3.0.5",
|
||||||
|
"resolved": "https://registry.npmjs.org/greenlock-manager-fs/-/greenlock-manager-fs-3.0.5.tgz",
|
||||||
|
"integrity": "sha512-r/q+tEFuDwklfzPfiGhcIrHuJxMrppC+EseESpu5f0DMokh+1iZVm9nGC/VE7/7GETdOYfEYhhQkmspsi8Gr/A==",
|
||||||
|
"requires": {
|
||||||
|
"@root/mkdirp": "^1.0.0",
|
||||||
|
"safe-replace": "^1.1.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"@root/acme": {
|
"@root/acme": {
|
||||||
"version": "3.0.8",
|
"version": "3.0.8",
|
||||||
"resolved": "https://registry.npmjs.org/@root/acme/-/acme-3.0.8.tgz",
|
"resolved": "https://registry.npmjs.org/@root/acme/-/acme-3.0.8.tgz",
|
||||||
|
@ -40,10 +59,11 @@
|
||||||
"integrity": "sha512-OaEub02ufoU038gy6bsNHQOjIn8nUjGiLcaRmJ40IUykneJkIW5fxDqKxQx48cszuNflYldsJLPPXCrGfHs8yQ=="
|
"integrity": "sha512-OaEub02ufoU038gy6bsNHQOjIn8nUjGiLcaRmJ40IUykneJkIW5fxDqKxQx48cszuNflYldsJLPPXCrGfHs8yQ=="
|
||||||
},
|
},
|
||||||
"@root/greenlock": {
|
"@root/greenlock": {
|
||||||
"version": "3.0.25",
|
"version": "3.1.5",
|
||||||
"resolved": "https://registry.npmjs.org/@root/greenlock/-/greenlock-3.0.25.tgz",
|
"resolved": "https://registry.npmjs.org/@root/greenlock/-/greenlock-3.1.5.tgz",
|
||||||
"integrity": "sha512-VC8H9MTkbqxlB2LGntmcq5cstkE0TdZLvxm25SO5i7c6abJBVMQafhTD415OXwoGimnmWTn6SZ93Fj73d9QX/w==",
|
"integrity": "sha512-qJ7OdHj6yQz8zdJCqurPtrUGF3j/L+Tz4cWFYRGN6+owCaAWhjc2rhafC6y/6asisBJWoZyGDypbaSfKh5097w==",
|
||||||
"requires": {
|
"requires": {
|
||||||
|
"@greenlock/manager": "^3.0.0",
|
||||||
"@root/acme": "^3.0.8",
|
"@root/acme": "^3.0.8",
|
||||||
"@root/csr": "^0.8.1",
|
"@root/csr": "^0.8.1",
|
||||||
"@root/keypairs": "^0.9.0",
|
"@root/keypairs": "^0.9.0",
|
||||||
|
@ -51,9 +71,20 @@
|
||||||
"@root/request": "^1.3.10",
|
"@root/request": "^1.3.10",
|
||||||
"acme-http-01-standalone": "^3.0.5",
|
"acme-http-01-standalone": "^3.0.5",
|
||||||
"cert-info": "^1.5.1",
|
"cert-info": "^1.5.1",
|
||||||
"greenlock-manager-fs": "^3.0.1",
|
"greenlock-manager-fs": "^3.0.5",
|
||||||
"greenlock-store-fs": "^3.2.0",
|
"greenlock-store-fs": "^3.2.0",
|
||||||
"safe-replace": "^1.1.0"
|
"safe-replace": "^1.1.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"greenlock-manager-fs": {
|
||||||
|
"version": "3.0.5",
|
||||||
|
"resolved": "https://registry.npmjs.org/greenlock-manager-fs/-/greenlock-manager-fs-3.0.5.tgz",
|
||||||
|
"integrity": "sha512-r/q+tEFuDwklfzPfiGhcIrHuJxMrppC+EseESpu5f0DMokh+1iZVm9nGC/VE7/7GETdOYfEYhhQkmspsi8Gr/A==",
|
||||||
|
"requires": {
|
||||||
|
"@root/mkdirp": "^1.0.0",
|
||||||
|
"safe-replace": "^1.1.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"@root/keypairs": {
|
"@root/keypairs": {
|
||||||
|
@ -106,15 +137,6 @@
|
||||||
"integrity": "sha512-8sJ78ElpbDJBHNeBzUbUVLsqKdccaa/BXF1uPTw3GrvQTBgrQrtObr2mUrE38vzYd8cEv+m/JBfDLioYcfXoaw==",
|
"integrity": "sha512-8sJ78ElpbDJBHNeBzUbUVLsqKdccaa/BXF1uPTw3GrvQTBgrQrtObr2mUrE38vzYd8cEv+m/JBfDLioYcfXoaw==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"greenlock-manager-fs": {
|
|
||||||
"version": "3.0.1",
|
|
||||||
"resolved": "https://registry.npmjs.org/greenlock-manager-fs/-/greenlock-manager-fs-3.0.1.tgz",
|
|
||||||
"integrity": "sha512-vZfGFq1TTKxaAqdGDUwNservrNzXx0xCwT/ovG/N378GrhS+U5S8B8LUlNtQU7Fdw6RToMiBcm22OOxSrvZ2zw==",
|
|
||||||
"requires": {
|
|
||||||
"@root/mkdirp": "^1.0.0",
|
|
||||||
"safe-replace": "^1.1.0"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"greenlock-store-fs": {
|
"greenlock-store-fs": {
|
||||||
"version": "3.2.0",
|
"version": "3.2.0",
|
||||||
"resolved": "https://registry.npmjs.org/greenlock-store-fs/-/greenlock-store-fs-3.2.0.tgz",
|
"resolved": "https://registry.npmjs.org/greenlock-store-fs/-/greenlock-store-fs-3.2.0.tgz",
|
||||||
|
|
|
@ -1,10 +1,12 @@
|
||||||
{
|
{
|
||||||
"name": "greenlock",
|
"name": "greenlock",
|
||||||
"version": "3.0.25",
|
"version": "3.1.0-wip",
|
||||||
"description": "The easiest Let's Encrypt client for Node.js and Browsers",
|
"description": "The easiest Let's Encrypt client for Node.js and Browsers",
|
||||||
"homepage": "https://rootprojects.org/greenlock/",
|
"homepage": "https://rootprojects.org/greenlock/",
|
||||||
"main": "greenlock.js",
|
"main": "greenlock.js",
|
||||||
"browser": {},
|
"browser": {},
|
||||||
|
"bin": {
|
||||||
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"*.js",
|
"*.js",
|
||||||
"lib",
|
"lib",
|
||||||
|
@ -37,13 +39,13 @@
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@root/acme": "^3.0.8",
|
"@root/acme": "^3.0.8",
|
||||||
"@root/csr": "^0.8.1",
|
"@root/csr": "^0.8.1",
|
||||||
"@root/greenlock": "^3.0.25",
|
"@root/greenlock": "^3.1.5",
|
||||||
"@root/keypairs": "^0.9.0",
|
"@root/keypairs": "^0.9.0",
|
||||||
"@root/mkdirp": "^1.0.0",
|
"@root/mkdirp": "^1.0.0",
|
||||||
"@root/request": "^1.3.10",
|
"@root/request": "^1.3.10",
|
||||||
"acme-http-01-standalone": "^3.0.5",
|
"acme-http-01-standalone": "^3.0.5",
|
||||||
"cert-info": "^1.5.1",
|
"cert-info": "^1.5.1",
|
||||||
"greenlock-manager-fs": "^3.0.1",
|
"greenlock-manager-fs": "^3.0.3",
|
||||||
"greenlock-store-fs": "^3.2.0",
|
"greenlock-store-fs": "^3.2.0",
|
||||||
"safe-replace": "^1.1.0"
|
"safe-replace": "^1.1.0"
|
||||||
},
|
},
|
||||||
|
|
|
@ -12,6 +12,7 @@ git checkout master -- package.json
|
||||||
git checkout master -- README.md
|
git checkout master -- README.md
|
||||||
sed -i '' -e 's|"name": ".root.greenlock"|"name": "greenlock"|' package.json
|
sed -i '' -e 's|"name": ".root.greenlock"|"name": "greenlock"|' package.json
|
||||||
sed -i '' -e 's|.root.greenlock|greenlock|' README.md
|
sed -i '' -e 's|.root.greenlock|greenlock|' README.md
|
||||||
|
sed -i '' '/bin.greenlock.js/d' package.json
|
||||||
npm install --save @root/greenlock@latest
|
npm install --save @root/greenlock@latest
|
||||||
git add package* README.md || true
|
git add package* README.md || true
|
||||||
git commit -m "bump" || true
|
git commit -m "bump" || true
|
||||||
|
|
Loading…
Reference in New Issue