GeoServer Developer Manual

https://docs.geoserver.org/stable/en/
Admin
GeoServer is an open-source server for sharing geospatial data, providing OWS, REST, and WPS...
Tokens:90,653
Snippets:527
Trust Score:9.6
Update:11 months ago
Show doc for...
Tokens:
Raw
### Start GeoServer for WMS 1.3 Tests

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

This command starts the GeoServer instance with a specific data directory required for WMS 1.3 testing. Ensure GeoServer is installed and the data directory path is correct.

```shell
cd <root of GeoServer install>
export GEOSERVER_DATA_DIR=<path of GeoServer repository>/build/cite/wms13/citewms-1.3
./bin/startup.sh
```

--------------------------------

### Example Extension README (Text)

Source: https://docs.geoserver.org/stable/en/developer/policies/community-modules

This text example provides a template for an extension's README file (`<module>-README.md`). It includes essential information such as the extension's name, purpose, references, and installation instructions.

```text
GeoServer H2 Data Store Extension
=================================

This package contains a H2 DataStore implementation that is distributed as a separate plug-in.

Reference:

* https://docs.geoserver.org/latest/en/user/data/database/h2.html
* https://www.h2database.com/html/main.html
* [LICENSE](LICENSE.md)

Installation
------------

1. Unzip this archive into the GeoServer library directory. In the binary
   install this is under ``<GEOSERVER_ROOT>/webapps/geoserver/WEB-INF/lib``.

2. Restart GeoServer.

```

--------------------------------

### Keycloak Test Container Setup - Java

Source: https://docs.geoserver.org/stable/en/developer/programming-guide/testing/index

Demonstrates setting up a Keycloak container for integration testing. It involves specifying the Keycloak image, copying realm import files into the container, enabling verbose output, and setting custom commands for debugging. The `beforeAll` method starts the container and retrieves the authentication server URL. Dependencies include Testcontainers library and Docker.

```java
/** keycloak container setup. We bring in 2 realms - master-realm and gs-realm. */
static KeycloakContainer keycloakContainer = new KeycloakContainer("quay.io/keycloak/keycloak:26.1")
        .withCopyToContainer(
                MountableFile.forClasspathResource(
                        "org/geoserver/web/security/oauth2/login/keycloak/master-realm.json"),
                "/opt/keycloak//data/import/master-realm.json")
        .withCopyToContainer(
                MountableFile.forClasspathResource(
                        "org/geoserver/web/security/oauth2/login/keycloak/gs-realm-realm.json"),
                "/opt/keycloak//data/import/gs-realm-realm.json")
        .withVerboseOutput()
        .withCustomCommand("--log-level=DEBUG"); // useful to see what's going on.  use `docker logs <container>`

@BeforeClass
public static void beforeAll() throws IOException, InterruptedException {
    assumeTrue(DockerClientFactory.instance().isDockerAvailable());
    keycloakContainer.start();
    authServerUrl = keycloakContainer.getAuthServerUrl();
}

```

--------------------------------

### Start GeoServer for WMS 1.1 Tests (Shell)

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

Initiates GeoServer with the data directory pre-configured for WMS 1.1 testing. This requires navigating to the GeoServer installation directory and setting the GEOSERVER_DATA_DIR.

```bash
cd <root of GeoServer install>
export GEOSERVER_DATA_DIR=<path of GeoServer repository>/build/cite/wms11/citewms-1.1
./bin/startup.sh
```

--------------------------------

### Run GeoServer with Maven Jetty Plugin

Source: https://docs.geoserver.org/stable/en/developer/quickstart/maven

Navigates to the web application directory and starts the GeoServer instance using the Maven Jetty plugin. This allows for local testing and development.

```bash
cd web/app
mvn jetty:run
```

--------------------------------

### Check out GeoServer Source Code with Git

Source: https://docs.geoserver.org/stable/en/developer/quickstart/eclipse

Clones the GeoServer source code from the official GitHub repository. This is the first step to begin development or to build GeoServer locally. Ensure you have Git installed.

```bash
git clone https://github.com/geoserver/geoserver.git geoserver

```

--------------------------------

### Start GeoServer with Custom Data Directory

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

This script starts the GeoServer instance. It's configured to use a specific data directory that contains the setup for WFS 1.0 tests. The GEOSERVER_DATA_DIR environment variable must be set correctly.

```bash
cd <root of GeoServer install>
export GEOSERVER_DATA_DIR=<path of GeoServer repository>/build/cite/wfs10/citewfs-1.0
./bin/startup.sh
```

