Deploy LibreChat to Hugging Face Spaces

- Add Dockerfile for LibreChat deployment
- Add environment configuration (secrets removed)
- Add setup documentation
- Configure for external MongoDB Atlas
- Set up for Hugging Face Spaces port 7860

.env.production

@@ -0,0 +1,75 @@
+# Environment Configuration for LibreChat on Hugging Face Spaces
+
+
+# Server Configuration
+HOST=0.0.0.0
+PORT=7860
+SERVER_HOST=localhost
+
+# MongoDB Configuration (Use MongoDB Atlas)
+# Set MONGO_URI in Hugging Face Secrets
+MONGO_URI=
+
+# Redis Configuration (Optional - Use Redis Cloud)
+USE_REDIS=false
+# REDIS_URI=redis://YOUR_REDIS_HOST:6379
+# REDIS_USERNAME=your_redis_username
+# REDIS_PASSWORD=your_redis_password
+
+# File Upload Configuration
+UPLOAD_DIR=/data/uploads
+LOGS_DIR=/data/logs
+IMAGES_DIR=/data/images
+
+# JWT Secret (Generate a secure random string)
+# Set JWT_SECRET in Hugging Face Secrets
+JWT_SECRET=
+
+# Encryption Keys (Generate secure random strings)
+# Set CREDS_KEY and CREDS_IV in Hugging Face Secrets
+CREDS_KEY=
+CREDS_IV=
+
+# App Configuration
+APP_TITLE=LibreChat
+ALLOW_REGISTRATION=true
+ALLOW_SOCIAL_LOGIN=false
+
+# Search Configuration (Disable Meilisearch for simplicity)
+SEARCH=false
+
+# RAG Configuration (Disable for simplicity)
+RAG_API_URL=
+
+# Model Configuration (Add your API keys)
+# OpenAI
+OPENAI_API_KEY=
+# OPENAI_MODELS=gpt-3.5-turbo,gpt-4
+
+# Anthropic
+ANTHROPIC_API_KEY=
+# ANTHROPIC_MODELS=claude-2,claude-instant
+
+# Google
+GOOGLE_KEY=
+# GOOGLE_MODELS=gemini-pro
+
+# Azure OpenAI
+# AZURE_API_KEY=
+# AZURE_OPENAI_API_INSTANCE_NAME=
+# AZURE_OPENAI_API_VERSION=
+
+# Other providers...
+# Check LibreChat documentation for more providers
+
+# Security
+SESSION_EXPIRY=1000 * 60 * 60 * 24 * 7 # 7 days
+REFRESH_TOKEN_EXPIRY=1000 * 60 * 60 * 24 * 7 # 7 days
+
+# Logging
+DEBUG_LOGGING=false
+DEBUG_CONSOLE=false
+
+# File Service Configuration
+FILE_SIZE_LIMIT=20
+FIREBASE_UPLOAD_SIZE_LIMIT=20

.gitignore

@@ -0,0 +1,35 @@
+# Environment files with secrets
+.env
+.env.local
+.env.*.local
+
+# Data directories
+data/
+uploads/
+logs/
+images/
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# IDE files
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Temporary files
+*.tmp
+*.temp
+*.log
+
+# Node modules (if testing locally)
+node_modules/
+
+# Build artifacts
+dist/
+build/
+
+# Local testing files
+docker-compose.local.yml

Dockerfile

