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 readme docs
Matthew Holt committed
Jul 3, 2019 at 14:50 UTC
ab101d75d0f2a855539d6fcf5d26af0fbec0db9e
1 file changed
+8
-31
README.md
+8
-31
@@ -13,6 +13,7 @@ Please file issues to propose new features and report bugs, and after the bug or
13
- [Install](#install)
14
- [Quick Start](#quick-start)
15
- [Configuration](#configuration)
16
+- [Full Documentation](#full-documentation)
17
- [List of Improvements](#list-of-improvements)
18
- [FAQ](#faq)
19
@@ -106,49 +107,25 @@ $ ./caddy stop
107
108
Note that this will stop any process named the same as `os.Args[0]`.
109
109
-Other commands:
110
+For other commands, please see [the Caddy 2 documentation](https://github.com/caddyserver/caddy/wiki/v2:-Documentation).
111
111
-```bash
112
-$ ./caddy run # same as start, but blocks forever
113
-$ ./caddy version # print the version
114
-$ ./caddy list-modules # print the installed modules (plugins)
115
-$ ./caddy environ # print the environment as seen by caddy
116
-```
112
113
## Configuration
114
115
Caddy 2 exposes an unprecedented level of control compared to any web server in existence. In Caddy 2, you are usually setting the actual values of the initialized types in memory that power everything from your HTTP handlers and TLS handshakes to your storage medium. Caddy 2 is also ridiculously extensible, with a module system that makes vast improvements over Caddy 1's plugin system.
116
122
-Nearly all of Caddy 2's configuration is contained in a single config document, rather than being spread across CLI flags and env variables and a configuration file as with other web servers (and Caddy 1). To wield the power of this design, you need to know how the config document is structured:
117
+Nearly all of Caddy 2's configuration is contained in a single config document, rather than being spread across CLI flags and env variables and a configuration file as with other web servers (and Caddy 1).
118
124
-```json
125
-{
126
- "admin": {},
127
- "storage": {},
128
- "apps": {}
129
-}
130
-```
119
+To wield the power of this design, you need to know how the config document is structured. Please see the [the Caddy 2 documentation in our wiki](https://github.com/caddyserver/caddy/wiki/v2:-Documentation) for details about Caddy's config structure.
120
132
-`"admin"` configures the endpoint which configures Caddy, like so:
121
+Configuration is normally given to Caddy through an API endpoint, which is likewise documented in the wiki pages.
122
134
-```json
135
-{
136
- "listen": "localhost:2019"
137
-}
138
-```
123
140
-`"storage"` configures Caddy's default storage mechanism. If unspecfied, the local file system is used in the `$HOME/.local/share` folder if `$XDG_DATA_HOME` is not set. A `caddy` subfolder will be created within the base folder. Example:
141
-
142
-```json
143
-{
144
- "system": "file_system",
145
- "root": "/var/caddy_storage"
146
-}
147
-```
124
+## Full Documentation
125
149
-`"apps"` is where the magic happens. Currently, Caddy 2 has two apps: `http` and `tls`.
126
+Caddy 2 is very much in development, so the documentation is an ongoing WIP, but the latest will be in our wiki for now:
127
151
-To learn how to use them, see their respective [wiki pages](https://github.com/caddyserver/caddy/wiki/v2:-Documentation).
128
+**https://github.com/caddyserver/caddy/wiki/v2:-Documentation**
129
130
131
## List of Improvements