rgem227 / knoweldge-base
git clone https://github.com/rgem227/knoweldge-base.git
Personal or team knowledge base, supports MCP API calls.
+~-88
stars, 24h · #62,590
+~-618
stars, 7 days · #62,737
+~-2.6k
stars, 30 days · #62,895
7
★ total · -99% this week
0
forks · 0 open issues
Star history (as recorded here)
LanguagePython
License—
Created2026-09-22 (1mo ago)
Last push1mo ago
Watchers6
OwnerUser
Links
README excerpt
# Knowledge Base Phase 1 This repository contains the phase 1 minimum viable file knowledge base. ## Current Stack - Backend: FastAPI - Database: SQLite - File storage: local filesystem - Task queue: placeholder for later phases PostgreSQL and object storage are reserved for a later migration. The current version does not require Docker, MinIO, or a running database service. ## Local development 1. Copy the root environment template to `backend/.env`: [code] 2. Install dependencies: [code] 3. Initialize the SQLite database: [code] 4. Run backend: [code] ## Verify From the `backend` directory: [code] PowerShell: [code] Initialize or recreate the SQLite tables: [code] Runtime files are created under `backend/data/`: - `knowledge_base.db`: SQLite database - `storage/`: uploaded files and generated Markdown files The existing Docker Compose file is reserved for the later PostgreSQL and object storage migration. It is not required for the current phase. Service start, restart, stop, and status commands are provided by the separate PowerShell control files under `scripts/`. ## Current scope - Administrator-created users, login, and JWT authentication - Public knowledge bases - Nested folders with breadcrumb navigation - Folder-scoped document listing and upload - Owner-only folder rename and empty-folder deletion API - Single-file and batch upload - Upload support for PDF, text/Markdown/HTML, images, PowerPoint, Word, and Excel files - Document metadata and tags - Original file preview and download - In-app reader for text, Markdown, PDF, DOCX, XLSX, PPTX, and images - Browser-local preview for PDF, DOCX, XLS/XLSX, and Markdown using Vue-based preview components, with PPTX rendered by the bundled `pptx-renderer` - Best-effort text extraction for legacy DOC, XLS, and PPT files - Owner-only document editing - Owner-only soft delete and restore - Recycle bin listing - SQLite database initialization - Local filesystem storage with path traversal protection - Administrator-only user management and audit log pages - Per-user MCP Token expiration policies, including persistent long-lived Tokens - In-app upload progress, safe HTML preview, document owner/uploader metadata, and administrator MCP invocation logs - Cross-scope copy for documents and folders, including recursive folder copies and physical local-storage duplication Operational configuration is controlled through `.env.example`, `backend/app/core/config.py`, and the scripts under `scripts/`. The repository also includes a read-only REST API, OpenAPI endpoints, MCP integration, and the knowledge-base Skill under `skills/knowledge-base/`. ## API examples Log in and receive a token: [code] Upload a document: [code] The generated API documentation is available at `/docs`. ## Browser-local document preview The frontend uses `vue3-office-preview` for DOCX, PPTX, XLS, and XLSX, `@vue3-office/vue-pdf` for PDF, and `@deot/docs-markdown` for Markdown. Files are fetched through the authent