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.

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 security docs #42703

Merged
merged 3 commits into from
Aug 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ quarkus.http.auth.basic=true
+
[source,properties]
----
security.users.embedded.enabled=true
quarkus.security.users.embedded.enabled=true
----

.. You can also configure the required user credentials, user name, secret, and roles.
Expand Down
8 changes: 6 additions & 2 deletions docs/src/main/asciidoc/security-getting-started-tutorial.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -79,13 +79,17 @@
You can create a new Maven project with the Security Jakarta Persistence extension or add the extension to an existing Maven project.
You can use either Hibernate ORM or Hibernate Reactive.

==== Creating new Maven project

* To create a new Maven project with the Jakarta Persistence extension, complete one of the following steps:
** To create the Maven project with Hibernate ORM, use the following command:

:create-app-artifact-id: security-jpa-quickstart
:create-app-extensions: security-jpa,jdbc-postgresql,rest,hibernate-orm-panache
include::{includes}/devtools/create-app.adoc[]

==== Adding Jakarta Persistence extension to existing project

* To add the Jakarta Persistence extension to an existing Maven project, complete one of the following steps:

** To add the Security Jakarta Persistence extension to an existing Maven project with Hibernate ORM, run the following command from your project base directory:
Expand Down Expand Up @@ -415,7 +419,7 @@
%prod.quarkus.datasource.db-kind=postgresql
%prod.quarkus.datasource.username=quarkus
%prod.quarkus.datasource.password=quarkus
%prod.quarkus.datasource.jdbc.url=jdbc:postgresql:elytron_security_jpa
%prod.quarkus.datasource.jdbc.url=jdbc:postgresql://localhost/quarkus
sberyozkin marked this conversation as resolved.
Show resolved Hide resolved

quarkus.hibernate-orm.database.generation=drop-and-create
----
Expand Down Expand Up @@ -505,10 +509,10 @@
[source,bash]
----
docker run --rm=true --name security-getting-started -e POSTGRES_USER=quarkus \
-e POSTGRES_PASSWORD=quarkus -e POSTGRES_DB=elytron_security_jpa \
-e POSTGRES_PASSWORD=quarkus -e POSTGRES_DB=quarkus \
-p 5432:5432 postgres:14.1
----
=== Compile and run the application

Check warning on line 515 in docs/src/main/asciidoc/security-getting-started-tutorial.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [Quarkus.HeadingPunctuation] Do not use end punctuation in headings. Raw Output: {"message": "[Quarkus.HeadingPunctuation] Do not use end punctuation in headings.", "location": {"path": "docs/src/main/asciidoc/security-getting-started-tutorial.adoc", "range": {"start": {"line": 515, "column": 1}}}, "severity": "INFO"}

* Compile and run your Quarkus application by using one of the following methods:
** JVM mode
Expand Down
2 changes: 2 additions & 0 deletions docs/src/main/asciidoc/security-proactive-authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,9 @@ package io.quarkus.it.keycloak;

import jakarta.annotation.Priority;
import jakarta.ws.rs.Priorities;
import jakarta.ws.rs.core.Context;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.UriInfo;
import jakarta.ws.rs.ext.ExceptionMapper;
import jakarta.ws.rs.ext.Provider;

Expand Down