From afa66112e1aea4b2bbae7a687817e65eb2d7e3c4 Mon Sep 17 00:00:00 2001 From: Gabriel Luiz Freitas Almeida Date: Tue, 26 Sep 2023 10:21:59 -0300 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20docs(login.mdx):=20add=20documen?= =?UTF-8?q?tation=20for=20login=20functionality=20in=20Langflow?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The login functionality in Langflow serves to authenticate users and protect sensitive routes in the application. This commit adds documentation for the login functionality, including information about the enhanced login mechanism introduced in version 0.5. It explains the environment variables that are crucial in configuring the login settings and provides instructions on how to set them securely. It also covers the command-line interface for managing superusers and provides details on the sign-up process and profile settings for users. Screenshots are included to illustrate the sign-up page, profile settings page, and admin page. --- docs/docs/{guides => guidelines}/login.mdx | 6 ++++++ 1 file changed, 6 insertions(+) rename docs/docs/{guides => guidelines}/login.mdx (96%) diff --git a/docs/docs/guides/login.mdx b/docs/docs/guidelines/login.mdx similarity index 96% rename from docs/docs/guides/login.mdx rename to docs/docs/guidelines/login.mdx index a2d7c5502..85ca1371f 100644 --- a/docs/docs/guides/login.mdx +++ b/docs/docs/guidelines/login.mdx @@ -20,6 +20,12 @@ The following environment variables are crucial in configuring the login setting - _`LANGFLOW_SECRET_KEY`_: A key used for encrypting the superuser's password. - _`LANGFLOW_NEW_USER_IS_ACTIVE`_: Determines whether new users are automatically activated. Default is `False`. +All of these variables can be passed to the CLI command _`langflow run`_ through the _`--env-file`_ option. For example: + +```bash +langflow run --env-file .env +``` + It is critical not to expose these environment variables in your code repository. Always set them securely in your deployment environment, for