This is an automated email from the ASF dual-hosted git repository.
cziegeler pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/felix-antora-site.git
The following commit(s) were added to refs/heads/main by this push:
new 0da985ac Fix some formatting errors
0da985ac is described below
commit 0da985acc01cb165b9c9821b2cd36a47cfbf3401
Author: Carsten Ziegeler <[email protected]>
AuthorDate: Thu Mar 27 07:29:40 2025 +0100
Fix some formatting errors
---
.../subprojects/apache-felix-web-console.adoc | 22 +++++++++-------------
.../extending-the-apache-felix-web-console.adoc | 3 +--
.../branding-the-web-console.adoc | 3 +--
.../providing-resources.adoc | 3 +--
.../providing-web-console-plugins.adoc | 3 +--
.../web-console-logging.adoc | 3 +--
.../web-console-output-templating.adoc | 3 +--
.../web-console-restful-api.adoc | 3 +--
.../web-console-security-provider.adoc | 3 +--
9 files changed, 17 insertions(+), 29 deletions(-)
diff --git a/modules/ROOT/pages/subprojects/apache-felix-web-console.adoc
b/modules/ROOT/pages/subprojects/apache-felix-web-console.adoc
index da5d6555..1c8a2e96 100644
--- a/modules/ROOT/pages/subprojects/apache-felix-web-console.adoc
+++ b/modules/ROOT/pages/subprojects/apache-felix-web-console.adoc
@@ -1,8 +1,8 @@
= Apache Felix Web Console
-NOTE: This documentation refers to the older version 4.x of the Apache Felix
Webconsole. For the latest version checkout
https://github.com/apache/felix-dev/tree/master/webconsole[this documentation].
+NOTE: This documentation refers to the older version 4.x of the Apache Felix
Web Console. For the latest version checkout
https://github.com/apache/felix-dev/tree/master/webconsole[this documentation].
-The Apache Felix Web Console is a simple tool to inspect and manage OSGi
framework instances using your favourite Web Browser.
+The Apache Felix Web Console is a simple tool to inspect and manage OSGi
framework instances using your favourite web browser.
== Requirements
@@ -11,17 +11,11 @@ The reason for this is, that the Web Console is implemented
as a servlet (actual
If your framework does not yet have a Http Service installed, you might select
from a variety of such implementations.
The following is just an incomplete list:
-* Apache Felix HTTP Service.
-This is a very basic implementation of the OSGi Http Service based on Jetty
6.1.7.
-The Apache Felix HTTP Service has not been released yet, so you would have to
build it yourself.
-* PAX Web Service.
-The PAX Web Service is the basis for a whole range of additions from the
https://ops4j.github.io/ops4j/index.html[OPS4J] project.
-The PAX Web Service is also based on Jetty 6 and may be dowloaded from the
https://ops4j1.jira.com/wiki/spaces/paxweb/overview[OPS4J PAX Web] page.
-* Equinox HTTP Service implementation.
-You can get more information on the Equinox implementation from the
https://www.eclipse.org/equinox/server/[Server-Side Equinox] page.
+* Apache Felix HTTP Service -- This is an implementation of the OSGi Http
Service based on Eclipse Jetty.
+* PAX Web Service -- The PAX Web Service is the basis for a whole range of
additions from the https://ops4j.github.io/ops4j/index.html[OPS4J] project. The
PAX Web Service is also based on Jetty and may be dowloaded from the
https://ops4j1.jira.com/wiki/spaces/paxweb/overview[OPS4J PAX Web] page.
+* Equinox HTTP Service implementation -- You can get more information on the
Equinox implementation from the
https://www.eclipse.org/equinox/server/[Server-Side Equinox] page.
-Apart from that Web Console has the following dependencies, which do not need
to be satisfied.
-In this case the respective functionality is just missing.
+Apart from that Web Console has the following optional dependencies. If these
dependencies are missing at runtime, the respective functionality based on it
is not available:
* OSGi Log Service -- The Log Service is used for logging.
If the service is not available the Web Console prints logging to the standard
output
@@ -55,7 +49,7 @@ This is
https://issues.apache.org/jira/browse/FELIX-2086[considered a bug] and w
To install just use your favourite current means of installing new bundles in
to the OSGi framework.
-NOTE: The webconsole does not provide a CSRF protection out of the box!
Therefore it is advisable to install additional software to protect the
webconsole. For example the bundle from
https://github.com/apache/sling-org-apache-sling-security[Apache Sling
Security] provides this additional protection. Make sure to use the latest
version (1.3.0 or higher).
+NOTE: The Web Console does not provide a CSRF protection out of the box!
Therefore it is advisable to install additional software to protect the Web
Console. For example the bundle from
https://github.com/apache/sling-org-apache-sling-security[Apache Sling
Security] provides this additional protection. Make sure to use the latest
version (1.3.0 or higher).
For example using the Apache Felix shell console you might do:
@@ -198,6 +192,8 @@ It is never displayed by the Configuration Manager.
== Security
+NOTE: The Web Console does not provide a CSRF protection out of the box!
Therefore it is advisable to install additional software to protect the Web
Console. For example the bundle from
https://github.com/apache/sling-org-apache-sling-security[Apache Sling
Security] provides this additional protection. Make sure to use the latest
version (1.3.0 or higher).
+
The Web Console only has very basic security at the moment supporting only
HTTP Basic authentication.
This security is enabled by default and may be disabled by simply clearing the
`username` property.
diff --git
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console.adoc
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console.adoc
index 2496d5f9..09006685 100644
---
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console.adoc
+++
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console.adoc
@@ -1,7 +1,6 @@
= Extending the Apache Felix Web Console
-NOTE: This documentation refers to the older version 4.x of the Apache Felix
Webconsole. For the latest version checkout https:/
-/github.com/apache/felix-dev/tree/master/webconsole[this documentation].
+NOTE: This documentation refers to the older version 4.x of the Apache Felix
Web Console. For the latest version checkout
https://github.com/apache/felix-dev/tree/master/webconsole[this documentation].
The xref:subprojects/apache-felix-web-console.adoc[Apache Felix Web Console]
is extensible in various ways described no these pages:
diff --git
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/branding-the-web-console.adoc
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/branding-the-web-console.adoc
index c8cb200a..3e72a46e 100644
---
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/branding-the-web-console.adoc
+++
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/branding-the-web-console.adoc
@@ -1,7 +1,6 @@
= Branding the Web Console
-NOTE: This documentation refers to the older version 4.x of the Apache Felix
Webconsole. For the latest version checkout https:/
-/github.com/apache/felix-dev/tree/master/webconsole[this documentation].
+NOTE: This documentation refers to the older version 4.x of the Apache Felix
Web Console. For the latest version checkout
https://github.com/apache/felix-dev/tree/master/webconsole[this documentation].
Branding the Web Consle mainly concerns hooking into the looks of the Web
Console providing vendor-provided setup like CSS, Logo, Main Title, Vendor URL,
etc.
diff --git
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/providing-resources.adoc
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/providing-resources.adoc
index 7f4ff936..dc1c4c3c 100644
---
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/providing-resources.adoc
+++
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/providing-resources.adoc
@@ -1,7 +1,6 @@
= Providing Resources
-NOTE: This documentation refers to the older version 4.x of the Apache Felix
Webconsole. For the latest version checkout https:/
-/github.com/apache/felix-dev/tree/master/webconsole[this documentation].
+NOTE: This documentation refers to the older version 4.x of the Apache Felix
Web Console. For the latest version checkout
https://github.com/apache/felix-dev/tree/master/webconsole[this documentation].
Extending the Apache Felix Web Console with new functionality is as easy as
registering a `javax.servlet.Servlet` with at least the
`felix.webconsole.label` service registration property set (see above).
Providing resources is a bit more complex and requires more work on behalf of
the plugin.
diff --git
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/providing-web-console-plugins.adoc
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/providing-web-console-plugins.adoc
index 6ab732ae..6dc296cf 100644
---
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/providing-web-console-plugins.adoc
+++
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/providing-web-console-plugins.adoc
@@ -1,7 +1,6 @@
= Providing Web Console Plugins
-NOTE: This documentation refers to the older version 4.x of the Apache Felix
Webconsole. For the latest version checkout https:/
-/github.com/apache/felix-dev/tree/master/webconsole[this documentation].
+NOTE: This documentation refers to the older version 4.x of the Apache Felix
Web Console. For the latest version checkout
https://github.com/apache/felix-dev/tree/master/webconsole[this documentation].
The Web Console can be extended by registering an OSGi service for the
interface `javax.servlet.Servlet` with the service property
`felix.webconsole.label` set to the label (last segment in the URL) of the page.
The respective service is called a Web Console Plugin or a plugin for short.
diff --git
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/web-console-logging.adoc
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/web-console-logging.adoc
index 8364db02..9f13fad3 100644
---
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/web-console-logging.adoc
+++
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/web-console-logging.adoc
@@ -1,7 +1,6 @@
= Web Console Logging
-NOTE: This documentation refers to the older version 4.x of the Apache Felix
Webconsole. For the latest version checkout https:/
-/github.com/apache/felix-dev/tree/master/webconsole[this documentation].
+NOTE: This documentation refers to the older version 4.x of the Apache Felix
Web Console. For the latest version checkout
https://github.com/apache/felix-dev/tree/master/webconsole[this documentation].
The Web Console does not provide its own mechanism for logging.
Rather the Servlet Container logging mechanism is used by calling the
`GenericServlet.log` methods for logging.
diff --git
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/web-console-output-templating.adoc
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/web-console-output-templating.adoc
index 56a83cda..48d9324d 100644
---
a/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/web-console-output-templating.adoc
+++
b/modules/ROOT/pages/subprojects/apache-felix-web-console/extending-the-apache-felix-web-console/web-console-output-templating.adoc
@@ -1,7 +1,6 @@
= Web Console Output Templating
-NOTE: This documentation refers to the older version 4.x of the Apache Felix
Webconsole. For the latest version checkout https:/
-/github.com/apache/felix-dev/tree/master/webconsole[this documentation].
+NOTE: This documentation refers to the older version 4.x of the Apache Felix
Web Console. For the latest version checkout
https://github.com/apache/felix-dev/tree/master/webconsole[this documentation].
Templating and Internationalization support of the Web Console is based on
Java Resource Bundles loaded from the plugin bundles and is transparent to the
plugin itself.
diff --git
a/modules/ROOT/pages/subprojects/apache-felix-web-console/web-console-restful-api.adoc
b/modules/ROOT/pages/subprojects/apache-felix-web-console/web-console-restful-api.adoc
index 00204d9f..28045fcc 100644
---
a/modules/ROOT/pages/subprojects/apache-felix-web-console/web-console-restful-api.adoc
+++
b/modules/ROOT/pages/subprojects/apache-felix-web-console/web-console-restful-api.adoc
@@ -1,7 +1,6 @@
= Web Console RESTful API
-NOTE: This documentation refers to the older version 4.x of the Apache Felix
Webconsole. For the latest version checkout https:/
-/github.com/apache/felix-dev/tree/master/webconsole[this documentation].
+NOTE: This documentation refers to the older version 4.x of the Apache Felix
Web Console. For the latest version checkout
https://github.com/apache/felix-dev/tree/master/webconsole[this documentation].
WARNING: Please note that the APIs described on this page have not been
standardized or stabilized yet.
As such they cannot be relied upon.
diff --git
a/modules/ROOT/pages/subprojects/apache-felix-web-console/web-console-security-provider.adoc
b/modules/ROOT/pages/subprojects/apache-felix-web-console/web-console-security-provider.adoc
index 01bae230..ea0057d0 100644
---
a/modules/ROOT/pages/subprojects/apache-felix-web-console/web-console-security-provider.adoc
+++
b/modules/ROOT/pages/subprojects/apache-felix-web-console/web-console-security-provider.adoc
@@ -1,7 +1,6 @@
= Web Console Security Provider
-NOTE: This documentation refers to the older version 4.x of the Apache Felix
Webconsole. For the latest version checkout https:/
-/github.com/apache/felix-dev/tree/master/webconsole[this documentation].
+NOTE: This documentation refers to the older version 4.x of the Apache Felix
Web Console. For the latest version checkout
https://github.com/apache/felix-dev/tree/master/webconsole[this documentation].
As of Apache Felix Web Console 3.1.0 security of the Web Console can be
extended by providing a `WebConsoleSecurityProvicer` service.
An extension to this service has been introduced with the
`WebConsoleSecurityProvider2` service in Apache Felix Web Console 3.1.4.
