{"type":"mcp_client","name":"Revornix","description":"**Option 1 (Focus on summarization):**\n\nMCP-powered document & news manager. Auto-summaries, notifications, & customizable model support.\n\n**Option 2 (Focus on document interaction):**\n\nDocument/news ","category":"AI","language":"TypeScript","stars":187,"forks":14,"owner":"Qingyon-AI","github_url":"https://github.com/Qingyon-AI/Revornix","homepage":"https://revornix.com","setup":"## Setup\n\nThis guide provides instructions for setting up Revornix using Docker (recommended) or manual deployment.\n\n### Docker Method (Recommended)\n\nThis method uses Docker Compose to orchestrate the various Revornix services.\n\n**Prerequisites:**\n\n*   Docker: Ensure Docker is installed and running on your system.  Refer to the official Docker documentation for installation instructions: [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/)\n*   Docker Compose: Ensure Docker Compose is installed.  Most Docker installations include Docker Compose by default.  If not, refer to the official Docker Compose documentation: [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)\n*   Git:  Git is required to clone the Revornix repository.\n\n**Installation Steps:**\n\n1.  **Clone the Repository:**\n\n    ```shell\n    git clone git@github.com:Qingyon-AI/Revornix.git\n    cd Revornix\n    ```\n\n2.  **Configure Environment Variables:**\n\n    *   Copy the example environment file:\n\n        ```shell\n        cp .env.example .env\n        ```\n\n    *   Edit the `.env` file to configure the necessary environment variables. Refer to the [Environment Variables Configuration](https://revornix.com/en/docs/environment) documentation for detailed descriptions of each variable.\n\n        ```shell\n        nano .env # Or your preferred text editor\n        ```\n\n    *   **Important Environment Variables:**\n\n        *   `OAUTH_SECRET_KEY`:  This is crucial for user authentication.  **It must be consistent across all Revornix services.**  Generate a strong, random key and set it in the `.env` file.  If this key is not consistent, user authentication will fail.\n\n        *   Other variables can be left as default in most cases, but review the documentation to understand their purpose and adjust as needed.\n\n3.  **Start the Services with Docker Compose:**\n\n    ```shell\n    docker compose up -d\n    ```\n\n    This command will pull the necessary Docker images and start all the Revornix services in detached mode (running in the background).\n\n4.  **Access Revornix:**\n\n    Once all services are started, you can access the front-end application in your web browser at:\n\n    ```\n    http://localhost\n    ```\n\n    **Troubleshooting:**\n\n    *   The front-end may take some time (10-15 minutes) to become fully functional after the services are started, as the back-end services need time to initialize.\n    *   You can check the status of the core back-end service using the following command:\n\n        ```shell\n        docker compose logs api\n        ```\n\n        This will display the logs for the `api` service, allowing you to identify any potential errors.\n\n### Manual Deployment Method\n\nFor detailed instructions on manual deployment, please refer to the official documentation: [official documentation manual deployment method](https://revornix.com/en/docs/start#manual-deployment-method)","tools":"## Available Tools\n\nHere's a breakdown of Revornix's features, presented as tools with their functions:\n\n*   **Cross-Platform Access:** Access Revornix through the web. iOS app and WeChat Mini Program support are planned.\n    *   **Function:** Provides access to Revornix on different devices.\n    *   **Usage:** Access the web version through a browser.\n\n*   **Content Aggregator:** Collects and centralizes content from various sources like news, blogs, and forums.\n    *   **Function:** Gathers information from different online sources into a single location.\n    *   **Usage:** Configure the tool to monitor specific websites or feeds.\n\n*   **Document Transformation & Vectorization:** Converts files to Markdown format and embeds them using multimodal large models, storing them in Milvus.\n    *   **Function:** Converts documents into a structured format suitable for AI processing and efficient storage.\n    *   **Usage:** Upload documents, and the tool automatically converts and stores them.\n\n*   **Multi-Tenancy:** Supports multiple users with independent document repositories.\n    *   **Function:** Allows multiple users to use the system concurrently, each with their own data.\n    *   **Usage:** Each user logs in and has access to their own workspace.\n\n*   **Localization & Open Source:** Open-source code with local data storage.\n    *   **Function:** Ensures data privacy and allows for customization.\n    *   **Usage:** Deploy the open-source code on a local server.\n\n*   **Smart Assistant (with built-in MCP):** An AI assistant that interacts with documents and tools, supporting multi-model switching.\n    *   **Function:** Provides AI-powered assistance for interacting with and managing documents.\n    *   **Usage:** Ask the assistant questions about your documents or request it to perform tasks.\n\n*   **LLM Integration:** Supports integration with various Large Language Models (LLMs), requiring OpenAI-compatible models.\n    *   **Function:** Allows users to choose and configure their preferred LLM for AI processing.\n    *   **Usage:** Configure the tool with the API key of your chosen LLM.\n\n*   **Multilingual Support:** Supports both Chinese and English languages.\n    *   **Function:** Provides a user interface in multiple languages.\n    *   **Usage:** Select your preferred language in the settings.\n\n*   **Responsive Design:** Provides a good user experience on both mobile and desktop devices.\n    *   **Function:** Adapts the user interface to different screen sizes.\n    *   **Usage:** Access the tool on any device, and the interface will adjust accordingly.","faq":null,"created_at":"2025-04-06T08:03:12+00:00","updated_at":"2025-08-08T09:02:53+00:00","source_url":"https://model-context-protocol.com/clients/revornix","related_articles":[]}