--------------------------------

### Run WFS 1.0 Test Setup Commands

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

These SQL commands are used to set up the PostgreSQL database for WFS 1.0 tests. They include creating a user, a database, and enabling the PostGIS extension.

```sql
createuser cite;
createdb cite_wfs10 own by cite;
create extension postgis;
```

--------------------------------

### Start GeoServer for WCS 1.1 Tests (Shell)

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

Starts GeoServer, ensuring the correct data directory is set for WCS 1.1 testing. This command navigates to the GeoServer installation and sets the GEOSERVER_DATA_DIR environment variable.

```bash
cd <root of GeoServer install>
export GEOSERVER_DATA_DIR=<path of GeoServer repository>/build/cite/wcs11/citewcs-1.1
./bin/startup.sh
```

--------------------------------

### Build GeoServer with Maven

Source: https://docs.geoserver.org/stable/en/developer/quickstart/maven

Executes the Maven build command to compile and install the GeoServer project. The '-DskipTests' flag skips running tests, and '-T 2C' optimizes the build by using 2 concurrent completion threads.

```bash
cd geoserver/src
mvn install -DskipTests -T 2C
```

--------------------------------

### Start GeoServer for WCS 1.0 Tests (Shell)

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

Launches GeoServer with the necessary data directory for WCS 1.0 testing. This involves changing to the GeoServer installation directory and exporting the GEOSERVER_DATA_DIR variable.

```bash
cd <root of GeoServer install>
export GEOSERVER_DATA_DIR=<path of GeoServer repository>/build/cite/wcs10/citewcs-1.0
./bin/startup.sh
```

--------------------------------

### Example OGC Features 1.0 Test Failure Output

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

This is an example of the console output when OGC Features 1.0 tests fail. It shows details about the failing test methods, their descriptions, and the exceptions encountered.

```text
test-method: verifyCollectionsPathCollectionCrsPropertyContainsDefaultCrs
description: Implements A.1 Discovery, Abstract Test 2 (Requirement /req/crs/fc-md-crs-list B), crs property contains default crs in the collection objects in the path /collections
depends-on-groups: crs-conformance
status: FAIL
exception: Collection with id 'sf:restricted' at collections path /collections does not specify one of the default CRS 'http://www.opengis.net/def/crs/OGC/1.3/CRS84' or 'http://www.opengis.net/def/crs/OGC/0/CRS84h' but provides at least one spatial feature collections
Request URI:

test-method: verifyCollectionsPathCollectionCrsPropertyContainsDefaultCrs
description: Implements A.1 Discovery, Abstract Test 2 (Requirement /req/crs/fc-md-crs-list B), crs property contains default crs in the collection objects in the path /collections
depends-on-groups: crs-conformance
status: FAIL
exception: Collection with id 'sf:roads' at collections path /collections does not specify one of the default CRS 'http://www.opengis.net/def/crs/OGC/1.3/CRS84' or 'http://www.opengis.net/def/crs/OGC/0/CRS84h' but provides at least one spatial feature collections
Request URI:

Passed: 2153
Failed: 9
Skipped: 96
make[2]: *** [validate-testng-results] Error 1
make[1]: *** [test-rest] Error 2
make: *** [test] Error 2
```

--------------------------------

### Start Teamengine Web UI for CITE Tests

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

This 'make' command initiates the Teamengine web UI, which is used to run the CITE test suites. After execution, the UI can be accessed via a web browser.

```bash
make webUI
```

--------------------------------

### Start Docker Services for CITE Tests (Shell)

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

Removes existing WFS data and starts PostgreSQL and GeoServer Docker services using docker-compose. This will initialize WFS databases if they are empty. Requires Docker and docker-compose.

```shell
rm -rf /home/cite/postgis-data/wfs
docker-compose -f docker-compose.yml up
```

--------------------------------

### Install 'hello' module with Maven

Source: https://docs.geoserver.org/stable/en/developer/programming-guide/ows-services/implementing

This command installs the 'hello' module into the local Maven repository. It requires Maven to be installed and configured. The output shows the build process, including compilation, testing, and packaging, culminating in the installation of the JAR, POM, and sources files.

```bash
[hello]% mvn install
```

