🔐 Free SSL, Free Wildcard SSL, and Fully Automated HTTPS for node.js, issued by Let's Encrypt v2 via ACME. Issues and PRs on Github.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
AJ ONeal 6fdafec304 v3.0.1: feeling confident 3 years ago
bin v3.0.1: feeling confident 3 years ago
examples wip: yeah! 3 years ago
tests move manager.js to own module 3 years ago
.gitignore wip: yeah! 3 years ago
LICENSE Initial commit 3 years ago
README.md updates for greenlock-express 3 years ago
accounts.js updates for greenlock-express 3 years ago
certificates.js minor updates 3 years ago
errors.js wip: yeah! 3 years ago
express.js wip: yeah! 3 years ago
greenlock.js minor updates 3 years ago
order.js wip: yeah! 3 years ago
package-lock.json v3.0.1: feeling confident 3 years ago
package.json v3.0.1: feeling confident 3 years ago
plugins.js export PKG_DIR for other libs to override 3 years ago
user-events.js wip: yeah! 3 years ago
utils.js updates for greenlock-express 3 years ago

README.md

@root/greenlock

🔐 Free SSL, Free Wildcard SSL, and Fully Automated HTTPS for Node.js and Browsers, issued by Let's Encrypt v2 via ACME

Greenlock™ is the easiest way to integrate Let's Encrypt into your projects, products, and infrastructure.

  • Wildcard Certificates
  • IoT Environments
  • Enterprise and On-Prem
  • Private Networks
  • Localhost Development
  • Web Hosting Providers
  • Commercial support

We've built it simple enough for Hobbyists, and robust enough for the Enterprise.

JavaScript Library

Greenlock API (shared among JS implementations)

Instantiate

// Creates an instance of greenlock with certain default values

var gl = Greenlock.create({
	// Staging for testing environments
	staging: true,

	// This should be the contact who receives critical bug and security notifications
	// Optionally, you may receive other (very few) updates, such as important new features
	maintainerEmail: 'jon@example.com',
	maintainerUpdates: true, // default: false

	// The "Let's Encrypt Subscriber" (often the same as the maintainer)
	// NOT the end customer (except where that is also the maintainer)
	subscriberEmail: 'jon@example.com',
	agreeToTerms: true // default: false
});
Parameter Description
servername the default servername to use for non-sni requests (many IoT clients)
maintainerEmail the developer contact for critical bug and security notifications
maintainerUpdates (default: false) receive occasional non-critical notifications
maintainerPackage if you publish your package for others to use, require('./package.json').name here
maintainerPackageVersion if you publish your package for others to use, require('./package.json').version here
subscriberEmail the contact who agrees to the Let's Encrypt Subscriber Agreement and the Greenlock Terms of Service
this contact receives renewal failure notifications
agreeToTerms (default: false) either 'true' or a function that presents the Terms of Service and returns it once accepted
store override the default storage module
store.module the name of your storage module
store.xxxx options specific to your storage module
challenges['http-01'] provide an http-01 challenge module
challenges['dns-01'] provide a dns-01 challenge module
challenges['tls-alpn-01'] provide a tls-alpn-01 challenge module
challenges[type].module the name of your challenge module
challenges[type].xxxx module-specific options

Add Approved Domains

gl.add({
	subject: 'example.com',
	altnames: ['example.com', 'www.example.com', 'exampleapi.com']
});
Parameter Description
subject the first domain on, and identifier of the certificate
altnames first domain, plus additional domains
note: the order should always be the same
subscriberEmail if different from the default (i.e. multi-tenant, whitelabel)
agreeToTerms if subscriber is different from the default

Issue and Renew Certificates

This will renew only domains that have reached their renewAt or are within the befault renewOffset.

return greenlock
	.renew()
	.then(function(pems) {
		console.info(pems);
	})
	.then(function(results) {
		results.forEach(function(site) {
			if (site.error) {
				console.error(site.subject, site.error);
				return;
			}
		});
	});
Parameter Type Description
(optional) - ALL parameters are optional, but some should be paired
force bool force silly options, such as tiny durations
duplicate bool force the domain to renew, regardless of age or expiration

Note: only previous approved domains (via gl.add()) may be renewed

Note: this will NOT throw an error. It will return an array of certifates or errors.

More

TODO

Node.js
npm install --save @root/greenlock
npm install --save greenlock-manager-fs
npm install --save greenlock-store-fs
npm install --save acme-http-01-standalone

HTTP-01 & DNS-01 Integrations

For Public Web Servers running on a VPS, the default HTTP-01 challenge plugin will work just fine for most people.

However, for

  • Wildcard Certificates
  • IoT Environments
  • Enterprise On-Prem
  • Private Networks

Greenlock provides an easy way to integrate Let's Encrypt with your existing services through a variety of DNS-01 infrastructure

Why Typically file propagation is faster and more reliably than DNS propagation. Therefore, http-01 will be preferred to dns-01 except when wildcards or private domains are in use.

http-01 will only be supplied as a defaut if no other challenge is provided.

You can use ACME (Let's Encrypt) with