Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for minor release of deegree 3.6 #1763

Merged
merged 10 commits into from
Dec 18, 2024
Merged

Update documentation for minor release of deegree 3.6 #1763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0dd47e8
#1543 - Remove INSPIRE workspace and references from the documentation
julianzz98 Oct 31, 2024
d8902a1
#1543 - Remove chapter 6.5.8. and references to deprecated functional…
julianzz98 Oct 31, 2024
89f31cc
#1543 - Unified naming of the deegree webservices administration console
julianzz98 Oct 31, 2024
4cd5792
#1543 - Removed outdated and unused images, added new terminal image
julianzz98 Nov 4, 2024
b832f0e
#1543 - Updated images of the documentation
julianzz98 Nov 14, 2024
15ab090
#1543 - Fixed typos and adjusted text to match updated images
julianzz98 Nov 14, 2024
6bb33c6
#1543 - Reworked the WPS workspace demo
julianzz98 Nov 15, 2024
5b6438b
#1543 - Reworked the Utah workspace demo, fixed mistake in table
julianzz98 Nov 15, 2024
f5e1d0a
#1543 - Improved image styling
julianzz98 Nov 18, 2024
494329d
#1543 - Removed further references to usused and deprecated functiona…
julianzz98 Nov 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion deegree-documentation/src/main/asciidoc/appendix.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ When using JNDI environment, more complex configurations are possible. For examp
type="java.lang.Float" override="false"
description="deegree Rendering - Miter Limit Factor"/>
----
More details on the datails of configuration can be found inside the documentation of the used Java Servlet containter
More details on the details of configuration can be found inside the documentation of the used Java Servlet container
like https://tomcat.apache.org/tomcat-9.0-doc/config/context.html#Environment_Entries[Apache Tomcat].

.List of current available parameters
Expand Down
82 changes: 37 additions & 45 deletions deegree-documentation/src/main/asciidoc/basics.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
== Configuration basics

In the previous chapter, you learned how to access and log in to the
deegree service console and how to download and activate example
deegree webservices administration console and how to download and activate example
workspaces. This chapter introduces the basic concepts of deegree
webservices configuration:

* The deegree workspace and the active workspace directory
* Workspace files and resources
* Workspace directories and resource types
* Resource identifiers and dependencies
* Usage of the service console for workspace configuration
* Usage of the administration console for workspace configuration

The final section of this chapter describes recommended practices for
creating your own workspace. The remaining chapters of the documentation
Expand Down Expand Up @@ -75,7 +75,7 @@ sections:


For example, to offer a Web Feature Service, a feature store (based on a
shapefile, database, etc) must be configured. With a rasterfile, like a
shapefile, database, etc.) must be configured. With a rasterfile, like a
GeoTIFF, you can configure a tile store and a coverage store to offer a
Web Map Service.

Expand Down Expand Up @@ -121,7 +121,7 @@ read/write access to this directory!
[[anchor-global-configuration]]
==== Global configuration files and the active workspace

If you downloaded all four example workspaces (as described in <<anchor-lightly>>), set a console password and the proxy parameters,
If you downloaded all four example workspaces (as described in <<anchor-lightly>>), set an administration console password and the proxy parameters,
your _.deegree_ directory will look like this:

.Example _.deegree_ directory
Expand All @@ -136,7 +136,7 @@ files exist:
|===
|File name |Function
|<subdirectory> |Workspace directory
|console.pw |Password for services console
|console.pw |Password for the administration console
|proxy.xml |Proxy settings
|webapps.properties |Selects the active workspace
|config.apikey |Contains the key to protect the REST API
Expand All @@ -146,7 +146,7 @@ NOTE: Only one single workspace can be active at a time! The
information on the active one is stored in file _webapps.properties_.

TIP: Usually, you don't need to care about the three files that are located
at the top level of this directory. The service console creates and
at the top level of this directory. The administration console creates and
modifies them as required (e.g. when switching to a different
workspace). In order to create a deegree webservices setup, you will
need to create or edit resource configuration files in the active
Expand All @@ -159,7 +159,7 @@ _webapps.properties_ stores the active workspace for every deegree
webapp separately.

