update docs
This commit is contained in:
parent
5db2a0b106
commit
d2ca6038dc
30
README.md
30
README.md
|
@ -4,11 +4,38 @@ Manages SSL Certificate issue and renewal for [Greenlock](https://git.rootprojec
|
||||||
|
|
||||||
Saves global and per-site config to a local File Sytem (current), with optional encrypted Cloud backup (coming soon).
|
Saves global and per-site config to a local File Sytem (current), with optional encrypted Cloud backup (coming soon).
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install --save greenlock@3
|
npm install --save greenlock@3
|
||||||
npm install --save greenlock-manager@3
|
npm install --save greenlock-manager@3
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
To enable encrypted cloud backup, when it becomes available:
|
||||||
|
|
||||||
|
```js
|
||||||
|
npx greenlock init --manager cloud --manager-config-file './greenlock.json'
|
||||||
|
```
|
||||||
|
|
||||||
|
For local file system only:
|
||||||
|
|
||||||
|
```js
|
||||||
|
npx greenlock init --manager fs --manager-config-file './greenlock.json'
|
||||||
|
```
|
||||||
|
|
||||||
|
Or, place this file in the root of your project:
|
||||||
|
|
||||||
|
`.greenlockrc`:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"manager": "@greenlock/manager",
|
||||||
|
"configFile": "./greenlock.json"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
# Greenlock Manager CLI & API
|
# Greenlock Manager CLI & API
|
||||||
|
|
||||||
All manager plugins have the **same API**.
|
All manager plugins have the **same API**.
|
||||||
|
@ -22,7 +49,7 @@ Instead, use the CLI (current) or Web API (coming soon).
|
||||||
## Initialize the Manager
|
## Initialize the Manager
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx greenlock init --manager cloud --manager-token 'xxxx' --manager-config-file './greenlock.json'
|
npx greenlock init --manager cloud --manager-config-file './greenlock.json'
|
||||||
```
|
```
|
||||||
|
|
||||||
Note: You **should not** initialize greenlock directly as
|
Note: You **should not** initialize greenlock directly as
|
||||||
|
@ -34,7 +61,6 @@ Instead use the file generated by the CLI `init` (shown above).
|
||||||
Greenlock.create({
|
Greenlock.create({
|
||||||
manager: "@greenlock/manager",
|
manager: "@greenlock/manager",
|
||||||
cloud: true,
|
cloud: true,
|
||||||
token: "xxxx",
|
|
||||||
configFile: "./greenlock.json",
|
configFile: "./greenlock.json",
|
||||||
packageRoot: __dirname
|
packageRoot: __dirname
|
||||||
});
|
});
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
{
|
{
|
||||||
"name": "@greenlock/manager",
|
"name": "@greenlock/manager",
|
||||||
"version": "3.0.0",
|
"version": "3.0.1",
|
||||||
"description": "FileSytem-based Manager with optional encrypted Cloud backup for Greenlock SSL",
|
"description": "FileSytem-based Manager with optional encrypted Cloud backup for Greenlock SSL",
|
||||||
"main": "manager.js",
|
"main": "manager.js",
|
||||||
"files": [
|
"files": [
|
||||||
|
|
Loading…
Reference in New Issue