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

Jump to bottom

Jetty 12.0.x documentation #9096

Merged
merged 17 commits into from
Jan 6, 2023
Merged

Jetty 12.0.x documentation #9096

merged 17 commits into from
Jan 6, 2023

Conversation

gregpoulos
Copy link
Contributor

This pull request includes two broad categories of change:

  1. Editorial suggestions for the "Getting Started" section of the Operations Guide. These suggestions mostly revolve around things like fixing typos and tightening up the language.
  2. Fixes for broken includes and references. These are largely related changes in naming conventions now that Jetty 12 features separate modules for EE8/9/10.

@joakime joakime added this to the 12.0.x milestone Jan 2, 2023
@lachlan-roberts
Copy link
Contributor

@gregpoulos looks like you need to sign the Eclipse Contributor Agreement
https://www.eclipse.org/legal/ecafaq.php

sbordet
sbordet requested changes Jan 3, 2023
View reviewed changes
documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/deploy.adoc Outdated Show resolved Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/deploy.adoc Outdated Show resolved Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/deploy.adoc Outdated Show resolved Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/deploy.adoc Outdated Show resolved Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/deploy.adoc Outdated Show resolved Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/jaspi/chapter.adoc Outdated Show resolved Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/jaspi/chapter.adoc Outdated Show resolved Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/jaspi/chapter.adoc Outdated Show resolved Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/jaspi/chapter.adoc Outdated Show resolved Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/jaspi/chapter.adoc Outdated Show resolved Hide resolved
gregpoulos and others added 8 commits January 3, 2023 15:23
@gregpoulos @sbordet
Update documentation/jetty-documentation/src/main/asciidoc/operations…
5221555 
…-guide/begin/start.adoc

Co-authored-by: Simone Bordet <[email protected]>
@gregpoulos @sbordet
Update documentation/jetty-documentation/src/main/asciidoc/operations…
31759fb 
…-guide/begin/start.adoc

Co-authored-by: Simone Bordet <[email protected]>
@gregpoulos @sbordet
Update documentation/jetty-documentation/src/main/asciidoc/operations…
a2bb352 
…-guide/begin/start.adoc

Co-authored-by: Simone Bordet <[email protected]>
@gregpoulos @sbordet
Update documentation/jetty-documentation/src/main/asciidoc/operations…
f345d08 
…-guide/begin/start.adoc

Co-authored-by: Simone Bordet <[email protected]>
Incorporate suggestions from sbordet
3dcac29
Merge branch 'jetty-12.0.x-documentation' of https://github.com/gregp…
14a5b96 
…oulos/jetty.project into jetty-12.0.x-documentation

* 'jetty-12.0.x-documentation' of https://github.com/gregpoulos/jetty.project:
  Update documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/start.adoc
  Update documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/start.adoc
  Update documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/start.adoc
  Update documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/start.adoc
Merge branch 'jetty-12.0.x-documentation' of https://github.com/gregp…
a3d9bc3 
…oulos/jetty.project into jetty-12.0.x-documentation

* 'jetty-12.0.x-documentation' of https://github.com/gregpoulos/jetty.project:
  Update documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/start.adoc
  Update documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/start.adoc
  Update documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/start.adoc
  Update documentation/jetty-documentation/src/main/asciidoc/operations-guide/begin/start.adoc
Merge branch 'jetty-12.0.x-documentation' of https://github.com/gregp…
e805fc1 
…oulos/jetty.project into jetty-12.0.x-documentation

* 'jetty-12.0.x-documentation' of https://github.com/gregpoulos/jetty.project:
@gregpoulos
Copy link
Contributor Author

I've incorporated all of @sbordet's suggestions.

I ran into an email mismatch issue regarding my ECA sign-off, since apparently the email I used for my Eclipse Foundation account wasn't the same one I use in my git settings. I just updated my Eclipse Foundation account and re-signed the ECA, so hopefully now I'm just waiting for a change to propagate through the system somewhere.

@gregpoulos
Copy link
Contributor Author

Update: Looks like the ECA sign-off situation has been resolved!

sbordet
sbordet requested changes Jan 6, 2023
View reviewed changes
documentation/jetty-documentation/src/main/asciidoc/operations-guide/jaspi/chapter.adoc Outdated Show resolved Hide resolved
documentation/jetty-documentation/src/main/asciidoc/operations-guide/jaspi/chapter.adoc
----

[[og-jaspi-xml]]
===== Configure JASPI

To enable the `jaspi` module you can use the following command (issued from within the `$JETTY_BASE` directory):
Activate the `ee{9,10}-jaspi` module that matches your EE platform version.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If a module exists for ee9, then it should also exist for ee8, since we mechanically generate ee8 from ee9.
I'd say to always use ee{8,9,10} everywhere so here ee{9,10} -> ee{8,9,10}.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's odd – when I run java -jar $JETTY_HOME/start.jar --list-modules=* | grep jaspi I get:

                            ee10-jaspi - Enables JASPI authentication for deployed web applications.
ee10-jaspi-default-auth-config-factory - Provides a DefaultAuthConfigFactory for jaspi
                       ee10-jaspi-demo - Enables JASPI basic authentication the /test context path.
                             ee9-jaspi - Enables JASPI authentication for deployed web applications.
 ee9-jaspi-default-auth-config-factory - Provides a DefaultAuthConfigFactory for jaspi
                        ee9-jaspi-demo - Enables JASPI basic authentication the /test context path.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@olamy do you know whether there is a ee8-jaspi module?

documentation/jetty-documentation/src/main/asciidoc/operations-guide/jaspi/chapter.adoc
@@ -61,8 +63,8 @@ The `CallerPrincipalCallback` and `GroupPrincipalCallback` do not require use of

Jetty provides an implementation of the `AuthConfigFactory` interface which is used to register `AuthConfigProviders`. This can be replaced by a custom implementation by adding a custom module which provides `auth-config-factory`.
This custom module must reference an XML file which sets a new instance of the `AuthConfigFactory` with the static method `AuthConfigFactory.setFactory()`.
For an example of this see the `jaspi-default-auth-config-factory` module, which provides the default implementation used by Jetty.
For an example of this see the `ee{9,10}-jaspi-default-auth-config-factory` module, which provides the default implementation used by Jetty.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ee{9,10} -> ee{8,9,10}.

@sbordet sbordet self-requested a review January 6, 2023 10:46
@sbordet sbordet merged commit 1dc175e into jetty:jetty-12.0.x Jan 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sbordet sbordet sbordet approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
12.0.x
Development

Successfully merging this pull request may close these issues.
4 participants
@gregpoulos @lachlan-roberts @sbordet @joakime