-
Notifications
You must be signed in to change notification settings - Fork 2.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added configuration guideline (#3309)
### What problem does this PR solve? ### Type of change - [x] Documentation Update
- Loading branch information
1 parent
ac64e35
commit 85047e7
Showing
5 changed files
with
181 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,173 @@ | ||
| --- | ||
| sidebar_position: 1 | ||
| slug: /configurations | ||
| --- | ||
|
|
||
| # Configurations | ||
|
|
||
| Configurations for installing RAGFlow via Docker. | ||
|
|
||
| ## Guidelines | ||
|
|
||
| When it comes to system configurations, you will need to manage the following files: | ||
|
|
||
| - [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env): Contains important environment variables for Docker. | ||
| - [service_conf.yaml](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml): Configures the back-end services. It specifies the system-level configuration for RAGFlow and is used by its API server and task executor. | ||
| - [docker-compose.yml](https://github.com/infiniflow/ragflow/blob/main/docker/docker-compose.yml): The Docker Compose file for starting up the RAGFlow service. | ||
|
|
||
| You must ensure that changes to the [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) file are in line with what are in the [service_conf.yaml](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml) file. | ||
|
|
||
| To update the default HTTP serving port (80), go to [docker-compose.yml](./docker/docker-compose.yml) and change `80:80` | ||
| to `<YOUR_SERVING_PORT>:80`. | ||
|
|
||
| :::tip NOTE | ||
| Updates to the above configurations require a reboot of all containers to take effect: | ||
|
|
||
| ```bash | ||
| docker compose -f docker/docker-compose.yml up -d | ||
| ``` | ||
|
|
||
| ::: | ||
|
|
||
| ## Docker Compose | ||
|
|
||
| - **docker-compose.yml** | ||
| Sets up environment for RAGFlow and its dependencies. | ||
| - **docker-compose-base.yml** | ||
| Sets up environment for RAGFlow's base services: Elasticsearch, MySQL, MinIO, and Redis. | ||
|
|
||
| ## Docker environment variables | ||
|
|
||
| The [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) file contains important environment variables for Docker. | ||
|
|
||
| ### Elasticsearch | ||
|
|
||
| - `STACK_VERSION` | ||
| The version of Elasticsearch. Defaults to `8.11.3` | ||
| - `ES_PORT` | ||
| The port used to expose the Elasticsearch service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `1200`. | ||
| - `ELASTIC_PASSWORD` | ||
| The password for Elasticsearch. When updated, you must revise the `es.password` entry in [service_conf.yaml](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml) accordingly. | ||
|
|
||
| ### Kibana | ||
|
|
||
| - `KIBANA_PORT` | ||
| The port used to expose the Kibana service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `6601`. | ||
| - `KIBANA_USER` | ||
| The username for Kibana. Defaults to `rag_flow`. | ||
| - `KIBANA_PASSWORD` | ||
| The password for Kibana. Defaults to `infini_rag_flow`. | ||
|
|
||
| ### Resource management | ||
|
|
||
| - `MEM_LIMIT` | ||
| The maximum amount of the memory, in bytes, that *a specific* Docker container can use while running. Defaults to `8073741824`. | ||
|
|
||
| ### MySQL | ||
|
|
||
| - `MYSQL_PASSWORD` | ||
| The password for MySQL. When updated, you must revise the `mysql.password` entry in [service_conf.yaml](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml) accordingly. | ||
| - `MYSQL_PORT` | ||
| The port used to expose the MySQL service to the host machine, allowing **external** access to the MySQL database running inside the Docker container. Defaults to `5455`. | ||
|
|
||
| ### MinIO | ||
|
|
||
| - `MINIO_CONSOLE_PORT` | ||
| The port used to expose the MinIO console interface to the host machine, allowing **external** access to the web-based console running inside the Docker container. Defaults to `9001` | ||
| - `MINIO_PORT` | ||
| The port used to expose the MinIO API service to the host machine, allowing **external** access to the MinIO object storage service running inside the Docker container. Defaults to `9000`. | ||
| - `MINIO_USER` | ||
| The username for MinIO. When updated, you must revise the `minio.user` entry in [service_conf.yaml](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml) accordingly. | ||
| - `MINIO_PASSWORD` | ||
| The password for MinIO. When updated, you must revise the `minio.password` entry in [service_conf.yaml](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml) accordingly. | ||
|
|
||
| ### Redis | ||
|
|
||
| - `REDIS_PORT` | ||
| The port used to expose the Redis service to the host machine, allowing **external** access to the Redis service running inside the Docker container. Defaults to `6379`. | ||
| - `REDIS_PASSWORD` | ||
| The password for Redis. When updated, you must revise the `redis.password` entry in [service_conf.yaml](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml) accordingly. | ||
|
|
||
| ### RAGFlow | ||
|
|
||
| - `SVR_HTTP_PORT` | ||
| The port used to expose RAGFlow's HTTP API service to the host machine, allowing **external** access to the service running inside the Docker container. Defaults to `9380`. | ||
| - `RAGFLOW-IMAGE` | ||
| The Docker image edition. Available editions: | ||
|
|
||
| - `infiniflow/ragflow:dev-slim` (default): The RAGFlow Docker image without embedding models. | ||
| - `infiniflow/ragflow:dev`: The RAGFlow Docker image with embedding models including: | ||
| - Embedded embedding models: | ||
| - `BAAI/bge-large-zh-v1.5` | ||
| - `BAAI/bge-reranker-v2-m3` | ||
| - `maidalun1020/bce-embedding-base_v1` | ||
| - `maidalun1020/bce-reranker-base_v1` | ||
| - Embedding models that will be downloaded once you select them in the RAGFlow UI: | ||
| - `BAAI/bge-base-en-v1.5` | ||
| - `BAAI/bge-large-en-v1.5` | ||
| - `BAAI/bge-small-en-v1.5` | ||
| - `BAAI/bge-small-zh-v1.5` | ||
| - `jinaai/jina-embeddings-v2-base-en` | ||
| - `jinaai/jina-embeddings-v2-small-en` | ||
| - `nomic-ai/nomic-embed-text-v1.5` | ||
| - `sentence-transformers/all-MiniLM-L6-v2` | ||
|
|
||
| :::tip NOTE | ||
| If you cannot download the RAGFlow Docker image, try the following mirrors. | ||
|
|
||
| - For the `dev-slim` edition: | ||
| - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev-slim` or, | ||
| - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev-slim`. | ||
| - For the `dev` edition: | ||
| - `RAGFLOW_IMAGE=swr.cn-north-4.myhuaweicloud.com/infiniflow/ragflow:dev` or, | ||
| - `RAGFLOW_IMAGE=registry.cn-hangzhou.aliyuncs.com/infiniflow/ragflow:dev`. | ||
| ::: | ||
|
|
||
| ### Miscellaneous | ||
|
|
||
| - `TIMEZONE` | ||
| The local time zone. Defaults to `'Asia/Shanghai'`. | ||
| - `HF_ENDPOINT` | ||
| The mirror site for huggingface.co. It is disabled by default. You can uncomment this line if you have limited access to the primary Hugging Face domain. | ||
| - `MACOS` | ||
| Optimizations for MacOS. It is disabled by default. You can uncomment this line if your OS is MacOS. | ||
|
|
||
| ## Service configuration | ||
|
|
||
| [service_conf.yaml](https://github.com/infiniflow/ragflow/blob/main/docker/service_conf.yaml) specifies the system-level configuration for RAGFlow and is used by its API server and task executor. | ||
|
|
||
| - `ragflow` | ||
| - `host`: The API server's IP address inside the Docker container. Defaults to `0.0.0.0`. | ||
| - `port`: The API server's serving port inside the Docker container. Defaults to `9380`. | ||
|
|
||
| - `mysql` | ||
| - `name`: The MySQL database name. Defaults to `rag_flow`. | ||
| - `user`: The username for MySQL. | ||
| - `password`: The password for MySQL. When updated, you must revise the `MYSQL_PASSWORD` variable in [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) accordingly. | ||
| - `port`: The MySQL serving port inside the Docker container. Defaults to `3306`. | ||
| - `max_connections`: The maximum number of concurrent connections to the MySQL database. Defaults to `100`. | ||
| - `stale_timeout`: Timeout in seconds. | ||
|
|
||
| - `minio` | ||
| - `user`: The username for MinIO. When updated, you must revise the `MINIO_USER` variable in [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) accordingly. | ||
| - `password`: The password for MinIO. When updated, you must revise the `MINIO_PASSWORD` variable in [.env](https://github.com/infiniflow/ragflow/blob/main/docker/.env) accordingly. | ||
| - `host`: The MinIO serving IP *and* port inside the Docker container. Defaults to `minio:9000`. | ||
|
|
||
| - `oauth` | ||
| The OAuth configuration for signing up or signing in to RAGFlow using a third-party account. It is disabled by default. To enable this feature, uncomment the corresponding lines in **service_conf.yaml**. | ||
| - `github`: The GitHub authentication settings for your application. Visit the [Github Developer Settings](https://github.com/settings/developers) page to obtain your client_id and secret_key. | ||
|
|
||
| - `user_default_llm` | ||
| The default LLM to use for a new RAGFlow user. It is disabled by default. To enable this feature, uncomment the corresponding lines in **service_conf.yaml**. | ||
| - `factory`: The LLM supplier. Available options: | ||
| - `"OpenAI"` | ||
| - `"DeepSeek"` | ||
| - `"Moonshot"` | ||
| - `"Tongyi-Qianwen"` | ||
| - `"VolcEngine"` | ||
| - `"ZHIPU-AI"` | ||
| - `api_key`: The API key for the specified LLM. You will need to apply for your model API key online. | ||
|
|
||
| :::tip NOTE | ||
| If you do not set the default LLM here, configure the default LLM on the **Settings** page in the RAGFlow UI. | ||
| ::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| --- | ||
| sidebar_position: 1 | ||
| sidebar_position: 0 | ||
| slug: / | ||
| --- | ||
|
|
||
|
|
||