jyapayne/langflow
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: refresh external postgresql database page (#9174)

Browse source 
* coming-back

* refresh-postgresql-page

* add-why

* Apply suggestions from code review

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>

* clarify-example-yml

---------

Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
This commit is contained in:
Mendon Kissling 2025-07-25 09:24:21 -04:00 • committed by GitHub
commit fe1e45ce2a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 98 additions and 115 deletions
Download patch file Download diff file Expand all files Collapse all files

213
docs/docs/Configuration/configuration-custom-database.mdx
View file

@ -4,25 +4,31 @@ slug: /configuration-custom-database
--- ---
Langflow's default database is [SQLite](https://www.sqlite.org/docs.html), but you can configure Langflow to use PostgreSQL instead. Langflow's default database is [SQLite](https://www.sqlite.org/docs.html), but you can configure Langflow to use PostgreSQL instead.
This guide walks you through setting up an external database for Langflow by replacing the default SQLite connection string `sqlite:///./langflow.db` with PostgreSQL. This guide walks you through setting up an external database for Langflow by replacing the default SQLite connection string `sqlite:///./langflow.db` with PostgreSQL, both in local and containerized environments.
## Prerequisite In this configuration, all structured application data from Langflow, including flows, message history, and logs, is instead managed by PostgreSQL.
PostgreSQL is better suited for production environments due to its robust support for concurrent users, advanced data integrity features, and scalability.
Langflow can more efficiently handle multiple users and larger workloads by using PostgreSQL as the database.
* A [PostgreSQL](https://www.pgadmin.org/download/) database ## Prerequisites
## Connect Langflow to PostgreSQL - [Install and start Langflow](/get-started-installation)
- Create a [PostgreSQL](https://www.pgadmin.org/download/) database
1. If Langflow is running, quit Langflow. ## Connect Langflow to a local PostgreSQL database
1. If Langflow is running, stop Langflow with <kbd>Ctrl+C</kbd>.
2. Find your PostgreSQL database's connection string in the format `postgresql://user:password@host:port/dbname`. 2. Find your PostgreSQL database's connection string in the format `postgresql://user:password@host:port/dbname`.
The hostname in your connection string depends on how you're running PostgreSQL: The hostname in your connection string depends on how you're running PostgreSQL:
- If you're running PostgreSQL directly on your machine, use `localhost`. - If you're running PostgreSQL directly on your machine, use `localhost`.
- If you're running PostgreSQL in Docker Compose, use the service name, such as `postgres`. - If you're running PostgreSQL in Docker Compose, use the service name, such as `postgres`.
- If you're running PostgreSQL in a separate Docker container with `docker run`, use the container's IP address or network alias. - If you're running PostgreSQL in a separate Docker container with `docker run`, use the container's IP address or network alias.
- If you're running a cloud-hosted PostgreSQL, your provider will share your connection string, which includes a username and password.
3. Create a Langflow `.env` file if you don't already have one: 3. Create a Langflow `.env` file:
``` ```
touch .env touch .env
@ -30,7 +36,7 @@ This guide walks you through setting up an external database for Langflow by rep
You can use the [`.env.example`](https://github.com/langflow-ai/langflow/blob/main/.env.example) file in the Langflow repository as a template for your own `.env` file. You can use the [`.env.example`](https://github.com/langflow-ai/langflow/blob/main/.env.example) file in the Langflow repository as a template for your own `.env` file.
4. In your `.env` file, set `LANGFLOW_DATABASE_URL` to your your PostgreSQL connection string: 4. In your `.env` file, set `LANGFLOW_DATABASE_URL` to your PostgreSQL connection string:
```text ```text
LANGFLOW_DATABASE_URL="postgresql://user:password@localhost:5432/dbname" LANGFLOW_DATABASE_URL="postgresql://user:password@localhost:5432/dbname"
@ -44,134 +50,111 @@ This guide walks you through setting up an external database for Langflow by rep
6. In Langflow, run any flow to create traffic. 6. In Langflow, run any flow to create traffic.
7. Inspect your PostgreSQL deployment's tables and activity to verify that new tables and traffic were created after you ran a flow. 7. Inspect your PostgreSQL database's tables and activity to verify that new tables and traffic were created after you ran a flow.
## Example Langflow and PostgreSQL docker-compose.yml ## Deploy Langflow and PostgreSQL containers with docker-compose.yml
Launching Langflow and PostgreSQL containers in the same Docker network ensures proper connectivity between services.
For an example, see the [`docker-compose.yml`](https://github.com/langflow-ai/langflow/blob/main/docker_example/docker-compose.yml) file in the Langflow repository.
The configuration in the example `docker-compose.yml` also sets up persistent volumes for both Langflow and PostgreSQL data.
Persistent volumes map directories inside of containers to storage on the host machine, so data persists through container restarts.
Docker Compose creates an isolated network for all services defined in `docker-compose.yml`. This ensures that the services can communicate with each other using their service names as hostnames, such as `postgres` in the database URL. Docker Compose creates an isolated network for all services defined in `docker-compose.yml`. This ensures that the services can communicate with each other using their service names as hostnames, such as `postgres` in the database URL.
In contrast, if you run PostgreSQL separately with `docker run`, it launches in a different network than the Langflow container, and this prevents Langflow from connecting to PostgreSQL using the service name. In contrast, if you run PostgreSQL separately with `docker run`, it launches in a different network than the Langflow container, and this prevents Langflow from connecting to PostgreSQL using the service name.
You can use the [`docker-compose.yml`](https://github.com/langflow-ai/langflow/blob/main/docker_example/docker-compose.yml) file in the Langflow repository to launches Langflow and PostgreSQL containers in the same Docker network, ensuring proper connectivity between services. To start the Langflow and PostgreSQL services with the example Docker Compose file, navigate to the `langflow/docker_example` directory, and then run `docker-compose up`.
This configuration also sets up persistent volumes for both Langflow and PostgreSQL data. If you're using a different `docker-compose.yml` file, run the `docker-compose up` command from the same directory as your `docker-compose.yml` file.
To start the services, navigate to the `/docker_example` directory, and then run `docker-compose up`: ## Deploy multiple Langflow instances with a shared PostgreSQL database
```yaml
services:
langflow:
image: langflowai/langflow:latest # or another version tag on https://hub.docker.com/r/langflowai/langflow
pull_policy: always # set to 'always' when using 'latest' image
ports:
- "7860:7860"
depends_on:
- postgres
environment:
- LANGFLOW_DATABASE_URL=postgresql://langflow:langflow@postgres:5432/langflow
# This variable defines where the logs, file storage, monitor data, and secret keys are stored.
- LANGFLOW_CONFIG_DIR=app/langflow
volumes:
- langflow-data:/app/langflow
postgres:
image: postgres:16
environment:
POSTGRES_USER: langflow
POSTGRES_PASSWORD: langflow
POSTGRES_DB: langflow
ports:
- "5432:5432"
volumes:
- langflow-postgres:/var/lib/postgresql/data
volumes:
langflow-postgres: # Persistent volume for PostgreSQL data
langflow-data: # Persistent volume for Langflow data
```
## Deploy multiple Langflow instances with a shared database
To configure multiple Langflow instances that share the same PostgreSQL database, modify your `docker-compose.yml` file to include multiple Langflow services. To configure multiple Langflow instances that share the same PostgreSQL database, modify your `docker-compose.yml` file to include multiple Langflow services.
Use environment variables for more centralized configuration management: This example populates the values in `docker-compose.yml` with values from your Langflow `.env` file.
This approach means you only have to manage deployment variables in one file, instead of copying values across multiple files.
1. Update your `.env` file with values for your PostgreSQL database: 1. Update your `.env` file with values for your PostgreSQL database:
```text
POSTGRES_USER=langflow
POSTGRES_PASSWORD=your_secure_password
POSTGRES_DB=langflow
POSTGRES_HOST=postgres
POSTGRES_PORT=5432
LANGFLOW_CONFIG_DIR=app/langflow
LANGFLOW_PORT_1=7860
LANGFLOW_PORT_2=7861
LANGFLOW_HOST=0.0.0.0
```
2. Reference these variables in your `docker-compose.yml`:
```yaml
services:
postgres:
image: postgres:16
environment:
- POSTGRES_USER=${POSTGRES_USER}
- POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
- POSTGRES_DB=${POSTGRES_DB}
ports:
- "${POSTGRES_PORT}:5432"
volumes:
- langflow-postgres:/var/lib/postgresql/data
langflow-1: ```text
image: langflowai/langflow:latest POSTGRES_USER=langflow
pull_policy: always POSTGRES_PASSWORD=your_secure_password
ports: POSTGRES_DB=langflow
- "${LANGFLOW_PORT_1}:7860" POSTGRES_HOST=postgres
depends_on: POSTGRES_PORT=5432
- postgres LANGFLOW_CONFIG_DIR=app/langflow
environment: LANGFLOW_PORT_1=7860
- LANGFLOW_DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB} LANGFLOW_PORT_2=7861
- LANGFLOW_CONFIG_DIR=${LANGFLOW_CONFIG_DIR} LANGFLOW_HOST=0.0.0.0
- LANGFLOW_HOST=${LANGFLOW_HOST} ```
- PORT=7860 2. Reference these variables in your `docker-compose.yml`.
volumes: For example:
- langflow-data-1:/app/langflow
langflow-2: ```yaml
image: langflowai/langflow:latest services:
pull_policy: always postgres:
ports: image: postgres:16
- "${LANGFLOW_PORT_2}:7860" environment:
depends_on: - POSTGRES_USER=${POSTGRES_USER}
- postgres - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
environment: - POSTGRES_DB=${POSTGRES_DB}
- LANGFLOW_DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB} ports:
- LANGFLOW_CONFIG_DIR=${LANGFLOW_CONFIG_DIR} - "${POSTGRES_PORT}:5432"
- LANGFLOW_HOST=${LANGFLOW_HOST} volumes:
- PORT=7860 - langflow-postgres:/var/lib/postgresql/data
volumes:
- langflow-data-2:/app/langflow
volumes: langflow-1:
langflow-postgres: image: langflowai/langflow:latest
langflow-data-1: pull_policy: always
langflow-data-2: ports:
``` - "${LANGFLOW_PORT_1}:7860"
depends_on:
- postgres
environment:
- LANGFLOW_DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}
- LANGFLOW_CONFIG_DIR=${LANGFLOW_CONFIG_DIR}
- LANGFLOW_HOST=${LANGFLOW_HOST}
- PORT=7860
volumes:
- langflow-data-1:/app/langflow
langflow-2:
image: langflowai/langflow:latest
pull_policy: always
ports:
- "${LANGFLOW_PORT_2}:7860"
depends_on:
- postgres
environment:
- LANGFLOW_DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}
- LANGFLOW_CONFIG_DIR=${LANGFLOW_CONFIG_DIR}
- LANGFLOW_HOST=${LANGFLOW_HOST}
- PORT=7860
volumes:
- langflow-data-2:/app/langflow
volumes:
langflow-postgres:
langflow-data-1:
langflow-data-2:
```
3. Deploy the file with `docker-compose up`. 3. Deploy the file with `docker-compose up`.
You can access the first Langflow instance at `http://localhost:7860`, and the second Langflow instance at `http://localhost:7861`. You can access the first Langflow instance at `http://localhost:7860`, and the second Langflow instance at `http://localhost:7861`.
4. To confirm both instances are using the same database, run the `docker exec` command to start `psql` in your PostgreSQL container. 4. To confirm both instances are using the same database, run the `docker exec` command to start `psql` in your PostgreSQL container.
Your container name may vary. Your container name may vary.
```bash
docker exec -it docker-test-postgres-1 psql -U langflow -d langflow ```bash
``` docker exec -it docker-test-postgres-1 psql -U langflow -d langflow
```
5. Query the database for active connections: 5. Query the database for active connections:
```sql
langflow=# SELECT * FROM pg_stat_activity WHERE datname = 'langflow'; ```sql
``` langflow=# SELECT * FROM pg_stat_activity WHERE datname = 'langflow';
```
6. Examine the query results for multiple connections with different `client_addr` values, for example `172.21.0.3` and `172.21.0.4`. 6. Examine the query results for multiple connections with different `client_addr` values, for example `172.21.0.3` and `172.21.0.4`.
Since each Langflow instance runs in its own container on the Docker network, using different incoming IP addresses confirms that both instances are actively connected to the PostgreSQL database. Since each Langflow instance runs in its own container on the Docker network, using different incoming IP addresses confirms that both instances are actively connected to the PostgreSQL database.
7. To quit psql, type `quit`. 7. To quit psql, type `quit`.