mirror of
https://github.com/tiennm99/DocsGPT.git
synced 2026-10-13 14:15:52 +00:00
Alex
574f96341e
The backend import package is now docsgpt, the name it will carry on PyPI; application was far too generic to install into anyone's site-packages. git mv plus a mechanical rewrite of every import, dotted string and path reference: 734 Python files, the compose files, Dockerfile, workflows, docs, setup scripts, devcontainer, k8s manifests, vscode config, pytest and coverage config, .gitignore. Behaviour is unchanged. Kept for one release: - A top-level application package whose meta-path finder resolves application.x.y to the already-imported docsgpt.x.y object, so old imports and entry points (celery -A application.app.celery, uvicorn application.asgi:asgi_app) keep working with a FutureWarning. - Celery registers every application.* task name as an alias of its docsgpt.* task on start-up, so messages queued by the previous release still run. The redbeat key prefix moves to redbeat:docsgpt:v2: so schedule entries the previous release wrote are left unread instead of firing twice. The backend image builds from the repository root (docker build -f docsgpt/Dockerfile .) so it can ship the alias package; a root .dockerignore allow-lists docsgpt/ and application/ and keeps caches, local data, .env files, the sample index files and the Dockerfile out. Compose and the image workflows point at the new context.
61 lines
1.9 KiB
Markdown
61 lines
1.9 KiB
Markdown
# Welcome to DocsGPT Devcontainer
|
|
|
|
Welcome to the DocsGPT development environment! This guide will help you get started quickly.
|
|
|
|
## Starting Services
|
|
|
|
To run DocsGPT, you need to start three main services: Flask (backend), Celery (task queue), and Vite (frontend). Here are the commands to start each service within the devcontainer:
|
|
|
|
### Vite (Frontend)
|
|
|
|
```bash
|
|
cd frontend
|
|
npm run dev -- --host
|
|
```
|
|
|
|
### Backend (ASGI)
|
|
|
|
Run the full app under uvicorn (serves `/mcp` and the async SSE reconnect
|
|
routes, and matches production):
|
|
|
|
```bash
|
|
uvicorn docsgpt.asgi:asgi_app --host 0.0.0.0 --port 7091 --reload
|
|
```
|
|
|
|
`flask --app docsgpt/app.py run --host=0.0.0.0 --port=7091` is faster but
|
|
serves only the WSGI Flask app — it omits `/mcp` and the reconnect reader
|
|
`GET /api/messages/<id>/events`, so a dropped stream won't auto-resume.
|
|
|
|
### Celery (Task Queue)
|
|
|
|
```bash
|
|
celery -A docsgpt.app.celery worker -l INFO -Q docsgpt,parsing,embeddings
|
|
```
|
|
|
|
The `parsing` queue serves document parsing (the `read_document` tool / workflow
|
|
native-file parse); without it those calls hang `DOCUMENT_PARSE_TIMEOUT` then
|
|
error. A dedicated `-Q parsing` worker can be GPU-enabled for heavier parsers.
|
|
|
|
## Github Codespaces Instructions
|
|
|
|
### 1. Make Ports Public:
|
|
|
|
Go to the "Ports" panel in Codespaces (usually located at the bottom of the VS Code window).
|
|
|
|
For both port 5173 and 7091, right-click on the port and select "Make Public".
|
|
|
|
|
|
|
|
|
|
### 2. Update VITE_API_HOST:
|
|
|
|
After making port 7091 public, copy the public URL provided by Codespaces for port 7091.
|
|
|
|
Open the file frontend/.env.development.
|
|
|
|
Find the line VITE_API_HOST=http://localhost:7091.
|
|
|
|
Replace http://localhost:7091 with the public URL you copied from Codespaces.
|
|
|
|
|