pywps-doc 4.0.0-5 / usr / share / doc / pywps / html / configuration.html

This file is indexed.

/usr/share/doc/pywps/html/configuration.html is in pywps-doc 4.0.0-5.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Configuration &#8212; PyWPS 4.0.0 documentation</title>
    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    './',
        VERSION:     '4.0.0',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true,
        SOURCELINK_SUFFIX: '.txt'
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="_static/mathjax/MathJax.js?config=tex-ams-mml_htmlormml"></script>
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Processes" href="process.html" />
    <link rel="prev" title="Installation" href="install.html" />
   
  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head>
  <body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body" role="main">
            
  <div class="section" id="configuration">
<span id="id1"></span><h1>Configuration<a class="headerlink" href="#configuration" title="Permalink to this headline"></a></h1>
<p>PyWPS is configured using a configuration file. The file uses the
<a class="reference external" href="https://wiki.python.org/moin/ConfigParserExamples">ConfigParser</a> format.</p>
<div class="versionadded">
<p><span class="versionmodified">New in version 4.0.0.</span></p>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">Compatibility with PyWPS 3.x: major changes have been made
to the config file in order to allow for shared configurations with <a class="reference external" href="http://pycsw.org/">PyCSW</a> and other projects.</p>
</div>
<p>The configuration file has 3 sections:</p>
<blockquote>
<div><ul class="simple">
<li><cite>metadata:main</cite> for the server metadata inputs</li>
<li><cite>server</cite> for server configuration</li>
<li><cite>loggging</cite> for logging configuration</li>
<li><cite>grass</cite> for <em>optional</em> configuration to support <a class="reference external" href="http://grass.osgeo.org">GRASS GIS</a></li>
</ul>
</div></blockquote>
<p>PyWPS ships with a sample configuration file (<code class="docutils literal"><span class="pre">default-sample.cfg</span></code>).
A similar file is also available in the <cite>demo</cite> service as
described in <a class="reference internal" href="install.html#demo"><span class="std std-ref">The demo service and its sample processes</span></a> section.</p>
<p>Copy the file to <code class="docutils literal"><span class="pre">default.cfg</span></code> and edit the following:</p>
<div class="section" id="metadata-main">
<h2>[metadata:main]<a class="headerlink" href="#metadata-main" title="Permalink to this headline"></a></h2>
<p>The <cite>[metadata:main]</cite> section was designed according to the <a class="reference external" href="http://docs.pycsw.org/en/latest/configuration.html">PyCSW project
configuration file</a>.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name" colspan="2">identification_title:</th></tr>
<tr class="field-odd field"><td>&#160;</td><td class="field-body">the title of the service</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">identification_abstract:</th></tr>
<tr class="field-even field"><td>&#160;</td><td class="field-body">some descriptive text about the service</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">identification_keywords:</th></tr>
<tr class="field-odd field"><td>&#160;</td><td class="field-body">comma delimited list of keywords about the service</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">identification_keywords_type:</th></tr>
<tr class="field-even field"><td>&#160;</td><td class="field-body">keyword type as per the <a class="reference external" href="http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#MD_KeywordTypeCode">ISO 19115 MD_KeywordTypeCode codelist</a>).
Accepted values are <code class="docutils literal"><span class="pre">discipline</span></code>, <code class="docutils literal"><span class="pre">temporal</span></code>, <code class="docutils literal"><span class="pre">place</span></code>, <code class="docutils literal"><span class="pre">theme</span></code>,
<code class="docutils literal"><span class="pre">stratum</span></code></td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">identification_fees:</th></tr>
<tr class="field-odd field"><td>&#160;</td><td class="field-body">fees associated with the service</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">identification_accessconstraints:</th></tr>
<tr class="field-even field"><td>&#160;</td><td class="field-body">access constraints associated with the service</td>
</tr>
<tr class="field-odd field"><th class="field-name">provider_name:</th><td class="field-body">the name of the service provider</td>
</tr>
<tr class="field-even field"><th class="field-name">provider_url:</th><td class="field-body">the URL of the service provider</td>
</tr>
<tr class="field-odd field"><th class="field-name">contact_name:</th><td class="field-body">the name of the provider contact</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">contact_position:</th></tr>
<tr class="field-even field"><td>&#160;</td><td class="field-body">the position title of the provider contact</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">contact_address:</th></tr>
<tr class="field-odd field"><td>&#160;</td><td class="field-body">the address of the provider contact</td>
</tr>
<tr class="field-even field"><th class="field-name">contact_city:</th><td class="field-body">the city of the provider contact</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">contact_stateorprovince:</th></tr>
<tr class="field-odd field"><td>&#160;</td><td class="field-body">the province or territory of the provider contact</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">contact_postalcode:</th></tr>
<tr class="field-even field"><td>&#160;</td><td class="field-body">the postal code of the provider contact</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">contact_country:</th></tr>
<tr class="field-odd field"><td>&#160;</td><td class="field-body">the country of the provider contact</td>
</tr>
<tr class="field-even field"><th class="field-name">contact_phone:</th><td class="field-body">the phone number of the provider contact</td>
</tr>
<tr class="field-odd field"><th class="field-name">contact_fax:</th><td class="field-body">the facsimile number of the provider contact</td>
</tr>
<tr class="field-even field"><th class="field-name">contact_email:</th><td class="field-body">the email address of the provider contact</td>
</tr>
<tr class="field-odd field"><th class="field-name">contact_url:</th><td class="field-body">the URL to more information about the provider contact</td>
</tr>
<tr class="field-even field"><th class="field-name">contact_hours:</th><td class="field-body">the hours of service to contact the provider</td>
</tr>
<tr class="field-odd field"><th class="field-name" colspan="2">contact_instructions:</th></tr>
<tr class="field-odd field"><td>&#160;</td><td class="field-body">the how to contact the provider contact</td>
</tr>
<tr class="field-even field"><th class="field-name">contact_role:</th><td class="field-body">the role of the provider contact as per the <a class="reference external" href="http://www.isotc211.org/2005/resources/Codelist/gmxCodelists.xml#CI_RoleCode">ISO 19115 CI_RoleCode codelist</a>).
Accepted values are <code class="docutils literal"><span class="pre">author</span></code>, <code class="docutils literal"><span class="pre">processor</span></code>, <code class="docutils literal"><span class="pre">publisher</span></code>, <code class="docutils literal"><span class="pre">custodian</span></code>,
<code class="docutils literal"><span class="pre">pointOfContact</span></code>, <code class="docutils literal"><span class="pre">distributor</span></code>, <code class="docutils literal"><span class="pre">user</span></code>, <code class="docutils literal"><span class="pre">resourceProvider</span></code>,
<code class="docutils literal"><span class="pre">originator</span></code>, <code class="docutils literal"><span class="pre">owner</span></code>, <code class="docutils literal"><span class="pre">principalInvestigator</span></code></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="server">
<h2>[server]<a class="headerlink" href="#server" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">url:</th><td class="field-body">the URL of the WPS service endpoint</td>
</tr>
<tr class="field-even field"><th class="field-name">language:</th><td class="field-body">the ISO 639-1 language and ISO 3166-1 alpha2 country code of the service
(e.g. <code class="docutils literal"><span class="pre">en-CA</span></code>, <code class="docutils literal"><span class="pre">fr-CA</span></code>, <code class="docutils literal"><span class="pre">en-US</span></code>)</td>
</tr>
<tr class="field-odd field"><th class="field-name">encoding:</th><td class="field-body">the content type encoding (e.g. <code class="docutils literal"><span class="pre">ISO-8859-1</span></code>, see
<a class="reference external" href="https://docs.python.org/2/library/codecs.html#standard-encodings">https://docs.python.org/2/library/codecs.html#standard-encodings</a>).  Default
value is ‘UTF-8’</td>
</tr>
<tr class="field-even field"><th class="field-name" colspan="2">parallelprocesses:</th></tr>
<tr class="field-even field"><td>&#160;</td><td class="field-body">maximum number of parallel running processes - set this number carefully.
The effective number of parallel running processes is limited by the number
of cores  in the processor of the hosting machine. As well, speed and
response time of hard drives impact ultimate processing performance. A
reasonable number of parallel running processes is not higher than the
number of processor cores.</td>
</tr>
<tr class="field-odd field"><th class="field-name">maxrequestsize:</th><td class="field-body">maximal request size. 0 for no limit</td>
</tr>
<tr class="field-even field"><th class="field-name">workdir:</th><td class="field-body">a directory to store all temporary files (which should be always deleted,
once the process is finished).</td>
</tr>
<tr class="field-odd field"><th class="field-name">outputpath:</th><td class="field-body">server path where to store output files.</td>
</tr>
<tr class="field-even field"><th class="field-name">outputurl:</th><td class="field-body">corresponding URL</td>
</tr>
</tbody>
</table>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p><cite>outputpath</cite> and <cite>outputurl</cite> must corespond. <cite>outputpath</cite> is the name
of the resulting target directory, where all output data files are
stored (with unique names). <cite>outputurl</cite> is the corresponding full URL,
which is targeting to <cite>outputpath</cite> directory.</p>
<p class="last">Example: <cite>outputpath=/var/www/wps/outputs</cite> shall correspond with
<cite>outputurl=http://foo.bar/wps/outputs</cite></p>
</div>
</div>
<div class="section" id="logging">
<h2>[logging]<a class="headerlink" href="#logging" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">level:</th><td class="field-body">the logging level (see
<a class="reference external" href="http://docs.python.org/library/logging.html#logging-levels">http://docs.python.org/library/logging.html#logging-levels</a>)</td>
</tr>
<tr class="field-even field"><th class="field-name">file:</th><td class="field-body">the full file path to the log file for being able to see possible error
messages.</td>
</tr>
<tr class="field-odd field"><th class="field-name">database:</th><td class="field-body">Connection string to database where the login about requests/responses is to be stored. We are using <a class="reference external" href="http://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls">SQLAlchemy</a>
please use the configuration string. The default is SQLite3 <cite>:memory:</cite> object.</td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="grass">
<h2>[grass]<a class="headerlink" href="#grass" title="Permalink to this headline"></a></h2>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">gisbase:</th><td class="field-body">directory of the GRASS GIS instalation, refered as <a class="reference external" href="https://grass.osgeo.org/grass73/manuals/variables.html">GISBASE</a></td>
</tr>
</tbody>
</table>
<div class="section" id="sample-file">
<h3>Sample file<a class="headerlink" href="#sample-file" title="Permalink to this headline"></a></h3>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">[</span><span class="n">server</span><span class="p">]</span>
<span class="n">encoding</span><span class="o">=</span><span class="n">utf</span><span class="o">-</span><span class="mi">8</span>
<span class="n">language</span><span class="o">=</span><span class="n">en</span><span class="o">-</span><span class="n">US</span>
<span class="n">url</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">localhost</span><span class="o">/</span><span class="n">wps</span>
<span class="n">maxoperations</span><span class="o">=</span><span class="mi">30</span>
<span class="n">maxinputparamlength</span><span class="o">=</span><span class="mi">1024</span>
<span class="n">maxsingleinputsize</span><span class="o">=</span>
<span class="n">maxrequestsize</span><span class="o">=</span><span class="mi">3</span><span class="n">mb</span>
<span class="n">temp_path</span><span class="o">=/</span><span class="n">tmp</span><span class="o">/</span><span class="n">pywps</span><span class="o">/</span>
<span class="n">processes_path</span><span class="o">=</span>
<span class="n">outputurl</span><span class="o">=/</span><span class="n">data</span><span class="o">/</span>
<span class="n">outputpath</span><span class="o">=/</span><span class="n">tmp</span><span class="o">/</span><span class="n">outputs</span><span class="o">/</span>
<span class="n">logfile</span><span class="o">=</span>
<span class="n">loglevel</span><span class="o">=</span><span class="n">INFO</span>
<span class="n">logdatabase</span><span class="o">=</span>
<span class="n">workdir</span><span class="o">=</span>

<span class="p">[</span><span class="n">metadata</span><span class="p">:</span><span class="n">main</span><span class="p">]</span>
<span class="n">identification_title</span><span class="o">=</span><span class="n">PyWPS</span> <span class="n">Processing</span> <span class="n">Service</span>
<span class="n">identification_abstract</span><span class="o">=</span><span class="n">PyWPS</span> <span class="ow">is</span> <span class="n">an</span> <span class="n">implementation</span> <span class="n">of</span> <span class="n">the</span> <span class="n">Web</span> <span class="n">Processing</span> <span class="n">Service</span> <span class="n">standard</span> <span class="kn">from</span> <span class="nn">the</span> <span class="n">Open</span> <span class="n">Geospatial</span> <span class="n">Consortium</span><span class="o">.</span> <span class="n">PyWPS</span> <span class="ow">is</span> <span class="n">written</span> <span class="ow">in</span> <span class="n">Python</span><span class="o">.</span>
<span class="n">identification_keywords</span><span class="o">=</span><span class="n">PyWPS</span><span class="p">,</span><span class="n">WPS</span><span class="p">,</span><span class="n">OGC</span><span class="p">,</span><span class="n">processing</span>
<span class="n">identification_keywords_type</span><span class="o">=</span><span class="n">theme</span>
<span class="n">identification_fees</span><span class="o">=</span><span class="n">NONE</span>
<span class="n">identification_accessconstraints</span><span class="o">=</span><span class="n">NONE</span>
<span class="n">provider_name</span><span class="o">=</span><span class="n">Organization</span> <span class="n">Name</span>
<span class="n">provider_url</span><span class="o">=</span><span class="n">http</span><span class="p">:</span><span class="o">//</span><span class="n">pywps</span><span class="o">.</span><span class="n">org</span><span class="o">/</span>
<span class="n">contact_name</span><span class="o">=</span><span class="n">Lastname</span><span class="p">,</span> <span class="n">Firstname</span>
<span class="n">contact_position</span><span class="o">=</span><span class="n">Position</span> <span class="n">Title</span>
<span class="n">contact_address</span><span class="o">=</span><span class="n">Mailing</span> <span class="n">Address</span>
<span class="n">contact_city</span><span class="o">=</span><span class="n">City</span>
<span class="n">contact_stateorprovince</span><span class="o">=</span><span class="n">Administrative</span> <span class="n">Area</span>
<span class="n">contact_postalcode</span><span class="o">=</span><span class="n">Zip</span> <span class="ow">or</span> <span class="n">Postal</span> <span class="n">Code</span>
<span class="n">contact_country</span><span class="o">=</span><span class="n">Country</span>
<span class="n">contact_phone</span><span class="o">=+</span><span class="n">xx</span><span class="o">-</span><span class="n">xxx</span><span class="o">-</span><span class="n">xxx</span><span class="o">-</span><span class="n">xxxx</span>
<span class="n">contact_fax</span><span class="o">=+</span><span class="n">xx</span><span class="o">-</span><span class="n">xxx</span><span class="o">-</span><span class="n">xxx</span><span class="o">-</span><span class="n">xxxx</span>
<span class="n">contact_email</span><span class="o">=</span><span class="n">Email</span> <span class="n">Address</span>
<span class="n">contact_url</span><span class="o">=</span><span class="n">Contact</span> <span class="n">URL</span>
<span class="n">contact_hours</span><span class="o">=</span><span class="n">Hours</span> <span class="n">of</span> <span class="n">Service</span>
<span class="n">contact_instructions</span><span class="o">=</span><span class="n">During</span> <span class="n">hours</span> <span class="n">of</span> <span class="n">service</span><span class="o">.</span>  <span class="n">Off</span> <span class="n">on</span> <span class="n">weekends</span><span class="o">.</span>
<span class="n">contact_role</span><span class="o">=</span><span class="n">pointOfContact</span>

<span class="p">[</span><span class="n">grass</span><span class="p">]</span>
<span class="n">gisbase</span><span class="o">=/</span><span class="n">usr</span><span class="o">/</span><span class="n">local</span><span class="o">/</span><span class="n">grass</span><span class="o">-</span><span class="mf">7.3</span><span class="o">.</span><span class="n">svn</span><span class="o">/</span>
</pre></div>
</div>
</div>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<p class="logo">
  <a href="index.html">
    <img class="logo" src="_static/pywps.png" alt="Logo"/>
    
  </a>
</p>










<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="wps.html">OGC Web Processing Service (OGC WPS)</a></li>
<li class="toctree-l1"><a class="reference internal" href="pywps.html">PyWPS</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Installation</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Configuration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#metadata-main">[metadata:main]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#server">[server]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#logging">[logging]</a></li>
<li class="toctree-l2"><a class="reference internal" href="#grass">[grass]</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#sample-file">Sample file</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="process.html">Processes</a></li>
<li class="toctree-l1"><a class="reference internal" href="deployment.html">Deployment to a production server</a></li>
<li class="toctree-l1"><a class="reference internal" href="migration.html">Migrating from PyWPS 3.x to 4.x</a></li>
<li class="toctree-l1"><a class="reference internal" href="external-tools.html">PyWPS and external tools</a></li>
<li class="toctree-l1"><a class="reference internal" href="api.html">PyWPS API Doc</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Developers Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">Exceptions</a></li>
</ul>


<div id="searchbox" style="display: none" role="search">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <div><input type="text" name="q" /></div>
      <div><input type="submit" value="Go" /></div>
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;Copyright (C) 2014-2016 PyWPS Development Team, represented by Jachym Cepicky.This work is licensed under a Creative Commons Attribution 4.0 International License.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.7</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
      
      |
      <a href="_sources/configuration.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>

APT Browse - Built by Thomas Orozco.