mirror of
https://gitee.com/wanwujie/deer-flow
synced 2026-04-19 04:14:46 +08:00
chore: add a Makefile command to create all required local configuration files (#883)
* fix: polish the makefile to provide config command for local config setup * docs: polish the instructions in README
This commit is contained in:
8
Makefile
8
Makefile
@@ -1,6 +1,6 @@
|
|||||||
# DeerFlow - Unified Development Environment
|
# DeerFlow - Unified Development Environment
|
||||||
|
|
||||||
.PHONY: help check install dev stop clean docker-init docker-start docker-stop docker-logs docker-logs-frontend docker-logs-gateway
|
.PHONY: help config check install dev stop clean docker-init docker-start docker-stop docker-logs docker-logs-frontend docker-logs-gateway
|
||||||
|
|
||||||
help:
|
help:
|
||||||
@echo "DeerFlow Development Commands:"
|
@echo "DeerFlow Development Commands:"
|
||||||
@@ -19,6 +19,12 @@ help:
|
|||||||
@echo " make docker-logs-frontend - View Docker frontend logs"
|
@echo " make docker-logs-frontend - View Docker frontend logs"
|
||||||
@echo " make docker-logs-gateway - View Docker gateway logs"
|
@echo " make docker-logs-gateway - View Docker gateway logs"
|
||||||
|
|
||||||
|
config:
|
||||||
|
@test -f config.yaml || cp config.example.yaml config.yaml
|
||||||
|
@test -f .env || cp .env.example .env
|
||||||
|
@test -f frontend/.env || cp frontend/.env.example frontend/.env
|
||||||
|
@test -f extensions_config.json || cp extensions_config.example.json extensions_config.json
|
||||||
|
|
||||||
# Check required tools
|
# Check required tools
|
||||||
check:
|
check:
|
||||||
@echo "=========================================="
|
@echo "=========================================="
|
||||||
|
|||||||
16
README.md
16
README.md
@@ -37,17 +37,23 @@ Learn more and see **real demos** on our official website.
|
|||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
1. Clone the git repo of DeerFlow
|
1. Clone the git repo of DeerFlow:
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/bytedance/deer-flow.git && cd deer-flow
|
git clone https://github.com/bytedance/deer-flow.git && cd deer-flow
|
||||||
```
|
```
|
||||||
3. **Copy the example config**:
|
2. Create local config files by copying the example files:
|
||||||
```bash
|
```bash
|
||||||
cp config.example.yaml config.yaml
|
make config
|
||||||
cp .env.example .env
|
|
||||||
```
|
```
|
||||||
|
|
||||||
4. **Edit `config.yaml`** and set your API keys in `.env` and preferred sandbox mode.
|
3. Update the configs:
|
||||||
|
|
||||||
|
- **Required**
|
||||||
|
- `config.yaml`: configure your preferred models.
|
||||||
|
- `.env`: configure your API keys.
|
||||||
|
- **Optional**
|
||||||
|
- `frontend/.env`: configure backend API URLs.
|
||||||
|
- `extensions_config.json`: configure desired MCP servers and skills.
|
||||||
|
|
||||||
#### Sandbox Configuration
|
#### Sandbox Configuration
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user