Tethys Platform
Table Of Contents
Table Of Contents

Start and Register

Last Updated: June 2020

1. Scaffold New App

Create a new app, but don't install it yet:

tethys scaffold geoserver_app

2. Create Spatial Dataset Service Setting

Open the app.py and add the following method to the GeoserverApp class:

from tethys_sdk.app_settings import SpatialDatasetServiceSetting

class GeoserverApp(TethysAppBase):
    Tethys app class for Geoserver App.

    def spatial_dataset_service_settings(self):
        Example spatial_dataset_service_settings method.
        sds_settings = (
                description='spatial dataset service for app to use',

        return sds_settings

3. Install GeoServer and Start Tethys Development Server

cd tethysapp-geoserver_app
tethys install -d
tethys manage start

4. Start GeoServer

If you are using the Docker containers, create and start your GeoServer Docker container:

tethys docker init -c geoserver
tethys docker start -c geoserver

Otherwise ensure that you have GeoServer installed and running. Refer to the GeoServer Installation Guide for system specific instructions.

5. Create GeoServer Spatial Dataset Service

Register the GeoServer with Tethys Portal admin page by creating a Spatial Dataset Service:

  1. Select the "Site Admin" link from the drop down menu by your username.

  2. Scroll to the "Tethys Services" section and select the "Spatial Dataset Services" link.

  3. Create a new Spatial Dataset Service named "primary_geoserver" of type GeoServer.

  4. Enter the endpoint and public endpoint as the same (e.g.: http://localhost:8181/geoserver/rest/ if using Docker or http://localhost:8080/geoserver/rest/ if using a default installation of GeoServer).

  5. Fill out the username and password (default username and password is "admin" and "geoserver", respectively).

  6. No API Key is required.

  7. Press "Save".


In a production deployment of Tethys, the public endpoint should point to the publicly accessible host and port of the geoserver (e.g.: http://www.example.com:8181/geoserver/rest/)

6. Assign Spatial Dataset Service to App Setting

Assign the "primary_geoserver" Spatial Dataset Service to the "main_geoserver" setting for the app.

  1. Select the "Site Admin" link from the drop down menu by your username.

  2. Scroll to the "Tethys Apps" section and select the "Installed Apps" link.

  3. Select the "Geoserver App" link.

  4. Scroll down to the "Spatial Dataset Service Settings" section and assign the "primary_geoserver" to the Spatial Dataset Service property of the "main_geoserver" setting for the app.

  5. Press "Save".


If you don't see the "main_geoserver" setting in the "Spatial Dataset Service Settings" section try restarting the Tethys development server. If it still doesn't show up, then stop the Tethys development server, uninstall the app, reinstall it, and start the Tethys server again:

tethys uninstall geoserver_app
cd tethysapp-geoserver_app
tethys install -d
tethys manage start

7. Download Test Files

Download the sample shapefiles that you will use to test your app:


The archive contains several shapefiles organized into folders. Unzip the archive to your preferred location and inspect the files.

8. GeoServer Web Admin Interface

Explore the GeoServer web admin interface by visiting link: http://localhost:8181/geoserver/web/.

9. Solution

This concludes the this part of the GeoServer tutorial. You can view the solution on GitHub at https://github.com/tethysplatform/tethysapp-geoserver_app or clone it as follows:

git clone https://github.com/tethysplatform/tethysapp-geoserver_app.git
cd tethysapp-geoserver_app
git checkout -b start-and-register-solution start-and-register-solution-4.0