-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathhttp.html
More file actions
269 lines (225 loc) · 14.8 KB
/
http.html
File metadata and controls
269 lines (225 loc) · 14.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
<!DOCTYPE html>
<html lang="en" data-content_root="../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<title>HTTP Requests — MapServer 8.6.1 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../_static/sphinx.css?v=48f05237" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=dd298242" />
<link rel="stylesheet" type="text/css" href="../_static/ribbon.css?v=ea091bf4" />
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=ad95d4c4"></script>
<script src="../_static/doctools.js?v=fd6eb6e6"></script>
<script src="../_static/sphinx_highlight.js?v=6ffebe34"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
<script src="../_static/copybutton.js?v=f281be69"></script>
<link rel="icon" href="../_static/mapserver.ico"/>
<link rel="author" title="About these documents" href="../about.html" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="copyright" title="Copyright" href="../copyright.html" />
<link rel="next" title="FeatureInfo Requests" href="featureinfo.html" />
<link rel="prev" title="Tileset Dimensions" href="dimensions.html" />
</head><body>
<!-- for main branch only, do not backport this -->
<table width="100%" style="width: 100%; background-color: white;">
<tr>
<td rowspan="2" style="padding: 10px 0px 10px 10px;">
<a href="../index.html" title="Home"><img src="../_static/banner.png" alt="MapServer banner" border="0" /></a>
</td>
<td style="padding: 10px 10px 0px 0px; text-align: right; vertical-align: top;">
<a href="../index.html" title="Home">Home</a> |
<a href="../products.html" title="Products (MapServer core, MapCache, TinyOWS">Products</a> |
<a href="https://github.com/mapserver/mapserver/issues/" title="Issue Tracker (MapServer core)">Issue Tracker</a> |
<a href="../community/service_providers.html" title="Professional Service Providers">Service Providers</a> |
<a href="../faq.html" title="Frequently Asked Questions">FAQ</a> |
<a href="https://fosstodon.org/@mapserver" title="Mastodon" target="_blank">Mastodon</a> |
<a href="../download.html" title="Download Source or Binaries">Download </a> |
<a class="badge" href="https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=KRJ2X44N3HA6U&source=url" target="_blank">
<img src="https://img.shields.io/badge/donate-%E2%9D%A4%C2%A0-ff69b4.svg?style=flat" alt="Donate to MapServer">
</a>
</td>
</tr>
<tr>
<td style="padding: 0px 10px 0px 0px; text-align: right; vertical-align: bottom;">
<img src="../_static/flagicons/en.png" alt="en" title="en" border="0" width="18px" height="13px"/>
<a href="../ar/mapcache/http.html"><img src="../_static/flagicons/ar.png" alt="ar" title="ar" border="0" /></a>
<a href="../de/mapcache/http.html"><img src="../_static/flagicons/de.png" alt="de" title="de" border="0" /></a>
<a href="../el/mapcache/http.html"><img src="../_static/flagicons/el.png" alt="el" title="el" border="0" /></a>
<a href="../es/mapcache/http.html"><img src="../_static/flagicons/es.png" alt="es" title="es" border="0" /></a>
<a href="../fr/mapcache/http.html"><img src="../_static/flagicons/fr.png" alt="fr" title="fr" border="0" /></a>
<a href="../id/mapcache/http.html"><img src="../_static/flagicons/id.png" alt="id" title="id" border="0" /></a>
<a href="../it/mapcache/http.html"><img src="../_static/flagicons/it.png" alt="it" title="it" border="0" /></a>
<a href="../ja/mapcache/http.html"><img src="../_static/flagicons/ja.png" alt="ja" title="ja" border="0" /></a>
<a href="../nl_NL/mapcache/http.html"><img src="../_static/flagicons/nl_NL.png" alt="nl_NL" title="nl_NL" border="0" /></a>
<a href="../pl/mapcache/http.html"><img src="../_static/flagicons/pl.png" alt="pl" title="pl" border="0" /></a>
<a href="../ru/mapcache/http.html"><img src="../_static/flagicons/ru.png" alt="ru" title="ru" border="0" /></a>
<a href="../sq/mapcache/http.html"><img src="../_static/flagicons/sq.png" alt="sq" title="sq" border="0" /></a>
<a href="../tr/mapcache/http.html"><img src="../_static/flagicons/tr.png" alt="tr" title="tr" border="0" /></a>
</td>
</tr>
</table>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="featureinfo.html" title="FeatureInfo Requests"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="dimensions.html" title="Tileset Dimensions"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Home</a> »</li>
<li class="nav-item nav-item-1"><a href="../documentation.html" >MapServer 8.6.1 Documentation</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" accesskey="U">MapCache 1.14.1</a> »</li>
<li class="nav-item nav-item-this"><a href="">HTTP Requests</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="http-requests">
<span id="mapcache-http"></span><h1>HTTP Requests<a class="headerlink" href="#http-requests" title="Link to this heading">¶</a></h1>
<p>HTTP configuration blocks are used in multiple places in the MapCache configuration.</p>
<section id="specifying-the-url">
<h2>Specifying the URL<a class="headerlink" href="#specifying-the-url" title="Link to this heading">¶</a></h2>
<p>The simplest HTTP configuration block requires a single <cite><url></cite> child element:</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><http></span>
<span class="w"> </span><span class="nt"><url></span>http://server/path?key=value<span class="nt"></url></span>
<span class="nt"></http></span>
</pre></div>
</div>
</section>
<section id="timeouts">
<h2>Timeouts<a class="headerlink" href="#timeouts" title="Link to this heading">¶</a></h2>
<p>You may configure the timeouts after which an HTTP request is abandoned:</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><http></span>
<span class="w"> </span><span class="nt"><url></span>http://server/path?key=value<span class="nt"></url></span>
<span class="w"> </span><span class="cm"><!-- timeout in seconds to wait while establishing a connection. This may be needed for</span>
<span class="cm"> firewalled MapCache or HTTP instances --></span>
<span class="w"> </span><span class="nt"><connection_timeout></span>30<span class="nt"></connection_timeout></span>
<span class="w"> </span><span class="cm"><!-- total maximum time allowed for the whole request. Includes the time needed to</span>
<span class="cm"> transfer data down the wire --></span>
<span class="w"> </span><span class="nt"><timeout></span>60<span class="nt"></timeout></span>
<span class="nt"></http></span>
</pre></div>
</div>
</section>
<section id="headers">
<h2>Headers<a class="headerlink" href="#headers" title="Link to this heading">¶</a></h2>
<p>You can insert custom headers in the request, or forward headers received from the client
request:</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><http></span>
<span class="w"> </span><span class="nt"><url></span>http://server/path?key=value<span class="nt"></url></span>
<span class="w"> </span><span class="nt"><headers></span>
<span class="w"> </span><span class="nt"><User-Agent></span>My<span class="w"> </span>MapCache<span class="w"> </span>User-Agent<span class="nt"></User-Agent></span><span class="w"> </span><span class="cm"><!-- hard coded header --></span>
<span class="w"> </span><span class="nt"><X-My-Forwarded-Header></span>{X-Received-Header}<span class="nt"><X-My-Forwarded-Header></span><span class="w"> </span><span class="cm"><!-- Forwarded from client, optionally changing the header name --></span>
<span class="w"> </span><span class="nt"><X-My-Forwarded-Header-2></span>foobar-{X-Received-Header}-baz<span class="nt"><X-My-Forwarded-Header-2></span><span class="w"> </span><span class="cm"><!-- Forwarded and modified from client, optionally changing the header name --></span>
<span class="w"> </span><span class="nt"></headers></span>
<span class="nt"></http></span>
</pre></div>
</div>
</section>
<section id="authorization">
<h2>Authorization<a class="headerlink" href="#authorization" title="Link to this heading">¶</a></h2>
<p>To access resources protected by a username and password, provide the <cite><auth></cite> element.
Currently, only basic authentication is supported. Given that usernames and
passwords are stored in unencrypted form, exercise caution when handling
the configuration file (e.g., avoid committing it to a public repository and
set restrictive file access permissions). The same precautions should be taken
with the memory of the mapcache process (e.g., core files).</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><http></span>
<span class="w"> </span><span class="nt"><url></span>http://example.com/path?key=value<span class="nt"></url></span>
<span class="w"> </span><span class="nt"><auth</span><span class="w"> </span><span class="na">scheme=</span><span class="s">"basic"</span><span class="nt">></span>
<span class="w"> </span><span class="nt"><user></span>alice<span class="nt"></user></span>
<span class="w"> </span><span class="nt"><pass></span>attackatdawn<span class="nt"></pass></span>
<span class="w"> </span><span class="nt"></auth></span>
<span class="nt"></http></span>
</pre></div>
</div>
<p>Both the username and password are processed verbatim. Ensure not to include
any extra symbols (e.g., space, newline). If there is no username or no password,
simply leave the respective element empty.</p>
<div class="highlight-xml notranslate"><div class="highlight"><pre><span></span><span class="nt"><http></span>
<span class="w"> </span><span class="nt"><url></span>http://example.com/path?key=value<span class="nt"></url></span>
<span class="w"> </span><span class="nt"><auth</span><span class="w"> </span><span class="na">scheme=</span><span class="s">"basic"</span><span class="nt">></span>
<span class="w"> </span><span class="nt"><user></span>bob<span class="nt"></user></span>
<span class="w"> </span><span class="nt"><pass></pass></span><span class="w"> </span><span class="cm"><!-- user "bob" has no password --></span>
<span class="w"> </span><span class="nt"></auth></span>
<span class="nt"></http></span>
</pre></div>
</div>
</section>
</section>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
<p>
<a href="../about.html" title="About">About</a><br>
<a href="../products.html" title="Products">Products</a><br>
<a href="../community/index.html" title="Community">Community</a><br>
<a href="../development/index.html" title="Development">Development</a><br>
<a href="../download.html" title="Downloads">Downloads</a><br>
<a href="../documentation.html" title="Documentation">Documentation</a><br>
<a href="../faq.html" title="FAQ">FAQ</a><br>
<a href="../psc.html" title="PSC">PSC</a><br>
<a href="https://fosstodon.org/@mapserver" title="Mastodon">Mastodon</a>
</p>
<h3>Current Table Of Contents</h3>
<ul>
<li><a class="reference internal" href="#">HTTP Requests</a><ul>
<li><a class="reference internal" href="#specifying-the-url">Specifying the URL</a></li>
<li><a class="reference internal" href="#timeouts">Timeouts</a></li>
<li><a class="reference internal" href="#headers">Headers</a></li>
<li><a class="reference internal" href="#authorization">Authorization</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="featureinfo.html" title="FeatureInfo Requests"
>next</a> |</li>
<li class="right" >
<a href="dimensions.html" title="Tileset Dimensions"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="../index.html">Home</a> »</li>
<li class="nav-item nav-item-1"><a href="../documentation.html" >MapServer 8.6.1 Documentation</a> »</li>
<li class="nav-item nav-item-2"><a href="index.html" >MapCache 1.14.1</a> »</li>
<li class="nav-item nav-item-this"><a href="">HTTP Requests</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© <a href="../copyright.html">Copyright</a> 2026, Open Source Geospatial Foundation.
Last updated on 2026-03-30.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 9.1.0.
</div>
</body>
</html>