Clarify the expected value of the web_external_url config option (#252)

canonical · Mar 22, 2022 · 8b8e23b · 8b8e23b
1 parent 522db28
commit 8b8e23b
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/config.yaml b/config.yaml
@@ -16,6 +16,15 @@ options:
       Prometheus itself. If the URL has a path portion, it will be used to
       prefix all HTTP endpoints served by Prometheus.
 
+      The URL provided must point to the root of the Prometheus web application,
+      e.g.:
+
+      http://foo.bar/
+      
+      Note, do *not* set this configuration to a specific to an API path, e.g.,
+      
+      http://foo.bar//api/v1/write  # DO NOT TRY THIS AT HOME
+
       This configuration option takes precedence over the URL provided over
       the "ingress" relation.
     type: string