A docker recipe for GeoServer
Clone or download
NyakudyaA Merge pull request #47 from hishamkaram/war_from_url
download war file from url provided by the user
Latest commit 9ec69c8 Oct 22, 2018

README.md

docker-geoserver

A simple docker container that runs Geoserver influenced by this docker recipe: https://github.com/eliotjordan/docker-geoserver/blob/master/Dockerfile

Getting the image

There are various ways to get the image onto your system:

The preferred way (but using most bandwidth for the initial image) is to get our docker trusted build like this:

docker pull kartoza/geoserver

Setting Tomcat properties during build

The Tomcat properties such as maximum heap memory size are included in the Dockerfile. You need to change them them before building the image in accordance to the resources available on your server:

You can change the variables based on geoserver container considerations

To build yourself with a local checkout:

git clone git://github.com/kartoza/docker-geoserver
cd docker-geoserver
./build.sh

Ensure that you look at the build script to see what other build arguments you can include whilst building your image.

Building with war file from a URL

If you need to build the image with a custom geoserver war file that will be downloaded from a server, you can pass the war file url as a build argument to docker, example:

docker build --build-arg WAR_URL=http://download2.nust.na/pub4/sourceforge/g/project/ge/geoserver/GeoServer/2.13.0/geoserver-2.13.0-war.zip --build-arg GS_VERSION=2.13.0

Note: war file version should match the version number provided by GS_VERSION argument otherwise we will have a mismatch of plugins and GeoServer installed.

Building with Oracle JDK

To replace OpenJDK Java with the Oracle JDK, set build-arg ORACLE_JDK=true:

docker build --build-arg ORACLE_JDK=true --build-arg GS_VERSION=2.13.0 -t kartoza/geoserver .

Alternatively, you can download the Oracle JDK 7 Linux x64 tar.gz currently in use by webupd8team's Oracle JDK installer (usually the latest version available from Oracle).

To enable strong cryptography when using the Oracle JDK (recommended), download the Oracle Java policy jar zip for the correct JDK version .

The setup scripts download these files already and installs them.

Building with plugins

Inspect setup.sh to confirm which plugins (community modules or standard plugins) you want to include in the build process, then add them in their respective sections in the script.

You should ensure that the plugins match the version for the GeoServer WAR zip file.

Removing Tomcat extras during build

To remove Tomcat extras including docs, examples, and the manager webapp, set the TOMCAT_EXTRAS build-arg to false:

docker build --build-arg TOMCAT_EXTRAS=false --build-arg GS_VERSION=2.13.0 -t kartoza/geoserver .

Building with file system overlays (advanced)

The contents of resources/overlays will be copied to the image file system during the build. For example, to include a static Tomcat setenv.sh, create the file at resources/overlays/usr/local/tomcat/bin/setenv.sh.

You can use this functionality to write a static GeoServer directory to /opt/geoserver/data_dir, include additional jar files, and more.

Overlay files will overwrite existing destination files, so be careful!

Run (manual docker commands)

Note: You probably want to use docker-compose for running as it will provide a repeatable orchestrated deployment system.

You probably want to also have postgis running too. To create a running container do:

docker run --name "postgis" -d -t kartoza/postgis:9.4-2.1
docker run --name "geoserver"  --link postgis:postgis -p 8080:8080 -d -t kartoza/geoserver

You can also use the following environment variables to pass a user name and password. To postgis:

  • -e USERNAME=
  • -e PASS=

You can also use the following environment variables to pass arguments to GeoServer:

  • GEOSERVER_DATA_DIR=
  • ENABLE_JSONP=
  • MAX_FILTER_RULES=
  • OPTIMIZE_LINE_WIDTH=
  • FOOTPRINTS_DATA_DIR=
  • GEOWEBCACHE_CACHE_DIR=

Note: The default geoserver user is 'admin' and the password is 'geoserver'. We highly recommend changing the admin password on login.

Run (automated using docker-compose)

We provide a sample docker-compose.yml file that illustrates how you can establish a GeoServer + Postgis + Geogig orchestrated environment with nightly backups that are synchronised to your backup server via btsync.

