Skip to content

Commit

Permalink
#36 more detail on Docker in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
justb4 committed Jun 17, 2016
1 parent d14ba27 commit a9b778f
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 16 deletions.
3 changes: 2 additions & 1 deletion docker/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Stetl Docker

Docker image to run ETL tool Stetl. See www.stetl.org.
Docker image to run ETL tool Stetl. See http://stetl.org.
Public Docker images are available at: https://hub.docker.com/r/justb4/stetl/.

## Status

Expand Down
3 changes: 2 additions & 1 deletion docs/cases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,7 @@ Smart Emission
--------------

Sensors for air quality, meteo and audio at civilians. Project by University of Nijmegen/Gemeente Nijmegen with participation
by Geonovum. Stetl used to transform a low-level sensor API to PostGIS and later on WMS/WFS/SOS.
by Geonovum. Stetl is used to transform a low-level sensor API to PostGIS and later on WMS/WFS/SOS.
This is also an example how to use a Stetl Docker image:

See https://github.com/Geonovum/smartemission/tree/master/etl
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,9 +52,9 @@
# built documents.
#
# The short X.Y version.
version = '1.0.7rc7'
version = '1.0.9'
# The full version, including alpha/beta/rc tags.
release = '1.0.7rc7'
release = '1.0.9'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ The code is on GitHub: https://github.com/justb4/stetl.

See an `introductory Stetl presentation at Slideshare <http://www.slideshare.net/justb4/stetl-foss4g20131024v1>`_.

This is document version |release| generated on |today|.

Contents:

Expand Down
16 changes: 5 additions & 11 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -134,20 +134,14 @@ Look for any error messages in your output.
Install with Docker
-------------------

One of the cleanest ways to use Stetl is via Docker. Offcourse your environment needs to be
setup to use Docker and probably you need some tooling like Vagrant. The author uses
One of the cleanest ways to use Stetl is via `Docker <http://docker.com>`_. Your environment needs to be
setup to use Docker and probably you want to use some tooling like `Vagrant <https://www.vagrantup.com/>`_. The author uses
a combination of VirtualBox with Ubuntu and Vagrant on Mac OSX to run Docker, but this
is a bit out of the scope here.
is a bit out of scope here.

Assuming you have a Docker environment, there are two ways to use Stetl with Docker:
Assuming you have a working Docker environment, there are two ways to install Stetl with Docker:

* build a Docker image yourself using the Dockerfile in https://github.com/justb4/stetl/tree/master/docker
* use a prebuilt public Stetl Docker image: https://hub.docker.com/r/justb4/stetl








For running Stetl using Docker see :ref:`run_docker`.
3 changes: 2 additions & 1 deletion docs/using.rst
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,8 @@ whatever it gets as input from the previous Filter in the Chain. ::
output/gmlcities.shp
temp/gmlcities.gml

.. _run_docker:

Using Docker
~~~~~~~~~~~~

Expand All @@ -181,7 +183,6 @@ https://github.com/Geonovum/smartemission/tree/master/etl.
In the simplest case you run a Stetl Docker container from your own built image or the Dockerhub-provided
one, `justb4/stetl:latest <https://hub.docker.com/r/justb4/stetl>`_ basically as follows: ::


sudo docker run -v <host dir>:<container dir> -w <work dir> justb4/stetl:latest <any Stetl arguments>

For example within the current directory you may have an ``etl.cfg`` Stetl file: ::
Expand Down

0 comments on commit a9b778f

Please sign in to comment.