writinwaters commited on
Commit
7d2bd69
Β·
1 Parent(s): 1311113

Update README.md (#181)

Browse files
Files changed (1) hide show
  1. README.md +10 -6
README.md CHANGED
@@ -30,14 +30,18 @@
30
  ### 🍭 **"Quality in, quality out"**
31
  - Deep document understanding-based knowledge extraction from unstructured data with complicated formats.
32
  - Finds "needle in a data haystack" of literally unlimited tokens.
 
33
  ### 🍱 **Template-based chunking**
34
  - Intelligent and explainable.
35
  - Plenty of template options to choose from.
 
36
  ### 🌱 **Grounded citations with reduced hallucinations**
37
  - Visualization of text chunking to allow human intervention.
38
  - Quick view of the key references and traceable citations to support grounded answers.
 
39
  ### πŸ” **Compatibility with heterogeneous data sources**
40
  - Supports Word, slides, excel, txt, images, scanned copies, structured data, web pages, and more.
 
41
  ### πŸ›€ **Automated and effortless RAG workflow**
42
  - Streamlined RAG orchestration catered to both personal and large businesses.
43
  - Configurable LLMs as well as embedding models.
@@ -59,7 +63,7 @@
59
  - Docker
60
  > If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/).
61
 
62
- ### Start up the server
63
 
64
  1. Ensure `vm.max_map_count` > 65535:
65
 
@@ -88,7 +92,6 @@
88
  $ git clone https://github.com/infiniflow/ragflow.git
89
  ```
90
 
91
-
92
  3. Build the pre-built Docker images and start up the server:
93
 
94
  ```bash
@@ -118,7 +121,9 @@
118
  INFO:werkzeug:Press CTRL+C to quit
119
  ```
120
 
121
- 5. In your web browser, enter the IP address and port of your server as prompted and log in to RAGFlow.
 
 
122
 
123
  *The show is now on!*
124
 
@@ -131,12 +136,11 @@ When it comes to system configurations, you will need to manage the following fi
131
  - [service_conf.yaml](./docker/service_conf.yaml): Configures the back-end services.
132
  - [docker-compose.yml](./docker/docker-compose.yml): The system relies on [docker-compose.yml](./docker/docker-compose.yml) to start up.
133
 
134
-
135
  You must ensure that changes to the [.env](./docker/.env) file are in line with what are in the [service_conf.yaml](./docker/service_conf.yaml) file.
136
 
137
- > The [./docker/README](./docker/README.md) file provides a detailed description of the environment settings and service configurations, and it is IMPORTANT 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.
138
 
139
- To change the default serving port (80), go to [docker-compose.yml](./docker/docker-compose.yml) and change `80:80` to `<YOUR_SERVING_PORT>:80`.
140
 
141
  > Updates to all system configurations require a system reboot to take effect:
142
  >
 
30
  ### 🍭 **"Quality in, quality out"**
31
  - Deep document understanding-based knowledge extraction from unstructured data with complicated formats.
32
  - Finds "needle in a data haystack" of literally unlimited tokens.
33
+
34
  ### 🍱 **Template-based chunking**
35
  - Intelligent and explainable.
36
  - Plenty of template options to choose from.
37
+
38
  ### 🌱 **Grounded citations with reduced hallucinations**
39
  - Visualization of text chunking to allow human intervention.
40
  - Quick view of the key references and traceable citations to support grounded answers.
41
+
42
  ### πŸ” **Compatibility with heterogeneous data sources**
43
  - Supports Word, slides, excel, txt, images, scanned copies, structured data, web pages, and more.
44
+
45
  ### πŸ›€ **Automated and effortless RAG workflow**
46
  - Streamlined RAG orchestration catered to both personal and large businesses.
47
  - Configurable LLMs as well as embedding models.
 
63
  - Docker
64
  > If you have not installed Docker on your local machine (Windows, Mac, or Linux), see [Install Docker Engine](https://docs.docker.com/engine/install/).
65
 
66
+ ### πŸš€ Start up the server
67
 
68
  1. Ensure `vm.max_map_count` > 65535:
69
 
 
92
  $ git clone https://github.com/infiniflow/ragflow.git
93
  ```
94
 
 
95
  3. Build the pre-built Docker images and start up the server:
96
 
97
  ```bash
 
121
  INFO:werkzeug:Press CTRL+C to quit
122
  ```
123
 
124
+ 5. In your web browser, enter the IP address of your server as prompted and log in to RAGFlow.
125
+ 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.
126
+ > See [./docs/llm_api_key_setup.md](./docs/llm_api_key_setup.md) for more information.
127
 
128
  *The show is now on!*
129
 
 
136
  - [service_conf.yaml](./docker/service_conf.yaml): Configures the back-end services.
137
  - [docker-compose.yml](./docker/docker-compose.yml): The system relies on [docker-compose.yml](./docker/docker-compose.yml) to start up.
138
 
 
139
  You must ensure that changes to the [.env](./docker/.env) file are in line with what are in the [service_conf.yaml](./docker/service_conf.yaml) file.
140
 
141
+ > 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.
142
 
143
+ 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`.
144
 
145
  > Updates to all system configurations require a system reboot to take effect:
146
  >