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

update docs

Browse Source
This commit is contained in:
AJ ONeal 2020-01-11 13:15:39 -07:00
parent a9feafeab3
commit 99f6ab0c1e
1 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -1,4 +1,4 @@
# [Greenlock Express](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/) |
@ -89,6 +89,8 @@ Works with _any_ node http app, including
Easy as 1, 2, 3... 4 Easy as 1, 2, 3... 4
### Overview
1. Create a Project with Greenlock Express 1. Create a Project with Greenlock Express
- `server.js` - `server.js`
- `app.js` - `app.js`
@ -99,6 +101,8 @@ Easy as 1, 2, 3... 4
4. Hello, World! 4. Hello, World!
- `npm start -- --staging` - `npm start -- --staging`
## 1. Create your Project
```bash ```bash
npm init npm init
npm install --save greenlock-express@v4 npm install --save greenlock-express@v4
@ -106,6 +110,8 @@ npm install --save greenlock-express@v4
You can use **local file storage** or a **database**. The default is to use file storage. You can use **local file storage** or a **database**. The default is to use file storage.
## 2. Initialize and Config (Dir or DB)
```bash ```bash
# Note: you can use the CLI to create `server.js` and `greenlock.d/config.json` # Note: you can use the CLI to create `server.js` and `greenlock.d/config.json`
npx greenlock init --config-dir ./greenlock.d --maintainer-email 'jon@example.com' npx greenlock init --config-dir ./greenlock.d --maintainer-email 'jon@example.com'
@ -147,7 +153,7 @@ var app = function(req, res) {
module.exports = app; module.exports = app;
``` ```
</details> ### 3. Add Sites
```bash ```bash
# Note: you can use the CLI to edit the config file # Note: you can use the CLI to edit the config file
@ -162,6 +168,8 @@ npx greenlock add --subject example.com --altnames example.com
{ "sites": [{ "subject": "example.com", "altnames": ["example.com"] }] } { "sites": [{ "subject": "example.com", "altnames": ["example.com"] }] }
``` ```
### 4. Hello, Encrypted World!
```bash ```bash
# Note: you can use npm start to run server.js with the --staging flag set # Note: you can use npm start to run server.js with the --staging flag set
npm start -- --staging npm start -- --staging
@ -177,7 +185,8 @@ Listening on 0.0.0.0:443 for secure traffic
## Walkthrough ## Walkthrough
Read the full [WALKTHROUGH](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/WALKTHROUGH.md) For a more detail read the full
[WALKTHROUGH](https://git.rootprojects.org/root/greenlock-express.js/src/branch/master/WALKTHROUGH.md).
# Examples # Examples