Skip to content

Repository files navigation

πŸš€ MemCloud

One-Click MemMachine Deployments Across Any Cloud

Deploy AI-powered memory systems to GCP, AWS, or Azure in under 20 minutes

Production Ready Multi-Cloud Documentation License

🎯 Quick Start β€’ πŸ“š Documentation β€’ ☁️ Choose Cloud β€’ πŸ”§ Features β€’ 🀝 Contributing


🎯 What is MemCloud?

MemCloud is a production-ready platform that enables one-click deployments of MemMachine instances across any major cloud provider. Built for the MemVerge hackathon and designed for enterprise adoption.

🎨 Beautiful Dashboard

Deploy and manage MemMachine instances through an intuitive Next.js interface

⚑ Lightning Fast

From zero to production in ~20 minutes with copy-paste commands

πŸ’° Cost Optimized

Scale-to-zero support. Pay only for what you use. Starting at $15/month


⭐ Key Features

Feature Description
🌐 Multi-Cloud Deploy to GCP, AWS, or Azure with identical commands
🐳 Custom Docker Image Pre-built with PostgreSQL support (psycopg2 fix)
πŸ”— Neo4j Aura Integration No infrastructure management, just works
πŸ“Š Real-Time Monitoring Track deployment status and instance health
πŸ”’ Production-Ready Security, monitoring, backups included
πŸ“– Elite Documentation 25+ troubleshooting scenarios documented

πŸš€ Quick Start

Choose Your Cloud and Deploy in 3 Steps

Google Cloud

$15-30/month ⚑ Fastest 🎯 Easiest

Deploy to GCP

Amazon Web Services

$45-65/month 🏒 Enterprise πŸ” Compliance

Deploy to AWS

Microsoft Azure

$30-55/month πŸ’Ό Microsoft Shops πŸ”§ .NET Integration

Deploy to Azure

Not sure which to choose? β†’ Cloud Comparison Guide


πŸ“š Documentation

Document Purpose Audience
README_DEPLOYMENT.md πŸ“– Start here - Overview & quick start Everyone
DEPLOYMENT_MASTER_INDEX.md ☁️ Cloud comparison & decision guide Decision makers
DEPLOY_GCP.md πŸ”΅ Step-by-step GCP deployment GCP users
DEPLOY_AWS.md 🟠 Step-by-step AWS deployment AWS users
DEPLOY_AZURE.md πŸ”· Step-by-step Azure deployment Azure users
TROUBLESHOOTING_RUNBOOK.md πŸ› Error reference (25+ scenarios) When things break
SECURITY.md πŸ”’ Security best practices DevOps & Security
DIRECTORY_STRUCTURE.md πŸ“ Repository organization Contributors

πŸ—οΈ Architecture

β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚                      🌐 User Browser                         β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                  β”‚ HTTPS
                  β–Ό
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚           πŸ“± Frontend Dashboard (Next.js)                    β”‚
β”‚           β€’ Instance Management                              β”‚
β”‚           β€’ Real-time Deployment Status                      β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
                  β”‚ REST API
                  β–Ό
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚            βš™οΈ Backend API (FastAPI)                          β”‚
β”‚            β€’ Deployment Orchestration                        β”‚
β”‚            β€’ Multi-Cloud Support                             β”‚
β””β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
      β”‚                                     β”‚
      β”‚ Orchestrates                        β”‚ Stores Metadata
      β–Ό                                     β–Ό
β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”          β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”
β”‚ 🧠 MemMachine       β”‚          β”‚   πŸ—„οΈ PostgreSQL         β”‚
β”‚    Instance         β”‚          β”‚   Database               β”‚
β”‚    (Cloud Run/      β”‚          β”‚   β€’ Instance tracking    β”‚
β”‚     Fargate/ACI)    β”‚          β”‚   β€’ User data            β”‚
β”‚                     β”‚          β”‚   β€’ API keys             β”‚
β”‚  +                  β”‚          β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜
β”‚ πŸ“Š Neo4j Aura       β”‚
β”‚    (External SaaS)  β”‚
β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜

πŸ”§ What Makes This Special?

1. 🐳 Custom Docker Image with PostgreSQL Support

The game-changing discovery that took 6+ attempts to solve

MemMachine's official image lacks PostgreSQL support. We solved it:

# Install psycopg2 to the EXACT location where MemMachine expects it
RUN /usr/local/bin/python3 -m pip install --no-cache-dir \
    --target=/app/.venv/lib/python3.12/site-packages \
    psycopg2-binary

Why this matters:

  • βœ… Works with Cloud SQL, RDS, Azure Database for PostgreSQL
  • βœ… Same image works across ALL clouds
  • βœ… No runtime installation (fast startup)
  • βœ… Production-tested and verified

πŸ“¦ Location: memmachine-docker/

πŸ“– How to build the custom image
# For GCP
cd memmachine-docker
docker build -t gcr.io/$PROJECT_ID/memmachine-custom:latest .
docker push gcr.io/$PROJECT_ID/memmachine-custom:latest

# For AWS
docker build -t $AWS_ACCOUNT_ID.dkr.ecr.$REGION.amazonaws.com/memmachine-custom:latest .
docker push $AWS_ACCOUNT_ID.dkr.ecr.$REGION.amazonaws.com/memmachine-custom:latest

