loading...
A separate source file contains the function to create the Echo instance and add the static
file handlers and middleware. Note the build tag on the first line which says to use this when not
-bulding with appengine or appenginevm tags (which thoese platforms automatically add for us). We also
+building with appengine or appenginevm tags (which those platforms automatically add for us). We also
have the main() function to start serving our app as normal. This should all be very familiar.
loading...
The handler-wireup that would normally also be a part of this Echo setup moves to separate files which diff --git a/docs/cookbook/graceful-shutdown.html b/docs/cookbook/graceful-shutdown.html index f6bc669b..29fdf8c0 100644 --- a/docs/cookbook/graceful-shutdown.html +++ b/docs/cookbook/graceful-shutdown.html @@ -10,7 +10,7 @@ - +
diff --git a/docs/cookbook/hello-world.html b/docs/cookbook/hello-world.html index fb948b2d..44fe7563 100644 --- a/docs/cookbook/hello-world.html +++ b/docs/cookbook/hello-world.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/http2-server-push.html b/docs/cookbook/http2-server-push.html index 2169a9da..3edfe8a3 100644 --- a/docs/cookbook/http2-server-push.html +++ b/docs/cookbook/http2-server-push.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/http2.html b/docs/cookbook/http2.html index 740b5898..bbd6ef50 100644 --- a/docs/cookbook/http2.html +++ b/docs/cookbook/http2.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/jsonp.html b/docs/cookbook/jsonp.html index 0cb3d27c..85345698 100644 --- a/docs/cookbook/jsonp.html +++ b/docs/cookbook/jsonp.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/jwt.html b/docs/cookbook/jwt.html index 0f67dec0..6e41446d 100644 --- a/docs/cookbook/jwt.html +++ b/docs/cookbook/jwt.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/load-balancing.html b/docs/cookbook/load-balancing.html index db823546..aeafbd93 100644 --- a/docs/cookbook/load-balancing.html +++ b/docs/cookbook/load-balancing.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/middleware.html b/docs/cookbook/middleware.html index 7038e69b..6f91fa6f 100644 --- a/docs/cookbook/middleware.html +++ b/docs/cookbook/middleware.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/reverse-proxy.html b/docs/cookbook/reverse-proxy.html index 3c98006a..3004a9b9 100644 --- a/docs/cookbook/reverse-proxy.html +++ b/docs/cookbook/reverse-proxy.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/sse.html b/docs/cookbook/sse.html index 0d364a60..14ba0467 100644 --- a/docs/cookbook/sse.html +++ b/docs/cookbook/sse.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/streaming-response.html b/docs/cookbook/streaming-response.html index e593a163..60223035 100644 --- a/docs/cookbook/streaming-response.html +++ b/docs/cookbook/streaming-response.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/subdomain.html b/docs/cookbook/subdomain.html index 5b688258..6ed086a1 100644 --- a/docs/cookbook/subdomain.html +++ b/docs/cookbook/subdomain.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/timeout.html b/docs/cookbook/timeout.html index 86fe94fa..23e34d2d 100644 --- a/docs/cookbook/timeout.html +++ b/docs/cookbook/timeout.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/twitter.html b/docs/cookbook/twitter.html index 45fbf883..7db522ae 100644 --- a/docs/cookbook/twitter.html +++ b/docs/cookbook/twitter.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookbook/websocket.html b/docs/cookbook/websocket.html index f1ec062e..a7bef860 100644 --- a/docs/cookbook/websocket.html +++ b/docs/cookbook/websocket.html @@ -10,7 +10,7 @@ - + diff --git a/docs/cookies.html b/docs/cookies.html index a65f2816..6029839c 100644 --- a/docs/cookies.html +++ b/docs/cookies.html @@ -10,7 +10,7 @@ - + diff --git a/docs/customization.html b/docs/customization.html index 78932060..94813d27 100644 --- a/docs/customization.html +++ b/docs/customization.html @@ -10,7 +10,7 @@ - + diff --git a/docs/error-handling.html b/docs/error-handling.html index 18482d08..e0610102 100644 --- a/docs/error-handling.html +++ b/docs/error-handling.html @@ -10,7 +10,7 @@ - + diff --git a/docs/ip-address.html b/docs/ip-address.html index 83976436..1c230b35 100644 --- a/docs/ip-address.html +++ b/docs/ip-address.html @@ -10,7 +10,7 @@ - + @@ -39,7 +39,7 @@In this case, use echo.ExtractIPDirect().
e.IPExtractor = echo.ExtractIPDirect()
X-Forwared-For (XFF) is the popular header to relay clients' IP addresses.
+
X-Forwarded-For (XFF) is the popular header to relay clients' IP addresses.
At each hop on the proxies, they append the request IP address at the end of the header.
Following example diagram illustrates this behavior.
┌──────────┐ ┌──────────┐ ┌──────────┐
───────────>│ Proxy 1 │───────────>│ Proxy 2 │───────────>│ Your app │
│ (IP: b) │ │ (IP: c) │ │ │
└──────────┘ └──────────┘ └──────────┘
Case 1.
XFF: "" "a" "a, b"
~~~~~~
Case 2.
XFF: "x" "x, a" "x, a, b"
~~~~~~~~~
↑ What your app will see
$ JAEGER_AGENT_HOST=192.168.1.10 JAEGER_AGENT_PORT=6831 ./myserver
The tracer can be initialized with values coming from environment variables. None of the env vars are required -and all of them can be overriden via direct setting of the property on the configuration object.
+and all of them can be overridden via direct setting of the property on the configuration object.| Property | Description |
|---|---|
| JAEGER_SERVICE_NAME | The service name |
| JAEGER_AGENT_HOST | The hostname for communicating with agent via UDP |
| JAEGER_AGENT_PORT | The port for communicating with agent via UDP |
| JAEGER_ENDPOINT | The HTTP endpoint for sending spans directly to a collector, i.e. http://jaeger-collector:14268/api/traces |
| JAEGER_USER | Username to send as part of "Basic" authentication to the collector endpoint |
| JAEGER_PASSWORD | Password to send as part of "Basic" authentication to the collector endpoint |
| JAEGER_REPORTER_LOG_SPANS | Whether the reporter should also log the spans |
| JAEGER_REPORTER_MAX_QUEUE_SIZE | The reporter's maximum queue size |
| JAEGER_REPORTER_FLUSH_INTERVAL | The reporter's flush interval, with units, e.g. "500ms" or "2s" ([valid units][timeunits]) |
| JAEGER_SAMPLER_TYPE | The sampler type |
| JAEGER_SAMPLER_PARAM | The sampler parameter (number) |
| JAEGER_SAMPLER_MANAGER_HOST_PORT | The HTTP endpoint when using the remote sampler, i.e. http://jaeger-agent:5778/sampling |
| JAEGER_SAMPLER_MAX_OPERATIONS | The maximum number of operations that the sampler will keep track of |
| JAEGER_SAMPLER_REFRESH_INTERVAL | How often the remotely controlled sampler will poll jaeger-agent for the appropriate sampling strategy, with units, e.g. "1m" or "30s" ([valid units][timeunits]) |
| JAEGER_TAGS | A comma separated list of name = value tracer level tags, which get added to all reported spans. The value can also refer to an environment variable using the format ${envVarName:default}, where the :default is optional, and identifies a value to be used if the environment variable cannot be found |
| JAEGER_DISABLED | Whether the tracer is disabled or not. If true, the default opentracing.NoopTracer is used. |
| JAEGER_RPC_METRICS | Whether to store RPC metrics |
By default, the client sends traces via UDP to the agent at localhost:6831. Use JAEGER_AGENT_HOST and
JAEGER_AGENT_PORT to send UDP traces to a different host:port. If JAEGER_ENDPOINT is set, the client sends traces
diff --git a/docs/middleware/jwt.html b/docs/middleware/jwt.html
index 87824ee0..18434d2a 100644
--- a/docs/middleware/jwt.html
+++ b/docs/middleware/jwt.html
@@ -10,7 +10,7 @@
-
+
group := root.Group("somepath")
group.Use(middleware.Static(filepath.Join("filesystempath")))
// When an incoming request comes for `/somepath` the actual filesystem request goes to `filesystempath/somepath` instead of only `filesystempath`.
To turn off this behavior set the IgnoreBase config param to true.
Serve SPA assets from embbeded filesystem
+Serve SPA assets from embedded filesystem
//go:embed web
var webAssets embed.FS
func main() {
e := echo.New()
e.Use(middleware.StaticWithConfig(middleware.StaticConfig{
HTML5: true,
Root: "web", // because files are located in `web` directory in `webAssets` fs
Filesystem: http.FS(webAssets),
}))
api := e.Group("/api")
api.GET("/users", func(c echo.Context) error {
return c.String(http.StatusOK, "users")
})
if err := e.Start(":8080"); err != nil && !errors.Is(err, http.ErrServerClosed) {
log.Fatal(err)
}
}
StaticConfig struct {
// Skipper defines a function to skip middleware.
Skipper Skipper
// Root directory from where the static content is served.
// Required.
Root string `json:"root"`
// Index file for serving a directory.
// Optional. Default value "index.html".
Index string `json:"index"`
// Enable HTML5 mode by forwarding all not-found requests to root so that
// SPA (single-page application) can handle the routing.
// Optional. Default value false.
HTML5 bool `json:"html5"`
// Enable directory browsing.
// Optional. Default value false.
Browse bool `json:"browse"`
// Enable ignoring of the base of the URL path.
// Example: when assigning a static middleware to a non root path group,
// the filesystem path is not doubled
// Optional. Default value false.
IgnoreBase bool `yaml:"ignoreBase"`
// Filesystem provides access to the static content.
// Optional. Defaults to http.Dir(config.Root)
Filesystem http.FileSystem `yaml:"-"`
}
/users/anything...There can be only one effective match-any parameter in route. When route is added with multiple match-any
-/v1/*/images/*. The router matches always the first * till the end of requst URL i.e. it works as /v1/*.
/v1/*/images/*. The router matches always the first * till the end of request URL i.e. it works as /v1/*.