"Fossies" - the Fresh Open Source Software Archive

Member "geoserver-2.23.1/src/README.txt" (22 May 2023, 2443 Bytes) of package /linux/www/geoserver-2.23.1.tar.gz:

As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the last Fossies "Diffs" side-by-side code changes report for "README.txt": 2.22.2_vs_2.23.0.

    1 This README helps you getting started with GeoServer development. It will guide you through the process of checking out the source code, compiling it, and running.
    2 
    3 GeoServer Development requires Java 11, Maven, and git.
    4 
    5 
    6 Further readings:
    7   https://docs.geoserver.org/latest/en/developer/index.html
    8 
    9 
   10 Linux
   11 -----
   12 
   13 1) Install prerequisites
   14 
   15 Obtain OpenJDK 11, Maven and git from your Linux distribution.
   16 
   17 
   18 macOS
   19 -----
   20 
   21 1) Install Java Runtime Environment
   22 
   23    Download and install Java 11 runtime environment, as provided by adoptium macOS installers:
   24    https://adoptium.net/temurin/archive/?version=11
   25 
   26    Update your shell environment with:
   27 
   28      export JAVA_HOME=/Library/Java/JavaVirtualMachines/adoptiumjdk-11.jdk/Contents/Home
   29   
   30 The system /usr/bin/java makes use of JAVA_HOME setting above.
   31 
   32 2) Download and install git:
   33    https://git-scm.com/download/mac
   34 
   35 3) Download and install Maven:
   36    https://maven.apache.org/download.html
   37 
   38 Windows
   39 -------
   40 
   41 1) Install Java Runtime Environment
   42 
   43    Download and install Java 11 runtime environment, as provided by Adoptium windows installers:
   44    https://adoptium.net
   45 
   46    Update Windows *Environment Variables*:
   47 
   48    * Create an environment variable JAVA_HOME and point it to your Java JDK directory.
   49    * Modify the PATH variable and add: ;%JAVA_HOME%/bin
   50 
   51 2) Download and install git:
   52    https://git-scm.com/download/windows
   53 
   54 3) Download and install Maven:
   55    https://maven.apache.org/download.html
   56 
   57 OS independent tasks
   58 --------------------
   59 
   60 1) Get the source code
   61 
   62    Go to the command line and run:
   63    
   64      git clone https://github.com/geoserver/geoserver.git
   65 
   66 2) Build the source code
   67    
   68    Go to the command line and navigate to the folder you just checked out. Now run:
   69    
   70      cd geoserver
   71      cd src
   72      mvn clean install
   73 
   74 3) Running locally:
   75 
   76      cd web/app
   77      mvn jetty:run
   78 
   79 Troubleshooting
   80 ---------------
   81 
   82 The build process may fail because of several reasons:
   83 
   84 * Unavailable dependencies - Maven tries to download dependencies which might not be available on the server side yet.
   85 
   86   Solution: Try again in a few minutes.
   87 
   88 
   89 * Failing tests - Maven runs existing tests automatically. If some of them fail, the build fails.
   90 
   91   Solution: You can tell Maven not to run the tests. This is discouraged.
   92 
   93   Bug the developers instead or fix the test and send a patch, thanks!
   94   
   95   If you really just want to disable the test, run maven like so:
   96   
   97     mvn -DskipTests=true install