If you are not interested in the backups and btsync options, comment out those services in the docker-compose.yml file.

Please read the docker-compose documentation for details on usage and syntax of docker-compose - it is not covered here.

If you are interested in btsync backups, install [Resilio sync] on your desktop NAS or other backup destination and create two folders:

  • one for database backup dumps
  • one for geoserver data dir

Then make a copy of each of the provided EXAMPLE environment files e.g.:

cp docker-env/btsync-db.env.EXAMPLE docker-env/btsync-db.env
cp docker-env/btsync-media.env.EXAMPLE docker-env/btsync-media.env

Then edit the two env files, placing your Read/Write resilio keys in the place provided.

To run the example do:

docker-compose up

Which will run everything in the foreground giving you the opportunity to peruse logs and see that everything spins up nicely.

Once all services are started, test by visiting the GeoServer landing page in your browser: http://localhost:8600/geoserver.

To run in the background rather, press ctrl-c to stop the containers and run again in the background:

docker-compose up -d

Note: The docker-compose.yml does not use persistent storage so when you remove the containers, all data will be lost. Either set up btsync (and test to verify that your backups are working, we take no responsibiliy if the examples provided here do not produce a reliable backup system), or use host based volumes (you will need to modify the ``docker-compose.yml``` example to do this) so that your data persists between invocations of the compose file.

Run (automated using rancher)

An even nicer way to run the examples provided is to use our Rancher Catalogue Stack for GeoServer. See http://rancher.com for more details on how to set up and configure your Rancher environment. Once Rancher is set up, use the Admin -> Settings menu to add our Rancher catalogue using this URL:

https://github.com/kartoza/kartoza-rancher-catalogue

Once your settings are saved open a Rancher environment and set up a stack from the catalogue's 'Kartoza' section - you will see GeoServer listed there.

If you want to synchronise your GeoServer settings and database backups (created by the nightly backup tool in the stack), use (Resilio sync)[https://www.resilio.com/] to create two Read/Write keys:

  • one for database backups
  • one for GeoServer media backups

Note: Resilio sync is not Free Software. It is free to use for individuals. Business users need to pay - see their web site for details.

You can try a similar approach with Syncthing or Seafile (for free options) or Dropbox or Google Drive if you want to use another commercial product. These products all have one limitation though: they require interaction to register applications or keys. With Resilio Sync you can completely automate the process without user intervention.

Storing data on the host rather than the container.

Docker volumes can be used to persist your data.

If you need to use geoserver data directory that contains sample examples and configurations download it from geonode site as indicated below:

# Example - ${GS_VERSION} is the geoserver version i.e 2.13.0 
wget http://build.geonode.org/geoserver/latest/data-2.13.x.zip
unzip data-2.13.x.zip -d ~/geoserver_data
cp scripts/controlflow.properties ~/geoserver_data
chmod -R a+rwx ~/geoserver_data
docker run -d -p 8580:8080 --name "geoserver" -v $HOME/geoserver_data:/opt/geoserver/data_dir kartoza/geoserver:${GS_VERSION}

Create an empty data directory to use to persist your data.

mkdir -p ~/geoserver_data && chmod -R a+rwx ~/geoserver_data
docker run -d -v $HOME/geoserver_data:/opt/geoserver/data_dir kartoza/geoserver

Control flow properties

The control flow module is installed by default and it is used to manage request in geoserver. In order to customise it based on your resources and use case read the instructions from documentation. Modify the file scripts/controlflow.properties before building the image.

Setting Tomcat properties

To set Tomcat properties such as maximum heap memory size, create a setenv.sh file such as:

JAVA_OPTS="$JAVA_OPTS -Xmx1536M -XX:MaxPermSize=756M"
JAVA_OPTS="$JAVA_OPTS -Djava.awt.headless=true -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled"

Then pass the setenv.sh file as a volume at /usr/local/tomcat/bin/setenv.sh when running:

docker run -d -v $HOME/setenv.sh:/usr/local/tomcat/bin/setenv.sh kartoza/geoserver

Credits