```text
[INFO] Scanning for projects...
[INFO]
[INFO] ------------------------------------------------------------------------
[INFO] Building Hello World Service Module 1.0
[INFO] ------------------------------------------------------------------------
[INFO]
[INFO] --- maven-clean-plugin:2.5:clean (default-clean) @ hello ---
[INFO] Deleting /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target
[INFO]
[INFO] --- cobertura-maven-plugin:2.6:clean (default) @ hello ---
[INFO]
[INFO] --- git-commit-id-plugin:2.0.4:revision (default) @ hello ---
[INFO] [GitCommitIdMojo] .git directory could not be found, skipping execution
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ hello ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO] skip non existing resourceDirectory /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/src/main/resources
[INFO]
[INFO] --- maven-compiler-plugin:2.3.2:compile (default-compile) @ hello ---
[INFO] Compiling 1 source file to /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/classes
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ hello ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/src/test/java
[INFO] skip non existing resourceDirectory /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/src/test/resources
[INFO]
[INFO] --- maven-compiler-plugin:2.3.2:testCompile (default-testCompile) @ hello ---
[INFO] No sources to compile
[INFO]
[INFO] --- maven-surefire-plugin:2.12.3:test (default-test) @ hello ---
[INFO] No tests to run.
[INFO]
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ hello ---
[INFO] Building jar: /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0.jar
[INFO]
[INFO] --- maven-jar-plugin:2.4:test-jar (default) @ hello ---
[WARNING] JAR will be empty - no content was marked for inclusion!
[INFO] Building jar: /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0-tests.jar
[INFO]
[INFO] >>> maven-source-plugin:2.2.1:jar (attach-sources) > generate-sources @ hello >>>
[INFO]
[INFO] --- git-commit-id-plugin:2.0.4:revision (default) @ hello ---
[INFO] [GitCommitIdMojo] .git directory could not be found, skipping execution
[INFO]
[INFO] <<< maven-source-plugin:2.2.1:jar (attach-sources) < generate-sources @ hello <<<
[INFO]
[INFO] --- maven-source-plugin:2.2.1:jar (attach-sources) @ hello ---
[INFO] Building jar: /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0-sources.jar
[INFO]
[INFO] >>> maven-source-plugin:2.2.1:test-jar (attach-sources) > generate-sources @ hello >>>
[INFO]
[INFO] --- git-commit-id-plugin:2.0.4:revision (default) @ hello ---
[INFO] [GitCommitIdMojo] .git directory could not be found, skipping execution
[INFO]
[INFO] <<< maven-source-plugin:2.2.1:test-jar (attach-sources) < generate-sources @ hello <<<
[INFO]
[INFO] --- maven-source-plugin:2.2.1:test-jar (attach-sources) @ hello ---
[INFO] No sources in project. Archive not created.
[INFO]
[INFO] --- maven-install-plugin:2.4:install (default-install) @ hello ---
[INFO] Installing /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0.jar to /home/bradh/.m2/repository/org/geoserver/hello/1.0/hello-1.0.jar
[INFO] Installing /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/pom.xml to /home/bradh/.m2/repository/org/geoserver/hello/1.0/hello-1.0.pom
[INFO] Installing /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0-tests.jar to /home/bradh/.m2/repository/org/geoserver/hello/1.0/hello-1.0-tests.jar
[INFO] Installing /home/bradh/devel/geoserver/doc/en/developer/source/programming-guide/ows-services/hello/target/hello-1.0-sources.jar to /home/bradh/.m2/repository/org/geoserver/hello/1.0/hello-1.0-sources.jar
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 2.473 s
[INFO] Finished at: 2015-10-20T10:14:16+11:00
[INFO] Final Memory: 23M/589M
[INFO] ------------------------------------------------------------------------

```

--------------------------------

### Setup PostgreSQL Data for WFS 1.1 Tests (SQL)

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

Executes a SQL script to populate the PostgreSQL database with test data for WFS 1.1. Requires navigating to the GeoServer repository and specifying the user and database.

```bash
cd <path of GeoServer repository>
psql -U cite cite < build/cite/wfs11/citewfs-1.1/dataset-sf0-postgis2.sql
```

--------------------------------

### Example Version Information from Nightly Build

Source: https://docs.geoserver.org/stable/en/developer/release/guide/index

This snippet shows the typical output from a `VERSION.txt` file found in GeoServer's nightly builds. It provides details about the current GeoServer version, Git revision and branch, build date, and corresponding GeoTools and GeoWebCache versions and revisions. This information is crucial for identifying the exact code used for a release.

```text
version = 2.27-SNAPSHOT
git revision = 1ee183d9af205080f1543dc94616bbe3b3e4f890
git branch = origin/2.27.x
build date = 19-Jul-2024 04:41
geotools version = 27-SNAPSHOT
geotools revision = 3bde6940610d228e01aec9de7c222823a2638664
geowebcache version = 1.27-SNAPSHOT
geowebcache revision = 27eec3fb31b8b4064ce8cc0894fa84d0ff97be61/27eec
hudson build = -1
```

