Fast and extensible multi-platform HTTP/1-2-3 web server with automatic HTTPS
Mirrored from https://github.com/Slazee/caddy.git
Synced Nov 14, 05:15 UTC
Update v2 readme in prep for beta1
Matthew Holt committed
Sep 13, 2019 at 12:50 UTC
3b80c505fbb57fbf6f6abc429cacdade2ac08dc9
1 file changed
+17
-10
README.md
+17
-10
@@ -10,7 +10,7 @@ Please file issues to propose new features and report bugs, and after the bug or
10
11
### Menu
12
13
-- [Install](#install)
13
+- [Build from source](#build-from-source)
14
- [Quick Start](#quick-start)
15
- [Configuration](#configuration)
16
- [Full Documentation](#full-documentation)
@@ -18,14 +18,14 @@ Please file issues to propose new features and report bugs, and after the bug or
18
- [FAQ](#faq)
19
20
21
-## Install
21
+## Build from source
22
23
Requirements:
24
25
- [Go 1.13 or newer](https://golang.org/dl/)
26
- Make sure you do not disable [Go modules](https://github.com/golang/go/wiki/Modules) (`export GO111MODULE=auto`)
27
28
-Download source code:
28
+Download the `v2` source code:
29
30
```bash
31
$ git clone -b v2 "https://github.com/caddyserver/caddy.git"
@@ -358,15 +358,15 @@ Caddy 2 and Caddy Enterprise offer equal levels of security and, as mentioned, s
358
359
### Does Caddy 2 have telemetry?
360
361
-No. There was not enough academic interest to continue supporting it. If telemetry does get added later, it will not be on by default or will be vastly reduced in its scope so that it simply helps the community gain an understanding of how widely Caddy is deployed (i.e. counts of servers running, number of requests/connections handled, etc).
361
+No. There was not enough academic interest to continue supporting it. If telemetry does get added later, it will not be on by default or will be vastly reduced in its scope.
362
363
## Does Caddy 2 use HTTPS by default?
364
365
-Yes. HTTPS is automatic and enabled by default when possible, just like in Caddy 1. Basically, if your HTTP routes specify a `host` matcher with qualifying domain names, those names will be enabled for automatic HTTPS.
365
+Yes. HTTPS is automatic and enabled by default when possible, just like in Caddy 1. Basically, if your HTTP routes specify a `host` matcher with qualifying domain names, those names will be enabled for automatic HTTPS. Automatic HTTPS is disabled for domains which match certificates that are manually loaded by your config.
366
367
-## I'm getting HTTPS errors with Caddy 2. The certificates aren't valid?
367
+## How do I avoid Let's Encrypt rate limits with Caddy 2?
368
369
-During development, Caddy 2 uses Let's Encrypt's staging endpoint to avoid rate limit issues, so the certificates are not trusted. You can force the production endpoint if you are confident that your setup is correct and will last a while. You can add a catch-all automation policy to your `tls` app that specifies the production CA endpoint:
369
+As you are testing and developing with Caddy 2, you may wish to use test ("staging") certificates from Let's Encrypt to avoid rate limits. By default, Caddy 2 uses Let's Encrypt's production endpoint to get real certificates for your domains, but their [rate limits](https://letsencrypt.org/docs/rate-limits/) forbid testing and development use of this endpoint for good reasons. You can switch to their [staging endpoint](https://letsencrypt.org/docs/staging-environment/) by adding the staging CA to your automation policy in the `tls` app:
370
371
```json
372
"tls": {
@@ -375,7 +375,7 @@ During development, Caddy 2 uses Let's Encrypt's staging endpoint to avoid rate
375
{
376
"management": {
377
"module": "acme",
378
- "ca": "https://acme-v02.api.letsencrypt.org/directory"
378
+ "ca": "https://acme-staging-v02.api.letsencrypt.org/directory"
379
}
380
}
381
]
@@ -383,7 +383,14 @@ During development, Caddy 2 uses Let's Encrypt's staging endpoint to avoid rate
383
}
384
```
385
386
-## Can we get some access controls on the admin endpoint?
386
+Or with the Caddyfile:
387
+
388
+```
389
+tls {
390
+ ca https://acme-staging-v02.api.letsencrypt.org/directory
391
+}
392
+```
393
388
-Yeah, that's coming.
394
+## Can we get some access controls on the admin endpoint?
395
396
+Yeah, that's coming. For now, you can use a unix socket that is properly permissioned for some basic security.