Feature/keycloak OIDC

[igorcampos-dev]

Summary by CodeRabbit

• New Features

  • Added OpenID Connect (OIDC) authentication via Keycloak, including new security configuration and endpoints for public and secured pages.
  • Introduced OAuth2 client support and OIDC-specific application configuration.
  • Added a PostgreSQL database service for Keycloak integration.

• Improvements

  • Updated Docker and Compose configurations to support supervisor-managed containers running both Nginx and the Spring app, and to enable OIDC integration.
  • Enhanced documentation with OIDC setup instructions, user credentials, and related resources.

• Bug Fixes

  • Explicitly set application server port and improved configuration clarity.

• Chores

  • Removed obsolete development configuration files.

[coderabbitai]

Walkthrough

This update introduces OpenID Connect (OIDC) authentication via Keycloak to the Spring Boot example. It adds new security and controller classes for OIDC and default profiles, updates the Docker and Compose setup to run Keycloak with a PostgreSQL backend, and incorporates Nginx and Supervisor for process management. Documentation and configuration files are revised to reflect these changes.

Changes

Cohort / File(s)	Change Summary
Dockerfile, Compose, Multi-process Setup spring-keycloak-example/Dockerfile, spring-keycloak-example/compose.yaml, spring-keycloak-example/docker/nginx/nginx.conf, spring-keycloak-example/docker/nginx/supervisord.conf	Dockerfile restructured to run both Nginx and the Spring app under Supervisor; Nginx and Supervisor installed; ports and entrypoint updated. Compose file enhanced: app uses OIDC, Keycloak uses PostgreSQL, new health checks, new keycloak-database service, and custom Docker network. New Nginx and Supervisor configs added.
OIDC Security and Controllers spring-keycloak-example/src/main/java/com/io/example/config/OIDCSecurityConfig.java, spring-keycloak-example/src/main/java/com/io/example/controller/OIDCHomeController.java	New OIDC-specific security config and controller: /public is open, /secured requires OIDC authentication and greets the user. Active under "OIDC" profile.
Default Security and Controller spring-keycloak-example/src/main/java/com/io/example/config/DefaultSecurityConfig.java, spring-keycloak-example/src/main/java/com/io/example/controller/DefaultHomeController.java	New default profile security config and controller: all endpoints open, /public endpoint returns static message. Active under "default" profile.
Spring Boot Configuration spring-keycloak-example/src/main/resources/application-OIDC.yml, spring-keycloak-example/src/main/resources/application.yml, spring-keycloak-example/src/main/resources/application-dev.yml	Added OIDC-specific application YAML with Keycloak OAuth2 client settings. Default config updated for port and app name. Dev config removed.
Documentation spring-keycloak-example/README.md	Updated with OIDC setup details, user credentials, protected routes, and related resources. Table formatting adjusted.
Maven Dependencies spring-keycloak-example/pom.xml	Added spring-boot-starter-oauth2-client dependency for OIDC support.
Keycloak Dockerfile spring-keycloak-example/Dockerfile.keycloak	Added a blank line after WORKDIR, no functional changes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~18 minutes

Complexity rationale:
The review involves several new Java classes, security configurations, multi-process Docker and Compose changes, new configuration files, and documentation updates. While each change is conceptually straightforward, the integration of OIDC, Keycloak with PostgreSQL, and multi-process container management increases the review scope beyond a simple update.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Free

📥 Commits

Reviewing files that changed from the base of the PR and between 643dbb3 and 46ce8b6.

📒 Files selected for processing (14)

• spring-keycloak-example/Dockerfile (1 hunks)
• spring-keycloak-example/Dockerfile.keycloak (1 hunks)
• spring-keycloak-example/README.md (1 hunks)
• spring-keycloak-example/compose.yaml (3 hunks)
• spring-keycloak-example/docker/nginx/nginx.conf (1 hunks)
• spring-keycloak-example/docker/nginx/supervisord.conf (1 hunks)
• spring-keycloak-example/pom.xml (1 hunks)
• spring-keycloak-example/src/main/java/com/io/example/config/DefaultSecurityConfig.java (1 hunks)
• spring-keycloak-example/src/main/java/com/io/example/config/OIDCSecurityConfig.java (1 hunks)
• spring-keycloak-example/src/main/java/com/io/example/controller/DefaultHomeController.java (1 hunks)
• spring-keycloak-example/src/main/java/com/io/example/controller/OIDCHomeController.java (1 hunks)
• spring-keycloak-example/src/main/resources/application-OIDC.yml (1 hunks)
• spring-keycloak-example/src/main/resources/application-dev.yml (0 hunks)
• spring-keycloak-example/src/main/resources/application.yml (1 hunks)

💤 Files with no reviewable changes (1)

• spring-keycloak-example/src/main/resources/application-dev.yml

---

Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Join our Discord community for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.