TIP: If there is no _config.apikey_ file, one will be generated on startup
with an random value. Alternatively, a value of `*` in config.apikey will
with a random value. Alternatively, a value of `*` in config.apikey will
turn off security for the REST API. We strongly advise against doing this
in productive environments.

Expand Down Expand Up @@ -290,7 +290,7 @@ documented for each resource configuration format.
The configuration format for the deegree proxy configuration is defined
by schema file https://schemas.deegree.org/core/3.5/proxy/proxy.xsd. The
following table lists all available configuration options. When
specifiying them, their order must be respected.
specifying them, their order must be respected.

[width="100%",cols="24%,10%,7%,59%",options="header",]
|===
Expand All @@ -313,21 +313,21 @@ specifiying them, their order must be respected.

|FtpProxyPort | 0..1 | Integer | The port number of the proxy server for protocol `FTP`

|ProxyUser |0..1 | String | Username for proxy server authtentication
|ProxyUser |0..1 | String | Username for proxy server authentication

|HttpProxyUser |0..1 | String | Username for proxy server authtentication for protocol `HTTP`
|HttpProxyUser |0..1 | String | Username for proxy server authentication for protocol `HTTP`

|HttpsProxyUser |0..1 | String | Username for proxy server authtentication for protocol `HTTPS`
|HttpsProxyUser |0..1 | String | Username for proxy server authentication for protocol `HTTPS`

|FtpProxyUser |0..1 | String | Username for proxy server authtentication for protocol `FTP`
|FtpProxyUser |0..1 | String | Username for proxy server authentication for protocol `FTP`

|ProxyPassword |0..1 | String | Password for proxy server authtentication
|ProxyPassword |0..1 | String | Password for proxy server authentication

|HttpProxyPassword |0..1 | String | Password for proxy server authtentication for protocol `HTTP`
|HttpProxyPassword |0..1 | String | Password for proxy server authentication for protocol `HTTP`

|HttpsProxyPassword |0..1 | String | Password for proxy server authtentication for protocol `HTTPS`
|HttpsProxyPassword |0..1 | String | Password for proxy server authentication for protocol `HTTPS`

|FtpProxyPassword |0..1 | String | Password for proxy server authtentication for protocol `FTP`
|FtpProxyPassword |0..1 | String | Password for proxy server authentication for protocol `FTP`

|NonProxyHosts |0..1 | String | Indicates the hosts that should be accessed without going through the proxy. Multiple values can be separated by the `{vbar}` character.

Expand Down Expand Up @@ -358,37 +358,37 @@ specifiying them, their order must be respected.

____
NOTE: When specifying the proxy server, this can be defined individually
per protocol or in general. It is recommend to specify the proxy servers with
per protocol or in general. It is recommended to specify the proxy servers with
protocol if possible and to define the settings for
`HttpProxy...` and `HttpsProxy...` identically.
____

=== Using the service console for managing resources
=== Using the deegree webservices administration console for managing resources

As an alternative to dealing with the workspace resource configuration
files directly on the filesystem, you can also use the service console
for this task. The service console has a corresponding menu entry for
files directly on the filesystem, you can also use the administration console
for this task. The administration console has a corresponding menu entry for
every type of workspace resource. All resource menu entries are grouped
in the lower menu on the left:

.Workspace resource menu entries
image::console_resources.png[Workspace resource menu entries,scaledwidth=50.0%]

Although the console offers additional functionality for some resource
Although the administration console offers additional functionality for some resource
types, the basic management of resources is always identical.

==== Displaying configured resources

In order to display the configured workspace resources of a certain
type, click on the corresponding menu entry. The following screenshot
shows the metadata store resources in deegree-workspace-csw:
shows the tile store resources in deegree-workspace-utah:

.Displaying metadata store resources
image::console_metadata_stores.png[Displaying metadata store resources,scaledwidth=50.0%]
.Displaying tile store resources
image::console_tile_stores.png[Displaying tile store resources,scaledwidth=50.0%]

The right part of the window displays a table with all configured
metadata store resources. In this case, the workspace contains a single
resource with identifier "iso19115" which is in status "On".
tile store resources. In this case, the workspace contains a single
resource with identifier "utah_ortho" which is in status "On".