--------------------------------

### Example Extension License Notice (Text)

Source: https://docs.geoserver.org/stable/en/developer/policies/community-modules

This text example shows the format and content for an extension's license notice file (`<module>-LICENSE.md`). It includes placeholders for module names and links to relevant licenses like GPL, LGPL, MPL 2.0, and EPL 1.0.

```text
Extension License Notice
========================

This GeoServer plugin is licensed under the GNU General Public License (GPL). For more information see license [notice](licenses/NOTICE.md) and the full [GPL](licenses/GPL.html).

This plugin contains content from the GeoTools Library. For more information see GeoTools license [notice](licenses/GEOTOOLS_NOTICE.md) and [LGPL](licenses/LGPL.md).

H2 is dual licensed and available under the [MPL 2.0](licenses/mpl-2.0.html) (Mozilla Public License Version 2.0) or under the [EPL 1.0](licenses/epl-1.0.html) (Eclipse Public License).

```

--------------------------------

### Run GeoServer from IntelliJ

Source: https://docs.geoserver.org/stable/en/developer/quickstart/intellij

Instructions on how to run the GeoServer application from within IntelliJ IDEA. This involves selecting the 'web-app' module, navigating to the 'Start' class, modifying run configurations, and executing the application.

```java
// No direct code snippet, but describes IDE actions.
// Right-click 'Start' class in org.geoserver.web package and select 'Modify Run Configuration...'
// Set 'Working directory' to 'src/web/app'
// Run -> Run 'Start'
```

--------------------------------

### Configuring System Test Setup Frequency with JUnit Annotation

Source: https://docs.geoserver.org/stable/en/developer/programming-guide/testing/index

Demonstrates how to control the frequency of GeoServer system test setup using the @TestSetup annotation from JUnit. This is useful for optimizing test execution time by specifying whether the setup should run once or for each test method.

```java
import org.geoserver.test.TestSetup;
import org.geoserver.test.TestSetupFrequency;

@TestSetup(run=TestSetupFrequency.REPEAT)
public class MyTestCase extends GeoServerSystemTestSupport {
   // ... test methods ...
}
```

--------------------------------

### Troubleshoot GeoServer Build with Maven

Source: https://docs.geoserver.org/stable/en/developer/quickstart/intellij

Provides solutions for common build errors encountered during GeoServer development in IntelliJ. This includes cleaning and installing specific modules, managing Maven profiles like 'errorprone', and rebuilding projects.

```bash
mvn clean install -f src/web/app/pom.xml
```

```bash
mvn clean install -f security-tests/pom.xml
```

--------------------------------

### Start GeoServer for WFS 1.1 Tests (Shell)

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

Starts the GeoServer instance with a specific data directory configured for WFS 1.1 testing. This involves changing directories and setting the GEOSERVER_DATA_DIR environment variable.

```bash
cd <path of GeoServer install>
export GEOSERVER_DATA_DIR=<path of GeoServer repository>/build/cite/wfs11/citewfs-1.1
./bin/startup.sh
```

--------------------------------

### GeoServer Release Announcement Email

Source: https://docs.geoserver.org/stable/en/developer/release/guide/index

An example email template for announcing a new GeoServer release to mailing lists. It includes a subject line, download link, a summary of new features and improvements, and acknowledgments.

```email
Subject: GeoServer 2.5.1 Released

The GeoServer team is happy to announce the release of GeoServer 2.5.1.

The release is available for download from:

https://geoserver.org/release/2.29.0/

GeoServer 2.29.0 is the next stable release of GeoServer and is recommended for production deployment.

This release comes with some exciting new features. The new and
noteworthy include:

* By popular request Top/Bottom labels when configuring layer group order
* You can now identify GeoServer “nodes” in a cluster by configuring a label and color in the UI. Documentation and example in the user guide.
* Have you ever run GeoServer and not quite gotten your file permissions correct? GeoServer now has better logging when it cannot your data directory and is required to “fall back” to the embedded data directory during start up.
* We have a new GRIB community module (community modules are not in the release until they pass a    QA check, but great to see new development taking shape)
* Documentation on the jp2kak extension now in the user guide
* Additional documentation for the image mosaic in the user guide with tutorials covering the plugin, raster time-series, time and elevation and footprint management.
* WCS 2.0 support continues to improve with DescribeCoverage now supporting null values
* Central Authentication Service (CAS) authentication has received a lot of QA this release and is now available in the GeoServer 2.5.x series.
* This release is made in conjunction with GeoTools 34.0

Along with many other improvements and bug fixes:

* https://osgeo-org.atlassian.net/jira/secure/ReleaseNote.jspa?projectId=10000&version=10164

Thanks to Andrea and Jody (GeoSolutions and Boundless) for publishing this release. A very special thanks to all those who contributed bug fixes, new
features, bug reports, and testing to this release.

--
The GeoServer Team
```

