Skip to content

Add comprehensive Keycloak integration documentation#210

Merged
micbar merged 2 commits intoopencloud-eu:mainfrom
michaelstingl:add-keycloak-documentation
Apr 9, 2025
Merged

Add comprehensive Keycloak integration documentation#210
micbar merged 2 commits intoopencloud-eu:mainfrom
michaelstingl:add-keycloak-documentation

Conversation

@michaelstingl
Copy link
Copy Markdown
Contributor

@michaelstingl michaelstingl commented Apr 6, 2025

This PR adds detailed documentation for the Keycloak integration with OpenCloud, replacing the empty draft page with comprehensive content.

Content added:

  • Overview of OpenCloud's authentication strategy
  • Step-by-step setup instructions with Docker Compose
  • OpenCloud configuration guide
  • Detailed client configuration for all client types:
    • Web client
    • Desktop client
    • Mobile apps (Android/iOS)
    • Additional clients (Cyberduck)
  • Advanced configuration (Backchannel Logout)
  • Troubleshooting advice
  • User and group management overview

Related Issues and PRs

Copilot AI review requested due to automatic review settings April 6, 2025 17:05
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

docs/admin/30-configuration/30-keycloak.md:3

  • [nitpick] If the page is intended for publication, consider explicitly setting 'draft: false' in the YAML header for improved clarity and consistency with published documentation.
id: keycloak

Comment thread docs/admin/30-configuration/30-keycloak.md Outdated
@michaelstingl
Copy link
Copy Markdown
Contributor Author

Thank you @micbar for pointing this out! You're absolutely right about simplifying the Docker Compose command.

I've implemented the suggested change and added explanatory notes about how this "magic mechanism" works with the COMPOSE_FILE variable in the .env file. The changes are now included in the latest commit.

Thanks for the improvement! 👍

@micbar
Copy link
Copy Markdown
Member

micbar commented Apr 9, 2025

@michaelstingl happy to help!

@rhafer seems that @michaelstingl has already contributed the first version for the idp docs.

@micbar
Copy link
Copy Markdown
Member

micbar commented Apr 9, 2025

@michaelstingl please rebase to get a green CI run.

This adds detailed documentation for Keycloak integration with OpenCloud, including:
- Setup with Docker Compose
- OpenCloud configuration
- Client configuration details (matching built-in IdP)
- Advanced configuration (Backchannel Logout)
- Troubleshooting advice
- User and group management overview

Relates to opencloud-eu/opencloud#589
@michaelstingl michaelstingl force-pushed the add-keycloak-documentation branch from a52541f to 97138cc Compare April 9, 2025 19:10
@michaelstingl
Copy link
Copy Markdown
Contributor Author

Rebased onto current main branch. All requested changes have been implemented.

@micbar micbar merged commit 7f4e543 into opencloud-eu:main Apr 9, 2025
1 check passed
@openclouders openclouders mentioned this pull request Apr 9, 2025
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants