Skip to content

Conversation

jpshackelford
Copy link

@jpshackelford jpshackelford commented Sep 23, 2025

Add Self-Registration Design Document

Summary

This PR adds a design document for implementing a self-registration feature in OpenHands Enterprise. The feature addresses friction experienced by enterprise customers during POC evaluations by allowing users to create accounts without requiring pre-configured SSO integration.

Problem Statement

Some enterprise customers experience friction when setting up OpenHands for proof-of-concept (POC) evaluations due to the requirement for IT partner engagement to configure corporate Single Sign-On (SSO) integration. This can delay POC timelines and create unnecessary overhead for temporary evaluation environments.

Proposed Solution

Implement a self-registration feature that allows users to create accounts and access OpenHands without requiring pre-configured SSO integration. The solution will:

  • Enable immediate access: Users can register and start using OpenHands without any additional administrative process
  • Maintain security: Leverage Keycloak's built-in user management and email verification
  • Be configurable: Controlled by a Helm chart configuration flag (ENTERPRISE_SELF_REGISTRATION)

Key Features

  • Self-registration flow through Keycloak UI
  • Email verification for account activation
  • Configurable via Helm chart settings

Design Doc

  • enterprise/doc/design-doc/self-registration.md - view

Next Steps

Open PRs in OpenHands & OpenHands-Cloud for the various pieces:

OpenHands Repository PR

Title: feat: implement self-registration UI and backend integration

  • Frontend UI modifications to add self-registration button and flow (see design doc section 3.1)
  • Backend API updates to handle self-registered users (see design doc section 4.2)
  • Keycloak client configuration updates (see design doc section 4.3)
  • Authentication flow modifications (see design doc section 3.2)
  • User management integration and role assignment (see design doc section 4.4)
  • Documentation updates and testing

OpenHands-Cloud Repository PR

Title: feat: add self-registration Helm chart configuration

  • Helm chart configuration for ENTERPRISE_SELF_REGISTRATION flag (see design doc section 4.1)
  • Keycloak configuration templates for self-registration (see design doc section 4.3.1)
  • Email verification configuration (see design doc section 4.3.3)
  • Client redirect URL configuration (see design doc section 4.3.2)
  • Environment-specific deployment settings and documentation

Copy link

openhands-ai bot commented Sep 23, 2025

Looks like there are a few issues preventing this PR from being merged!

  • GitHub Actions are failing:
    • Lint

If you'd like me to help, just leave a comment, like

@OpenHands please fix the failing actions on PR #11077 at branch `jps/self-registration`

Feel free to include any additional details that might help me get this PR into a better state.

You can manage your notification settings

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