update changelog

Signed-off-by: yeya24 <[email protected]>
thanos-io · Aug 3, 2019 · 0f9f503 · 0f9f503
1 parent 05563c3
commit 0f9f503
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 19 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,8 @@ We use *breaking* word for marking changes that are not backward compatible (rel
 
 - [#1358](https://github.com/thanos-io/thanos/pull/1358) Added `part_size` configuration option for HTTP multipart requests minimum part size for S3 storage type
 
+- [#1368](https://github.com/thanos-io/thanos/pull/1368) Flags for Bucket web UIs: --web.route-prefix, --web.external-prefix, --web.prefix-header.
+
 ### Changed
 
 - [#1338](https://github.com/thanos-io/thanos/pull/1338) Querier still warns on store API duplicate, but allows a single one from duplicated set. This is gracefully warn about the problematic logic and not disrupt immediately.

diff --git a/docs/components/bucket.md b/docs/components/bucket.md
@@ -92,28 +92,51 @@ usage: thanos bucket web [<flags>]
 Web interface for remote storage bucket
 
 Flags:
-  -h, --help                   Show context-sensitive help (also try --help-long
-                               and --help-man).
-      --version                Show application version.
-      --log.level=info         Log filtering level.
-      --log.format=logfmt      Log format to use.
+  -h, --help                    Show context-sensitive help (also try
+                                --help-long and --help-man).
+      --version                 Show application version.
+      --log.level=info          Log filtering level.
+      --log.format=logfmt       Log format to use.
       --tracing.config-file=<tracing.config-yaml-path>
-                               Path to YAML file that contains tracing
-                               configuration.
+                                Path to YAML file that contains tracing
+                                configuration.
       --tracing.config=<tracing.config-yaml>
-                               Alternative to 'tracing.config-file' flag.
-                               Tracing configuration in YAML.
+                                Alternative to 'tracing.config-file' flag.
+                                Tracing configuration in YAML.
       --objstore.config-file=<bucket.config-yaml-path>
-                               Path to YAML file that contains object store
-                               configuration.
+                                Path to YAML file that contains object store
+                                configuration.
       --objstore.config=<bucket.config-yaml>
-                               Alternative to 'objstore.config-file' flag.
-                               Object store configuration in YAML.
-      --listen="0.0.0.0:8080"  HTTP host:port to listen on
-      --refresh=30m            Refresh interval to download metadata from remote
-                               storage
-      --timeout=5m             Timeout to download metadata from remote storage
-      --label=LABEL            Prometheus label to use as timeline title
+                                Alternative to 'objstore.config-file' flag.
+                                Object store configuration in YAML.
+      --listen="0.0.0.0:8080"   HTTP host:port to listen on
+      --refresh=30m             Refresh interval to download metadata from
+                                remote storage
+      --timeout=5m              Timeout to download metadata from remote storage
+      --label=LABEL             Prometheus label to use as timeline title
+      --web.route-prefix=""     Prefix for API and UI endpoints. This allows
+                                thanos UI to be served on a sub-path. This
+                                option is analogous to --web.route-prefix of
+                                Prometheus.
+      --web.external-prefix=""  Static prefix for all HTML links and redirect
+                                URLs in the UI bucket web interface. Actual
+                                endpoints are still served on / or the
+                                web.route-prefix. This allows thanos UI to be
+                                served behind a reverse proxy that strips a URL
+                                sub-path.
+      --web.prefix-header=""    Name of HTTP request header used for dynamic
+                                prefixing of UI links and redirects. This option
+                                is ignored if web.external-prefix argument is
+                                set. Security risk: enable this option only if a
+                                reverse proxy in front of thanos is resetting
+                                the header. The
+                                --web.prefix-header=X-Forwarded-Prefix option
+                                can be useful, for example, if Thanos UI is
+                                served via Traefik reverse proxy with
+                                PathPrefixStrip option enabled, which sends the
+                                stripped prefix value in X-Forwarded-Prefix
+                                header. This allows thanos UI to be served on a
+                                sub-path.
 
 ```
 

diff --git a/docs/components/query.md b/docs/components/query.md
@@ -207,7 +207,7 @@ Flags:
       --web.route-prefix=""      Prefix for API and UI endpoints. This allows
                                  thanos UI to be served on a sub-path. This
                                  option is analogous to --web.route-prefix of
-                                 Promethus.
+                                 Prometheus.
       --web.external-prefix=""   Static prefix for all HTML links and redirect
                                  URLs in the UI query web interface. Actual
                                  endpoints are still served on / or the