==== Deactivating a resource

Expand Down Expand Up @@ -426,20 +426,18 @@ image::console_editing.png[Editing a resource configuration,scaledwidth=50.0%]
You can now perform configuration changes in the text area and click on
"Save". Or click any of the links:

* Display Schema: Displays the XML schema file for the resource
configuration format.
* Cancel: Discards any changes.
* Turn on highlighting: Perform syntax highlighting.
* Validate: Perform an XML validation.

If there are no (syntactical) errors in the configuration, the "Save"
link will take you back to the corresponding resource view. Before
actually saving the file, the service console will perform an XML
actually saving the file, the administration console will perform an XML
validation of the file and display any syntactical errors:

.Displaying a syntax error
image::console_edit_error.png[Displaying a syntax error,scaledwidth=50.0%]

In this case, the mandatory "JDBCConnId" element was removed, which
In this case, the mandatory "TileMatrixSetId" element was removed, which
violates the configuration schema. This needs to be corrected, before
"Save" will actually save the file to the workspace directory.

Expand Down Expand Up @@ -467,7 +465,7 @@ configuration file in the workspace.
[[anchor-console-errors]]
==== Displaying error messages

One of the most helpful features of the console is that it can help to
One of the most helpful features of the administration console is that it can help to
detect and fix errors in a workspace setup. For example, if you delete
(or deactivate) JDBC connection "conn1" in deegree-workspace-csw and
click "[Reload]", you will see the following:
Expand Down Expand Up @@ -513,11 +511,7 @@ chapters, but here's a short overview:
service metadata ("Edit metadata"), edit controller configuration ("Edit
global config")
* Feature Stores: Display feature types and number of stored features
("Info"), Import GML feature collections ("Loader"), Mapping wizard
("Create new" SQL feature store)
* Metadata Stores: Import metadata sets ("Loader"), create database
tables ("Setup tables")
* Server Connections (JDBC): Test database connection ("Test")
("Info")

=== Best practices for creating workspaces

Expand All @@ -529,17 +523,15 @@ For creating your own workspace, you have two options. Option 1 is to
use an existing workspace as a template and adapt it to your needs.
Option 2 is to start from scratch, using an empty workspace. Adapting an
existing workspace makes a lot of sense if your use-case is close to the
scenario of the workspace. For example, if you want to set up INSPIRE
View and Download Services, it is a good option to use
<<anchor-workspace-inspire>> as a starting point.
scenario of the workspace.

In order to create a new workspace, simply create a new directory in the
_.deegree_ directory.

.Creating the new workspace _myscenario_
image::workspace-new.png[Creating the new workspace _myscenario_]

Afterwards, switch to the new workspace using the services console, as
Afterwards, switch to the new workspace using the administration console, as
described in <<anchor-downloading-workspaces>>.

==== Find out which resources you need
Expand Down Expand Up @@ -584,12 +576,12 @@ created later (references have to be added to the layers configuration).

All deegree XML configuration files have a corresponding XML schema,
which allows to detect syntactical errors easily. The editor built into
the services console performs validation when you save a configuration
the administration console performs validation when you save a configuration
file. If the contents is not valid according to the schema, the file
will not be saved, but an error message will be displayed:

.The services console displays an XML syntax error
image::console_edit_error.png[The services console displays an XML syntax error,scaledwidth=50.0%]
.The administration console displays an XML syntax error
image::console_edit_error.png[The administration console displays an XML syntax error,scaledwidth=50.0%]

If you prefer to use a different editor for editing deegree's
configuration files, it is highly recommended to choose a validating XML
Expand All @@ -602,7 +594,7 @@ schema files are hosted at https://schemas.deegree.org.

==== Check the resource status and error messages

As pointed out in <<anchor-console-errors>>, the service console
As pointed out in <<anchor-console-errors>>, the administration console
indicates errors if resources cannot be initialized. Here's an example:

.Error message
Expand Down
2 changes: 1 addition & 1 deletion deegree-documentation/src/main/asciidoc/cli-utility.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[[deegree-gml-tools]]
== deegree GML tools CLI
The deegree GML tools command line interface (CLI) provides commands to generate SQL DDL scripts and deegree SQLFeatureStore configuration files from GML application schemas. Furthermore it provides a interface to load a GML file from disk into a deegree SQLFeatureStore splitting large files into smaller chunks so that even huge (1 GB and more) files can be imported.
The deegree GML tools command line interface (CLI) provides commands to generate SQL DDL scripts and deegree SQLFeatureStore configuration files from GML application schemas. Furthermore, it provides a interface to load a GML file from disk into a deegree SQLFeatureStore splitting large files into smaller chunks so that even huge (1 GB and more) files can be imported.

You can download the latest release from https://repo.deegree.org/repository/public/org/deegree/deegree-tools-gml/.

Expand Down
22 changes: 11 additions & 11 deletions deegree-documentation/src/main/asciidoc/coveragestores.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
Coverage stores are resources that provide access to raster data. The
most common use case for coverage stores is to provide data for coverage
layers. You can access this configuration level by clicking the
*coverage stores* link in the service console. The corresponding
*coverage stores* link in the administration console. The corresponding
resource configuration files are located in subdirectory
*datasources/coverage/* of the active deegree workspace directory.

Expand Down Expand Up @@ -48,11 +48,11 @@ declare the pixel origin of the coverage. If omitted, center is used
as origin location.
* The nodata attribute can be optionally used to declare a nodata value.
* The readWorldFiles parameter can have the values true or false to
indicate if worlfiles will be read. Default value is true.
* The StorageCRS paramter is optional but recommended. It contains the
indicate if world files will be read. Default value is true.
* The StorageCRS parameter is optional but recommended. It contains the
EPSG code of the coverage sources.
* The RasterFile and RasterDirectory parameters contain the path to your
coverage sources. The RasterDirectory paramter can additionally have the
coverage sources. The RasterDirectory parameter can additionally have the
recursive attribute with true and false as value to declare
subdirectories to be included.

Expand All @@ -61,7 +61,7 @@ Depending on the raster data used, the size of the cache files may vary.
In individual cases, the use of cache files can be prevented by creating a
file _<filename>.no-cache_ or _<filename>.no-cache-<level>_ for whole files
or individual levels. Disabling the cache files can have a negative effect
on memory consumption. It is recommend to leave the cache enabled if possible.
on memory consumption. It is recommended to leave the cache enabled if possible.

=== MultiResolutionRaster

Expand Down Expand Up @@ -93,7 +93,7 @@ Here is an example for a MultiResolutionRaster:
* A MultiResolustionRaster contains at least one Resolution
* The Raster parameter has a res attribute. Its value is related to the
provided resolution.
* The StorageCRS paramter is optional but recommended. It contains the
* The StorageCRS parameter is optional but recommended. It contains the
EPSG code of the coverage sources.
* All elements and attributes from the Raster configuration can be used
for the resolutions.
Expand All @@ -105,7 +105,7 @@ it is required that the raster pyramid must be a GeoTIFF, containing the
extent and coordinate system of the data. Overlays must be multiples of
2. This is best tested with source data being processed with GDAL.

==== Prerequisities for Pyramids
==== Prerequisites for Pyramids

* Must be a GeoTiff as BigTiff
* Must be RGB or RGBA
Expand Down Expand Up @@ -144,7 +144,7 @@ To be able to use the module it is required that the Oracle GeoRaster
libraries are available, see <<anchor-db-libraries>> for details.

The following example shows, how to configure a GeoRaster coverage
(minmal required options):
(minimal required options):

[source,xml]
----
Expand Down Expand Up @@ -189,14 +189,14 @@ store.
</OracleGeoraster>
----

If your GeoRaster coverage only consist in a greyscale coverage or you
only want to server a single band you could specifiy the following:
If your GeoRaster coverage only consist in a greyscale coverage, or you
only want to server a single band you could specify the following:

[source,xml]
----
<Bands>
<Single>1</Single>
</Bands>]
</Bands>
----

[width="100%",cols="20%,11%,7%,62%",options="header",]
Expand Down
Loading