Skip to content
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

feat: hide all API keys by default in admin settings #3418

Merged
merged 2 commits into from
Jun 25, 2024

Conversation

cheahjs
Copy link
Contributor

@cheahjs cheahjs commented Jun 25, 2024

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions and describe your changes before submitting a pull request.

Before submitting, make sure you've checked the following:

  • Target branch: Please verify that the pull request targets the dev branch.
  • Description: Provide a concise description of the changes made in this pull request.
  • Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
  • Documentation: Have you updated relevant documentation Open WebUI Docs, or other documentation sources?
  • Dependencies: Are there any new dependencies? Have you updated the dependency versions in the documentation?
  • Testing: Have you written and run sufficient tests for validating the changes?
  • Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
  • Prefix: To cleary categorize this pull request, prefix the pull request title, using one of the following:
    • BREAKING CHANGE: Significant changes that may affect compatibility
    • build: Changes that affect the build system or external dependencies
    • ci: Changes to our continuous integration processes or workflows
    • chore: Refactor, cleanup, or other non-functional code changes
    • docs: Documentation update or addition
    • feat: Introduces a new feature or enhancement to the codebase
    • fix: Bug fix or error correction
    • i18n: Internationalization or localization changes
    • perf: Performance improvement
    • refactor: Code restructuring for better maintainability, readability, or scalability
    • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc.)
    • test: Adding missing tests or correcting existing tests
    • WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

Hide all API keys in Admin Settings by default by setting the input type to password, and provide a button to unhide the keys.

One side effect that might require some hacks to solve is that Chrome will ask to save the API keys as passwords due to type=password. It's probably worth making a ToggleableSensitiveInput component that can be reused.

The {...{ type: showSTTKey ? 'text' : 'password' }} construction is used because Svelte disallows the use of a bind:value and a dynamic type.

Changed

  • API keys in Admin Settings are hidden by default.

Screenshots or Videos

image

@tjbck
Copy link
Contributor

tjbck commented Jun 25, 2024

LGTM, Thanks!

@tjbck tjbck merged commit 3750e69 into open-webui:dev Jun 25, 2024
3 of 5 checks passed
@silentoplayz
Copy link
Collaborator

silentoplayz commented Jun 25, 2024

Thanks! This is a great addition!

One side effect that might require some hacks to solve is that Chrome will ask to save the API keys as passwords due to type=password. It's probably worth making a ToggleableSensitiveInput component that can be reused.

I will note that I am also asked to save the API keys as passwords when un-hiding any of the hidden API keys on FireFox v127.0.2 (64-bit).

@justinh-rahb
Copy link
Collaborator

One side effect that might require some hacks to solve is that Chrome will ask to save the API keys as passwords due to type=password. It's probably worth making a ToggleableSensitiveInput component that can be reused.

Hmm 🤔 that gives me the ick.

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.

None yet

4 participants