Add instructions for setting up local Keycloak instance#31
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR adds detailed instructions for setting up a local Keycloak instance to support SSO login.
- Introduces a new section in the developer documentation outlining steps for running Keycloak via Docker.
- Provides detailed configuration steps for the realm, client, user, token mapping, and required environment variable setup for both front-end and back-end.
docs/backend/for_developers.md
Outdated
Comment on lines
225
to
226
| **Notice that `localhost` and `127.0.0.1` is NOT interchangeable, use the same URL when you navigate to your app in the browser** | ||
|
|
There was a problem hiding this comment.
Consider changing 'is' to 'are' to improve grammatical accuracy ('localhost and 127.0.0.1 are NOT interchangeable').
Suggested change
| **Notice that `localhost` and `127.0.0.1` is NOT interchangeable, use the same URL when you navigate to your app in the browser** | |
| **Notice that `localhost` and `127.0.0.1` are NOT interchangeable, use the same URL when you navigate to your app in the browser** |
There was a problem hiding this comment.
Pull Request Overview
This PR adds detailed instructions for setting up a local Keycloak instance to support SSO login and makes a minor configuration update in the project file.
- Added a new section in the developer documentation outlining steps to set up and configure a local Keycloak instance using Docker.
- Updated the pyproject.toml file by adding a new configuration flag.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pyproject.toml | Added a new configuration flag (package-mode) to the project configuration. |
| docs/backend/for_developers.md | Added comprehensive instructions for setting up a local Keycloak instance for SSO support. |
Comments suppressed due to low confidence (1)
pyproject.toml:5
- [nitpick] Please confirm that 'package-mode' is the intended configuration property name and adheres to the project naming conventions, as some systems might expect an underscore (e.g., package_mode).
package-mode = false
grzanka
approved these changes
Mar 31, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request includes significant updates to the
docs/backend/for_developers.mdfile to add instructions for setting up Keycloak for SSO login, and a small change to thepyproject.tomlfile to add a new configuration option.Documentation updates:
docs/backend/for_developers.md: Added detailed instructions for setting up Keycloak, configuring the realm, client, and user, and setting environment variables for both front-end and back-end.Configuration updates:
pyproject.toml: Added a new configuration optionpackage-modeset tofalse.