--------------------------------

### Clone GeoServer Repository

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

This command clones the GeoServer Git repository to your local machine, which is necessary to access the CITE test tools. Ensure Git is installed and configured on your system.

```git
git clone https://github.com/geoserver/geoserver.git
```

--------------------------------

### Updating Documentation Index

Source: https://docs.geoserver.org/stable/en/developer/release/guide/index

Example snippet showing how to add a new release version to the documentation index HTML file. This involves adding a new table row with links to the user and developer manuals for the new version.

```html
<tr>
  <td><strong><a href="https://geoserver.org/release/2.29.x/">2.29.x</a></strong></td>
  <td><a href="2.29.x/en/user/">User Manual</a></td>
  <td><a href="2.29.x/en/developer/">Developer Manual</a></td>
</tr>

```

--------------------------------

### Build GeoServer with Maven

Source: https://docs.geoserver.org/stable/en/developer/maven-guide/index

The most common Maven command to build GeoServer. It cleans previous build artifacts, compiles source code, runs unit tests, and installs the resulting artifacts into the local Maven repository. This command ensures a fresh and complete build.

```bash
mvn clean install
```

--------------------------------

### Clone GeoServer Repository

Source: https://docs.geoserver.org/stable/en/developer/source

Clones the GeoServer source code repository from GitHub to a local machine. This is the initial step to start development.

```bash
% git clone git://github.com/geoserver/geoserver.git geoserver

```

--------------------------------

### Example Git Revision Output from Hudson

Source: https://docs.geoserver.org/stable/en/developer/release/guide/old

This snippet shows an example of the output from a Hudson build log for a CITE test, which is used to determine the specific Git revisions for GeoServer and GeoTools that have passed all tests. It includes version numbers, Git revisions, Git branches, and build dates.

```text
version = 2.4-SNAPSHOT
Git revision = 68cbe445ca378e0dd04405870ef95c852189c1b0
Git branch = 68cbe445ca378e0dd04405870ef95c852189c1b0
build date = 08-Jul-2012 03:36
geotools version = 9-SNAPSHOT
geotools revision = 9517eebf412ce5cda354e7945672293c37cddcc4

```

--------------------------------

### Interactive Program Startup Notice (GNU GPL)

Source: https://docs.geoserver.org/stable/en/developer/_downloads/77f229b4525ee99a13b9d5e761acf8fb/GPL

This is a sample notice that an interactive program should display upon startup. It informs the user about the program's version, copyright, lack of warranty, and how to view details about redistribution terms.

```text
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
type `show w'.  This is free software, and you are welcome
to redistribute it under certain conditions; type `show c' 
for details.
```

--------------------------------

### Run Test Setup Before Method - Java

Source: https://docs.geoserver.org/stable/en/developer/programming-guide/testing/index

Annotates a test method with @RunTestSetup to ensure the test setup runs specifically before that method's execution. This is useful for methods requiring a clean or specific setup state.

```java
public class MyTestCase extends GeoServerSystemTestSupport {

   @Before
   public void revertChanges() {
       //roll back any changes made
       revertLayer("foo");
   }

   @Test
   public void test1() {
   }

   @Test
   public void test2() {
   }

   @Test
   @RunTestSetup
   public void test3() {

   }

   @Test
   public void test4() {
   }

}
```

--------------------------------

### Example Release Assembly Configuration (XML)

Source: https://docs.geoserver.org/stable/en/developer/policies/community-modules

This XML snippet shows a sample Maven assembly configuration for an extension (`ext-<module>.xml`). It defines the format as zip and includes file sets for necessary JARs and license files.

