From d38e79bde630a88ea569a1c4aed6209f9387b059 Mon Sep 17 00:00:00 2001 From: Eric Schneider <37347760+eric-schneider@users.noreply.github.com> Date: Wed, 30 Oct 2024 05:52:17 -0700 Subject: [PATCH] docs: Update CLI page and add new environment variables page (#4311) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Update drafts * Sync CLI and env variables * More drafts * Converge CLI pages * Formalize env variables page * Remove Required column * Remove some variables * More tweaks to env * Small changes to CLI config * Add anchor links to env variables and cli options * Add cross references between cli and env options * Some qol tweaks to env variable page * Remove unused env variables * Fix double period * Fix typo --------- Co-authored-by: Ítalo Johnny --- docs/docs/Configuration/configuration-cli.md | 246 +++++++++--------- .../Configuration/environment-variables.md | 146 +++++++++++ 2 files changed, 270 insertions(+), 122 deletions(-) create mode 100644 docs/docs/Configuration/environment-variables.md diff --git a/docs/docs/Configuration/configuration-cli.md b/docs/docs/Configuration/configuration-cli.md index 770ff17fb..205604103 100644 --- a/docs/docs/Configuration/configuration-cli.md +++ b/docs/docs/Configuration/configuration-cli.md @@ -1,168 +1,170 @@ --- -title: Command Line Interface (CLI) +title: Langflow CLI sidebar_position: 2 slug: /configuration-cli --- -:::info +# Langflow CLI -This page may contain outdated information. It will be updated as soon as possible. +The Langflow command line interface (Langflow CLI) is the main interface for managing and running the Langflow server. -::: +## CLI commands -Langflow's Command Line Interface (CLI) is a powerful tool that allows you to interact with the Langflow server from the command line. The CLI provides a wide range of commands to help you shape Langflow to your needs. +The following sections describe the available CLI commands and their options, as well as their corresponding [environment variables](./environment-variables.md). -The available commands are below. Navigate to their individual sections of this page to see the parameters. - -- [langflow](/configuration-cli) -- [langflow api-key](/configuration-cli) -- [langflow copy-db](/configuration-cli) -- [langflow migration](/configuration-cli) -- [langflow run](/configuration-cli) -- [langflow superuser](/configuration-cli) - -## Overview {#c50e5530289349cf8ed7bee22ba2211a} +### langflow Running the CLI without any arguments displays a list of available options and commands. -```shell -langflow +```bash +langflow [OPTIONS] # or -langflow --help -# or -python -m langflow - +python -m langflow [OPTIONS] ``` -| Command | Description | -| ----------- | ---------------------------------------------------------------------- | -| `api-key` | Creates an API key for the default superuser if AUTO_LOGIN is enabled. | -| `copy-db` | Copy the database files to the current directory (`which langflow`). | -| `migration` | Run or test migrations. | -| `run` | Run the Langflow. | -| `superuser` | Create a superuser. | +#### Options -### Options {#8a3b5b7ed55b4774ad6d533bb337ef47} +| Option | Default | Values | Description | +|--------|------|-----------|-------------| +| `--install-completion` | *Not applicable* | *Not applicable* | Install auto-completion for the current shell. | +| `--show-completion` | *Not applicable* | *Not applicable* | Show the location of the auto-completion config file (if installed). | +| `--help` | *Not applicable* | *Not applicable* | Display information about the command usage and its options and arguments. | -| Option | Description | -| ---------------------- | -------------------------------------------------------------------------------- | -| `--install-completion` | Install completion for the current shell. | -| `--show-completion` | Show completion for the current shell, to copy it or customize the installation. | -| `--help` | Show this message and exit. | +### langflow api-key -## langflow api-key {#dbfc8c4c83474b83a38bdc7471bccf41} +Create an API key for the default superuser if the [`LANGFLOW_AUTO_LOGIN` environment variable] is set to `true`. -Run the `api-key` command to create an API key for the default superuser if `LANGFLOW_AUTO_LOGIN` is set to `True`. - -```shell -langflow api-key +```bash +langflow api-key [OPTIONS] # or -python -m langflow api-key -╭─────────────────────────────────────────────────────────────────────╮ -│ API Key Created Successfully: │ -│ │ -│ sk-O0elzoWID1izAH8RUKrnnvyyMwIzHi2Wk-uXWoNJ2Ro │ -│ │ -│ This is the only time the API key will be displayed. │ -│ Make sure to store it in a secure location. │ -│ │ -│ The API key has been copied to your clipboard. Cmd + V to paste it. │ -╰────────────────────────────── - +python -m langflow api-key [OPTIONS] ``` -### Options {#ec2ef993dc984811b25838c8d8230b31} +#### Options -| Option | Type | Description | -| ----------- | ---- | ------------------------------------------------------------- | -| --log-level | TEXT | Logging level. [env var: LANGFLOW_LOG_LEVEL] [default: error] | -| --help | | Show this message and exit. | +| Option | Default | Values | Description | +|--------|---------|--------|-------------| +| `--log-level` | `critical` | `debug`
`info`
`warning`
`error`
`critical` | Set the logging level. | +| `--help` | *Not applicable* | *Not applicable* | Display information about the command usage and its options and arguments. | -## langflow copy-db {#729a13f4847545e5973d8f9c20f8833d} +### langflow copy-db -Run the `copy-db` command to copy the cached `langflow.db` and `langflow-pre.db` database files to the current directory. +Copy the database files to the current directory. +Copy the Langflow database files, `langflow.db` and `langflow-pre.db` (if they exist), from the cache directory to the current directory. -If the files exist in the cache directory, they will be copied to the same directory as `__main__.py`, which can be found with `which langflow`. +:::note +The current directory is the directory containing `__main__.py`. +You can find this directory by running `which langflow`. +::: -### Options {#7b7e6bd02b3243218e1d666711854673} - -None. - -## langflow migration {#7027c1925a444119a7a8ea2bff4bd16d} - -Run or test migrations with the Alembic database tool. - -```shell -langflow migration +```bash +langflow copy-db # or -python -m langflow migration - +python -m langflow copy-db ``` -### Options {#0b38fbe97bb34edeb7740a7db58433e9} +#### Options -| Option | Description | -| ------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `--test, --no-test` | Run migrations in test mode. [default: test] | -| `--fix, --no-fix` | Fix migrations. This is a destructive operation, and should only be used if you know what you are doing. [default: no-fix] | -| `--help` | Show this message and exit. | +| Option | Default | Values | Description | +|--------|---------|--------|-------------| +| `--help` | *Not applicable* | *Not applicable* | Display information about the command usage and its options and arguments. | -## langflow run {#fe050aa659cb4d33a560b859d54c94ea} +### langflow migration -Run Langflow. +Run or test database migrations. -```shell -langflow run +```bash +langflow migration [OPTIONS] # or -python -m langflow run - +python -m langflow migration [OPTIONS] ``` -### Options {#4e811481ec9142f1b60309bb1ce5a2ce} +#### Options -| Option | Description | -| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `--help` | Displays all available options. | -| `--host` | Defines the host to bind the server to. Can be set using the `LANGFLOW_HOST` environment variable. The default is `127.0.0.1`. | -| `--workers` | Sets the number of worker processes. Can be set using the `LANGFLOW_WORKERS` environment variable. The default is `1`. | -| `--timeout` | Sets the worker timeout in seconds. The default is `60`. | -| `--port` | Sets the port to listen on. Can be set using the `LANGFLOW_PORT` environment variable. The default is `7860`. | -| `--env-file` | Specifies the path to the .env file containing environment variables. The default is `.env`. | -| `--log-level` | Defines the logging level. Can be set using the `LANGFLOW_LOG_LEVEL` environment variable. The default is `critical`. | -| `--components-path` | Specifies the path to the directory containing custom components. Can be set using the `LANGFLOW_COMPONENTS_PATH` environment variable. The default is `langflow/components`. | -| `--log-file` | Specifies the path to the log file. Can be set using the `LANGFLOW_LOG_FILE` environment variable. The default is `logs/langflow.log`. | -| `--cache` | Select the type of cache to use. Options are `InMemoryCache` and `SQLiteCache`. Can be set using the `LANGFLOW_LANGCHAIN_CACHE` environment variable. The default is `SQLiteCache`. | -| `--dev`/`--no-dev` | Toggles the development mode. The default is `no-dev`. | -| `--path` | Specifies the path to the frontend directory containing build files. This option is for development purposes only. Can be set using the `LANGFLOW_FRONTEND_PATH` environment variable. | -| `--open-browser`/`--no-open-browser` | Toggles the option to open the browser after starting the server. Can be set using the `LANGFLOW_OPEN_BROWSER` environment variable. The default is `open-browser`. | -| `--remove-api-keys`/`--no-remove-api-keys` | Toggles the option to remove API keys from the projects saved in the database. Can be set using the `LANGFLOW_REMOVE_API_KEYS` environment variable. The default is `no-remove-api-keys`. | -| `--install-completion [bash\|zsh\|fish\|powershell\|pwsh]` | Installs completion for the specified shell. | -| `--show-completion [bash\|zsh\|fish\|powershell\|pwsh]` | Shows completion for the specified shell, allowing you to copy it or customize the installation. | -| `--backend-only` | This parameter, with a default value of `False`, allows running only the backend server without the frontend. It can also be set using the `LANGFLOW_BACKEND_ONLY` environment variable. | -| `--store` | This parameter, with a default value of `True`, enables the store features, use `--no-store` to deactivate it. It can be configured using the `LANGFLOW_STORE` environment variable. | -| `--auto-saving` | This parameter, with a default value of `True`, enables the auto-saving functionality, use `--no-auto-saving` to deactivate it. It can be configured using the `LANGFLOW_AUTO_SAVING` environment variable. | +| Option | Default | Values | Description | +|--------|---------|--------|-------------| +| `--test` | `true` | [Boolean](#boolean) | Run migrations in test mode. Use `--no-test` to disable test mode. | +| `--fix` | `false` (`--no-fix`) | [Boolean](#boolean) | Fix migrations. This is a destructive operation, and all affected data will be deleted. Only use this option if you know what you are doing. | +| `--help` | *Not applicable* | *Not applicable* | Display information about the command usage and its options and arguments. | -### CLI environment variables {#5868aaccfcc74e26968538ef4d07e756} -You can configure many of the CLI options using environment variables. These can be exported in your operating system or added to a `.env` file and loaded using the `--env-file` option. +### langflow run -A sample `.env` file named `.env.example` is included with the project. Copy this file to a new file named `.env` and replace the example values with your actual settings. If you're setting values in both your OS and the `.env` file, the `.env` settings will take precedence. +Start the Langflow server. -## langflow superuser {#5944233ce0c942878e928e1f2945d717} - -Create a superuser for Langflow. - -```shell -langflow superuser +```bash +langflow run [OPTIONS] # or -python -m langflow superuser +python -m langflow run [OPTIONS] ``` -### Options {#f333c5635ead4c3d95985467bb08cc8f} +#### Options -| Option | Type | Description | -| ------------- | ---- | ------------------------------------------------------------- | -| `--username` | TEXT | Username for the superuser. [default: None] [required] | -| `--password` | TEXT | Password for the superuser. [default: None] [required] | -| `--log-level` | TEXT | Logging level. [env var: LANGFLOW_LOG_LEVEL] [default: error] | -| `--help` | | Show this message and exit. | +| Option | Default | Values | Description | +|--------|---------|--------|-------------| +| `--host` | `127.0.0.1` | String | The host on which the Langflow server will run.
See [`LANGFLOW_HOST` variable](./environment-variables.md#LANGFLOW_HOST). | +| `--workers` | `1` | Integer | Number of worker processes.
See [`LANGFLOW_WORKERS` variable](./environment-variables.md#LANGFLOW_WORKERS). | +| `--worker-timeout` | `300` | Integer | Worker timeout in seconds.
See [`LANGFLOW_WORKER_TIMEOUT` variable](./environment-variables.md#LANGFLOW_WORKER_TIMEOUT). | +| `--port` | `7860` | Integer | The port on which the Langflow server will run. The server automatically selects a free port if the specified port is in use.
See [`LANGFLOW_PORT` variable](./environment-variables.md#LANGFLOW_PORT). | +| `--components-path` | `langflow/components` | String | Path to the directory containing custom components.
See [`LANGFLOW_COMPONENTS_PATH` variable](./environment-variables.md#LANGFLOW_COMPONENTS_PATH). | +| `--env-file` | Not set | String | Path to the `.env` file containing environment variables.
See [Import environment variables from a .env file](./environment-variables.md#configure-variables-env-file). | +| `--log-level` | `critical` | `debug`
`info`
`warning`
`error`
`critical` | Set the logging level.
See [`LANGFLOW_LOG_LEVEL` variable](./environment-variables.md#LANGFLOW_LOG_LEVEL). | +| `--log-file` | `logs/langflow.log` | String | Set the path to the log file for Langflow.
See [`LANGFLOW_LOG_FILE` variable](./environment-variables.md#LANGFLOW_LOG_FILE). | +| `--cache` | `InMemoryCache` | `InMemoryCache`
`SQLiteCache` | Type of cache to use.
See [`LANGFLOW_LANGCHAIN_CACHE` variable](./environment-variables.md#LANGFLOW_LANGCHAIN_CACHE). | +| `--dev` | `false` (`--no-dev`) | [Boolean](#boolean) | Run Langflow in development mode (may contain bugs).
See [`LANGFLOW_DEV` variable](./environment-variables.md#LANGFLOW_DEV). | +| `--frontend-path` | `./frontend` | String | Path to the frontend directory containing build files. This is for development purposes only.
See [`LANGFLOW_FRONTEND_PATH` variable](./environment-variables.md#LANGFLOW_FRONTEND_PATH). | +| `--open-browser` | `true` | [Boolean](#boolean) | Open the system web browser on startup. Use `--no-open-browser` to disable opening the system web browser on startup.
See [`LANGFLOW_OPEN_BROWSER` variable](./environment-variables.md#LANGFLOW_OPEN_BROWSER). | +| `--remove-api-keys` | `false` (`--no-remove-api-keys`) | [Boolean](#boolean) | Remove API keys from the projects saved in the database.
See [`LANGFLOW_REMOVE_API_KEYS` variable](./environment-variables.md#LANGFLOW_REMOVE_API_KEYS). | +| `--backend-only` | `false` (`--no-backend-only`) | [Boolean](#boolean) | Only run Langflow's backend server (no frontend).
See [`LANGFLOW_BACKEND_ONLY` variable](./environment-variables.md#LANGFLOW_BACKEND_ONLY). | +| `--store` | `true` | [Boolean](#boolean) | Enable the Langflow Store features. Use `--no-store` to disable the Langflow Store features.
See [`LANGFLOW_STORE` variable](./environment-variables.md#LANGFLOW_STORE). | +| `--auto-saving` | `true` | [Boolean](#boolean) | Enable flow auto-saving. Use `--no-auto-saving` to disable flow auto-saving.
See [`LANGFLOW_AUTO_SAVING` variable](./environment-variables.md#LANGFLOW_AUTO_SAVING). | +| `--auto-saving-interval` | `1000` | Integer | Set the interval for flow auto-saving in milliseconds.
See [`LANGFLOW_AUTO_SAVING_INTERVAL` variable](./environment-variables.md#LANGFLOW_AUTO_SAVING_INTERVAL). | +| `--health-check-max-retries` | `5` | Integer | Set the maximum number of retries for the health check. Use `--no-health-check-max-retries` to disable the maximum number of retries for the health check.
See [`LANGFLOW_HEALTH_CHECK_MAX_RETRIES` variable](./environment-variables.md#LANGFLOW_HEALTH_CHECK_MAX_RETRIES). | +| `--max-file-size-upload` | `100` | Integer | Set the maximum file size for the upload in megabytes.
See [`LANGFLOW_MAX_FILE_SIZE_UPLOAD` variable](./environment-variables.md#LANGFLOW_MAX_FILE_SIZE_UPLOAD). | +| `--help` | *Not applicable* | *Not applicable* | Display information about the command usage and its options and arguments. | + +### langflow superuser + +Create a superuser account. + +```bash +langflow superuser [OPTIONS] +# or +python -m langflow superuser [OPTIONS] +``` + +#### Options + +| Option | Default | Values | Description | +|--------|---------|--------|-------------| +| `--username` | Required | String | Specify the name for the superuser.
See [`LANGFLOW_SUPERUSER` variable](./environment-variables.md#LANGFLOW_SUPERUSER). | +| `--password` | Required | String | Specify the password for the superuser.
See [`LANGFLOW_SUPERUSER_PASSWORD` variable](./environment-variables.md#LANGFLOW_SUPERUSER_PASSWORD). | +| `--log-level` | `critical` | `debug`
`info`
`warning`
`error`
`critical` | Set the logging level. | + +## Precedence + +Langflow CLI options override the values of corresponding [environment variables](./environment-variables.md). + +For example, if you have `LANGFLOW_PORT=7860` defined as an environment variable, but you run the CLI with `--port 7880`, then Langflow will set the port to **`7880`** (the value passed with the CLI). + +## Assign values + +There are two ways you can assign a value to a CLI option. +You can write the option flag and its value with a single space between them: `--option value`. +Or, you can write them using an equals sign (`=`) between the option flag and the value: `--option=value`. + +Values that contain spaces must be surrounded by quotation marks: `--option 'Value with Spaces'` or `--option='Value with Spaces'`. + +### Boolean values {#boolean} + +Boolean options turn a behavior on or off, and therefore accept no arguments. +To activate a boolean option, type it on the command line. +For example: + +```bash +langflow run --remove-api-keys +``` + +All boolean options have a corresponding option that negates it. +For example, the negating option for `--remove-api-keys` is `--no-remove-api-keys`. +These options let you negate boolean options that you may have set using [environment variables](./environment-variables.md). diff --git a/docs/docs/Configuration/environment-variables.md b/docs/docs/Configuration/environment-variables.md new file mode 100644 index 000000000..dd0087d86 --- /dev/null +++ b/docs/docs/Configuration/environment-variables.md @@ -0,0 +1,146 @@ +--- +title: Environment Variables +sidebar_position: 7 +slug: /environment-variables +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# Environment Variables + +Langflow lets you configure a number of settings using environment variables. + +## Configure environment variables + +Langflow recognizes [supported environment variables](#supported-variables) from the following sources: + +- Environment variables that you've set in your terminal. +- Environment variables that you've imported from a `.env` file using the `--env-file` option in the Langflow CLI. + +You can choose to use one source exclusively, or use both sources together. +If you choose to use both sources together, be aware that environment variables imported from a `.env` file take [precedence](#precedence) over those set in your terminal. + +### Set environment variables in your terminal {#configure-variables-terminal} + +Run the following commands to set environment variables for your current terminal session: + + + + +```bash +export VARIABLE_NAME='VALUE' +``` + + + +``` +set VARIABLE_NAME='VALUE' +``` + + + +```bash +docker run -it --rm \ + -p 7860:7860 \ + -e VARIABLE_NAME='VALUE' \ + langflowai/langflow:latest +``` + + + + +When you start Langflow, it looks for environment variables that you've set in your terminal. +If it detects a supported environment variable, then it automatically adopts the specified value, subject to [precedence rules](#precedence). + +### Import environment variables from a .env file {#configure-variables-env-file} + +1. Create a `.env` file and open it in your preferred editor. + +2. Add your environment variables to the file: + + ```plaintext title=".env" + VARIABLE_NAME='VALUE' + VARIABLE_NAME='VALUE' + ``` + + :::tip + The Langflow project includes a [`.env.example`](https://github.com/langflow-ai/langflow/blob/main/.env.example) file to help you get started. + You can copy the contents of this file into your own `.env` file and replace the example values with your own preferred settings. + ::: + +3. Save and close the file. + +4. Start Langflow using the `--env-file` option to define the path to your `.env` file: + + + + + ```bash + python -m langflow run --env-file .env + ``` + + + + ```bash + docker run -it --rm \ + -p 7860:7860 \ + --env-file .env \ + langflowai/langflow:latest + ``` + + + + +On startup, Langflow imports the environment variables from your `.env` file, as well as any that you [set in your terminal](#configure-variables-terminal), and adopts their specified values. + +## Precedence {#precedence} + +Environment variables [defined in the .env file](#configure-variables-env-file) take precedence over those [set in your terminal](#configure-variables-terminal). +That means, if you happen to set the same environment variable in both your terminal and your `.env` file, Langflow adopts the value from the the `.env` file. + +:::info[CLI precedence] +[Langflow CLI options](./configuration-cli.md) override the value of corresponding environment variables defined in the `.env` file as well as any environment variables set in your terminal. +::: + +## Supported environment variables {#supported-variables} + +The following table lists the environment variables supported by Langflow. + +| Variable | Format / Values | Default | Description | +|----------|---------------|---------|-------------| +| `DO_NOT_TRACK` | Boolean | `false` | If enabled, Langflow will not track telemetry. | +| `LANGFLOW_AUTO_LOGIN` | Boolean | `true` | Enable automatic login for Langflow. Set to `false` to disable automatic login and require the login form to log into the Langflow UI. Setting to `false` requires [`LANGFLOW_SUPERUSER`](#LANGFLOW_SUPERUSER) and [`LANGFLOW_SUPERUSER_PASSWORD`](#LANGFLOW_SUPERUSER_PASSWORD) to be set. | +| `LANGFLOW_AUTO_SAVING` | Boolean | `true` | Enable flow auto-saving.
See [`--auto-saving` option](./configuration-cli.md#run-auto-saving). | +| `LANGFLOW_AUTO_SAVING_INTERVAL` | Integer | `1000` | Set the interval for flow auto-saving in milliseconds.
See [`--auto-saving-interval` option](./configuration-cli.md#run-auto-saving-interval). | +| `LANGFLOW_BACKEND_ONLY` | Boolean | `false` | Only run Langflow's backend server (no frontend).
See [`--backend-only` option](./configuration-cli.md#run-backend-only). | +| `LANGFLOW_CACHE_TYPE` | `async`
`redis`
`memory`
`disk`
`critical` | `async` | Set the cache type for Langflow.
If you set the type to `redis`, then you must also set the following environment variables: [`LANGFLOW_REDIS_HOST`](#LANGFLOW_REDIS_HOST), [`LANGFLOW_REDIS_PORT`](#LANGFLOW_REDIS_PORT), [`LANGFLOW_REDIS_DB`](#LANGFLOW_REDIS_DB), and [`LANGFLOW_REDIS_CACHE_EXPIRE`](#LANGFLOW_REDIS_CACHE_EXPIRE). | +| `LANGFLOW_COMPONENTS_PATH` | String | `langflow/components` | Path to the directory containing custom components.
See [`--components-path` option](./configuration-cli.md#run-components-path). | +| `LANGFLOW_CONFIG_DIR` | String | | Set the Langflow configuration directory where files, logs, and the Langflow database are stored. | +| `LANGFLOW_DATABASE_URL` | String | | Set the database URL for Langflow. If you don't provide one, Langflow uses an SQLite database. | +| `LANGFLOW_DEV` | Boolean | `false` | Run Langflow in development mode (may contain bugs).
See [`--dev` option](./configuration-cli.md#run-dev). | +| `LANGFLOW_FALLBACK_TO_ENV_VAR` | Boolean | `true` | If enabled, [global variables](../Settings/settings-global-variables.md) set in the Langflow UI fall back to an environment variable with the same name when Langflow fails to retrieve the variable value. | +| `LANGFLOW_FRONTEND_PATH` | String | `./frontend` | Path to the frontend directory containing build files. This is for development purposes only.
See [`--frontend-path` option](./configuration-cli.md#run-frontend-path). | +| `LANGFLOW_HEALTH_CHECK_MAX_RETRIES` | Integer | `5` | Set the maximum number of retries for the health check.
See [`--health-check-max-retries` option](./configuration-cli.md#run-health-check-max-retries). | +| `LANGFLOW_HOST` | String | `127.0.0.1` | The host on which the Langflow server will run.
See [`--host` option](./configuration-cli.md#run-host). | +| `LANGFLOW_LANGCHAIN_CACHE` | `InMemoryCache`
`SQLiteCache` | `InMemoryCache` | Type of cache to use.
See [`--cache` option](./configuration-cli.md#run-cache). | +| `LANGFLOW_LOG_FILE` | String | `logs/langflow.log` | Set the path to the log file for Langflow.
See [`--log-file` option](./configuration-cli.md#run-log-file). | +| `LANGFLOW_LOG_LEVEL` | `debug`
`info`
`warning`
`error`
`critical` | `critical` | Set the logging level.
See [`--log-level` option](./configuration-cli.md#run-log-level). | +| `LANGFLOW_MAX_FILE_SIZE_UPLOAD` | Integer | `100` | Set the maximum file size for the upload in megabytes.
See [`--max-file-size-upload` option](./configuration-cli.md#run-max-file-size-upload). | +| `LANGFLOW_OPEN_BROWSER` | Boolean | `true` | Open the system web browser on startup.
See [`--open-browser` option](./configuration-cli.md#run-open-browser). | +| `LANGFLOW_PORT` | Integer | `7860` | The port on which the Langflow server will run. The server automatically selects a free port if the specified port is in use.
See [`--port` option](./configuration-cli.md#run-port). | +| `LANGFLOW_PROMETHEUS_ENABLED` | Boolean | `false` | Expose Prometheus metrics. | +| `LANGFLOW_PROMETHEUS_PORT` | Integer | `9090` | Set the port on which Langflow exposes Prometheus metrics. | +| `LANGFLOW_REDIS_CACHE_EXPIRE` | Integer | `3600` | See [`LANGFLOW_CACHE_TYPE`](#LANGFLOW_CACHE_TYPE). | +| `LANGFLOW_REDIS_DB` | Integer | `0` | See [`LANGFLOW_CACHE_TYPE`](#LANGFLOW_CACHE_TYPE). | +| `LANGFLOW_REDIS_HOST` | String | `localhost` | See [`LANGFLOW_CACHE_TYPE`](#LANGFLOW_CACHE_TYPE). | +| `LANGFLOW_REDIS_PORT` | String | `6379` | See [`LANGFLOW_CACHE_TYPE`](#LANGFLOW_CACHE_TYPE). | +| `LANGFLOW_REMOVE_API_KEYS` | Boolean | `false` | Remove API keys from the projects saved in the database.
See [`--remove-api-keys` option](./configuration-cli.md#run-remove-api-keys). | +| `LANGFLOW_SAVE_DB_IN_CONFIG_DIR` | Boolean | `false` | Save the Langflow database in [`LANGFLOW_CONFIG_DIR`](#LANGFLOW_CONFIG_DIR) instead of in the Langflow package directory. Note, when this variable is set to default (`false`), the database isn't shared between different virtual environments and the database is deleted when you uninstall Langflow. | +| `LANGFLOW_STORE` | Boolean | `true` | Enable the Langflow Store.
See [`--store` option](./configuration-cli.md#run-store). | +| `LANGFLOW_STORE_ENVIRONMENT_VARIABLES` | Boolean | `true` | Store environment variables as [global variables](../Settings/settings-global-variables.md) in the database. | +| `LANGFLOW_SUPERUSER` | String | Not set | Set the name for the superuser. Required if [`LANGFLOW_AUTO_LOGIN`](#LANGFLOW_AUTO_LOGIN) is set to `false`.
See [`superuser --username` option](./configuration-cli.md#superuser-username). | +| `LANGFLOW_SUPERUSER_PASSWORD` | String | Not set | Set the password for the superuser. Required if [`LANGFLOW_AUTO_LOGIN`](#LANGFLOW_AUTO_LOGIN) is set to `false`.
See [`superuser --password` option](./configuration-cli.md#superuser-password).| +| `LANGFLOW_VARIABLES_TO_GET_FROM_ENVIRONMENT` | String | Not set | Comma-separated list of environment variables to get from the environment and store as [global variables](../Settings/settings-global-variables.md). | +| `LANGFLOW_WORKER_TIMEOUT` | Integer | `300` | Worker timeout in seconds.
See [`--worker-timeout` option](./configuration-cli.md#run-worker-timeout). | +| `LANGFLOW_WORKERS` | Integer | `1` | Number of worker processes.
See [`--workers` option](./configuration-cli.md#run-workers). |