@@ -0,0 +1,49 @@
+FROM node:20-slim
+
+# Install dependencies
+RUN apt-get update && apt-get install -y \
+    git \
+    python3 \
+    build-essential \
+    && rm -rf /var/lib/apt/lists/*
+
+# Create non-root user (Hugging Face requires UID 1000)
+RUN useradd -m -u 1000 -s /bin/bash user
+
+# Set working directory
+WORKDIR /app
+
+# Clone LibreChat repository
+RUN git clone https://github.com/danny-avila/LibreChat.git . && \
+    chown -R user:user /app
+
+# Switch to non-root user
+USER user
+
+# Install dependencies
+RUN npm ci
+
+# Build the application
+RUN npm run build
+
+# Create necessary directories with proper permissions
+RUN mkdir -p /app/uploads /app/logs /app/images && \
+    chmod 755 /app/uploads /app/logs /app/images
+
+# Copy environment configuration
+COPY --chown=user:user .env.production /app/.env
+
+# Expose the port (Hugging Face Spaces default)
+EXPOSE 7860
+
+# Set environment variables for Hugging Face Spaces
+ENV HOST=0.0.0.0
+ENV PORT=7860
+ENV NODE_ENV=production
+
+# Health check
+HEALTHCHECK --interval=30s --timeout=10s --start-period=5s --retries=3 \
+    CMD node -e "require('http').get('http://localhost:7860/health', (res) => { process.exit(res.statusCode === 200 ? 0 : 1); })"
+
+# Start the application
+CMD ["npm", "start"]

README.md

@@ -8,4 +8,47 @@ pinned: false
 short_description: librechat docker
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# LibreChat on Hugging Face Spaces
+
+Deploy your own instance of LibreChat on Hugging Face Spaces with external database support.
+
+## Quick Start
+
+1. **Fork/Duplicate this Space**
+2. **Set up MongoDB Atlas** (free tier)
+   - Create account at [MongoDB Atlas](https://www.mongodb.com/cloud/atlas)
+   - Create a free M0 cluster
+   - Get your connection string
+3. **Configure Secrets** in Space Settings:
+   - `MONGO_URI`: Your MongoDB connection string
+   - `JWT_SECRET`: Random 32+ character string
+   - `CREDS_KEY`: Random 32 character string
+   - `CREDS_IV`: Random 16 character string
+   - Add your AI provider API keys (e.g., `OPENAI_API_KEY`)
+4. **Enable Persistent Storage** (optional but recommended)
+
+## Features
+
+- Multi-model AI chat interface (OpenAI, Anthropic, Google, etc.)
+- User authentication and management
+- Conversation history
+- File uploads (with persistent storage)
+- External database support
+
+## Documentation
+
+- [Setup Guide](./SETUP_GUIDE.md) - Detailed deployment instructions
+- [LibreChat Docs](https://www.librechat.ai/docs) - Official documentation
+- [Configuration Reference](https://huggingface.co/docs/hub/spaces-config-reference) - Hugging Face Spaces
+
+## Architecture
+
+- **Frontend + Backend**: Single Docker container
+- **Database**: MongoDB Atlas (external)
+- **Cache**: Redis Cloud (optional, external)
+- **Storage**: Hugging Face persistent storage for uploads
+
+## Support
+
+For issues specific to this Hugging Face deployment, please open an issue in this Space.
+For LibreChat issues, visit the [main repository](https://github.com/danny-avila/LibreChat).

SETUP_GUIDE.md

@@ -0,0 +1,161 @@
+# LibreChat Deployment on Hugging Face Spaces
+
+This guide explains how to deploy LibreChat on Hugging Face Spaces using Docker.
+
+## Architecture Overview
+
+- **Single Container**: Frontend and backend run in one Docker container
+- **External Database**: MongoDB Atlas (cloud-hosted)
+- **External Cache** (Optional): Redis Cloud
+- **File Storage**: Uses Hugging Face Spaces `/data` directory (requires persistent storage upgrade)
+
+## Prerequisites
+
+1. **MongoDB Atlas Account** (Free tier available)
+   - Sign up at: https://www.mongodb.com/cloud/atlas
+   
+2. **Redis Cloud Account** (Optional, free tier available)
+   - Sign up at: https://redis.com/try-free/
+
+3. **AI Model API Keys** (At least one)
+   - OpenAI: https://platform.openai.com/
+   - Anthropic: https://console.anthropic.com/
+   - Google: https://makersuite.google.com/app/apikey
+   - Others as needed
+
+## Setup Steps
+
+### 1. Set up MongoDB Atlas
+
+1. Create a new project in MongoDB Atlas
+2. Create a free cluster (M0 Sandbox)
+3. Create a database user with password
+4. Add IP whitelist: `0.0.0.0/0` (allows access from anywhere)
+5. Get your connection string from "Connect" button
+   - Format: `mongodb+srv://username:password@cluster.mongodb.net/librechat?retryWrites=true`
+
+### 2. Configure Environment Variables
+
+Edit `.env.production` file:
+
+```bash
+# Required: MongoDB connection
+MONGO_URI=mongodb+srv://YOUR_USERNAME:YOUR_PASSWORD@YOUR_CLUSTER.mongodb.net/librechat?retryWrites=true
+
+# Required: Security keys (generate random strings)
+JWT_SECRET=<generate-32-char-random-string>
+CREDS_KEY=<generate-32-char-random-string>
+CREDS_IV=<generate-16-char-random-string>
+
+# Required: At least one AI provider API key
+OPENAI_API_KEY=sk-...
+# or
+ANTHROPIC_API_KEY=sk-ant-...
+# or other providers
+```
+
+### 3. Deploy to Hugging Face Spaces
+
+1. Create a new Space on Hugging Face
+2. Choose "Docker" as the SDK
+3. Upload these files:
+   - `Dockerfile`
+   - `.env.production`
+   - `README.md` (already configured)
+
+4. Set up Secrets in Space Settings:
+   - Add sensitive environment variables as secrets
+   - They'll override values in `.env.production`
+
+### 4. Enable Persistent Storage (Recommended)
+
+In your Space settings:
+- Enable "Persistent storage" upgrade
+- This ensures uploaded files and logs persist across restarts
+
+## Configuration Options
+
+### Basic Setup (Minimum Requirements)
+- MongoDB Atlas (external)
+- One AI provider API key
+- JWT and encryption keys
+
+### Advanced Setup (Optional)
+- Redis Cloud for caching
+- Multiple AI providers
+- Custom branding
+- Authentication providers
+
+### Disabled Features (for simplicity)
+- Meilisearch (search functionality)
+- RAG API (vector database features)
+- Local MongoDB/Redis instances
+
+## Environment Variables Reference
+
+Key variables to configure:
+
+```bash
+# Database
+MONGO_URI=              # MongoDB Atlas connection string
+
+# Caching (optional)
+USE_REDIS=false         # Set to true if using Redis
+REDIS_URI=              # Redis Cloud connection string
+
+# Security
+JWT_SECRET=             # 32+ character random string
+CREDS_KEY=              # 32 character string
+CREDS_IV=               # 16 character string
+
+# AI Providers (configure as needed)
+OPENAI_API_KEY=
+ANTHROPIC_API_KEY=
+GOOGLE_KEY=
+# ... other providers
+
+# App Settings
+ALLOW_REGISTRATION=true # Allow new user signups
+APP_TITLE=LibreChat     # Custom app title
+```
+
+## Limitations
+
+1. **No Built-in Databases**: Hugging Face Spaces isn't suitable for running MongoDB/Redis
+2. **Persistent Storage**: Requires paid upgrade for file persistence
+3. **Single Container**: Can't use docker-compose multi-service setup
+4. **Port Restrictions**: Must use port 7860 (Hugging Face default)
+
+## Troubleshooting
+
+### Container Won't Start
+- Check logs in Hugging Face Spaces
+- Verify MongoDB connection string
+- Ensure all required environment variables are set
+
+### Can't Connect to MongoDB
+- Verify IP whitelist includes `0.0.0.0/0`
+- Check username/password are correct
+- Ensure connection string format is correct
+
+### Files Don't Persist
+- Enable persistent storage in Space settings
+- Verify upload directories use `/data` prefix
+
+## Security Considerations
+
+1. **Use Secrets**: Store sensitive data in Hugging Face Secrets, not in files
+2. **MongoDB Security**: In production, restrict IP whitelist to specific IPs
+3. **Strong Keys**: Generate cryptographically secure random strings for JWT/encryption
+4. **HTTPS**: Hugging Face Spaces provides HTTPS by default
+
+## Next Steps
+
+After deployment:
+1. Access your Space URL
+2. Create an admin account (first user)
+3. Configure additional settings in the UI
+4. Test AI model integrations
+
+For advanced configuration, refer to LibreChat documentation:
+https://www.librechat.ai/docs