This project provides a self-hostable mirror for Grok, enabling multi-user access and management of Grok services. It aims to offer an experience equivalent to the official Grok website, including a compatible OpenAI-like chat API, allowing users to access Grok functionalities without needing to bypass geographical restrictions.

How It Works

The mirror operates by leveraging SSO tokens to authenticate users with Grok's official services. It acts as a gateway, abstracting the underlying Grok access and providing a unified interface. This approach allows multiple users to share a single backend instance, simplifying management and access. The system also supports an API endpoint (/v1/chat/completions) that mimics OpenAI's chat API format, facilitating integration with other applications.

Quick Start & Requirements

• Primary install / run command: docker run --rm -p 50005:8080 -v grok_gateway_db:/app/.cache_data dairoot/grok-gateway:latest
• Prerequisites: Docker.
• Access: http://127.0.0.1:50005 or http://<external_ip>:50005.
• Configuration: Environment variables for ADMIN_PASSWORD, AUTHORIZATION (SSO Token), ENABLE_MIRROR_API, MIRROR_API_PREFIX, API_HATD, PROXY_URL_POOL, HOST, and GOOGLEADS.
• Documentation: Full deployment process and API details.

Highlighted Details

• Provides an OpenAI-compatible /v1/chat/completions API endpoint.
• Supports streaming responses for chat interactions.
• Allows configuration of proxy pools for network access.
• Offers multi-account management via SSO tokens.

Maintenance & Community

• Project maintainer: dairoot.
• Community links: Telegram group.

Licensing & Compatibility

• License: Not explicitly stated in the README.
• Compatibility: Designed for self-hosting; commercial use implications are unclear due to the unstated license.

Limitations & Caveats

The project's license is not specified, which may impact commercial use or redistribution. The README mentions a daily limit of 200 requests for the chat API to prevent abuse, and the AUTHORIZATION environment variable is crucial for API access, requiring a valid Grok SSO token.