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.

Sign up for GitHub

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

Jump to bottom

docs: update API and authentication pages #7271

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

docs: update API and authentication pages #7271

wants to merge 8 commits into from

Conversation

mendonk
Copy link
Collaborator

@mendonk mendonk commented Mar 25, 2025 •
edited
Loading

Test and update API and authentication docs.
Add a guide for starting a Langflow server with auth and secret key enabled.
Clarify API usage and global variable/env/component precedence.

API Key Management:

Draft build

  • Added sections for generating Langflow API keys, including steps for using them in HTTP headers and query parameters. Removed outdated Python code examples and added instructions for adding component API keys via the .env file or Langflow UI.

Authentication Configuration:

Draft build

  • Updated the guide to cover Langflow's authentication system and API key management, including detailed instructions for configuring environment variables like LANGFLOW_AUTO_LOGIN, LANGFLOW_SUPERUSER, and LANGFLOW_SECRET_KEY.
  • Added steps for generating and using a LANGFLOW_SECRET_KEY and managing users as an administrator. [
  • Added a guide for creating a Langflow server with auth and secret key enabled.

@mendonk mendonk self-assigned this Mar 25, 2025
@dosubot dosubot bot added the size:L This PR changes 100-499 lines, ignoring generated files. label Mar 25, 2025
@mendonk mendonk requested a review from msmygit March 25, 2025 17:04
@dosubot dosubot bot added the documentation Improvements or additions to documentation label Mar 25, 2025
@mendonk mendonk requested a review from ogabrielluiz March 25, 2025 17:04
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 25, 2025
@mendonk mendonk mentioned this pull request Mar 25, 2025
Closed
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 25, 2025 •
edited
Loading

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 25, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 25, 2025 •
edited
Loading

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

msmygit
msmygit approved these changes Mar 25, 2025
View reviewed changes
Copy link
Collaborator

@msmygit msmygit left a comment

Choose a reason for hiding this comment

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

Content LGTM on draft site. 👍🏼

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Mar 25, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Mar 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@msmygit msmygit msmygit approved these changes

@ogabrielluiz ogabrielluiz Awaiting requested review from ogabrielluiz

Assignees

@mendonk mendonk

Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mendonk @msmygit