mirror of
https://github.com/caddyserver/caddy.git
synced 2025-01-06 22:40:31 -05:00
Minor changes to readme
This commit is contained in:
parent
811c6a986f
commit
411f3256cc
1 changed files with 18 additions and 11 deletions
29
README.md
29
README.md
|
@ -7,15 +7,17 @@ Caddy is a web server for your files like Apache, nginx, or lighttpd, but with d
|
|||
|
||||
### Features
|
||||
|
||||
- SSL (TLS)
|
||||
- TLS
|
||||
- FastCGI (mostly for PHP sites)
|
||||
- WebSockets
|
||||
- IPv4 and IPv6 support
|
||||
- Gzip
|
||||
- FastCGI (yes, it can serve PHP sites)
|
||||
- Logging
|
||||
- Rewrite
|
||||
- Redirect
|
||||
- Extensionless (clean) URLs
|
||||
- Multi-core
|
||||
- Custom headers
|
||||
- Logging
|
||||
- Rewrites
|
||||
- Redirects
|
||||
- Multi-core
|
||||
- + more
|
||||
|
||||
Caddy is designed to be super-easy to use and configure.
|
||||
|
||||
|
@ -29,9 +31,9 @@ Caddy will, by default, serve the current working directory on [http://localhost
|
|||
|
||||
### Configuring Caddy
|
||||
|
||||
If the current directory has a file called `Caddyfile`, it will be loaded and parsed and used as configuration. To configure Caddy, use a Caddyfile.
|
||||
Use a Caddyfile to configure Caddy. If the current directory has a file called `Caddyfile`, it will be loaded and parsed and used as configuration.
|
||||
|
||||
A Caddyfile always starts with the address to bind to. The rest of the lines are configuration directives. Here's an example:
|
||||
A Caddyfile always starts with an address to bind to. The rest of the lines are configuration directives. Here's an example:
|
||||
|
||||
```
|
||||
mydomain.com:80
|
||||
|
@ -40,7 +42,7 @@ ext .html
|
|||
header /api Access-Control-Allow-Origin *
|
||||
```
|
||||
|
||||
This simple file enables gzip compression, serves clean URLs (tries `.html` files under the hood), and adds the coveted `Access-Control-Allow-Origin: *` header to all requests starting with `/api`. Wow! Caddy can do a lot with just four lines.
|
||||
This simple file enables gzip compression, serves clean URLs, and adds the coveted `Access-Control-Allow-Origin: *` header to all requests starting with `/api`. Wow! Caddy can do a lot with just four lines.
|
||||
|
||||
Maybe you want to serve both HTTP and HTTPS. You can define multiple (virtual) hosts using curly braces:
|
||||
|
||||
|
@ -63,4 +65,9 @@ Better documentation (and rigorous tests) are on their way as the program mature
|
|||
|
||||
### Contributing
|
||||
|
||||
Please submit your ideas in an issue or you can drop a quick [tweet to @mholt6](https://twitter.com/mholt6). Pull requests that fix bugs are totally welcome, too. (Pull requests for new features should be discussed in an issue first.) Thanks for being involved!
|
||||
Please get involved! Before adding a new feature or changing existing behavior, open an issue to discuss it. For other non-breaking changes and bug fixes, pull requests are accepted. You can also drop a quick [tweet to @mholt6](https://twitter.com/mholt6) for quick feedback or comments.
|
||||
|
||||
|
||||
### About the project
|
||||
|
||||
Caddy was born out of the need for a lightweight but configurable web server that didn't have to be "installed" and was readily available for any platform. Caddy took some inspiration from nginx, lighttpd, Websocketd, and Vagrant, and provides a pleasant mixture of the handy features from each of them. Caddy is suitable for use in both dev and production environments.
|
||||
|
|
Loading…
Reference in a new issue