# For Azure
docker build -t $ACR_LOGIN_SERVER/memmachine-custom:latest .
docker push $ACR_LOGIN_SERVER/memmachine-custom:latest

Full instructions in memmachine-docker/README.md


2. πŸ”— Neo4j Aura Integration (Zero Infrastructure)

Before After
❌ Self-host Neo4j on Cloud Run βœ… Use Neo4j Aura (managed SaaS)
❌ VPC networking complexity βœ… Works immediately
❌ $100+/month βœ… $0-65/month (free tier available)
❌ Manual scaling & backups βœ… Fully managed

Simply provide your Neo4j Aura credentials:

{
  "neo4j_uri": "neo4j+s://xxxxx.databases.neo4j.io",
  "neo4j_user": "neo4j",
  "neo4j_password": "your-password"
}

Get Neo4j Aura: https://neo4j.com/cloud/aura/ (Free tier available)


3. πŸ“Š Comprehensive Documentation

Documentation Stats Guides Errors Success Rate

  • βœ… Copy-paste commands that work
  • βœ… Verification at every step
  • βœ… Troubleshooting for 25+ errors
  • βœ… Production checklists
  • βœ… Security best practices

☁️ Deployment Options

Cloud Provider Comparison

Feature πŸ”΅ GCP 🟠 AWS πŸ”· Azure
Container Platform Cloud Run ECS Fargate Container Instances
Database Cloud SQL RDS PostgreSQL Azure DB for PostgreSQL
Monthly Cost $15-30 πŸ† $45-65 $30-55
Deployment Time ~20 min πŸ† ~25 min ~20 min
Scale to Zero βœ… Native βœ… Native ⚠️ Requires Container Apps
Free Tier $300 (90 days) 12 months $200 (30 days)
Best For Startups, MVPs Enterprise, Compliance Microsoft Shops

πŸ† Winner: GCP for cost and simplicity πŸ’Ό Runner-up: AWS for enterprise features πŸ”· Alternative: Azure for Microsoft ecosystem

See detailed comparison β†’


πŸ’» Technology Stack

Backend

Python FastAPI SQLAlchemy PostgreSQL

Frontend

Next.js React TypeScript TailwindCSS

Infrastructure

Docker Neo4j GCP AWS Azure


🎬 Getting Started

Prerequisites

  • ☁️ Cloud account (GCP, AWS, or Azure)
  • 🐳 Docker installed locally
  • πŸ”‘ Neo4j Aura account (free tier available)
  • βš™οΈ Cloud CLI installed (gcloud, aws, or az)

Installation

# 1. Clone the repository
git clone https://github.com/yourusername/memcloud.git
cd memcloud

# 2. Choose your cloud and follow the guide
# For GCP:
open DEPLOY_GCP.md

# For AWS:
open DEPLOY_AWS.md

# For Azure:
open DEPLOY_AZURE.md

Deployment Flow

Step 1: πŸ“– Read deployment guide for your cloud Step 2: πŸ”§ Setup cloud account and enable APIs Step 3: 🐳 Build custom Docker image with psycopg2 Step 4: πŸ—„οΈ Deploy PostgreSQL database Step 5: πŸš€ Deploy backend and frontend services Step 6: βœ… Verify deployment and test Step 7: πŸŽ‰ Production ready!


πŸ“Š Project Stats

Metric Count
πŸ“„ Lines of Documentation 15,000+
πŸ—‚οΈ Deployment Guides 5 (GCP, AWS, Azure + 2 reference)
πŸ› Errors Documented 25+ with solutions
☁️ Cloud Providers 3 (GCP, AWS, Azure)
⏱️ Deployment Time ~20 minutes
πŸ’° Starting Cost $15/month
βœ… Success Rate 100% (when following guides)

πŸ”’ Security

All credentials are managed securely:

  • βœ… No hardcoded API keys or passwords
  • βœ… Environment variables and secret managers
  • βœ… Comprehensive .gitignore
  • βœ… Security documentation included

See: SECURITY.md for full guidelines.


🀝 Contributing

We welcome contributions! Here's how:

  1. 🍴 Fork the repository
  2. 🌿 Create a feature branch (git checkout -b feature/amazing-feature)
  3. πŸ’Ύ Commit your changes (git commit -m 'Add amazing feature')
  4. πŸ“€ Push to the branch (git push origin feature/amazing-feature)
  5. πŸŽ‰ Open a Pull Request

πŸ“ License

This project is licensed under the MIT License - see the LICENSE file for details.


🌟 Acknowledgments

Built for the MemVerge Hackathon πŸ†

Special thanks to:

  • 🧠 MemVerge for MemMachine
  • πŸ“Š Neo4j for Aura
  • ☁️ GCP, AWS, Azure for cloud platforms

πŸ“ž Support

Need Help?

Documentation Issues Discussions


πŸš€ Ready to Deploy?

Choose your cloud and get started in 20 minutes!

Deploy to GCP Deploy to AWS Deploy to Azure

Made with ❀️ for the MemVerge community

⭐ Star us on GitHub if this helped you!

About

Hackathon Cloud Instance of MemMachine

Resources

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages