<commit_before>.. _anchor-installation:

============
Installation
============

-------------------
System requirements
-------------------

deegree webservices work on any platform with a compatible Java installation, including:

* Microsoft Windows
* Linux
* Mac OS X
* Solaris

Supported Java versions are `Oracle Java 8 (JDK) <http://www.oracle.com/technetwork/java/javase/downloads/index.html>` [#f1]_, `OpenJDK <http://openjdk.java.net>`_ version 8 (currently only available for Linux). Newer Java versions may work, but are not officially supported by the deegree development team.

-----------
Downloading
-----------

deegree webservices downloads are available on the `deegree home page <http://www.deegree.org>`_. You have the choice of two flavors:

* *ZIP*: Multi-operating system package bundled with Apache Tomcat
* *WAR*: Plain Java Web Archive for deployment in an existing servlet container [#f2]_

.. tip::
  If you are confused by the two options and unsure which version to pick, use the ZIP. Both variants contain exactly the same deegree software, they only differ in packaging.

---------------------
Starting and stopping
---------------------

In order to run the ZIP version, extract it into a directory of your choice. Afterwards, fire up the included start script for your operating system:

* Microsoft Windows: ``start-deegree-windows`` 
* Linux/Solaris: ``start-deegree-linux.sh`` (when starting via a Desktop Environment such as Gnome, choose "Run in terminal")
* Mac OS X: ``start-deegree-osx.cmd``

You should now see a terminal window on your screen with a lot of log messages: 

.. figure:: images/terminal.png
   :figwidth: 60%
   :width: 50%
   :target: _images/terminal.png

   deegree webservices starting up

.. tip::
  If you don't see this terminal window, make sure that the ``java`` command is on the system path. You can verify this by entering ``java -version`` at the command prompt. Also ensure that ``JAVA_HOME`` system environment variable points to the correct installation directory of a compatible JDK.

You may minimize this window, but don't close it as long as you want to be able to use the deegree webservices. In order to check if the services are actually running, open http://localhost:8080 in your browser. You should see the following page:

.. figure:: images/console_start.png
   :figwidth: 60%
   :width: 50%
   :target: _images/console_start.png

   deegree webservices administration console

To shut deegree webservices down, switch back to the terminal window and press ``CTRL+C`` or simply close it. 

.. tip::
  If you want to run deegree webservices on system startup automatically, consider installing `Apache Tomcat 8/7 <http://tomcat.apache.org>`_ as a system service. Afterwards, download the WAR version of deegree webservices and deploy it into your Tomcat installation (e.g. by copying the WAR file into the ``webapps`` folder). Consult the Tomcat documentation for more information and options.

.. rubric:: Footnotes

.. [#f1] In case you consider to run Oracle JDK 6 or 7 be aware that both versions are out of maintenance and reached EOF.
.. [#f2] A Servlet 2.5 compliant web container is required. We recommend using the latest Apache Tomcat 8 release.
<commit_msg>Updated installation section with ZIP distribution bundle, Docker Image and other improvments<commit_after>.. _anchor-installation:

============
Installation
============

-------------------
System requirements
-------------------

deegree webservices work on any platform with a compatible Java SE installation, including:

* Microsoft Windows
* Linux
* Mac OS X
* Solaris

Supported Java SE versions are `Oracle JDK 8 <http://www.oracle.com/technetwork/java/javase/downloads/index.html>`_ [#f1]_, `OpenJDK <http://openjdk.java.net>`_ version 8. Newer Java SE versions may work, but are not officially supported by the deegree development team.

-----------
Downloading
-----------

deegree webservices downloads are available on the `deegree home page <http://www.deegree.org>`_. You have the choice between:

* *Docker* : Docker Image with deegree webservices on OpenJDK and Apache Tomcat [#f11]_
* *WAR*: Generic Java Web Archive for deployment in an existing Java Servlet container [#f2]_
* *ZIP*: Distribution bundle with Apache Tomcat [#f3]_

.. tip::
  If you are confused by the two options and unsure which version to pick, use the ZIP. Both variants contain exactly the same deegree software, they only differ in packaging.

---------------------
Starting and stopping
---------------------

In order to run the ZIP version, extract it into a directory of your choice. Afterwards, fire up the included start script for your operating system:

* Microsoft Windows: ``start-deegree-windows`` 
* Linux/Solaris: ``start-deegree-linux.sh`` (when starting via a Desktop Environment such as Gnome, choose "Run in terminal")
* Mac OS X: ``start-deegree-osx.cmd``

You should now see a terminal window on your screen with a lot of log messages: 

.. figure:: images/terminal.png
   :figwidth: 60%
   :width: 50%
   :target: _images/terminal.png

   deegree webservices starting up

.. tip::
  If you don't see this terminal window, make sure that the ``java`` command is on the system path. You can verify this by entering ``java -version`` at the command prompt. Also ensure that ``JAVA_HOME`` system environment variable points to the correct installation directory of a compatible JDK.

You may minimize this window, but don't close it as long as you want to be able to use the deegree webservices. In order to check if the services are actually running, open http://localhost:8080 in your browser. You should see the following page:

.. figure:: images/console_start.png
   :figwidth: 60%
   :width: 50%
   :target: _images/console_start.png

   deegree webservices administration console

To shut deegree webservices down, switch back to the terminal window and press ``CTRL+C`` or simply close it. 

.. tip::
  If you want to run deegree webservices on system startup automatically, consider installing `Apache Tomcat 8/9 <http://tomcat.apache.org>`_ as a system service. Afterwards, download the WAR version of deegree webservices and deploy it into your Tomcat installation (e.g. by copying the WAR file into the ``webapps`` folder). Consult the Tomcat documentation for more information and options.

.. rubric:: Footnotes

.. [#f1] Oracle JDK 7 and earlier are not supported anymore, be aware that those versions are out of maintenance and reached EOF.
.. [#f11] This requires an installation of Docker Community or Enterprise Edition, download Docker from `www.docker.com <https://www.docker.com/>`_.
.. [#f2] A Java Servlet 2.5 compliant container is required. We recommend using the latest `Apache Tomcat 8 <http://tomcat.apache.org/>`_ release.
.. [#f3] As of deegree 3.4.0 the ZIP distribution bundle is deprecated and the download links are removed from the website. Download the ZIP from the `Nexus repository <http://repo.deegree.org/content/groups/public/org/deegree/deegree-webservices-tomcat-bundle/>` instead.
{'fraction_non_alphanumeric': 0.1100451467268623, 'fraction_numerical': 0.008182844243792325, 'mean_word_length': 3.7513404825737267, 'pattern_counts': {'":': 0, '<': 14, '<?xml version=': 0, '>': 14, 'https://': 1, 'lorem ipsum': 0, 'www.': 6, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 11, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5015043', 'n_tokens_mistral': 1965, 'n_tokens_neox': 1844, 'n_words': 920}