Skip to content

Commit

Permalink
Document env variables in nodes directories
Browse files Browse the repository at this point in the history
  • Loading branch information
@JJK801
JJK801 committed Oct 28, 2024
1 parent 4e1f4c4 commit 675641b
Show file tree
Hide file tree
Showing 4 changed files with 38 additions and 48 deletions.
13 changes: 0 additions & 13 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -159,19 +159,6 @@ Flowise support different environment variables to configure your instance. You
| S3_ENDPOINT_URL | Custom Endpoint for S3 | String | |
| S3_FORCE_PATH_STYLE | Set this to true to force the request to use path-style addressing | Boolean | false |
| SHOW_COMMUNITY_NODES | Show nodes created by community | Boolean | |
| POSTGRES_VECTORSTORE_HOST | Default `host` for Postgres Vector Store | String | |
| POSTGRES_VECTORSTORE_PORT | Default `port` for Postgres Vector Store | Number | 5432 |
| POSTGRES_VECTORSTORE_USER | Default `user` for Postgres Vector Store | String | |
| POSTGRES_VECTORSTORE_PASSWORD | Default `password` for Postgres Vector Store | String | |
| POSTGRES_VECTORSTORE_DATABASE | Default `database` for Postgres Vector Store | String | |
| POSTGRES_VECTORSTORE_TABLE_NAME | Default `tableName` for Postgres Vector Store | String | documents |
| POSTGRES_VECTORSTORE_CONTENT_COLUMN_NAME | Default `contentColumnName` for Postgres Vector Store | String | pageContent |
| POSTGRES_RECORDMANAGER_HOST | Default `host` for Postgres Record Manager | String | |
| POSTGRES_RECORDMANAGER_PORT | Default `port` for Postgres Record Manager | Number | 5432 |
| POSTGRES_RECORDMANAGER_USER | Default `user` for Postgres Record Manager | String | |
| POSTGRES_RECORDMANAGER_PASSWORD | Default `password` for Postgres Record Manager | String | |
| POSTGRES_RECORDMANAGER_DATABASE | Default `database` for Postgres Record Manager | String | |
| POSTGRES_RECORDMANAGER_TABLE_NAME | Default `tableName` for Postgres Record Manager | String | upsertion_records |
You can also specify the env variables when using `npx`. For example:

```
Expand Down
36 changes: 1 addition & 35 deletions docker/.env.example
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,38 +51,4 @@ BLOB_STORAGE_PATH=/root/.flowise/storage
# S3_FORCE_PATH_STYLE=false

# APIKEY_STORAGE_TYPE=json (json | db)
# SHOW_COMMUNITY_NODES=true

############################################
# Default postgres vectorstore credentials #
############################################

# POSTGRES_VECTORSTORE_USER=
# POSTGRES_VECTORSTORE_PASSWORD=

#######################################
# Default postgres vectorstore config #
#######################################

# POSTGRES_VECTORSTORE_HOST=
# POSTGRES_VECTORSTORE_DATABASE=
# POSTGRES_VECTORSTORE_PORT=
# POSTGRES_VECTORSTORE_TABLE_NAME=
# POSTGRES_VECTORSTORE_CONTENT_COLUMN_NAME=

###############################################
# Default postgres record manager credentials #
###############################################

# POSTGRES_RECORDMANAGER_USER=
# POSTGRES_RECORDMANAGER_PASSWORD=

##########################################
# Default postgres record manager config #
##########################################

# POSTGRES_RECORDMANAGER_HOST=
# POSTGRES_RECORDMANAGER_DATABASE=
# POSTGRES_RECORDMANAGER_PORT=
# POSTGRES_RECORDMANAGER_TABLE_NAME=
# POSTGRES_RECORDMANAGER_CONTENT_COLUMN_NAME=
# SHOW_COMMUNITY_NODES=true
18 changes: 18 additions & 0 deletions packages/components/nodes/recordmanager/PostgresRecordManager/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Postgres Record Manager

Postgres Record Manager integration for Flowise

## 🌱 Env Variables

| Variable | Description | Type | Default |
| ---------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------- |
| POSTGRES_RECORDMANAGER_HOST | Default `host` for Postgres Record Manager | String | |
| POSTGRES_RECORDMANAGER_PORT | Default `port` for Postgres Record Manager | Number | 5432 |
| POSTGRES_RECORDMANAGER_USER | Default `user` for Postgres Record Manager | String | |
| POSTGRES_RECORDMANAGER_PASSWORD | Default `password` for Postgres Record Manager | String | |
| POSTGRES_RECORDMANAGER_DATABASE | Default `database` for Postgres Record Manager | String | |
| POSTGRES_RECORDMANAGER_TABLE_NAME | Default `tableName` for Postgres Record Manager | String | upsertion_records |

## License

Source code in this repository is made available under the [Apache License Version 2.0](https://github.com/FlowiseAI/Flowise/blob/master/LICENSE.md).
19 changes: 19 additions & 0 deletions packages/components/nodes/vectorstores/Postgres/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Postgres Vector Store

Postgres Vector Store integration for Flowise

## 🌱 Env Variables

| Variable | Description | Type | Default |
| ---------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------------------------------- |
| POSTGRES_VECTORSTORE_HOST | Default `host` for Postgres Vector Store | String | |
| POSTGRES_VECTORSTORE_PORT | Default `port` for Postgres Vector Store | Number | 5432 |
| POSTGRES_VECTORSTORE_USER | Default `user` for Postgres Vector Store | String | |
| POSTGRES_VECTORSTORE_PASSWORD | Default `password` for Postgres Vector Store | String | |
| POSTGRES_VECTORSTORE_DATABASE | Default `database` for Postgres Vector Store | String | |
| POSTGRES_VECTORSTORE_TABLE_NAME | Default `tableName` for Postgres Vector Store | String | documents |
| POSTGRES_VECTORSTORE_CONTENT_COLUMN_NAME | Default `contentColumnName` for Postgres Vector Store | String | pageContent |

## License

Source code in this repository is made available under the [Apache License Version 2.0](https://github.com/FlowiseAI/Flowise/blob/master/LICENSE.md).

0 comments on commit 675641b

Please sign in to comment.