Update README.md

master
basilhendroff 2020-05-21 13:32:50 +08:00 committed by GitHub
parent f111bde5b3
commit e6e4c03754
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions

View File

@ -3,7 +3,7 @@ The aim is to develop a script to install Caddy V2 in a FreeNAS jail
### Currently supported
The centrepiece is a rc.d script, which supports default methods such as `service caddy stop` and `service caddy status`, but also includes a modifed `service caddy start` method to support the Caddy V2 executable as well as the following extra commands:
The centrepiece is a rc.d script (in includes/caddy), which supports default methods such as `service caddy stop` and `service caddy status`, but also includes a modifed `service caddy start` method to support the Caddy V2 executable as well as the following extra commands:
1. `service caddy reload` - A config reload with zero downtime. More info at https://caddyserver.com/docs/command-line#caddy-reload
2. `service caddy validate` - Check for a valid Caddyfile configuration. More info at https://caddyserver.com/docs/command-line#caddy-validate
@ -12,7 +12,7 @@ Additional commands may be added at a later stage if deemed useful.
For other configurable script parameters, refer to the comments at the top of the rc.d script. At this stage, configurable script parameters include:
1. `caddy_enable` - Set to enable caddy. The default is disabled.
1. `caddy_enable` - Set to YES to enable caddy. The default is NO.
2. `caddy_bin_path` - location of the Caddy executable. The default is /usr/local/bin/caddy.
3. `caddy_config_path` - location of the Caddyfile. The default is /usr/local/www/Caddyfile
@ -28,7 +28,7 @@ Additional configurable script parameters may be added at a later stage if deeme
#### Build the install script
The script will mirror the steps below, that are presently manually executed.
The script will (eventually!) mirror the majority of steps below, which are presently executed manually.
```
# Set up the jail
iocage create --name="caddyv2" -r 11.3-RELEASE ip4_addr="vnet0|10.1.1.45/24" defaultrouter="10.1.1.1" boot="on" host_hostname="caddyv2" vnet="on"