diff --git a/README.md b/README.md index fa1a5ed0b..cc93b5cb9 100644 --- a/README.md +++ b/README.md @@ -73,23 +73,7 @@ $ cargo run --example # shows a list of available examples $ cargo run --example hello ``` -## TLS termination and reverse proxies - -Tide's default backend currently does not support TLS, and only supports HTTP/1.1. - -### To use with nginx - -In order to use nginx as reverse proxy for Tide, your upstream proxy configuration must include this line: - -``` -proxy_http_version 1.1; -``` - - -## Resources - -Read about the design here: - +# Tide's design: - [Rising Tide: building a modular web framework in the open](https://rustasync.github.io/team/2018/09/11/tide.html) - [Routing and extraction in Tide: a first sketch](https://rustasync.github.io/team/2018/10/16/tide-routing.html) - [Middleware in Tide](https://rustasync.github.io/team/2018/11/07/tide-middleware.html) @@ -97,8 +81,41 @@ Read about the design here: - [Tide, the present and future of](https://blog.yoshuawuyts.com/tide/) - [Tide channels](https://blog.yoshuawuyts.com/tide-channels/) -## Contributing - +# Community Resources +To add a link to this list, [edit the markdown +file](https://github.com/http-rs/tide/edit/master/README.md) and +submit a pull request (github login required)
Listing here +does not constitute an endorsement or recommendation from the tide +team. Use at your own risk. + +### Listeners +* [tide-rustls](https://github.com/http-rs/tide-rustls) tls for tide based on async-tls/rustls + +### Template engines +* [tide-tera](https://github.com/jbr/tide-tera) +* [tide-handlebars](https://github.com/No9/tide-handlebars) +* [askama](https://github.com/djc/askama) (includes support for tide) + +### Auth +* [tide-http-auth](https://github.com/chrisdickinson/tide-http-auth) + +### Middleware +* [tide-compress](https://github.com/Fishrock123/tide-compress) +* [tide-trace](https://github.com/no9/tide-trace) +* [tide-tracing](https://github.com/ethanboxx/tide-tracing) +* [opentelemetry-tide](https://github.com/asaaki/opentelemetry-tide) + +### Session Stores +* [async-redis-session](https://github.com/jbr/async-redis-session) +* [async-sqlx-session](https://github.com/jbr/async-sqlx-session) (sqlite and postgres currently) +* [async-mongodb-session](https://github.com/yoshuawuyts/async-mongodb-session/) + +### Example applications +* [tide-example](https://github.com/jbr/tide-example) (sqlx + askama) +* [playground-tide-mongodb](https://github.com/yoshuawuyts/playground-tide-mongodb) +* [tide-morth-example](https://github.com/No9/tide-morth-example/) + +# Contributing Want to join us? Check out our [The "Contributing" section of the guide][contributing] and take a look at some of these issues: diff --git a/src/lib.rs b/src/lib.rs index d9fe8a989..706d20373 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -171,6 +171,16 @@ //! } //! ``` //! +//! # HTTP Version 1.1 only +//! +//! Tide's default backend currently only supports HTTP/1.1. In order +//! to use nginx as reverse proxy for Tide, your upstream proxy +//! configuration must include this line: +//! +//! ```text +//! proxy_http_version 1.1; +//! ``` +//! //! # API Stability //! //! It's still early in Tide's development cycle. While the general shape of Tide might have