Skip to content

Commit 8269a67

Browse files
committed
Clarify CONTEXT_PATH servlet mapping behavior and path conflicts
1 parent 901814b commit 8269a67

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

docs/src/main/resources/templates/docker.html

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -27,21 +27,32 @@ <h4 id="docker_tunings">
2727
<li><code>CATALINA_OPTS</code>: Java startup parameters.</li>
2828
<li>
2929
<code>CONTEXT_PATH</code>: Optional external URL prefix (sub path) when the service is exposed behind a
30-
reverse proxy under a sub path (for example <code>/print</code> or <code>/foo/bar</code>). When set, the
31-
container entrypoint will:
30+
reverse proxy under a sub path (for example <code>/printservice</code>). When set, the container
31+
entrypoint will:
3232
<ul>
3333
<li>
34-
Prefix the servlet mappings (for example <code>/metrics</code> becomes <code>/print/metrics</code>).
34+
Prefix <strong>all</strong> servlet mappings:
35+
<ul>
36+
<li><code>/metrics</code> becomes <code>/printservice/metrics</code></li>
37+
<li><code>/print/*</code> becomes <code>/printservice/print/*</code></li>
38+
<li><code>/sec/print/*</code> becomes <code>/printservice/sec/print/*</code></li>
39+
</ul>
3540
</li>
3641
<li>
37-
Copy the UI assets (index + icons) under the sub path (for example <code>/print/index.html</code>).
42+
Copy the UI assets (index + icons) under the sub path (for example
43+
<code>/printservice/index.html</code>).
3844
</li>
3945
<li>
40-
Inject a <code>&lt;base href=&quot;/print/&quot;&gt;</code> tag into the copied UI page so relative
41-
links work.
46+
Inject a <code>&lt;base href=&quot;/printservice/&quot;&gt;</code> tag into the copied UI page so
47+
relative links work.
4248
</li>
4349
</ul>
44-
This mode is intended for proxies/ingresses that forward the prefixed path as-is (no path rewrite).
50+
This mode is intended for proxies/ingresses that forward the prefixed path as-is (no path rewrite).<br />
51+
The value must start with <code>/</code> and may contain only alphanumeric characters, dots
52+
(<code>.</code>), underscores (<code>_</code>), hyphens (<code>-</code>) and slashes (<code>/</code>) (for
53+
example <code>/printservice</code> or <code>/api/v1/print</code>). Invalid
54+
<code>CONTEXT_PATH</code> values will cause the container to exit with error code <code>2</code> during
55+
startup.
4556
</li>
4657
<li><code>DEFAULT_LOG_LEVEL</code>: Set the default log level (defaults to <code>INFO</code>)</li>
4758
<li><code>TOMCAT_LOG_LEVEL</code>: Set the tomcat log level (defaults to <code>INFO</code>)</li>
@@ -125,7 +136,7 @@ <h4 id="docker_filesystem">
125136
</li>
126137
<li>
127138
<code>/usr/local/tomcat/webapps/ROOT&lt;CONTEXT_PATH&gt;</code>: created and populated with UI assets
128-
(for example <code>/usr/local/tomcat/webapps/ROOT/print</code>).
139+
(for example <code>/usr/local/tomcat/webapps/ROOT/printservice</code>).
129140
</li>
130141
</ul>
131142
</li>

0 commit comments

Comments
 (0)