Skip to content

Commit

Permalink
docs: add section with variable global precautions
Browse files Browse the repository at this point in the history
  • Loading branch information
italojohnny committed Aug 12, 2024
1 parent ebc2e7d commit 798a7dc
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions docs/docs/Settings/settings-global-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,3 +111,52 @@ The default list of variables includes the ones below and more:

<ReactPlayer controls url="https://youtu.be/RedPOCsYNAM" />


### Precautions

Global variables are stored in the database, and their values are protected by encryption using a secret
key. To preserve access to your global variables and avoid losing them, you should take a few precautions:

1. Consider using a more robust database, such as PostgreSQL: If this isn't an option or if you're unsure
how to set it up, make it a habit to regularly back up your SQLite database file. Additionally, you might
choose to change the database location by setting the LANGFLOW_SAVE_DB_IN_CONFIG_DIR environment variable
to true and configuring LANGFLOW_CONFIG_DIR to point to a directory of your choice.

2. Keep your secret key safe: Even if your database is secure, it won’t be of much use if you can't decrypt
the values. Ideally, you can set your own secret key using the LANGFLOW_SECRET_KEY environment variable. If
you don't provide a custom value for the secret key, one will be generated randomly and saved in the Langflow
installation directory.

For your convenience, if you’re running Langflow directly on your system or in a virtual environment
via a pip installation, you can set these values by providing Langflow with a .env file containing these
environment variables, using the following command:

```bash
langflow run --env-file .env
```

If you’re running Langflow in a Docker container, you can set these values by providing Langflow with:

```bash
docker run \
--privileged \
--user 1000:0 \
-p 7860:7860 \
-e LANGFLOW_SECRET_KEY=<YOUR_SECRET_KEY_VALUE> \
-e LANGFLOW_SAVE_DB_IN_CONFIG_DIR=true \
-e LANGFLOW_CONFIG_DIR=/app/container_path \
-v $(PWD)/your_path:/app/container_path \
langflowai/langflow:latest
```

or

```bash
docker run \
--privileged \
--user 1000:0 \
-p 7860:7860 \
--env-file .env \
-v $(PWD)/your_path:/app/container_path \
langflowai/langflow:latest
```

0 comments on commit 798a7dc

Please sign in to comment.