pengjunjie/ragflow
1
0
Fork 1
mirror of https://github.com/infiniflow/ragflow.git synced 2025-12-08 20:42:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Added 0.17.0 release notes (#5608)

Browse Source 
### What problem does this PR solve?



### Type of change


- [x] Documentation Update
This commit is contained in:
writinwaters
2025-03-04 19:21:28 +08:00
committed by GitHub
parent f256e1a59a
commit fb4b5b0a06
26 changed files with 132 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/develop/_category_.json
View File

@ -1,8 +1,8 @@
{
"label": "Developer guides",
"label": "Developers",
"position": 4,
"link": {
"type": "generated-index",
"description": "Guides for Hardcore Developers"
"description": "Guides for hardcore developers"
}
}

2
docs/develop/acquire_ragflow_api_key.md
View File

@ -3,7 +3,7 @@ sidebar_position: 3
slug: /acquire_ragflow_api_key
---
# Acquire a RAGFlow API key
# Acquire RAGFlow API key
A key is required for the RAGFlow server to authenticate your requests via HTTP or a Python API. This documents provides instructions on obtaining a RAGFlow API key.

2
docs/develop/build_docker_image.mdx
View File

@ -3,7 +3,7 @@ sidebar_position: 1
slug: /build_docker_image
---
# Build a RAGFlow Docker Image
# Build RAGFlow Docker image
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

14
docs/develop/launch_ragflow_from_source.md
View File

@ -3,11 +3,11 @@ sidebar_position: 2
slug: /launch_ragflow_from_source
---
# Launch a RAGFlow Service from Source
# Launch RAGFlow service from source
A guide explaining how to set up a RAGFlow service from its source code. By following this guide, you'll be able to debug using the source code.
## Target Audience
## Target audience
Developers who have added new features or modified existing code and wish to debug using the source code, *provided that* their machine has the target deployment environment set up.
@ -22,11 +22,11 @@ Developers who have added new features or modified existing code and wish to deb
If you have not installed Docker on your local machine (Windows, Mac, or Linux), see the [Install Docker Engine](https://docs.docker.com/engine/install/) guide.
:::
## Launch the Service from Source
## Launch a service from source
To launch the RAGFlow service from source code:
To launch a RAGFlow service from source code:
### Clone the RAGFlow Repository
### Clone the RAGFlow repository
```bash
git clone https://github.com/infiniflow/ragflow.git
@ -52,7 +52,7 @@ cd ragflow/
```
*A virtual environment named `.venv` is created, and all Python dependencies are installed into the new environment.*
### Launch Third-party Services
### Launch third-party services
The following command launches the 'base' services (MinIO, Elasticsearch, Redis, and MySQL) using Docker Compose:
@ -70,7 +70,7 @@ docker compose -f docker/docker-compose-base.yml up -d
2. In **docker/service_conf.yaml.template**, update mysql port to `5455` and es port to `1200`, as specified in **docker/.env**.
### Launch the RAGFlow Backend Service
### Launch the RAGFlow backend service
1. Comment out the `nginx` line in **docker/entrypoint.sh**.