writinwaters
commited on
Commit
Β·
830d3c7
1
Parent(s):
cfbf213
Update README.md
Browse files
README.md
CHANGED
@@ -22,7 +22,7 @@
|
|
22 |
|
23 |
## π‘ What is RAGFlow?
|
24 |
|
25 |
-
[RAGFlow](http://demo.ragflow.io) is an open-source, Retrieval-Augmented Generation engine built on large language models (LLM)
|
26 |
|
27 |
## π Key Features
|
28 |
|
@@ -128,6 +128,7 @@
|
|
128 |
```
|
129 |
|
130 |
5. In your web browser, enter the IP address of your server as prompted and log in to RAGFlow.
|
|
|
131 |
6. In [service_conf.yaml](./docker/service_conf.yaml), select the desired LLM factory in `user_default_llm` and update the `API_KEY` field with the corresponding API key.
|
132 |
|
133 |
> See [./docs/llm_api_key_setup.md](./docs/llm_api_key_setup.md) for more information.
|
@@ -146,7 +147,7 @@ You must ensure that changes to the [.env](./docker/.env) file are in line with
|
|
146 |
|
147 |
> The [./docker/README](./docker/README.md) file provides a detailed description of the environment settings and service configurations, and you are REQUIRED to ensure that all environment settings listed in the [./docker/README](./docker/README.md) file are aligned with the corresponding configurations in the [service_conf.yaml](./docker/service_conf.yaml) file.
|
148 |
|
149 |
-
To update the default serving port (80), go to [docker-compose.yml](./docker/docker-compose.yml) and change `80:80` to `<YOUR_SERVING_PORT>:80`.
|
150 |
|
151 |
> Updates to all system configurations require a system reboot to take effect:
|
152 |
>
|
|
|
22 |
|
23 |
## π‘ What is RAGFlow?
|
24 |
|
25 |
+
[RAGFlow](http://demo.ragflow.io) is an open-source, Retrieval-Augmented Generation engine built on large language models (LLM) and deep document understanding. It offers a streamlined RAG workflow for businesses of any scale, providing truthful responses with solid citations through a generative AI knowledge management platform.
|
26 |
|
27 |
## π Key Features
|
28 |
|
|
|
128 |
```
|
129 |
|
130 |
5. In your web browser, enter the IP address of your server as prompted and log in to RAGFlow.
|
131 |
+
> In the given scenario, you only need to enter `http://172.22.0.5` as the port `9380` has been mapped to the default HTTP serving port `80` through Docker port mapping.
|
132 |
6. In [service_conf.yaml](./docker/service_conf.yaml), select the desired LLM factory in `user_default_llm` and update the `API_KEY` field with the corresponding API key.
|
133 |
|
134 |
> See [./docs/llm_api_key_setup.md](./docs/llm_api_key_setup.md) for more information.
|
|
|
147 |
|
148 |
> The [./docker/README](./docker/README.md) file provides a detailed description of the environment settings and service configurations, and you are REQUIRED to ensure that all environment settings listed in the [./docker/README](./docker/README.md) file are aligned with the corresponding configurations in the [service_conf.yaml](./docker/service_conf.yaml) file.
|
149 |
|
150 |
+
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`.
|
151 |
|
152 |
> Updates to all system configurations require a system reboot to take effect:
|
153 |
>
|