doc: updated, recipe: auto tls

Signed-off-by: Vishal Rana <[email protected]>

Author: vishr

echo.go

@@ -1,5 +1,5 @@
 /*
-Package echo implements a fast and unfancy HTTP server framework for Go (Golang).
+Package echo implements high performance, minimalist Go web framework.
 
 Example:
 

recipe/auto-tls/server.go

@@ -0,0 +1,21 @@
+package main
+
+import (
+	"net/http"
+
+	"github.com/labstack/echo"
+	"github.com/labstack/echo/middleware"
+)
+
+func main() {
+	e := echo.New()
+	e.Use(middleware.Recover())
+	e.Use(middleware.Logger())
+	e.GET("/", func(c echo.Context) error {
+		return c.HTML(http.StatusOK, `
+			<h1>Welcome to Echo!</h1>
+			<h3>TLS certificates automatically installed from Let's Encrypt :)</h3>
+		`)
+	})
+	e.StartAutoTLS(":443", []string{"<your_domain>"}, "le.cache")
+}

website/config.json

@@ -1,7 +1,7 @@
 {
   "baseurl": "https://echo.labstack.com",
   "languageCode": "en-us",
-  "title": "Echo - Fast and Unfancy Go Web Framework",
+  "title": "Echo - High performance, minimalist Go web framework",
   "canonifyurls": true,
   "googleAnalytics": "UA-85059636-2",
   "permalinks": {

website/content/guide/context.md

@@ -3,7 +3,6 @@ title = "Context"
 description = "Context in Echo"
 [menu.main]
   name = "Context"
-  identifier = "context"
   parent = "guide"
   weight = 5
 +++

website/content/middleware/basic-auth.md

@@ -1,13 +1,13 @@
 +++
-title = "BasicAuth Middleware"
+title = "Basic Auth Middleware"
 description = "Basic auth middleware for Echo"
 [menu.main]
-  name = "BasicAuth"
+  name = "Basic Auth"
   parent = "middleware"
   weight = 5
 +++
 
-BasicAuth middleware provides an HTTP basic authentication.
+Basic auth middleware provides an HTTP basic authentication.
 
 - For valid credentials it calls the next handler.
 - For invalid credentials, it sends "401 - Unauthorized" response.

website/content/middleware/body-limit.md

@@ -1,13 +1,13 @@
 +++
-title = "BodyLimit Middleware"
+title = "Body Limit Middleware"
 description = "Body limit middleware for Echo"
 [menu.main]
-  name = "BodyLimit"
+  name = "Body Limit"
   parent = "middleware"
   weight = 5
 +++
 
-BodyLimit middleware sets the maximum allowed size for a request body, if the
+Body limit middleware sets the maximum allowed size for a request body, if the
 size exceeds the configured limit, it sends "413 - Request Entity Too Large"
 response. The body limit is determined based on both `Content-Length` request
 header and actual content read, which makes it super secure.

website/content/middleware/method-override.md

@@ -1,13 +1,13 @@
 +++
-title = "MethodOverride Middleware"
+title = "Method Override Middleware"
 description = "Method override middleware for Echo"
 [menu.main]
-  name = "MethodOverride"
+  name = "Method Override"
   parent = "middleware"
   weight = 5
 +++
 
-MethodOverride middleware checks for the overridden method from the request and
+Method override middleware checks for the overridden method from the request and
 uses it instead of the original method.
 
 For security reasons, only `POST` method can be overridden.

website/content/middleware/redirect.md

@@ -7,9 +7,9 @@ description = "Redirect middleware for Echo"
   weight = 5
 +++
 
-## HTTPSRedirect
+## HTTPS Redirect
 
-HTTPSRedirect middleware redirects http requests to https.
+HTTPS redirect middleware redirects http requests to https.
 For example, http://labstack.com will be redirected to https://labstack.com.
 
 *Usage*
@@ -19,9 +19,9 @@ e := echo.New()
 e.Pre(middleware.HTTPSRedirect())
 ```
 
-## HTTPSWWWRedirect
+## HTTPS WWW Redirect
 
-HTTPSWWWRedirect redirects http requests to www https.
+HTTPS WWW redirect redirects http requests to www https.
 For example, http://labstack.com will be redirected to https://www.labstack.com.
 
 *Usage*
@@ -31,9 +31,9 @@ e := echo.New()
 e.Pre(middleware.HTTPSWWWRedirect())
 ```
 
-## HTTPSNonWWWRedirect
+## HTTPS NonWWW Redirect
 
-HTTPSNonWWWRedirect redirects http requests to https non www.
+HTTPS NonWWW redirect redirects http requests to https non www.
 For example, http://www.labstack.com will be redirect to https://labstack.com.
 
 *Usage*
@@ -43,9 +43,9 @@ e := echo.New()
 e.Pre(middleware.HTTPSNonWWWRedirect())
 ```
 
-## WWWRedirect
+## WWW Redirect
 
-WWWRedirect redirects non www requests to www.
+WWW redirect redirects non www requests to www.
 
 For example, http://labstack.com will be redirected to http://www.labstack.com.
 
@@ -56,9 +56,9 @@ e := echo.New()
 e.Pre(middleware.WWWRedirect())
 ```
 
-## NonWWWRedirect
+## NonWWW Redirect
 
-NonWWWRedirect redirects www requests to non www.
+NonWWW redirect redirects www requests to non www.
 For example, http://www.labstack.com will be redirected to http://labstack.com.
 
 *Usage*

website/content/middleware/trailing-slash.md

@@ -1,15 +1,15 @@
 +++
-title = "TrailingSlash Middleware"
+title = "Trailing Slash Middleware"
 description = "Trailing slash middleware for Echo"
 [menu.main]
-  name = "TrailingSlash"
+  name = "Trailing Slash"
   parent = "middleware"
   weight = 5
 +++
 
-## AddTrailingSlash Middleware
+## Add Trailing Slash  
 
-AddTrailingSlash middleware adds a trailing slash to the request URI.
+Add trailing slash middleware adds a trailing slash to the request URI.
 
 *Usage*
 
@@ -18,9 +18,9 @@ e := echo.New()
 e.Pre(middleware.AddTrailingSlash())
 ```
 
-## RemoveTrailingSlash Middleware
+## Remove Trailing Slash
 
-RemoveTrailingSlash middleware removes a trailing slash from the request URI.
+Remove trailing slash middleware removes a trailing slash from the request URI.
 
 *Usage*
 

website/content/recipes/auto-tls.md

@@ -0,0 +1,29 @@
++++
+title = "Auto TLS Example"
+description = "Automatic TLS certificates from Let's Encrypt example for Echo"
+[menu.main]
+  name = "Auto TLS"
+  parent = "recipes"
+  weight = 2
++++
+
+This recipe shows how to obtain TLS certificates for a domain automatically from
+Let's Encrypt. `Echo#StartAutoTLS` accepts address which should listen on port `443`,
+list of host names for security and a file path to cache the certificates. 
+
+Browse to https://<your_domain>. If everything goes fine, you should see a welcome
+message with TLS enabled on the website.
+
+> To redirect HTTP traffic to HTTPS, you can use [redirect middleware](/middleware/redirect#https-redirect)
+
+## Server
+
+`server.go`
+
+{{< embed "auto-tls/server.go" >}}
+
+## [Source Code]({{< source "auto-tls" >}})
+
+## Maintainers
+
+- [vishr](https://github.com/vishr)