Skip to content

Commit

Permalink
deegree#1543 - Unified naming of the deegree webservices administrati…
Browse files Browse the repository at this point in the history
…on console
  • Loading branch information
julianzz98 committed Oct 31, 2024
1 parent d8902a1 commit 89f31cc
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 40 deletions.
32 changes: 16 additions & 16 deletions deegree-documentation/src/main/asciidoc/basics.adoc
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 @@ -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 Down Expand Up @@ -363,18 +363,18 @@ 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
Expand Down Expand Up @@ -433,7 +433,7 @@ configuration format.

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
Expand Down Expand Up @@ -467,7 +467,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 @@ -535,7 +535,7 @@ _.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 @@ -580,12 +580,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 @@ -598,7 +598,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
4 changes: 2 additions & 2 deletions deegree-documentation/src/main/asciidoc/coveragestores.adoc
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 @@ -196,7 +196,7 @@ only want to server a single band you could specifiy the following:
----
<Bands>
<Single>1</Single>
</Bands>]
</Bands>
----

[width="100%",cols="20%,11%,7%,62%",options="header",]
Expand Down
6 changes: 3 additions & 3 deletions deegree-documentation/src/main/asciidoc/featurestores.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ features. The two most common use cases for feature stores are:

The remainder of this chapter describes some relevant terms and the
feature store configuration files in detail. You can access this
configuration level by clicking *feature stores* in the service console.
configuration level by clicking *feature stores* in the administration console.
The corresponding resource configuration files are located in
subdirectory _datasources/feature/_ of the active deegree workspace
directory.
Expand Down Expand Up @@ -991,9 +991,9 @@ using a lot of trial-and-error. Here are some general practices to make
this as painless as possible.

* Map one property of a feature type at a time.
* Use the *Reload* link in the services console to activate changes.
* Use the *Reload* link in the administration console to activate changes.
* After changing the configuration file, make sure that the status of
the feature store stays green (in the console). If an exclamation mark
the feature store stays green (in the administration console). If an exclamation mark
occurs, you have an error in your configuration. Check the error message
and fix it.
* Check the results of your change (see below)
Expand Down
12 changes: 6 additions & 6 deletions deegree-documentation/src/main/asciidoc/installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ In order to run the WAR version, move it into the local deployment directory of

TIP: If you deploy the WAR into
a web container, you most probably will have to use a different URL for
accessing the deegree console and webservices, e.g.
accessing the administration console and webservices, e.g.
http://localhost:8080/deegree-webservices-${project.version}. The port
number and webapp name depend on your installation and deployment setup.
In the following the base URL http://localhost:8080/deegree-webservices without the version number will be used. You may rename the WAR file from _deegree-webservices-${project.version}.war_ to _deegree-webservices.war_ before deploying it.
Expand Down Expand Up @@ -109,21 +109,21 @@ behind a web server such as Apache httpd oder NGINX.
TIP: If you are running Apache Tomcat read the
https://tomcat.apache.org/tomcat-9.0-doc/ssl-howto.html[SSL HowTo].

==== Securing deegree console and REST API
==== Securing the deegree webservices administration console and REST API

It is as a huge security problem to operate the deegree web application without
setting a password for the deegree console. How to set the password for
the deegree console is described in <<anchor-configuration-basics>>. The
setting a password for the administration console. How to set the password for
the administration console is described in <<anchor-configuration-basics>>. The
same applies to the deegree REST API. Since both transfer the
credentials as clear text (with a little bit of obscurity) it is highly
recommended to enable encryption on the protocol level as described
above! For further information how to protect the deegree REST API read
more in <<anchor-configuration-restapi>>. You should also consider to
limit the access to both resources. Apply a filter by IP or hostname to
only allow a subset of machines to connect and access the deegree
only allow a subset of machines to connect and access the administration
console and REST API.

WARNING: The deegree console provides access to the server file system. Therefore,
WARNING: The administration console provides access to the server file system. Therefore,
you must not operate the Java Servlet container as root user!
Furthermore, you should consider to enable the Java Security Manager and
define restrictive file permissions.footnote:[How to run securely Java
Expand Down
6 changes: 3 additions & 3 deletions deegree-documentation/src/main/asciidoc/javamodules.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,10 @@ libraries) or by the application (_WEB-INF/lib_).

In order to see which JARs are available to your deegree webservices
instance/workspace, use the "module info" link in the general section of
the service console:
the administration console:

.Displaying available JARs using the service console
image::module_info.png[Displaying available JARs using the service console,scaledwidth=50.0%]
.Displaying available JARs using the administration console
image::module_info.png[Displaying available JARs using the administration console,scaledwidth=50.0%]

The list of JARs section displays the JARs found on the web application
classpath, while the lower section displays the JARs found on the
Expand Down
16 changes: 8 additions & 8 deletions deegree-documentation/src/main/asciidoc/lightly.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
== Getting started

In the previous chapter, you learned how to install and start deegree
webservices. In this chapter, we will introduce the deegree service
console and learn how to use it to perform basic tasks such as
webservices. In this chapter, we will introduce the deegree webservices
administration console and learn how to use it to perform basic tasks such as
downloading and activating example configurations. In deegree
terminology, a complete configuration for a deegree instance is called
"deegree workspace".
Expand All @@ -15,17 +15,17 @@ contains a complete configuration for a deegree webservice instance. You
may have multiple deegree workspaces on your machine, but only a single
workspace can be active.

=== Accessing deegree's service console
=== Accessing the deegree webservices administration console

The service console is a web-based administration interface for
The console is a web-based administration interface for
configuring your deegree webservices installation. If deegree
webservices are running on your machine, you can usually access the
webservices are running on your machine, you can usually access the administration
console from your browser via http://localhost:8080/deegree-webservices

.deegree webservices administration console
image::console_start.png[deegree webservices administration console,scaledwidth=50.0%]

TIP: You can access the service console from other machines on your network
TIP: You can access the administration console from other machines on your network
by exchanging _localhost_ with the name or IP address of the machine
that runs deegree webservices.

Expand All @@ -34,7 +34,7 @@ relevant. The menu items in this section:

* *workspaces*: Download and activate example configurations
* *proxy*: Configure network proxy settings
* *password*: Set a password for accessing the service console
* *password*: Set a password for accessing the administration console
* *module info*: Display loaded deegree modules
* *send requests*: Send raw OGC web service requests
* *see layers*: Display WMS layers
Expand Down Expand Up @@ -114,7 +114,7 @@ button in the map area.
image::console_workspace_utah3.png[Exploring Utah layers,scaledwidth=50.0%]

In order to send requests against the WFS, you may use the *send
requests* link in the service console (you may need to go back in your
requests* link in the administration console (you may need to go back in your
browser first). A simple interface for sending XML requests will open
up. This interface is meant for accessing OGC web services on the
protocol level and contains some reasonable example requests.
Expand Down
4 changes: 2 additions & 2 deletions deegree-documentation/src/main/asciidoc/webservices.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2282,9 +2282,9 @@ NOTE: Further information of the configuration of the cache can be found in http
<CacheName>map_cache</CacheName>
</CachingTileStore>

==== Supported steps by deegree services console
==== Supported steps by the deegree webservices administration console

Currently the deegree services console supports the following steps:
Currently, the administration console supports the following steps:

* creating TileStore and TileMatrixSet configuration files
* creating Layer and Themes configuration files
Expand Down

0 comments on commit 89f31cc

Please sign in to comment.