Skip to content

Refactors Docker Compose and updates deployment guides#97

Merged
fboucher merged 2 commits intov-nextfrom
docs-update-keycloak
Mar 9, 2026
Merged

Refactors Docker Compose and updates deployment guides#97
fboucher merged 2 commits intov-nextfrom
docs-update-keycloak

Conversation

@fboucher
Copy link
Owner

@fboucher fboucher commented Mar 8, 2026

Decomposes the Docker Compose setup into separate files for improved modularity and clarity:

  • Splits services: Separates the Keycloak and its PostgreSQL database configuration into keycloak-compose.yaml, distinct from the NoteBookmark application services (API and Blazor app) now defined in note-compose.yaml. This allows for independent management of the authentication infrastructure.
  • Enhances documentation: Introduces keycloak-container-setup.md to guide users through deploying a Keycloak container stack. It also refines keycloak-setup.md to focus exclusively on Keycloak realm and client configuration for NoteBookmark.
  • Streamlines app deployment: Rewrites docker-compose-deployment.md to provide a clearer, more concise process for deploying the NoteBookmark application, assuming Keycloak is already set up and configured.
  • Updates environment configuration: Modifies .env-sample to reflect the new Keycloak and PostgreSQL environment variables and includes a placeholder for the Reka AI API key.
  • Removes outdated files: Deletes the monolithic docker-compose.yaml and the build-and-push.ps1 script, streamlining the project's container orchestration assets.
  • Clarifies README: Updates README.md to highlight different run options (Aspire vs. containers) and directs users to the revised documentation for detailed setup.

fboucher added 2 commits March 8, 2026 14:34
Reorganizes the Docker Compose configuration into modular stacks for Keycloak and the application. This change updates the environment variable templates and provides new, detailed documentation for local container setup and realm configuration.
@github-actions
Copy link

github-actions bot commented Mar 8, 2026

Code Coverage

Package Line Rate Branch Rate Health
NoteBookmark.Domain 5% 9%
NoteBookmark.AIServices 97% 64%
NoteBookmark.Domain 83% 72%
NoteBookmark.ServiceDefaults 96% 75%
NoteBookmark.Api 81% 64%
NoteBookmark.Domain 83% 72%
NoteBookmark.ServiceDefaults 96% 75%
NoteBookmark.Api 81% 64%
NoteBookmark.Domain 5% 9%
NoteBookmark.AIServices 97% 64%
Summary 60% (1492 / 2178) 43% (310 / 568)

@fboucher fboucher merged commit 7100ad7 into v-next Mar 9, 2026
2 checks passed
@fboucher fboucher deleted the docs-update-keycloak branch March 9, 2026 11:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant