git-memory

git-memory exposes HTTP endpoints to manage Git repositories over REST, plus a WebSocket channel for real-time updates. It protects critical operations with an API key (required in production) and can be restricted to specific repository paths via a whitelist. You can perform common Git operations such as status, fetch, rebase, clone, push, pull, merge, and branch management through the /git/* endpoints. The server also provides repository statistics and diff views, and offers WebSocket-based real-time notifications for repository events and tool executions. Use the health and metrics endpoints to monitor the service, and consider enabling TLS behind a reverse proxy for production deployments.

Prerequisites:

• Redis server up and running (systemd: sudo systemctl start redis-server; macOS: brew services start redis; Windows: redis-server)
• Node.js (v18+ recommended)
• Git (for operations when interacting with repositories)

Install and run:

1. Install dependencies npm install

2. Configure environment

   • Create a .env file or set environment variables: GIT_MEMORY_API_KEY=your-secret-api-key-here GIT_MEMORY_ALLOWED_REPOS=/path/to/repo1:/path/to/repo2

3. Start the server npm run start or node server.js

4. Verify the server is running

   • Health check: curl http://localhost:3000/health
   • Metrics: curl http://localhost:3000/metrics

5. Optional: Run in production with a process manager (PM2) and a reverse proxy (NGINX/ Traefik) for TLS termination.

Security: Always set GIT_MEMORY_API_KEY in production and restrict access to allowed repositories via GIT_MEMORY_ALLOWED_REPOS. Use HTTPS in production behind a reverse proxy. Rotate API keys periodically and monitor the /metrics endpoint for unusual activity. Logs are typically found in the application's log directory or stdout/stderr depending on your process manager. If you deploy behind Kubernetes, ensure environment variables are configured in your deployment manifests and that Redis is accessible from the cluster.