Skip to content

feat: add customizable signups disabled text for all authentication methods #18887

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

blink-so[bot]
Copy link
Contributor

@blink-so blink-so bot commented Jul 15, 2025

This PR adds a general --signups-disabled-text configuration option that allows administrators to customize the message shown when signups are disabled, regardless of the authentication method used.

Changes

  • Add general SignupsDisabledText configuration: New field in DeploymentValues struct with CLI flag --signups-disabled-text and environment variable CODER_SIGNUPS_DISABLED_TEXT
  • Enhanced userauth logic: Updated to use general text with OIDC fallback for backward compatibility
  • New deployment group: Added "User Authentication" group for general auth settings
  • Markdown support: Custom text supports Markdown formatting for rich content

Benefits

  • Universal coverage: Works with all authentication methods, not just OIDC
  • Better user guidance: Administrators can provide specific instructions for their organization
  • Backward compatible: Existing OIDC-specific configurations continue to work
  • Flexible formatting: Markdown support allows for rich text with links and formatting

Usage

# Set custom signup disabled message
coder server --signups-disabled-text "Please contact IT at help@company.com to request access to Coder."

# Or via environment variable
export CODER_SIGNUPS_DISABLED_TEXT="Visit [our portal](https://portal.company.com) to request access."

The general setting takes precedence over the OIDC-specific setting, ensuring consistent messaging across all authentication methods while maintaining backward compatibility.

Tested: Code compiles successfully and maintains existing functionality.

blink-so bot and others added 10 commits July 15, 2025 19:11
…ethods

This change adds a general --signups-disabled-text configuration option
that allows administrators to customize the message shown when signups
are disabled, regardless of the authentication method used.

Changes:
- Add SignupsDisabledText field to DeploymentValues struct
- Add --signups-disabled-text CLI flag and CODER_SIGNUPS_DISABLED_TEXT env var
- Update userauth logic to use general text with OIDC fallback for backward compatibility
- Add new User Authentication deployment group for general auth settings
- Support Markdown formatting in the custom text

This enhances the existing OIDC-specific signups disabled text to work
with all authentication methods, providing better flexibility for
administrators to inform users about signup policies.

Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
- Update CLI documentation with new --signups-disabled-text flag
- Add USER AUTHENTICATION section to enterprise help golden file
- Update TypeScript types with signups_disabled_text field

Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
Remove extra blank lines and ensure files end with exactly one newline

Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
Add blank lines after titles and before sections to match linter expectations

Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
Add missing blank lines after '## Usage' sections in CLI documentation
files to match the expected formatting from make gen.

Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
Run CLI documentation generation using the project's clidocgen tool
to ensure proper formatting and structure that matches CI expectations.

Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
Run clidocgen followed by markdownlint-cli2 and markdown-table-formatter
to match the exact formatting that CI expects.

Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
Format docs/manifest.json with biome and include the generated
documentation for the new --signups-disabled-text CLI flag.

Co-authored-by: kylecarbs <7122116+kylecarbs@users.noreply.github.com>
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.

0 participants