```xml
<assembly>
  <id>h2-plugin</id>
  <formats>
    <format>zip</format>
  </formats>
  <includeBaseDirectory>false</includeBaseDirectory>
  <fileSets>
    <fileSet>
      <directory>release/target/dependency</directory>
      <outputDirectory></outputDirectory>
      <includes>
        <include>gt-jdbc-core-*.jar</include>
        <include>gt-jdbc-h2-*.jar</include>
        <include>gs-h2-*.jar</include>
        <include>h2-*.jar</include>
        <include>geodb-*.jar</include>
        <include>hatbox-*.jar</include>
      </includes>
      <excludes>
        <exclude>*-tests-*.jar</exclude>
      </excludes>
    </fileSet>
    <fileSet>
      <directory>release/target/html/licenses</directory>
      <outputDirectory>licenses</outputDirectory>
      <includes>
        <include>LGPL.html</include>
        <include>GEOTOOLS_NOTICE.html</include>
        <include>GPL.html</include>
        <include>epl-1.0.html</include>
        <include>mpl-2.0.html</include>

```

--------------------------------

### Start Jetty with Open SSL Port

Source: https://docs.geoserver.org/stable/en/developer/eclipse-guide/index

Configure Jetty to start with an open SSL port (default 8443). This involves setting the '-Dssl.hostname' parameter in the VM arguments to the fully qualified host name of the server running Jetty.

```java
-Dssl.hostname=<your_fully_qualified_hostname>

```

--------------------------------

### Clone GeoServer Source Code (Git)

Source: https://docs.geoserver.org/stable/en/developer/quickstart/maven

Clones the GeoServer source code repository from GitHub. This is the initial step to obtain the project files for development.

```bash
git clone https://github.com/geoserver/geoserver.git geoserver
```

--------------------------------

### List and Checkout Git Branches

Source: https://docs.geoserver.org/stable/en/developer/quickstart/eclipse

Lists available branches in the cloned GeoServer repository and demonstrates how to checkout a specific branch, such as 'main' for the latest development or a stable version like '2.22.x'.

```bash
% git branch
   2.21.x
   2.22.x
 * main

```

```bash
% git checkout main

```

```bash
% git checkout 2.22.x

```

--------------------------------

### GeoServer WMS Integration Test Setup

Source: https://docs.geoserver.org/stable/en/developer/programming-guide/testing/index

Sets up test data and layers for WMS integration tests. It configures raster layers, styles, and vector layers required for testing WMS capabilities.

```java
public class GetMapIntegrationTest extends WMSTestSupport {
  ...
  @Override
  protected void setUpTestData(SystemTestData testData) throws Exception {
      super.setUpTestData(testData);
      testData.setUpWcs11RasterLayers();
  }

  @Override
  protected void onSetUp(SystemTestData testData) throws Exception {
      super.onSetUp(testData);
      Catalog catalog = getCatalog();
      testData.addStyle("Population", "Population.sld", GetMapIntegrationTest.class, catalog);
      testData.addStyle("jiffleBandSelect", "jiffleBandSelect.sld", GetMapIntegrationTest.class, catalog);
      testData.addVectorLayer(
              new QName(MockData.SF_URI, "states", MockData.SF_PREFIX),
              Collections.emptyMap(),
              "states.properties",
              getClass(),
              catalog);
        ...

  }
  ...
  @Test
  public void testGetMapOpaqueGroup() throws Exception {
      String url = "wms?LAYERS="
              + OPAQUE_GROUP
              + "&STYLES=&FORMAT=image%2Fpng"
              + "&SERVICE=WMS&VERSION=1.1.1&REQUEST=GetMap&SRS=EPSG%3A4326&WIDTH=256&HEIGHT=256&BBOX=-0.0043,-0.0025,0.0043,0.0025";
      BufferedImage imageGroup = getAsImage(url, "image/png");

      ImageAssert.assertEquals(
              new File("./src/test/resources/org/geoserver/wms/wms_1_1_1/opaqueGroup.png"), imageGroup, 300);
  }


```

--------------------------------

### Build GeoServer WAR with Hello Extension

Source: https://docs.geoserver.org/stable/en/developer/programming-guide/ows-services/implementing

Instructions for building a complete GeoServer WAR file that includes the 'hello' extension. This involves adding the extension as a dependency to the 'web/app' module's pom.xml and then building the 'web/app' module.

```bash
[web/app] mvn install
```

--------------------------------

### Manage Git Branches

Source: https://docs.geoserver.org/stable/en/developer/quickstart/eclipse_m2

These commands show how to list available branches in a Git repository and how to switch to a specific branch, such as 'main' for the latest development or a stable branch like '2.22.x'.

```git
% git branch
   2.21.x
   2.22.x
 * main

```

```git
% git checkout main

```

```git
git checkout 2.22.x

```

--------------------------------

### Prepare PostgreSQL for WFS 1.1 Tests (SQL)

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

Commands to set up a PostgreSQL database with the PostGIS extension for WFS 1.1 testing. This involves creating a user, a database owned by that user, and enabling the PostGIS extension.

```sql
createuser cite;

createdb cite_wfs11 own by cite;

create extension postgis;
```

--------------------------------

### List and Checkout GeoServer Branches (Git)

Source: https://docs.geoserver.org/stable/en/developer/quickstart/maven

Lists available branches in the GeoServer repository and allows checking out a specific branch, such as 'main' for the latest development or a stable version like '2.22.x'.

```bash
% git branch
   2.21.x
   2.22.x
 * main
```

```bash
% git checkout main
```

```bash
% git checkout 2.22.x
```

--------------------------------

### Maven Dependencies for EasyMock Class Extension

Source: https://docs.geoserver.org/stable/en/developer/programming-guide/testing/index

Specifies the Maven dependencies required to enable EasyMock to mock classes, not just interfaces. It includes the easymockclassextension and cglib libraries, both set to the test scope. This setup allows for more comprehensive mocking capabilities.

```xml
<dependency>
  <groupId>org.easymock</groupId>
  <artifactId>easymockclassextension</artifactId>
  <scope>test</scope>
</dependency>
<dependency>
  <groupId>cglib</groupId>
  <artifactId>cglib-nodep</artifactId>
  <scope>test</scope>
</dependency>
```

--------------------------------

### Build GeoServer from Source with Hello Profile

Source: https://docs.geoserver.org/stable/en/developer/programming-guide/ows-services/implementing

Command to build GeoServer from its source tree, activating the 'hello' Maven profile. This command ensures that the 'hello' module is compiled and integrated into the build process.

```bash
[src] mvn -P hello eclipse:eclipse
```

--------------------------------

### Generate Release Announcement Script (Python)

Source: https://docs.geoserver.org/stable/en/developer/release/guide/index

This Python script is used to generate the release announcement for GeoServer. It requires the username, password, version number, and optional GeoTools and GeoWebCache versions as arguments. Ensure you have the necessary dependencies installed.

```python
python3 announcement.py username password 2.29.1 --geotools 34.1 --geowebcache 1.29.1
```

--------------------------------

### Create GitHub Release Notes

Source: https://docs.geoserver.org/stable/en/developer/release/guide/index

Steps to create a new release on GitHub by navigating to tags, selecting a tag, and creating a release. It involves setting a release title, pasting markdown notes, and deciding whether to set it as the latest release.

```markdown
4. Navigate to GitHub tags https://github.com/geoserver/geoserver/tags
Locate the new tag from the list, and use … ‣ Create release
     * Release title: GeoServer 2.29.0
     * Write: Paste the markdown from Jira release notes editor
     * Set as the latest release: only tick this for stable releases, leave unticked for maintenance and support releases
Use Publish release button to publish the release notes.
```

--------------------------------

### Maven Build Output for javacc-maven-plugin

Source: https://docs.geoserver.org/stable/en/developer/quickstart/eclipse_m2

This is an example of the console output when the `javacc-maven-plugin` runs during a Maven build. It shows the compilation of Java Compiler Compiler (JavacC) and the successful generation of Java files for the parser and lexer.

```text
[INFO] --- javacc-maven-plugin:2.3:jjtree (jjtree) @ gs-wcs1_1 ---
Java Compiler Compiler Version 4.0 (Tree Builder)
(type "jjtree" with no arguments for help)
"src/wcs1_1/target/jjtree/org/geoserver/wcs/kvp/rangesubset/ASTFieldId.java" does not exist.  Will create one.
...
Annotated grammar generated successfully in src/wcs1_1/target/jjtree/org/geoserver/wcs/kvp/rangesubset/rangeset.jj
[INFO]
[INFO] --- javacc-maven-plugin:2.3:javacc (javacc) @ gs-wcs1_1 ---
Java Compiler Compiler Version 4.0 (Parser Generator)
(type "javacc" with no arguments for help)
Reading from file src/wcs1_1/target/jjtree/org/geoserver/wcs/kvp/rangesubset/rangeset.jj . . .
File "TokenMgrError.java" does not exist.  Will create one.
File "ParseException.java" does not exist.  Will create one.
...
Parser generated successfully.
[INFO]

[INFO] --- fmt-maven-plugin:2.4.0:format (default) @ gs-wcs1_1 ---
[debug] Using AOSP style
[INFO] Processed 47 files (0 reformatted).
[INFO]

```

--------------------------------

### Build and Test OGC Features 1.0 Locally

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

This command cleans, builds the GeoServer WAR, and then runs the OGC Features 1.0 test suite. It requires the geoserver.war to be built previously using 'make war'.

```shell
make clean build test suite=ogcapi-features10
```

--------------------------------

### Configure JNDI Resources in Jetty

Source: https://docs.geoserver.org/stable/en/developer/eclipse-guide/index

Configure JNDI resources like data sources in Jetty by specifying a Jetty server configuration file via system properties. This example shows setting up an Oracle database connection pool.

```java
-Djetty.config.file=../../../../../settings/jetty.xml
-Djava.naming.factory.url.pkgs=org.eclipse.jetty.jndi
-Djava.naming.factory.initial=org.eclipse.jetty.jndi.InitialContextFactory

```

```xml
<?xml version="1.0"?>
<!DOCTYPE Configure PUBLIC "-//Mort Bay Consulting//DTD Configure//EN" "http://jetty.mortbay.org/configure.dtd">
<Configure class="org.eclipse.jetty.server.Server">
    <New class="org.eclipse.jetty.plus.jndi.Resource">
        <Arg>java:comp/env/jdbc/demo</Arg>
        <Arg>
            <New class="org.apache.commons.dbcp.BasicDataSource">
                <Set name="driverClassName">oracle.jdbc.OracleDriver</Set>
                <Set name="url">jdbc:oracle:thin:@oracle.example.com:1521:demodb</Set>
                <Set name="username">claudius</Set>
                <Set name="password">s3cr3t</Set>
                <Set name="maxActive">20</Set>
                <Set name="maxIdle">10</Set>
                <Set name="minIdle">0</Set>
                <Set name="maxWait">10000</Set>
                <Set name="minEvictableIdleTimeMillis">300000</Set>
                <Set name="timeBetweenEvictionRunsMillis">300000</Set>
                <Set name="numTestsPerEvictionRun">20</Set>
                <Set name="poolPreparedStatements">true</Set>
                <Set name="maxOpenPreparedStatements">100</Set>
                <Set name="testOnBorrow">true</Set>
                <Set name="validationQuery">SELECT SYSDATE FROM DUAL</Set>
                <Set name="accessToUnderlyingConnectionAllowed">true</Set>
            </New>
        </Arg>
    </New>
</Configure>

```

--------------------------------

### Build and Test Command

Source: https://docs.geoserver.org/stable/en/developer/programming-guide/rest-services/implementing-map

Provides the Maven command to build and test the 'hello_rest' module, specifically running the tests defined in 'HelloMapResourceTest'. This command compiles the code, runs the tests, and reports the results, ensuring the functionality of the implemented RESTful service.

```shell
[hello_rest]% mvn clean install -Dtest=HelloMapResourceTest

```

--------------------------------

### Clean CITE Test Environment with Make

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

The 'make clean' command removes artifacts from previous CITE test runs, ensuring a fresh environment for building and executing tests. This is useful for troubleshooting or starting with a clean slate.

```makefile
make clean
```

--------------------------------

### Build GeoServer Docker Image (Shell)

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

Builds a local Docker image for GeoServer from the latest nightly build. It involves pulling the latest changes from the docker repository and executing a release script. Assumes Docker and Git are installed.

```shell
cd geoserver-docker/build && git pull && ./release.sh build 2.27-SNAPSHOT
docker image ls
```

--------------------------------

### Generate Eclipse Project Files with Maven

Source: https://docs.geoserver.org/stable/en/developer/quickstart/eclipse

Uses the Maven Eclipse plugin to generate the necessary `.project` and `.classpath` files for Eclipse IDE. This command should be run from the root of the GeoServer source directory.

```bash
mvn eclipse:eclipse

```

--------------------------------

### Run Full CITE Automation Workflow with Make

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

This command executes the complete CITE test automation workflow, including cleaning the environment, building the GeoServer Docker image, and running the specified test suite. Replace '<suite-name>' with the desired test suite.

```makefile
make clean build test suite=<suite-name>
```

--------------------------------

### Run CITE Test Suite with Make

Source: https://docs.geoserver.org/stable/en/developer/cite-test-guide/index

This 'make' target executes the specified CITE test suite using the Docker Compose setup. Replace '<suite-name>' with the desired test suite (e.g., wms13, wfs20). This command runs the actual test execution against the GeoServer instance.

```makefile
make test suite=<suite-name>
```
Tokens:
Raw