Revornix

English | 中文文档 | 日本語ドキュメント

Introduction

🚀 RoadMap: RoadMap

🖥️ Official Website: https://revornix.com

❤️ Join our community: Discord | WeChat | QQ

Revornix is an information management tool for the AI era. It helps you conveniently integrate all visible information and provides you with a comprehensive report at a specific time.

Features

• Cross-platform availability: Currently supports web; iOS app and WeChat Mini Program support coming soon.
• All-in-one content aggregation: Centralized content collection, including news, blogs, forums, and more.
• Document Transformation & Vectorized Storage: Powered by multimodal large models, files are converted to Markdown and embedded before being stored in the industry-leading Milvus.
• Native Multi-Tenancy: Designed as a multi-tenant system, it supports concurrent usage by multiple users, each with their own independent document repository.
• Localization & Open Source: Open-source code with all data stored locally—no concerns about data leakage.
• Smart Assistant & Built-in MCP: An AI assistant powered by built-in MCP that can interact with your documents and tools, supporting multi-model switching.
• Seamless LLM integration: Built-in model integration support—freely configure and choose the LLM you want (OpenAI-compatible required).
• Multilingual & Responsive: Whether you're a Chinese or English user, on mobile or desktop, you'll enjoy a great experience.

Quick Start

Docker Method (Recommended)

Clone the Repository Locally

git clone git@github.com:Qingyon-AI/Revornix.git
cd Revornix

Environment Variables Configuration

cp .env.example .env

Go to the corresponding environment variable files and configure them. For details, refer to Environment Variables Configuration.

[!TIP]
In most cases, you only need to configure the OAUTH_SECRET_KEY parameter for the user authentication mechanism, and leave the other parameters as default. Note that the OAUTH_SECRET_KEY must be consistent across different services; otherwise, the user authentication systems will not be interoperable.

Pull Necessary Repositories and Start with Docker

docker compose up -d

Once all services are started, you can visit http://localhost to view the front-end page. Note that due to the back-end services taking longer to start, the front-end may need to wait for some time (usually around 10-15 minutes) before it can make successful requests. You can check the core back-end service status with docker compose logs api.

Manual Deployment Method

For detail, please refer to official documentation manual deployment method

Contributors