diff --git a/README.md b/README.md index 2ff714d..a21000e 100644 --- a/README.md +++ b/README.md @@ -9,18 +9,45 @@ Works on Supports - * systemd (Ubuntu, Fedora, Arch, etc) - * launchd (OS X, macOS, Darwin) + * **systemd** (Ubuntu, Fedora, Arch, etc) + * **launchd** (OS X, macOS, Darwin) -Install +Quick 'n' Dirty +------ + +**Caddy**: + +``` +curl -L https://git.daplie.com/Daplie/caddy-installer/raw/master/install-caddy | bash +``` + +**Caddy + Features**: + +``` +curl -L https://git.daplie.com/Daplie/caddy-installer/raw/master/install-caddy | bash -s -- search,realip +``` + +The default site location is `/srv/www/` and the server begins immediately. + +``` +http://localhost +``` + +Install... the installer ------- Yes... you install the installer ```bash -curl -L https://git.daplie.com/Daplie/daplie-snippets/raw/master/caddy-installer/install-caddy -o install-caddy -sudo mv install-caddy /usr/local/bin/install-caddy -sudo chmod a+x /usr/local/bin/install-caddy +# download +curl -L https://git.daplie.com/Daplie/caddy-installer/raw/master/install-caddy -o install-caddy + +#change permissions +sudo chown root:root ./install-caddy +sudo chmod a+x ./install-caddy + +# move +sudo mv ./install-caddy /usr/local/bin/install-caddy ``` Usage @@ -39,6 +66,35 @@ Features: DNS,awslambda,cors,expires,filemanager,filter,git,hugo,ipfilter,jsonp,jwt,locale,mailout,minify,multipass,prometheus,ratelimit,realip,search,upload,cloudflare,digitalocean,dnsimple,dyn,gandi,googlecloud,linode,namecheap,ovh,rfc2136,route53,vultr ``` +Where do my websites go? +------------------- + +The default site is `/srv/www/localhost`. + +If you own a domain (say example.com) then you +should put a new folder in `/srv/www` (such as `/srv/www/example.com`) +and then edit `/etc/caddy/Caddyfile` to include a config such as this: + +```Caddyfile +https://example.com { + root /srv/www/example.com +} +https://www.example.com { + redir https://example.com +} +``` + +Start caddy on boot +------------------- + +Startup Scripts are installed by the installer :) + + * **systemd** (Ubuntu, Fedora, Arch, etc) + * **launchd** (OS X, macOS, Darwin) + +Caddy should begin running on ports 80 and 443 as soon as you install it +and should automatically start on boot + Caveats -------