Merge pull request #25 from bird-house/update-config-docs

updated config docu
bird-house · Dec 5, 2018 · 0571a61 · 0571a61
2 parents f05d230 + 302d534
commit 0571a61
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/docs/source/configuration.rst b/docs/source/configuration.rst
@@ -3,6 +3,11 @@
 Configuration
 =============
 
+.. warning::
+
+  Please read the PyWPS documentation_ to find details about possible configuration options.
+
+
 Command-line options
 --------------------
 
@@ -45,5 +50,25 @@ Start the service with your custom configuration:
    # start the service with this configuration
    $ hummingbird start -c etc/custom.cfg
 
+Example
+~~~~~~~
+
+Here is an example of a customized configuration.
+Please read the PyWPS documentation_ for a detailed description of the options, like `outputpath` and `workdir`.
+
+.. code-block:: ini
+
+  [server]
+  url = http://demo.org:5000/wps
+  outputurl = http://demo.org:5000/outputs
+  outputpath = /var/lib/pywps/outputs
+  workdir = /var/lib/pywps/tmp
+
+  [logging]
+  level = DEBUG
+
+Find more examples in `etc/`.
+
 
 .. _PyWPS: http://pywps.org/
+.. _documentation: https://pywps.readthedocs.io/en/master/configuration.html
diff --git a/etc/sample-custom.cfg b/etc/sample-custom.cfg
@@ -1,6 +1,8 @@
 [server]
 url = http://demo.org:5000/wps
 outputurl = http://demo.org:5000/outputs
+outputpath = /var/lib/pywps/outputs
+workdir = /var/lib/pywps/tmp
 
 [logging]
 level = DEBUG