MapFish Print

The examples/geoserver-data directory contains a pre-packaged GeoServer data directory used for demonstrations and testing. This directory includes several distinct spatial data sets that can be used to test Mapfish Print capabilities with different data types (vector, raster, mosaics, etc.).

Available data sets include:

• arc_sample: Provided by GeoSolutions.
• img_sample: Provided by GeoSolutions.
• mosaic_sample: Provided by GeoSolutions.
• nyc: New York City data containing giant polygons, POIs, poly landmarks, and TIGER roads.
• sf: Spearfish data containing archsites, bugsites, restricted areas, roads, streams, and sfdem.
• states: Simplified shapefiles derived from GeoTools sample data (Census data).
• taz_shapes: Tasmania data containing cities, roads, state boundaries, and water bodies.

To run the end-to-end (e2e) integration tests for PDF and image generation, you must first start the required services (including a GeoServer instance) using Docker Compose, and then execute the Gradle test task.

1. Start the services:

   docker compose up -d

2. Run the tests using Gradle (refer to the Gradle Java plugin documentation for specific test subgroups or single test execution).

To run the printer directly from Eclipse, create a new Java Run Configuration with the following settings:

• Main class: org.mapfish.print.cli.Main
• Program arguments: Pass the -config, -spec, and -output flags (e.g., -config samples/config.yaml -spec samples/spec.json -output $HOME/print.pdf).

If you only need to generate the documentation site without building the full project artifacts, use the Gradle wrapper in the docs directory or run the specific docs task.

./gradlew docs:build

To build the project from source, ensure you have make and Docker installed. Running the build command generates three primary artifacts:

• print-servlet-xxx.war (Servlet container deployment)
• print-lib.jar (Library for integration)
• print-standalone.jar (Standalone executable)

Note: The build process includes tests that require the 'Liberation Sans' font to be installed on your system.

make build

For examples that depend on GeoServer, you must run them within the provided Docker composition.

1. Build the project and prepare the override configuration.
2. Start the composition.
3. Execute the print command inside the builder container.

# Setup the environment
make build
cp docker-compose.override.sample.yaml docker-compose.override.yaml
make acceptance-tests-up

# Execute the print job inside the running container
docker compose exec builder gradle print -PprintArgs="-config /src/examples/src/test/resources/examples/simple/config.yaml -spec /src/examples/src/test/resources/examples/simple/requestData.json -output /src/examples/output.pdf"

To use MapFish Print in Eclipse, first generate the Eclipse project metadata using Gradle, then import the project into your IDE.

./gradlew eclipse

By default, the test server runs in daemon mode (background thread, shuts down when the build completes). To run the server in non-daemon mode—allowing you to manually start the server and then run tests from an IDE like Eclipse—use:

docker compose up -d

After building the documentation locally using ./gradlew buildDocs, you can update the hosted documentation by pushing the contents of docs/build/site to the gh-pages branch of the mapfish-print-doc repository.

Follow these steps to sync and deploy:

cd mapfish-print-doc
git fetch origin
git checkout gh-pages
git merge --ff-only origin/gh-pages
git rm --ignore-unmatch -rqf .
cp -r ../mapfish-print/docs/build/site/. .
git add -A .
git commit -m 'Update docs'
git push origin gh-pages