mirror of
				https://github.com/therootcompany/greenlock.js.git
				synced 2024-11-16 17:29:00 +00:00 
			
		
		
		
	Compare commits
	
		
			No commits in common. "8ff17a093925e6667ea67f1f0c63cc44c643eeef" and "1a9f1d2a3414884adfb25ac7be8d63d094f21d34" have entirely different histories.
		
	
	
		
			8ff17a0939
			...
			1a9f1d2a34
		
	
		
							
								
								
									
										30
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										30
									
								
								README.md
									
									
									
									
									
								
							@ -1,4 +1,4 @@
 | 
			
		||||
# New Documentation & [v2/v3 Migration Guide](https://git.rootprojects.orggreenlock.js/src/branch/v3/MIGRATION_GUIDE_V2_V3.md)
 | 
			
		||||
# New Documentation & [v2/v3 Migration Guide](https://git.rootprojects.org/root/greenlock.js/src/branch/v3/MIGRATION_GUIDE_V2_V3.md)
 | 
			
		||||
 | 
			
		||||
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.
 | 
			
		||||
 | 
			
		||||
To start, check out the
 | 
			
		||||
[Migration Guide](https://git.rootprojects.orggreenlock.js/src/branch/v3/MIGRATION_GUIDE_V2_V3.md).
 | 
			
		||||
[Migration Guide](https://git.rootprojects.org/root/greenlock.js/src/branch/v3/MIGRATION_GUIDE_V2_V3.md).
 | 
			
		||||
 | 
			
		||||

 | 
			
		||||

 | 
			
		||||
 | 
			
		||||

 | 
			
		||||

 | 
			
		||||
 | 
			
		||||
# [Greenlock](https://git.rootprojects.orggreenlock.js) is Let's Encrypt for JavaScript
 | 
			
		||||
# [Greenlock](https://git.rootprojects.org/root/greenlock.js) is Let's Encrypt for JavaScript
 | 
			
		||||
 | 
			
		||||
| Built by [Root](https://rootprojects.org) for [Hub](https://rootprojects.org/hub/)
 | 
			
		||||
 | 
			
		||||
Greenlock™ is an Automated Certificate Management Environement 🔐.
 | 
			
		||||
 | 
			
		||||
| **Greenlock** | [Greenlock Express](https://git.rootprojects.orggreenlock-express.js) | [ACME.js](https://git.rootprojects.org/root/acme.js) |
 | 
			
		||||
| **Greenlock** | [Greenlock Express](https://git.rootprojects.org/root/greenlock-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 supports **Automated Renewal** of certs for Fully Automated HTTPS.
 | 
			
		||||
@ -289,7 +289,7 @@ gl.add({
 | 
			
		||||
## Greenlock#get()
 | 
			
		||||
 | 
			
		||||
**Disclaimer**: This is only intended for testing, demos, and SNICallback
 | 
			
		||||
(in [Greenlock Express](https://git.rootprojects.orggreenlock-express.js)).
 | 
			
		||||
(in [Greenlock Express](https://git.rootprojects.org/root/greenlock-express.js)).
 | 
			
		||||
 | 
			
		||||
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)
 | 
			
		||||
of certificate requests.
 | 
			
		||||
 | 
			
		||||
-   [Store Callback Documentation](https://git.rootprojects.orggreenlock-store-test.js)
 | 
			
		||||
-   [Store Callback Documentation](https://git.rootprojects.org/root/greenlock-store-test.js)
 | 
			
		||||
 | 
			
		||||
```js
 | 
			
		||||
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.
 | 
			
		||||
 | 
			
		||||
```bash
 | 
			
		||||
npm install --save greenlock
 | 
			
		||||
npm install --save @root/greenlock
 | 
			
		||||
npm install --save greenlock-manager-fs
 | 
			
		||||
npm install --save greenlock-store-fs
 | 
			
		||||
npm install --save acme-http-01-standalone
 | 
			
		||||
@ -420,7 +420,7 @@ TODO
 | 
			
		||||
```js
 | 
			
		||||
'use strict';
 | 
			
		||||
 | 
			
		||||
var Greenlock = require(greenlock-express);
 | 
			
		||||
var Greenlock = require(@root/greenlock-express);
 | 
			
		||||
 | 
			
		||||
var greenlock = Greenlock.create({
 | 
			
		||||
// for security and critical bug notices
 | 
			
		||||
@ -450,7 +450,7 @@ TODO
 | 
			
		||||
<!-- greenlock-manager-test => greenlock-manager-custom -->
 | 
			
		||||
 | 
			
		||||
<!--
 | 
			
		||||
- [greenlock.js/examples/](https://git.rootprojects.orggreenlock.js/src/branch/master/examples)
 | 
			
		||||
- [greenlock.js/examples/](https://git.rootprojects.org/root/greenlock.js/src/branch/master/examples)
 | 
			
		||||
-->
 | 
			
		||||
 | 
			
		||||
<details>
 | 
			
		||||
@ -458,7 +458,7 @@ TODO
 | 
			
		||||
 | 
			
		||||
## SSL Certificate & Domain Management
 | 
			
		||||
 | 
			
		||||
Full Docs: https://git.rootprojects.orggreenlock-manager-test.js
 | 
			
		||||
Full Docs: https://git.rootprojects.org/root/greenlock-manager-test.js
 | 
			
		||||
 | 
			
		||||
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.
 | 
			
		||||
@ -507,7 +507,7 @@ In many cases it will interact with the same database as the Key & Cert Store, a
 | 
			
		||||
 | 
			
		||||
## Key and Certificate Store
 | 
			
		||||
 | 
			
		||||
Full Docs: https://git.rootprojects.orggreenlock-store-test.js
 | 
			
		||||
Full Docs: https://git.rootprojects.org/root/greenlock-store-test.js
 | 
			
		||||
 | 
			
		||||
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:
 | 
			
		||||
 | 
			
		||||
> Built with [Greenlock Express](https://git.rootprojects.orggreenlock.js) (a [Root](https://rootprojects.org) project).
 | 
			
		||||
> Built with [Greenlock Express](https://git.rootprojects.org/root/greenlock.js) (a [Root](https://rootprojects.org) project).
 | 
			
		||||
 | 
			
		||||
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.
 | 
			
		||||
 | 
			
		||||
[Greenlock™](https://git.rootprojects.orggreenlock.js) |
 | 
			
		||||
[Greenlock™](https://git.rootprojects.org/root/greenlock.js) |
 | 
			
		||||
MPL-2.0 |
 | 
			
		||||
[Terms of Use](https://therootcompany.com/legal/#terms) |
 | 
			
		||||
[Privacy Policy](https://therootcompany.com/legal/#privacy)
 | 
			
		||||
 | 
			
		||||
							
								
								
									
										50
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										50
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							@ -1,28 +1,9 @@
 | 
			
		||||
{
 | 
			
		||||
    "name": "greenlock",
 | 
			
		||||
    "version": "3.1.0-wip",
 | 
			
		||||
    "version": "3.0.25",
 | 
			
		||||
    "lockfileVersion": 1,
 | 
			
		||||
    "requires": true,
 | 
			
		||||
    "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": {
 | 
			
		||||
            "version": "3.0.8",
 | 
			
		||||
            "resolved": "https://registry.npmjs.org/@root/acme/-/acme-3.0.8.tgz",
 | 
			
		||||
@ -59,11 +40,10 @@
 | 
			
		||||
            "integrity": "sha512-OaEub02ufoU038gy6bsNHQOjIn8nUjGiLcaRmJ40IUykneJkIW5fxDqKxQx48cszuNflYldsJLPPXCrGfHs8yQ=="
 | 
			
		||||
        },
 | 
			
		||||
        "@root/greenlock": {
 | 
			
		||||
            "version": "3.1.5",
 | 
			
		||||
            "resolved": "https://registry.npmjs.org/@root/greenlock/-/greenlock-3.1.5.tgz",
 | 
			
		||||
            "integrity": "sha512-qJ7OdHj6yQz8zdJCqurPtrUGF3j/L+Tz4cWFYRGN6+owCaAWhjc2rhafC6y/6asisBJWoZyGDypbaSfKh5097w==",
 | 
			
		||||
            "version": "3.0.25",
 | 
			
		||||
            "resolved": "https://registry.npmjs.org/@root/greenlock/-/greenlock-3.0.25.tgz",
 | 
			
		||||
            "integrity": "sha512-VC8H9MTkbqxlB2LGntmcq5cstkE0TdZLvxm25SO5i7c6abJBVMQafhTD415OXwoGimnmWTn6SZ93Fj73d9QX/w==",
 | 
			
		||||
            "requires": {
 | 
			
		||||
                "@greenlock/manager": "^3.0.0",
 | 
			
		||||
                "@root/acme": "^3.0.8",
 | 
			
		||||
                "@root/csr": "^0.8.1",
 | 
			
		||||
                "@root/keypairs": "^0.9.0",
 | 
			
		||||
@ -71,20 +51,9 @@
 | 
			
		||||
                "@root/request": "^1.3.10",
 | 
			
		||||
                "acme-http-01-standalone": "^3.0.5",
 | 
			
		||||
                "cert-info": "^1.5.1",
 | 
			
		||||
                "greenlock-manager-fs": "^3.0.5",
 | 
			
		||||
                "greenlock-manager-fs": "^3.0.1",
 | 
			
		||||
                "greenlock-store-fs": "^3.2.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": {
 | 
			
		||||
@ -137,6 +106,15 @@
 | 
			
		||||
            "integrity": "sha512-8sJ78ElpbDJBHNeBzUbUVLsqKdccaa/BXF1uPTw3GrvQTBgrQrtObr2mUrE38vzYd8cEv+m/JBfDLioYcfXoaw==",
 | 
			
		||||
            "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": {
 | 
			
		||||
            "version": "3.2.0",
 | 
			
		||||
            "resolved": "https://registry.npmjs.org/greenlock-store-fs/-/greenlock-store-fs-3.2.0.tgz",
 | 
			
		||||
 | 
			
		||||
@ -1,12 +1,10 @@
 | 
			
		||||
{
 | 
			
		||||
    "name": "greenlock",
 | 
			
		||||
    "version": "3.1.0-wip",
 | 
			
		||||
    "version": "3.0.25",
 | 
			
		||||
    "description": "The easiest Let's Encrypt client for Node.js and Browsers",
 | 
			
		||||
    "homepage": "https://rootprojects.org/greenlock/",
 | 
			
		||||
    "main": "greenlock.js",
 | 
			
		||||
    "browser": {},
 | 
			
		||||
    "bin": {
 | 
			
		||||
    },
 | 
			
		||||
    "files": [
 | 
			
		||||
        "*.js",
 | 
			
		||||
        "lib",
 | 
			
		||||
@ -39,13 +37,13 @@
 | 
			
		||||
    "dependencies": {
 | 
			
		||||
        "@root/acme": "^3.0.8",
 | 
			
		||||
        "@root/csr": "^0.8.1",
 | 
			
		||||
        "@root/greenlock": "^3.1.5",
 | 
			
		||||
        "@root/greenlock": "^3.0.25",
 | 
			
		||||
        "@root/keypairs": "^0.9.0",
 | 
			
		||||
        "@root/mkdirp": "^1.0.0",
 | 
			
		||||
        "@root/request": "^1.3.10",
 | 
			
		||||
        "acme-http-01-standalone": "^3.0.5",
 | 
			
		||||
        "cert-info": "^1.5.1",
 | 
			
		||||
        "greenlock-manager-fs": "^3.0.3",
 | 
			
		||||
        "greenlock-manager-fs": "^3.0.1",
 | 
			
		||||
        "greenlock-store-fs": "^3.2.0",
 | 
			
		||||
        "safe-replace": "^1.1.0"
 | 
			
		||||
    },
 | 
			
		||||
 | 
			
		||||
@ -12,7 +12,6 @@ git checkout master -- package.json
 | 
			
		||||
git checkout master -- README.md
 | 
			
		||||
sed -i '' -e 's|"name": ".root.greenlock"|"name": "greenlock"|' package.json
 | 
			
		||||
sed -i '' -e 's|.root.greenlock|greenlock|' README.md
 | 
			
		||||
sed -i '' '/bin.greenlock.js/d' package.json
 | 
			
		||||
npm install --save @root/greenlock@latest
 | 
			
		||||
git add package* README.md || true
 | 
			
		||||
git commit -m "bump" || true
 | 
			
		||||
 | 
			
		||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user