DocsMind
v0.2.0
DocsMind is an open-source project that allows you to chat with your docs.
It is currently under development and there may be major changes at any time.
Demo Site
Warning
Due to the free plan of Railway only providing 500 hours per month, the Demo on the 21st day of each month will not be available. Please clone it locally for use at that time.
Ask a question with your docs
Summarize docs
Highlight source
Upload docs .pdf,.md(best support)
Data saved locally
Token usage tracker
Dockerize
Chat mode
Dark mode
/ command (/fetch /summarize)
Reduce the size of the server image.
Support for more docs formats: txt...
Download docs from the internet
Markdown-formatted message
i18n
Desktop application
If you find this project helpful, please consider giving it a star ?
| Name | Description | Optional |
|---|---|---|
| OPENAI_PROXY | will replace https://api.openai.com/v1 | ✅ |
| VITE_SERVICES_URL | backend url for frontend code | ✅ |
| VITE_DISABLED_UPLOAD | DISABLED_UPLOAD | ✅ |
This project includes both frontend (/client) and backend (/server) code. The frontend code is used to display the UI, while the backend code provides services to the UI.
More details
Warning
Please check if you can access OpenAI in your region, you can refer to the issue for more information.
Create .env
Create a .env file and copy the contents of .env.example to modify it.
Run App
docker-compose up -d
Please add --build to rebuild the image after each code update.
docker-compose up -d --build
now you can access the app at http://localhost:8081
All data will be saved in the ./data directory.
Create a .env file and copy the contents of .env.example to modify it.
Install dependencies
yarn
Run app
yarn dev
you need a python environment
Create virtual environment
cd server python -m venv .venv
Active virtual environment
windows
.venvScriptsactivate
mac
. .venv/bin/activate
Install dependencies
pip install -r requirements.txt
Run Services
flask run --reload --port=8080
AGPL-3.0 License
