coolaj86/greenlock-express.js
1
0
Fork 0
mirror of https://github.com/therootcompany/greenlock-express.js.git synced 2024-11-16 17:28:59 +00:00
Code Issues 1 Projects Releases Wiki Activity

Mark as Mirror

Browse Source
This commit is contained in:
AJ ONeal 2020-08-03 01:06:05 -06:00
parent ca0ba9bc68
commit 34a0475b9d
1 changed files with 29 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
README.md
View File

@ -1,3 +1,10 @@
# Mirror of git.rootprojects.org/root/greenlock-express.js
Github does not expose the ability to automatically update mirrors,
so this may lag behind the official repository which is found at:
- <https://git.rootprojects.org/root/greenlock-express.js>
# [Greenlock Express v4](https://git.rootprojects.org/root/greenlock-express.js) is Let's Encrypt for Node # [Greenlock Express v4](https://git.rootprojects.org/root/greenlock-express.js) is Let's Encrypt for Node
| Built by [Root](https://therootcompany.com) for [Hub](https://rootprojects.org/hub/) | | Built by [Root](https://therootcompany.com) for [Hub](https://rootprojects.org/hub/) |
@ -167,16 +174,16 @@ Create `server.js` like so:
`server.js`: `server.js`:
```js ```js
'use strict'; "use strict";
var app = require('./app.js'); var app = require("./app.js");
require('greenlock-express') require("greenlock-express")
.init({ .init({
packageRoot: __dirname, packageRoot: __dirname,
// where to look for configuration // where to look for configuration
configDir: './greenlock.d', configDir: "./greenlock.d",
// whether or not to run at cloudscale // whether or not to run at cloudscale
cluster: false cluster: false
@ -191,12 +198,12 @@ Create `app.js` like so:
`app.js`: `app.js`:
```js ```js
'use strict'; "use strict";
// Here's a vanilla HTTP app to start, // Here's a vanilla HTTP app to start,
// but feel free to replace it with Express, Koa, etc // but feel free to replace it with Express, Koa, etc
var app = function(req, res) { var app = function (req, res) {
res.end('Hello, Encrypted World!'); res.end("Hello, Encrypted World!");
}; };
module.exports = app; module.exports = app;
@ -208,7 +215,7 @@ as well as where its root directory is.
`.greenlockrc` `.greenlockrc`
```json ```json
{"manager":{"module":"@greenlock/manager"},"configDir":"greenlock.d"} { "manager": { "module": "@greenlock/manager" }, "configDir": "greenlock.d" }
``` ```
The `greenlock.d/config.json` is NOT intended to be edited by hand, as it is a substitute for a database, but it looks like this: The `greenlock.d/config.json` is NOT intended to be edited by hand, as it is a substitute for a database, but it looks like this:
@ -240,7 +247,7 @@ You should NOT edit `greenlock.d/config.json` with your own tools. Use `greenloc
<!-- TODO update manager to write array rather than object --> <!-- TODO update manager to write array rather than object -->
```json ```json
{ "sites": [{ "subject": "example.com", "altnames": [ "example.com", "www.example.com" ] }] } { "sites": [{ "subject": "example.com", "altnames": ["example.com", "www.example.com"] }] }
``` ```
## 4. Hello, Encrypted World! ## 4. Hello, Encrypted World!
@ -281,19 +288,21 @@ echo '<h1>Hello!</h1>' >> public/index.html
`app.js`: `app.js`:
```js ```js
'use strict'; "use strict";
var path = require('path'); var path = require("path");
var express = require('express'); var express = require("express");
var app = express(); var app = express();
app.get('/', express.static(path.join(__dirname, "public"))); app.get("/", express.static(path.join(__dirname, "public")));
module.exports = app; module.exports = app;
// for development and debugging // for development and debugging
if (require.main === module) { if (require.main === module) {
require('http').createServer(app).listen(3000, function () { require("http")
.createServer(app)
.listen(3000, function () {
console.info("Listening for HTTP on", this.address()); console.info("Listening for HTTP on", this.address());
}); });
} }
@ -333,8 +342,8 @@ To see all of the examples, just browse [greenlock-express.js/examples/](https:/
[ex-cicd]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/ci-cd/ [ex-cicd]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/ci-cd/
[ex-http-proxy]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/http-proxy/ [ex-http-proxy]: https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/examples/http-proxy/
# FAQ # FAQ
## 1. But did YOU read the QuickStart? ## 1. But did YOU read the QuickStart?
99% of the questions I get are answered in the QuickStart, or in the Examples. 99% of the questions I get are answered in the QuickStart, or in the Examples.