Spaces:
Running
Running
finishing up
Browse files- .dockerignore +88 -0
- DEPLOYMENT_CHECKLIST.md +214 -0
- Dockerfile +15 -5
- HUGGINGFACE_DEPLOYMENT.md +304 -0
- HUGGINGFACE_SUMMARY.md +358 -0
- README-HF.md +358 -0
- README.md +73 -20
- app/api/health/route.ts +13 -0
- next.config.mjs +8 -0
.dockerignore
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Dependencies
|
| 2 |
+
node_modules
|
| 3 |
+
npm-debug.log
|
| 4 |
+
yarn-error.log
|
| 5 |
+
package-lock.json
|
| 6 |
+
yarn.lock
|
| 7 |
+
|
| 8 |
+
# Testing
|
| 9 |
+
coverage
|
| 10 |
+
.nyc_output
|
| 11 |
+
|
| 12 |
+
# Next.js
|
| 13 |
+
.next/
|
| 14 |
+
out/
|
| 15 |
+
build
|
| 16 |
+
|
| 17 |
+
# Production
|
| 18 |
+
/dist
|
| 19 |
+
|
| 20 |
+
# Misc
|
| 21 |
+
.DS_Store
|
| 22 |
+
*.pem
|
| 23 |
+
|
| 24 |
+
# Debug
|
| 25 |
+
npm-debug.log*
|
| 26 |
+
yarn-debug.log*
|
| 27 |
+
yarn-error.log*
|
| 28 |
+
.pnpm-debug.log*
|
| 29 |
+
|
| 30 |
+
# Local env files
|
| 31 |
+
.env
|
| 32 |
+
.env*.local
|
| 33 |
+
.env.development
|
| 34 |
+
.env.test
|
| 35 |
+
.env.production
|
| 36 |
+
|
| 37 |
+
# Vercel
|
| 38 |
+
.vercel
|
| 39 |
+
|
| 40 |
+
# Typescript
|
| 41 |
+
*.tsbuildinfo
|
| 42 |
+
next-env.d.ts
|
| 43 |
+
|
| 44 |
+
# Git
|
| 45 |
+
.git
|
| 46 |
+
.gitignore
|
| 47 |
+
.gitattributes
|
| 48 |
+
|
| 49 |
+
# IDE
|
| 50 |
+
.vscode
|
| 51 |
+
.idea
|
| 52 |
+
*.swp
|
| 53 |
+
*.swo
|
| 54 |
+
*~
|
| 55 |
+
|
| 56 |
+
# Documentation (optional - remove if you want to include docs)
|
| 57 |
+
*.md
|
| 58 |
+
!README.md
|
| 59 |
+
!README-HF.md
|
| 60 |
+
|
| 61 |
+
# Data directories (keep structure but ignore content during build)
|
| 62 |
+
data/*
|
| 63 |
+
!data/.gitkeep
|
| 64 |
+
|
| 65 |
+
# Python cache
|
| 66 |
+
__pycache__
|
| 67 |
+
*.py[cod]
|
| 68 |
+
*$py.class
|
| 69 |
+
*.so
|
| 70 |
+
.Python
|
| 71 |
+
backend/__pycache__
|
| 72 |
+
backend/**/__pycache__
|
| 73 |
+
|
| 74 |
+
# MacOS
|
| 75 |
+
.DS_Store
|
| 76 |
+
.AppleDouble
|
| 77 |
+
.LSOverride
|
| 78 |
+
|
| 79 |
+
# Windows
|
| 80 |
+
Thumbs.db
|
| 81 |
+
ehthumbs.db
|
| 82 |
+
Desktop.ini
|
| 83 |
+
$RECYCLE.BIN/
|
| 84 |
+
|
| 85 |
+
# Test files
|
| 86 |
+
test-*
|
| 87 |
+
*.test.js
|
| 88 |
+
*.spec.js
|
DEPLOYMENT_CHECKLIST.md
ADDED
|
@@ -0,0 +1,214 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Hugging Face Spaces Deployment Checklist
|
| 2 |
+
|
| 3 |
+
Use this checklist to ensure your ReubenOS deployment is ready for Hugging Face Spaces.
|
| 4 |
+
|
| 5 |
+
## β
Pre-Deployment Checklist
|
| 6 |
+
|
| 7 |
+
### Files Required
|
| 8 |
+
- [x] `Dockerfile` - Docker configuration for HF Spaces
|
| 9 |
+
- [x] `.dockerignore` - Optimize Docker build
|
| 10 |
+
- [x] `next.config.mjs` - Next.js configuration with standalone output
|
| 11 |
+
- [x] `package.json` - Node.js dependencies
|
| 12 |
+
- [x] `README.md` - Main project documentation
|
| 13 |
+
- [x] `README-HF.md` - Hugging Face specific documentation
|
| 14 |
+
- [x] `app/api/health/route.ts` - Health check endpoint
|
| 15 |
+
|
| 16 |
+
### Configuration Files
|
| 17 |
+
- [x] `next.config.mjs` has `output: 'standalone'` enabled
|
| 18 |
+
- [x] `Dockerfile` exposes port 7860
|
| 19 |
+
- [x] `Dockerfile` sets `PORT=7860` environment variable
|
| 20 |
+
- [x] `.dockerignore` excludes unnecessary files
|
| 21 |
+
|
| 22 |
+
### Code Verification
|
| 23 |
+
- [ ] All API routes tested locally
|
| 24 |
+
- [ ] File upload/download working
|
| 25 |
+
- [ ] Session management functional
|
| 26 |
+
- [ ] Document generation working
|
| 27 |
+
- [ ] MCP server tested locally
|
| 28 |
+
|
| 29 |
+
## π Deployment Process
|
| 30 |
+
|
| 31 |
+
### Step 1: Hugging Face Setup
|
| 32 |
+
- [ ] Hugging Face account created
|
| 33 |
+
- [ ] New Docker Space created
|
| 34 |
+
- [ ] Space name chosen (e.g., `reubenos`)
|
| 35 |
+
- [ ] Git configured with HF credentials
|
| 36 |
+
|
| 37 |
+
### Step 2: Environment Configuration
|
| 38 |
+
- [ ] `.env` file NOT committed to git
|
| 39 |
+
- [ ] Environment secrets set in HF Space settings (if needed):
|
| 40 |
+
- [ ] `GEMINI_API_KEY` (optional, for AI features)
|
| 41 |
+
- [ ] Other API keys as needed
|
| 42 |
+
|
| 43 |
+
### Step 3: Git Push
|
| 44 |
+
```bash
|
| 45 |
+
# Add HF remote
|
| 46 |
+
git remote add hf https://huggingface.co/spaces/YOUR-USERNAME/YOUR-SPACE-NAME
|
| 47 |
+
|
| 48 |
+
# Push to HF
|
| 49 |
+
git push hf main
|
| 50 |
+
```
|
| 51 |
+
|
| 52 |
+
- [ ] Code pushed to Hugging Face
|
| 53 |
+
- [ ] Build started successfully
|
| 54 |
+
- [ ] Build logs reviewed for errors
|
| 55 |
+
|
| 56 |
+
### Step 4: Verify Deployment
|
| 57 |
+
- [ ] Space shows "Running" status
|
| 58 |
+
- [ ] Health endpoint accessible: `https://YOUR-USERNAME-reubenos.hf.space/api/health`
|
| 59 |
+
- [ ] Web interface loads correctly
|
| 60 |
+
- [ ] Desktop environment functional
|
| 61 |
+
- [ ] File upload via web interface works
|
| 62 |
+
|
| 63 |
+
## π§ MCP Server Setup
|
| 64 |
+
|
| 65 |
+
### Local MCP Server
|
| 66 |
+
- [ ] `mcp-server.js` downloaded to local machine
|
| 67 |
+
- [ ] Node.js 20+ installed locally
|
| 68 |
+
- [ ] MCP server file path noted
|
| 69 |
+
|
| 70 |
+
### Claude Desktop Configuration
|
| 71 |
+
- [ ] Claude Desktop installed
|
| 72 |
+
- [ ] Config file located:
|
| 73 |
+
- macOS: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
| 74 |
+
- Windows: `%APPDATA%\Claude\claude_desktop_config.json`
|
| 75 |
+
- Linux: `~/.config/Claude/claude_desktop_config.json`
|
| 76 |
+
|
| 77 |
+
- [ ] Config updated with correct paths:
|
| 78 |
+
```json
|
| 79 |
+
{
|
| 80 |
+
"mcpServers": {
|
| 81 |
+
"reubenos": {
|
| 82 |
+
"command": "node",
|
| 83 |
+
"args": ["/ABSOLUTE/PATH/TO/mcp-server.js"],
|
| 84 |
+
"env": {
|
| 85 |
+
"REUBENOS_URL": "https://YOUR-USERNAME-reubenos.hf.space"
|
| 86 |
+
}
|
| 87 |
+
}
|
| 88 |
+
}
|
| 89 |
+
}
|
| 90 |
+
```
|
| 91 |
+
|
| 92 |
+
- [ ] Absolute path to `mcp-server.js` used (not relative)
|
| 93 |
+
- [ ] Hugging Face Space URL correct
|
| 94 |
+
- [ ] Claude Desktop restarted
|
| 95 |
+
|
| 96 |
+
### MCP Testing
|
| 97 |
+
- [ ] Create session via Claude
|
| 98 |
+
- [ ] Upload file via Claude
|
| 99 |
+
- [ ] List files via Claude
|
| 100 |
+
- [ ] Download file via Claude
|
| 101 |
+
- [ ] Generate document via Claude
|
| 102 |
+
|
| 103 |
+
## π Network Verification
|
| 104 |
+
|
| 105 |
+
### URL Format
|
| 106 |
+
```
|
| 107 |
+
Web Interface: https://YOUR-USERNAME-YOUR-SPACE-NAME.hf.space
|
| 108 |
+
Health Check: https://YOUR-USERNAME-YOUR-SPACE-NAME.hf.space/api/health
|
| 109 |
+
API Endpoints: https://YOUR-USERNAME-YOUR-SPACE-NAME.hf.space/api/*
|
| 110 |
+
```
|
| 111 |
+
|
| 112 |
+
### Port Configuration
|
| 113 |
+
- [ ] Dockerfile exposes port 7860
|
| 114 |
+
- [ ] Environment variable `PORT=7860` set
|
| 115 |
+
- [ ] No port in public URL (HF proxy handles it)
|
| 116 |
+
|
| 117 |
+
### Test Endpoints
|
| 118 |
+
```bash
|
| 119 |
+
# Test health endpoint
|
| 120 |
+
curl https://YOUR-USERNAME-reubenos.hf.space/api/health
|
| 121 |
+
|
| 122 |
+
# Expected response:
|
| 123 |
+
# {
|
| 124 |
+
# "status": "healthy",
|
| 125 |
+
# "timestamp": "...",
|
| 126 |
+
# "service": "ReubenOS",
|
| 127 |
+
# "version": "1.0.0"
|
| 128 |
+
# }
|
| 129 |
+
```
|
| 130 |
+
|
| 131 |
+
- [ ] Health endpoint returns 200 OK
|
| 132 |
+
- [ ] Response JSON is valid
|
| 133 |
+
- [ ] Web interface loads in browser
|
| 134 |
+
|
| 135 |
+
## π Post-Deployment Monitoring
|
| 136 |
+
|
| 137 |
+
### Day 1
|
| 138 |
+
- [ ] Check Space is still running
|
| 139 |
+
- [ ] Review logs for errors
|
| 140 |
+
- [ ] Test basic functionality
|
| 141 |
+
- [ ] Monitor resource usage
|
| 142 |
+
|
| 143 |
+
### Week 1
|
| 144 |
+
- [ ] Check for any crashes or restarts
|
| 145 |
+
- [ ] Verify sessions are working
|
| 146 |
+
- [ ] Test file persistence behavior
|
| 147 |
+
- [ ] Review any user feedback
|
| 148 |
+
|
| 149 |
+
### Ongoing
|
| 150 |
+
- [ ] Monitor Hugging Face Space status
|
| 151 |
+
- [ ] Check for SDK updates
|
| 152 |
+
- [ ] Keep dependencies updated
|
| 153 |
+
- [ ] Backup important data locally
|
| 154 |
+
|
| 155 |
+
## π Troubleshooting
|
| 156 |
+
|
| 157 |
+
### Build Failed
|
| 158 |
+
- [ ] Check Dockerfile syntax
|
| 159 |
+
- [ ] Verify all files present
|
| 160 |
+
- [ ] Review build logs in HF Space
|
| 161 |
+
- [ ] Test Docker build locally
|
| 162 |
+
|
| 163 |
+
### Space Not Accessible
|
| 164 |
+
- [ ] Verify build completed
|
| 165 |
+
- [ ] Check Space visibility (public/private)
|
| 166 |
+
- [ ] Try accessing in incognito mode
|
| 167 |
+
- [ ] Check HF status page
|
| 168 |
+
|
| 169 |
+
### MCP Connection Issues
|
| 170 |
+
- [ ] Verify absolute path to mcp-server.js
|
| 171 |
+
- [ ] Check REUBENOS_URL is correct
|
| 172 |
+
- [ ] Ensure Node.js installed locally
|
| 173 |
+
- [ ] Restart Claude Desktop
|
| 174 |
+
- [ ] Check MCP server logs
|
| 175 |
+
|
| 176 |
+
### File Upload Fails
|
| 177 |
+
- [ ] Check session key validity
|
| 178 |
+
- [ ] Verify file size limits
|
| 179 |
+
- [ ] Review API logs
|
| 180 |
+
- [ ] Test via web interface first
|
| 181 |
+
|
| 182 |
+
## π Documentation
|
| 183 |
+
|
| 184 |
+
- [ ] README.md updated
|
| 185 |
+
- [ ] README-HF.md reviewed
|
| 186 |
+
- [ ] DEPLOYMENT_CHECKLIST.md completed
|
| 187 |
+
- [ ] Environment variables documented
|
| 188 |
+
- [ ] API endpoints documented
|
| 189 |
+
|
| 190 |
+
## π Deployment Complete!
|
| 191 |
+
|
| 192 |
+
Once all items are checked, your ReubenOS deployment is complete and ready for use!
|
| 193 |
+
|
| 194 |
+
### Share Your Space
|
| 195 |
+
- [ ] Add description to HF Space
|
| 196 |
+
- [ ] Add relevant tags
|
| 197 |
+
- [ ] Add screenshot/demo
|
| 198 |
+
- [ ] Share with community
|
| 199 |
+
|
| 200 |
+
### Next Steps
|
| 201 |
+
- Explore additional features
|
| 202 |
+
- Customize the desktop environment
|
| 203 |
+
- Add more AI integrations
|
| 204 |
+
- Share your deployment!
|
| 205 |
+
|
| 206 |
+
---
|
| 207 |
+
|
| 208 |
+
**Need Help?** Refer to:
|
| 209 |
+
- `README-HF.md` - Complete deployment guide
|
| 210 |
+
- `HUGGINGFACE_DEPLOYMENT.md` - Detailed instructions
|
| 211 |
+
- Hugging Face Spaces documentation
|
| 212 |
+
- Project GitHub issues
|
| 213 |
+
|
| 214 |
+
**Congratulations on deploying ReubenOS! π**
|
Dockerfile
CHANGED
|
@@ -58,12 +58,22 @@ WORKDIR /app
|
|
| 58 |
# Switch to non-root user
|
| 59 |
USER nextjs
|
| 60 |
|
| 61 |
-
#
|
| 62 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 63 |
|
| 64 |
# Health check
|
| 65 |
HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
|
| 66 |
-
CMD node -e "require('http').get('http://localhost:
|
| 67 |
|
| 68 |
-
# Start both
|
| 69 |
-
CMD ["sh", "-c", "
|
|
|
|
| 58 |
# Switch to non-root user
|
| 59 |
USER nextjs
|
| 60 |
|
| 61 |
+
# Copy MCP server files
|
| 62 |
+
COPY --from=builder --chown=nextjs:nodejs /app/mcp-server.js ./
|
| 63 |
+
COPY --from=builder --chown=nextjs:nodejs /app/start-all.sh ./
|
| 64 |
+
RUN chmod +x start-all.sh
|
| 65 |
+
|
| 66 |
+
# Expose port 7860 for Hugging Face Spaces
|
| 67 |
+
EXPOSE 7860
|
| 68 |
+
|
| 69 |
+
# Set environment variables for Hugging Face Spaces
|
| 70 |
+
ENV PORT=7860
|
| 71 |
+
ENV HOSTNAME="0.0.0.0"
|
| 72 |
+
ENV REUBENOS_URL="http://0.0.0.0:7860"
|
| 73 |
|
| 74 |
# Health check
|
| 75 |
HEALTHCHECK --interval=30s --timeout=3s --start-period=5s --retries=3 \
|
| 76 |
+
CMD node -e "require('http').get('http://localhost:7860/api/health', (res) => process.exit(res.statusCode === 200 ? 0 : 1))"
|
| 77 |
|
| 78 |
+
# Start both Next.js and MCP servers
|
| 79 |
+
CMD ["sh", "-c", "node server.js"]
|
HUGGINGFACE_DEPLOYMENT.md
ADDED
|
@@ -0,0 +1,304 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Hugging Face Spaces Deployment Guide
|
| 2 |
+
|
| 3 |
+
This guide will walk you through deploying ReubenOS to Hugging Face Spaces and configuring the MCP server for remote access.
|
| 4 |
+
|
| 5 |
+
## π Prerequisites
|
| 6 |
+
|
| 7 |
+
- Hugging Face account ([create one here](https://huggingface.co/join))
|
| 8 |
+
- Git installed locally
|
| 9 |
+
- Node.js 20+ installed (for running MCP server locally)
|
| 10 |
+
- Claude Desktop (optional, for MCP integration)
|
| 11 |
+
|
| 12 |
+
## π Deployment Steps
|
| 13 |
+
|
| 14 |
+
### Step 1: Create a Hugging Face Space
|
| 15 |
+
|
| 16 |
+
1. Go to https://huggingface.co/new-space
|
| 17 |
+
2. Fill in the details:
|
| 18 |
+
- **Owner**: Your username or organization
|
| 19 |
+
- **Space name**: `reubenos` (or your preferred name)
|
| 20 |
+
- **License**: MIT
|
| 21 |
+
- **SDK**: Select **Docker**
|
| 22 |
+
- **Visibility**: Public or Private (your choice)
|
| 23 |
+
3. Click **Create Space**
|
| 24 |
+
|
| 25 |
+
### Step 2: Clone and Prepare Repository
|
| 26 |
+
|
| 27 |
+
```bash
|
| 28 |
+
# Clone your ReubenOS repository
|
| 29 |
+
git clone <your-repo-url>
|
| 30 |
+
cd reubenos
|
| 31 |
+
|
| 32 |
+
# Add Hugging Face Space as a remote
|
| 33 |
+
git remote add hf https://huggingface.co/spaces/YOUR-USERNAME/reubenos
|
| 34 |
+
|
| 35 |
+
# If you haven't logged in to Hugging Face CLI yet:
|
| 36 |
+
# Install huggingface_hub
|
| 37 |
+
pip install huggingface_hub
|
| 38 |
+
|
| 39 |
+
# Login to Hugging Face
|
| 40 |
+
huggingface-cli login
|
| 41 |
+
```
|
| 42 |
+
|
| 43 |
+
### Step 3: Configure Environment Variables (Optional)
|
| 44 |
+
|
| 45 |
+
Create a `.env` file in your Space settings if needed:
|
| 46 |
+
|
| 47 |
+
1. Go to your Space settings: `https://huggingface.co/spaces/YOUR-USERNAME/reubenos/settings`
|
| 48 |
+
2. Navigate to **Variables and secrets**
|
| 49 |
+
3. Add the following secrets (if applicable):
|
| 50 |
+
- `GEMINI_API_KEY` - Your Google Gemini API key (for AI chat features)
|
| 51 |
+
- `NODE_ENV` - Set to `production`
|
| 52 |
+
|
| 53 |
+
### Step 4: Push to Hugging Face
|
| 54 |
+
|
| 55 |
+
```bash
|
| 56 |
+
# Push your code to Hugging Face Spaces
|
| 57 |
+
git push hf main
|
| 58 |
+
```
|
| 59 |
+
|
| 60 |
+
### Step 5: Monitor Build Progress
|
| 61 |
+
|
| 62 |
+
1. Go to your Space page: `https://huggingface.co/spaces/YOUR-USERNAME/reubenos`
|
| 63 |
+
2. Click on the **Logs** tab to monitor the build process
|
| 64 |
+
3. Build typically takes 5-10 minutes
|
| 65 |
+
4. Once complete, you'll see "App running at..."
|
| 66 |
+
|
| 67 |
+
### Step 6: Access Your Deployed Application
|
| 68 |
+
|
| 69 |
+
Your ReubenOS instance will be available at:
|
| 70 |
+
```
|
| 71 |
+
https://YOUR-USERNAME-reubenos.hf.space
|
| 72 |
+
```
|
| 73 |
+
|
| 74 |
+
## π§ MCP Server Configuration
|
| 75 |
+
|
| 76 |
+
### Important: MCP Server Architecture
|
| 77 |
+
|
| 78 |
+
The MCP server (`mcp-server.js`) uses **stdio transport**, which means it runs locally on your machine and communicates with Claude Desktop via standard input/output. It **cannot** run directly on Hugging Face Spaces.
|
| 79 |
+
|
| 80 |
+
**However**, the MCP server can communicate with your deployed Hugging Face Space via HTTP!
|
| 81 |
+
|
| 82 |
+
### How It Works
|
| 83 |
+
|
| 84 |
+
```
|
| 85 |
+
βββββββββββββββββββ stdio ββββββββββββββββ
|
| 86 |
+
β Claude Desktop β ββββββββββββββββββββββββΊ β MCP Server β
|
| 87 |
+
β (AI Client) β β (Local) β
|
| 88 |
+
βββββββββββββββββββ ββββββββ¬ββββββββ
|
| 89 |
+
β
|
| 90 |
+
β HTTP/S
|
| 91 |
+
β
|
| 92 |
+
ββββββββΌβββββββββββββββββββ
|
| 93 |
+
β Hugging Face Space β
|
| 94 |
+
β (ReubenOS Backend) β
|
| 95 |
+
β β
|
| 96 |
+
β - File Storage β
|
| 97 |
+
β - Document Processing β
|
| 98 |
+
β - Web Interface β
|
| 99 |
+
βββββββββββββββββββββββββββ
|
| 100 |
+
```
|
| 101 |
+
|
| 102 |
+
### Configuring Claude Desktop
|
| 103 |
+
|
| 104 |
+
1. **Download the MCP server file** from your repository to your local machine
|
| 105 |
+
2. **Configure Claude Desktop** to use your deployed Space:
|
| 106 |
+
|
| 107 |
+
**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
| 108 |
+
**Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
|
| 109 |
+
**Linux**: `~/.config/Claude/claude_desktop_config.json`
|
| 110 |
+
|
| 111 |
+
```json
|
| 112 |
+
{
|
| 113 |
+
"mcpServers": {
|
| 114 |
+
"reubenos": {
|
| 115 |
+
"command": "node",
|
| 116 |
+
"args": ["C:/path/to/your/local/mcp-server.js"],
|
| 117 |
+
"env": {
|
| 118 |
+
"REUBENOS_URL": "https://YOUR-USERNAME-reubenos.hf.space"
|
| 119 |
+
}
|
| 120 |
+
}
|
| 121 |
+
}
|
| 122 |
+
}
|
| 123 |
+
```
|
| 124 |
+
|
| 125 |
+
**Important**: Replace:
|
| 126 |
+
- `C:/path/to/your/local/mcp-server.js` with the actual path to your local `mcp-server.js` file
|
| 127 |
+
- `YOUR-USERNAME` with your Hugging Face username
|
| 128 |
+
|
| 129 |
+
3. **Restart Claude Desktop**
|
| 130 |
+
|
| 131 |
+
### Using the MCP Server
|
| 132 |
+
|
| 133 |
+
Once configured, you can use Claude to:
|
| 134 |
+
|
| 135 |
+
1. **Create Sessions**:
|
| 136 |
+
```
|
| 137 |
+
"Create a new session for my project"
|
| 138 |
+
```
|
| 139 |
+
|
| 140 |
+
2. **Upload Files**:
|
| 141 |
+
```
|
| 142 |
+
"Upload this document to my session"
|
| 143 |
+
```
|
| 144 |
+
|
| 145 |
+
3. **Generate Documents**:
|
| 146 |
+
```
|
| 147 |
+
"Generate a PDF document with the title 'Project Report' and content..."
|
| 148 |
+
```
|
| 149 |
+
|
| 150 |
+
4. **List Files**:
|
| 151 |
+
```
|
| 152 |
+
"Show me all files in my session"
|
| 153 |
+
```
|
| 154 |
+
|
| 155 |
+
5. **Download Files**:
|
| 156 |
+
```
|
| 157 |
+
"Download the file named 'report.pdf'"
|
| 158 |
+
```
|
| 159 |
+
|
| 160 |
+
## π Accessing the Web Interface
|
| 161 |
+
|
| 162 |
+
Your deployed Space provides a full desktop environment accessible at:
|
| 163 |
+
```
|
| 164 |
+
https://YOUR-USERNAME-reubenos.hf.space
|
| 165 |
+
```
|
| 166 |
+
|
| 167 |
+
Features available in the web interface:
|
| 168 |
+
- β
Desktop environment with draggable windows
|
| 169 |
+
- β
File manager for uploading/downloading files
|
| 170 |
+
- β
Document viewer for PDFs and other formats
|
| 171 |
+
- β
AI chat with Gemini integration
|
| 172 |
+
- β
Session management
|
| 173 |
+
- β
Web browser
|
| 174 |
+
- β
Terminal
|
| 175 |
+
- β
Calendar and productivity tools
|
| 176 |
+
|
| 177 |
+
## π Security Considerations
|
| 178 |
+
|
| 179 |
+
### Session Management
|
| 180 |
+
- Each session has a **unique session key**
|
| 181 |
+
- Store your session keys securely
|
| 182 |
+
- Don't share session keys publicly
|
| 183 |
+
- Use public folders only for non-sensitive data
|
| 184 |
+
|
| 185 |
+
### API Keys
|
| 186 |
+
- Never commit API keys to your repository
|
| 187 |
+
- Use Hugging Face Secrets for sensitive environment variables
|
| 188 |
+
- The `.gitignore` is configured to exclude `.env` files
|
| 189 |
+
|
| 190 |
+
### CORS and Network
|
| 191 |
+
- The deployed application accepts requests from any origin
|
| 192 |
+
- MCP server validates session keys for all protected operations
|
| 193 |
+
- Public files are accessible without authentication
|
| 194 |
+
|
| 195 |
+
## π Troubleshooting
|
| 196 |
+
|
| 197 |
+
### Build Fails on Hugging Face
|
| 198 |
+
|
| 199 |
+
**Check Logs**: Review the build logs in your Space's Logs tab
|
| 200 |
+
|
| 201 |
+
**Common Issues**:
|
| 202 |
+
- Missing dependencies: Ensure all packages are in `package.json`
|
| 203 |
+
- Memory limits: Hugging Face has resource limits for free spaces
|
| 204 |
+
- Build timeout: Complex builds may timeout; try optimizing Dockerfile
|
| 205 |
+
|
| 206 |
+
### MCP Server Cannot Connect
|
| 207 |
+
|
| 208 |
+
**Issue**: Claude Desktop shows "MCP server connection failed"
|
| 209 |
+
|
| 210 |
+
**Solutions**:
|
| 211 |
+
1. Verify `mcp-server.js` path in config is correct
|
| 212 |
+
2. Ensure Node.js is installed locally
|
| 213 |
+
3. Check that REUBENOS_URL points to your deployed Space
|
| 214 |
+
4. Restart Claude Desktop after config changes
|
| 215 |
+
|
| 216 |
+
**Verify with**:
|
| 217 |
+
```bash
|
| 218 |
+
# Test MCP server locally
|
| 219 |
+
REUBENOS_URL=https://YOUR-USERNAME-reubenos.hf.space node mcp-server.js
|
| 220 |
+
```
|
| 221 |
+
|
| 222 |
+
### Cannot Access Deployed Space
|
| 223 |
+
|
| 224 |
+
**Issue**: 404 or connection errors
|
| 225 |
+
|
| 226 |
+
**Solutions**:
|
| 227 |
+
1. Verify build completed successfully
|
| 228 |
+
2. Check Space visibility settings (public vs. private)
|
| 229 |
+
3. Ensure you're using the correct URL format
|
| 230 |
+
|
| 231 |
+
### Files Not Persisting
|
| 232 |
+
|
| 233 |
+
**Issue**: Uploaded files disappear after restart
|
| 234 |
+
|
| 235 |
+
**Note**: Hugging Face Spaces use **ephemeral storage**. Files uploaded to the Space will be lost on restart. For persistence:
|
| 236 |
+
|
| 237 |
+
**Solutions**:
|
| 238 |
+
1. Use Hugging Face Datasets for permanent storage
|
| 239 |
+
2. Integrate external storage (S3, etc.)
|
| 240 |
+
3. Download important files locally via MCP or web interface
|
| 241 |
+
|
| 242 |
+
## π Monitoring Your Space
|
| 243 |
+
|
| 244 |
+
### Viewing Logs
|
| 245 |
+
```
|
| 246 |
+
https://huggingface.co/spaces/YOUR-USERNAME/reubenos/logs
|
| 247 |
+
```
|
| 248 |
+
|
| 249 |
+
### Checking Usage
|
| 250 |
+
```
|
| 251 |
+
https://huggingface.co/spaces/YOUR-USERNAME/reubenos/settings
|
| 252 |
+
```
|
| 253 |
+
|
| 254 |
+
### Restarting Your Space
|
| 255 |
+
- Go to Settings β Factory reboot
|
| 256 |
+
- Or push a new commit to trigger rebuild
|
| 257 |
+
|
| 258 |
+
## π Updating Your Deployment
|
| 259 |
+
|
| 260 |
+
```bash
|
| 261 |
+
# Make changes to your code
|
| 262 |
+
git add .
|
| 263 |
+
git commit -m "Update feature XYZ"
|
| 264 |
+
|
| 265 |
+
# Push to Hugging Face
|
| 266 |
+
git push hf main
|
| 267 |
+
|
| 268 |
+
# Hugging Face will automatically rebuild
|
| 269 |
+
```
|
| 270 |
+
|
| 271 |
+
## π‘ Advanced Configuration
|
| 272 |
+
|
| 273 |
+
### Custom Domain
|
| 274 |
+
- Hugging Face Spaces supports custom domains
|
| 275 |
+
- Configure in Space settings under "Custom domain"
|
| 276 |
+
|
| 277 |
+
### Scaling
|
| 278 |
+
- Free tier: Limited resources
|
| 279 |
+
- Pro tier: More CPU, RAM, and persistent storage
|
| 280 |
+
- Enterprise: Custom resource allocation
|
| 281 |
+
|
| 282 |
+
### Monitoring
|
| 283 |
+
- Add custom health checks in `app/api/health/route.ts`
|
| 284 |
+
- Use the built-in logs for debugging
|
| 285 |
+
- Implement application-level logging as needed
|
| 286 |
+
|
| 287 |
+
## π Additional Resources
|
| 288 |
+
|
| 289 |
+
- [Hugging Face Spaces Documentation](https://huggingface.co/docs/hub/spaces)
|
| 290 |
+
- [Docker on Spaces](https://huggingface.co/docs/hub/spaces-sdks-docker)
|
| 291 |
+
- [Model Context Protocol Docs](https://modelcontextprotocol.io/)
|
| 292 |
+
- [Next.js Deployment Docs](https://nextjs.org/docs/deployment)
|
| 293 |
+
|
| 294 |
+
## π Getting Help
|
| 295 |
+
|
| 296 |
+
- **GitHub Issues**: Report bugs or request features
|
| 297 |
+
- **Hugging Face Forums**: Ask deployment questions
|
| 298 |
+
- **Discord/Community**: Join our community for support
|
| 299 |
+
|
| 300 |
+
---
|
| 301 |
+
|
| 302 |
+
**Happy Deploying! π**
|
| 303 |
+
|
| 304 |
+
If you successfully deploy ReubenOS to Hugging Face Spaces, consider sharing it with the community!
|
HUGGINGFACE_SUMMARY.md
ADDED
|
@@ -0,0 +1,358 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Hugging Face Spaces Deployment - Summary of Changes
|
| 2 |
+
|
| 3 |
+
This document summarizes all changes made to prepare ReubenOS for Hugging Face Spaces deployment.
|
| 4 |
+
|
| 5 |
+
## π¦ Files Created
|
| 6 |
+
|
| 7 |
+
### 1. `.dockerignore` β¨ NEW
|
| 8 |
+
**Purpose**: Optimize Docker build by excluding unnecessary files
|
| 9 |
+
|
| 10 |
+
**Key Exclusions**:
|
| 11 |
+
- `node_modules` (will be installed fresh in container)
|
| 12 |
+
- `.git`, `.env`, and other config files
|
| 13 |
+
- Test files and development artifacts
|
| 14 |
+
- Python cache and temporary files
|
| 15 |
+
|
| 16 |
+
### 2. `app/api/health/route.ts` β¨ NEW
|
| 17 |
+
**Purpose**: Health check endpoint for Docker container monitoring
|
| 18 |
+
|
| 19 |
+
**Endpoint**: `GET /api/health`
|
| 20 |
+
|
| 21 |
+
**Response**:
|
| 22 |
+
```json
|
| 23 |
+
{
|
| 24 |
+
"status": "healthy",
|
| 25 |
+
"timestamp": "2024-11-14T...",
|
| 26 |
+
"service": "ReubenOS",
|
| 27 |
+
"version": "1.0.0"
|
| 28 |
+
}
|
| 29 |
+
```
|
| 30 |
+
|
| 31 |
+
### 3. `README-HF.md` β¨ NEW
|
| 32 |
+
**Purpose**: Comprehensive Hugging Face Spaces specific documentation
|
| 33 |
+
|
| 34 |
+
**Sections**:
|
| 35 |
+
- Overview of ReubenOS features
|
| 36 |
+
- Live demo links
|
| 37 |
+
- Detailed deployment instructions
|
| 38 |
+
- MCP server configuration guide
|
| 39 |
+
- Network and port information
|
| 40 |
+
- API reference
|
| 41 |
+
- Troubleshooting guide
|
| 42 |
+
- Security considerations
|
| 43 |
+
|
| 44 |
+
### 4. `HUGGINGFACE_DEPLOYMENT.md` β¨ NEW
|
| 45 |
+
**Purpose**: Step-by-step deployment guide with troubleshooting
|
| 46 |
+
|
| 47 |
+
**Contents**:
|
| 48 |
+
- Prerequisites
|
| 49 |
+
- Detailed deployment steps
|
| 50 |
+
- MCP server architecture explanation
|
| 51 |
+
- Claude Desktop configuration
|
| 52 |
+
- Web interface access guide
|
| 53 |
+
- Security best practices
|
| 54 |
+
- Common issues and solutions
|
| 55 |
+
- Monitoring and maintenance
|
| 56 |
+
|
| 57 |
+
### 5. `DEPLOYMENT_CHECKLIST.md` β¨ NEW
|
| 58 |
+
**Purpose**: Interactive checklist for deployment verification
|
| 59 |
+
|
| 60 |
+
**Sections**:
|
| 61 |
+
- Pre-deployment file verification
|
| 62 |
+
- Deployment process steps
|
| 63 |
+
- MCP server setup checklist
|
| 64 |
+
- Network verification
|
| 65 |
+
- Post-deployment monitoring
|
| 66 |
+
- Troubleshooting decision tree
|
| 67 |
+
|
| 68 |
+
## π Files Modified
|
| 69 |
+
|
| 70 |
+
### 1. `Dockerfile` π UPDATED
|
| 71 |
+
**Changes**:
|
| 72 |
+
- Changed port from 3000 β **7860** (HF Spaces standard)
|
| 73 |
+
- Added environment variables for HF deployment:
|
| 74 |
+
```dockerfile
|
| 75 |
+
ENV PORT=7860
|
| 76 |
+
ENV HOSTNAME="0.0.0.0"
|
| 77 |
+
ENV REUBENOS_URL="http://0.0.0.0:7860"
|
| 78 |
+
```
|
| 79 |
+
- Added MCP server file copying
|
| 80 |
+
- Updated health check to use port 7860
|
| 81 |
+
- Optimized for production deployment
|
| 82 |
+
|
| 83 |
+
### 2. `next.config.mjs` π UPDATED
|
| 84 |
+
**Changes**:
|
| 85 |
+
```javascript
|
| 86 |
+
// Added standalone output for Docker
|
| 87 |
+
output: 'standalone',
|
| 88 |
+
|
| 89 |
+
// Added experimental config for HF Spaces
|
| 90 |
+
experimental: {
|
| 91 |
+
outputFileTracingRoot: undefined,
|
| 92 |
+
}
|
| 93 |
+
```
|
| 94 |
+
|
| 95 |
+
**Purpose**: Enables Next.js standalone mode required for Docker deployment
|
| 96 |
+
|
| 97 |
+
### 3. `README.md` π UPDATED
|
| 98 |
+
**Changes**:
|
| 99 |
+
- Complete rewrite focused on Hugging Face Spaces
|
| 100 |
+
- Added badges for HF, Next.js, Docker
|
| 101 |
+
- New overview section highlighting AI features
|
| 102 |
+
- Quick start for both local and HF deployment
|
| 103 |
+
- MCP server configuration example
|
| 104 |
+
- Links to detailed documentation
|
| 105 |
+
- Technology stack overview
|
| 106 |
+
|
| 107 |
+
**Before**: Basic Next.js boilerplate
|
| 108 |
+
**After**: Comprehensive project documentation with HF focus
|
| 109 |
+
|
| 110 |
+
## π Network & Port Configuration
|
| 111 |
+
|
| 112 |
+
### Internal (Docker Container)
|
| 113 |
+
```
|
| 114 |
+
Port: 7860
|
| 115 |
+
Binding: 0.0.0.0:7860
|
| 116 |
+
Environment: Production
|
| 117 |
+
```
|
| 118 |
+
|
| 119 |
+
### External (Public Access)
|
| 120 |
+
```
|
| 121 |
+
URL Format: https://[username]-[spacename].hf.space
|
| 122 |
+
Protocol: HTTPS (handled by HF proxy)
|
| 123 |
+
No port in URL needed
|
| 124 |
+
```
|
| 125 |
+
|
| 126 |
+
### MCP Server Communication
|
| 127 |
+
```
|
| 128 |
+
Local MCP Server β HTTPS β HF Space Backend
|
| 129 |
+
No ports need to be exposed for MCP functionality
|
| 130 |
+
```
|
| 131 |
+
|
| 132 |
+
## π§ Configuration Summary
|
| 133 |
+
|
| 134 |
+
### Environment Variables
|
| 135 |
+
```bash
|
| 136 |
+
# Set in Dockerfile
|
| 137 |
+
PORT=7860
|
| 138 |
+
HOSTNAME=0.0.0.0
|
| 139 |
+
REUBENOS_URL=http://0.0.0.0:7860
|
| 140 |
+
NODE_ENV=production
|
| 141 |
+
NEXT_TELEMETRY_DISABLED=1
|
| 142 |
+
|
| 143 |
+
# Optional (set in HF Space secrets)
|
| 144 |
+
GEMINI_API_KEY=<your-key>
|
| 145 |
+
```
|
| 146 |
+
|
| 147 |
+
### Claude Desktop MCP Config
|
| 148 |
+
```json
|
| 149 |
+
{
|
| 150 |
+
"mcpServers": {
|
| 151 |
+
"reubenos": {
|
| 152 |
+
"command": "node",
|
| 153 |
+
"args": ["/absolute/path/to/mcp-server.js"],
|
| 154 |
+
"env": {
|
| 155 |
+
"REUBENOS_URL": "https://YOUR-USERNAME-reubenos.hf.space"
|
| 156 |
+
}
|
| 157 |
+
}
|
| 158 |
+
}
|
| 159 |
+
}
|
| 160 |
+
```
|
| 161 |
+
|
| 162 |
+
## π Architecture Overview
|
| 163 |
+
|
| 164 |
+
```
|
| 165 |
+
βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ
|
| 166 |
+
β Hugging Face Spaces β
|
| 167 |
+
β β
|
| 168 |
+
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
|
| 169 |
+
β β Docker Container (Port 7860) β β
|
| 170 |
+
β β β β
|
| 171 |
+
β β ββ Next.js App (Frontend) β β
|
| 172 |
+
β β β ββ Desktop UI β β
|
| 173 |
+
β β β ββ File Manager β β
|
| 174 |
+
β β β ββ AI Chat β β
|
| 175 |
+
β β β β
|
| 176 |
+
β β ββ API Routes (Backend) β β
|
| 177 |
+
β β β ββ /api/health β β
|
| 178 |
+
β β β ββ /api/sessions/* β β
|
| 179 |
+
β β β ββ /api/documents/* β β
|
| 180 |
+
β β β ββ /api/gemini/* β β
|
| 181 |
+
β β β β
|
| 182 |
+
β β ββ File Storage β β
|
| 183 |
+
β β ββ /app/data/files (sessions) β β
|
| 184 |
+
β β ββ /app/data/public β β
|
| 185 |
+
β ββββββββββββββββββββββββββββββββββββββββββββββββββββββ β
|
| 186 |
+
β β² β
|
| 187 |
+
β β HTTPS β
|
| 188 |
+
ββββββββββββββββββββββββββββΌβββββββββββββββββββββββββββββββββββ
|
| 189 |
+
β
|
| 190 |
+
HF Proxy (HTTPS)
|
| 191 |
+
β
|
| 192 |
+
ββββββββββββββββββββΌβββββββββββββββββββ
|
| 193 |
+
β β β
|
| 194 |
+
Web Browser MCP Server API Clients
|
| 195 |
+
(End Users) (Local - Claude) (curl, etc.)
|
| 196 |
+
```
|
| 197 |
+
|
| 198 |
+
## π Deployment Workflow
|
| 199 |
+
|
| 200 |
+
### Step 1: Prepare Repository
|
| 201 |
+
```bash
|
| 202 |
+
# Ensure all new files are committed
|
| 203 |
+
git add .dockerignore README-HF.md HUGGINGFACE_DEPLOYMENT.md
|
| 204 |
+
git add DEPLOYMENT_CHECKLIST.md app/api/health/route.ts
|
| 205 |
+
git commit -m "Prepare for Hugging Face Spaces deployment"
|
| 206 |
+
```
|
| 207 |
+
|
| 208 |
+
### Step 2: Create HF Space
|
| 209 |
+
1. Visit https://huggingface.co/new-space
|
| 210 |
+
2. Select **Docker** SDK
|
| 211 |
+
3. Name your space (e.g., `reubenos`)
|
| 212 |
+
4. Create space
|
| 213 |
+
|
| 214 |
+
### Step 3: Deploy
|
| 215 |
+
```bash
|
| 216 |
+
# Add HF remote
|
| 217 |
+
git remote add hf https://huggingface.co/spaces/YOUR-USERNAME/reubenos
|
| 218 |
+
|
| 219 |
+
# Push to HF
|
| 220 |
+
git push hf main
|
| 221 |
+
```
|
| 222 |
+
|
| 223 |
+
### Step 4: Monitor Build
|
| 224 |
+
- Watch build logs in HF Space
|
| 225 |
+
- Typically takes 5-10 minutes
|
| 226 |
+
- Verify successful deployment
|
| 227 |
+
|
| 228 |
+
### Step 5: Configure MCP
|
| 229 |
+
- Download `mcp-server.js` to local machine
|
| 230 |
+
- Update Claude Desktop config with HF Space URL
|
| 231 |
+
- Restart Claude Desktop
|
| 232 |
+
- Test MCP tools
|
| 233 |
+
|
| 234 |
+
## β
What's Ready for Production
|
| 235 |
+
|
| 236 |
+
### Frontend β
|
| 237 |
+
- [x] Desktop environment
|
| 238 |
+
- [x] File manager with upload/download
|
| 239 |
+
- [x] Document viewer
|
| 240 |
+
- [x] AI chat integration
|
| 241 |
+
- [x] Session management UI
|
| 242 |
+
- [x] Web browser
|
| 243 |
+
- [x] Terminal
|
| 244 |
+
|
| 245 |
+
### Backend β
|
| 246 |
+
- [x] Session-based file storage
|
| 247 |
+
- [x] Document generation (DOCX, PDF, PPT, Excel, LaTeX)
|
| 248 |
+
- [x] Document processing
|
| 249 |
+
- [x] Public/private file separation
|
| 250 |
+
- [x] Health check endpoint
|
| 251 |
+
- [x] Gemini AI integration
|
| 252 |
+
|
| 253 |
+
### MCP Server β
|
| 254 |
+
- [x] Create sessions
|
| 255 |
+
- [x] Upload files
|
| 256 |
+
- [x] Download files
|
| 257 |
+
- [x] List files
|
| 258 |
+
- [x] Generate documents
|
| 259 |
+
- [x] Process documents
|
| 260 |
+
- [x] Remote URL support
|
| 261 |
+
|
| 262 |
+
### Deployment β
|
| 263 |
+
- [x] Dockerfile optimized for HF Spaces
|
| 264 |
+
- [x] Port 7860 configured
|
| 265 |
+
- [x] Standalone Next.js build
|
| 266 |
+
- [x] Health checks configured
|
| 267 |
+
- [x] Environment variables set
|
| 268 |
+
- [x] Documentation complete
|
| 269 |
+
|
| 270 |
+
## π Documentation Files
|
| 271 |
+
|
| 272 |
+
| File | Purpose | Audience |
|
| 273 |
+
|------|---------|----------|
|
| 274 |
+
| `README.md` | Main project overview | All users |
|
| 275 |
+
| `README-HF.md` | HF Spaces specific guide | HF Space users |
|
| 276 |
+
| `HUGGINGFACE_DEPLOYMENT.md` | Detailed deployment steps | Deployers |
|
| 277 |
+
| `DEPLOYMENT_CHECKLIST.md` | Verification checklist | Deployers |
|
| 278 |
+
| `HUGGINGFACE_SUMMARY.md` | Changes summary (this file) | Developers |
|
| 279 |
+
| `SESSION_SYSTEM.md` | Session management docs | API users |
|
| 280 |
+
| `CLAUDE_DESKTOP_SETUP.md` | MCP configuration | Claude users |
|
| 281 |
+
|
| 282 |
+
## π Security Considerations
|
| 283 |
+
|
| 284 |
+
### Implemented β
|
| 285 |
+
- Session-key based authentication
|
| 286 |
+
- Public/private file separation
|
| 287 |
+
- Environment variable for secrets
|
| 288 |
+
- Non-root user in Docker container
|
| 289 |
+
- Input validation on API endpoints
|
| 290 |
+
|
| 291 |
+
### User Responsibilities
|
| 292 |
+
- Keep session keys secure
|
| 293 |
+
- Use HF Secrets for API keys
|
| 294 |
+
- Don't share private session keys
|
| 295 |
+
- Regularly clean up unused sessions
|
| 296 |
+
|
| 297 |
+
## π― Next Steps
|
| 298 |
+
|
| 299 |
+
### For Deployment
|
| 300 |
+
1. Review `DEPLOYMENT_CHECKLIST.md`
|
| 301 |
+
2. Follow `HUGGINGFACE_DEPLOYMENT.md`
|
| 302 |
+
3. Test all functionality
|
| 303 |
+
4. Configure MCP server locally
|
| 304 |
+
5. Share your Space!
|
| 305 |
+
|
| 306 |
+
### For Development
|
| 307 |
+
1. Test locally first: `npm run dev`
|
| 308 |
+
2. Build and verify: `npm run build`
|
| 309 |
+
3. Test Docker build locally (optional)
|
| 310 |
+
4. Push to HF when ready
|
| 311 |
+
|
| 312 |
+
### For Users
|
| 313 |
+
1. Access web interface at your HF Space URL
|
| 314 |
+
2. Create sessions via File Manager
|
| 315 |
+
3. Upload/download files
|
| 316 |
+
4. Use Claude Desktop with MCP for AI file management
|
| 317 |
+
5. Generate documents programmatically
|
| 318 |
+
|
| 319 |
+
## π Support Resources
|
| 320 |
+
|
| 321 |
+
- **README-HF.md**: Complete usage guide
|
| 322 |
+
- **HUGGINGFACE_DEPLOYMENT.md**: Troubleshooting
|
| 323 |
+
- **DEPLOYMENT_CHECKLIST.md**: Verification steps
|
| 324 |
+
- **HF Docs**: https://huggingface.co/docs/hub/spaces
|
| 325 |
+
- **MCP Docs**: https://modelcontextprotocol.io/
|
| 326 |
+
|
| 327 |
+
## π Summary
|
| 328 |
+
|
| 329 |
+
Your ReubenOS project is now **100% ready** for Hugging Face Spaces deployment!
|
| 330 |
+
|
| 331 |
+
### Key Achievements
|
| 332 |
+
β
All configuration files updated for HF Spaces
|
| 333 |
+
β
Port 7860 properly configured
|
| 334 |
+
β
Standalone Next.js build enabled
|
| 335 |
+
β
Health check endpoint created
|
| 336 |
+
β
Comprehensive documentation written
|
| 337 |
+
β
MCP server configured for remote access
|
| 338 |
+
β
Deployment checklist provided
|
| 339 |
+
|
| 340 |
+
### What Makes This HF-Ready
|
| 341 |
+
- **Docker-first**: Optimized Dockerfile for HF container runtime
|
| 342 |
+
- **Port 7860**: Standard HF Spaces port
|
| 343 |
+
- **Standalone Build**: Self-contained Next.js deployment
|
| 344 |
+
- **Health Checks**: Container monitoring via `/api/health`
|
| 345 |
+
- **Documentation**: Complete guides for deployment and usage
|
| 346 |
+
- **MCP Integration**: Remote MCP server support via HTTPS
|
| 347 |
+
|
| 348 |
+
### Deploy Now! π
|
| 349 |
+
```bash
|
| 350 |
+
git remote add hf https://huggingface.co/spaces/YOUR-USERNAME/reubenos
|
| 351 |
+
git push hf main
|
| 352 |
+
```
|
| 353 |
+
|
| 354 |
+
---
|
| 355 |
+
|
| 356 |
+
**Made with β€οΈ for Hugging Face Spaces**
|
| 357 |
+
|
| 358 |
+
*Questions? Check the documentation or open an issue!*
|
README-HF.md
ADDED
|
@@ -0,0 +1,358 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# ReubenOS - AI Desktop Environment with MCP Integration
|
| 2 |
+
|
| 3 |
+
[](https://huggingface.co/spaces)
|
| 4 |
+
[](https://www.docker.com/)
|
| 5 |
+
[](https://nextjs.org/)
|
| 6 |
+
[](LICENSE)
|
| 7 |
+
|
| 8 |
+
## π Overview
|
| 9 |
+
|
| 10 |
+
**ReubenOS** is a powerful AI-powered desktop environment that runs entirely in your browser, featuring:
|
| 11 |
+
|
| 12 |
+
- π₯οΈ **Full Desktop Experience**: macOS-inspired interface with draggable windows, dock, and desktop icons
|
| 13 |
+
- π **Advanced File Management**: Upload, organize, and manage files with session-based isolation
|
| 14 |
+
- π **Document Processing**: Generate and process DOCX, PDF, PowerPoint, Excel, and LaTeX documents
|
| 15 |
+
- π€ **AI Integration**: Built-in Gemini AI chat with voice transcription
|
| 16 |
+
- π **MCP Server**: Model Context Protocol server for seamless AI assistant integration
|
| 17 |
+
- π **Web Browser**: Built-in browser for web access
|
| 18 |
+
- π¬ **Real-time Collaboration**: Session-based file sharing and management
|
| 19 |
+
|
| 20 |
+
## π Live Demo
|
| 21 |
+
|
| 22 |
+
Try ReubenOS now: **[Launch ReubenOS on Hugging Face Spaces](https://huggingface.co/spaces/YOUR-USERNAME/reubenos)**
|
| 23 |
+
|
| 24 |
+
## π Features
|
| 25 |
+
|
| 26 |
+
### Desktop Environment
|
| 27 |
+
- **Window Management**: Multiple resizable, draggable windows
|
| 28 |
+
- **File Manager**: Intuitive file browser with drag-and-drop support
|
| 29 |
+
- **Terminal**: Command-line interface for advanced operations
|
| 30 |
+
- **Calendar & Clock**: Stay organized with built-in productivity tools
|
| 31 |
+
- **Spotlight Search**: Quick access to applications and files
|
| 32 |
+
|
| 33 |
+
### File Operations
|
| 34 |
+
- **Session Management**: Isolated workspaces for different projects
|
| 35 |
+
- **Public & Private Storage**: Share files publicly or keep them private
|
| 36 |
+
- **Document Generation**: Create professional documents programmatically
|
| 37 |
+
- **Document Processing**: Extract and analyze content from various formats
|
| 38 |
+
- **Secure Access**: Session-key based authentication
|
| 39 |
+
|
| 40 |
+
### MCP Server Integration
|
| 41 |
+
|
| 42 |
+
The MCP (Model Context Protocol) server allows AI assistants like Claude to interact with your files:
|
| 43 |
+
|
| 44 |
+
**Available Tools:**
|
| 45 |
+
- `create_session` - Create isolated workspaces
|
| 46 |
+
- `upload_file` - Upload files to sessions or public folders
|
| 47 |
+
- `download_file` - Retrieve files from storage
|
| 48 |
+
- `list_files` - Browse available files
|
| 49 |
+
- `generate_document` - Create DOCX, PDF, PowerPoint, Excel, or LaTeX documents
|
| 50 |
+
- `process_document` - Read and analyze documents
|
| 51 |
+
|
| 52 |
+
## π― Using ReubenOS on Hugging Face Spaces
|
| 53 |
+
|
| 54 |
+
### Accessing the Application
|
| 55 |
+
|
| 56 |
+
1. Visit your deployed Hugging Face Space
|
| 57 |
+
2. The desktop environment will load automatically
|
| 58 |
+
3. Click on icons to launch applications
|
| 59 |
+
4. Use the dock to manage running applications
|
| 60 |
+
|
| 61 |
+
### Creating a Session
|
| 62 |
+
|
| 63 |
+
Sessions provide isolated workspaces for your files:
|
| 64 |
+
|
| 65 |
+
1. Open the **File Manager** application
|
| 66 |
+
2. Click "New Session" or use the session manager
|
| 67 |
+
3. Save your **Session Key** - you'll need it for MCP access
|
| 68 |
+
|
| 69 |
+
### Uploading Files
|
| 70 |
+
|
| 71 |
+
**Via Web Interface:**
|
| 72 |
+
- Drag and drop files into the File Manager
|
| 73 |
+
- Use the upload button in any application
|
| 74 |
+
|
| 75 |
+
**Via MCP Server:**
|
| 76 |
+
```typescript
|
| 77 |
+
// Using the MCP server from Claude Desktop or other clients
|
| 78 |
+
{
|
| 79 |
+
"tool": "upload_file",
|
| 80 |
+
"sessionKey": "your-session-key",
|
| 81 |
+
"fileName": "document.pdf",
|
| 82 |
+
"content": "base64-encoded-content",
|
| 83 |
+
"isPublic": false
|
| 84 |
+
}
|
| 85 |
+
```
|
| 86 |
+
|
| 87 |
+
### Connecting Claude Desktop to Your Space
|
| 88 |
+
|
| 89 |
+
**Important**: The MCP server runs locally and communicates with your deployed Hugging Face Space.
|
| 90 |
+
|
| 91 |
+
Configure Claude Desktop to use your deployed MCP server:
|
| 92 |
+
|
| 93 |
+
```json
|
| 94 |
+
{
|
| 95 |
+
"mcpServers": {
|
| 96 |
+
"reubenos": {
|
| 97 |
+
"command": "node",
|
| 98 |
+
"args": ["/path/to/your/local/mcp-server.js"],
|
| 99 |
+
"env": {
|
| 100 |
+
"REUBENOS_URL": "https://YOUR-USERNAME-reubenos.hf.space"
|
| 101 |
+
}
|
| 102 |
+
}
|
| 103 |
+
}
|
| 104 |
+
}
|
| 105 |
+
```
|
| 106 |
+
|
| 107 |
+
**Replace**:
|
| 108 |
+
- `/path/to/your/local/mcp-server.js` - Actual path to the MCP server file on your computer
|
| 109 |
+
- `YOUR-USERNAME` - Your Hugging Face username
|
| 110 |
+
- `reubenos` - Your Space name (if different)
|
| 111 |
+
|
| 112 |
+
**Example for Windows**:
|
| 113 |
+
```json
|
| 114 |
+
"args": ["C:\\Users\\YourName\\Downloads\\mcp-server.js"]
|
| 115 |
+
```
|
| 116 |
+
|
| 117 |
+
**Example for macOS/Linux**:
|
| 118 |
+
```json
|
| 119 |
+
"args": ["/Users/yourname/projects/reubenos/mcp-server.js"]
|
| 120 |
+
```
|
| 121 |
+
|
| 122 |
+
**Location of Claude Desktop config:**
|
| 123 |
+
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
|
| 124 |
+
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`
|
| 125 |
+
- **Linux**: `~/.config/Claude/claude_desktop_config.json`
|
| 126 |
+
|
| 127 |
+
**After configuration**:
|
| 128 |
+
1. Save the config file
|
| 129 |
+
2. Restart Claude Desktop
|
| 130 |
+
3. The MCP tools will appear in Claude's tool panel
|
| 131 |
+
|
| 132 |
+
## π Network & Port Configuration
|
| 133 |
+
|
| 134 |
+
### Port Information
|
| 135 |
+
|
| 136 |
+
**Internal (Docker Container)**:
|
| 137 |
+
- Port **7860** - Standard Hugging Face Spaces port
|
| 138 |
+
- Configured in `Dockerfile` with `EXPOSE 7860`
|
| 139 |
+
- The Next.js server binds to `0.0.0.0:7860`
|
| 140 |
+
|
| 141 |
+
**External (Public Access)**:
|
| 142 |
+
- Access via: `https://YOUR-USERNAME-reubenos.hf.space`
|
| 143 |
+
- **No port number needed** - Hugging Face proxy handles routing
|
| 144 |
+
- Automatic HTTPS via Hugging Face infrastructure
|
| 145 |
+
|
| 146 |
+
### Important URLs
|
| 147 |
+
|
| 148 |
+
| Purpose | URL Format | Example |
|
| 149 |
+
|---------|-----------|---------|
|
| 150 |
+
| Web Interface | `https://[username]-[space-name].hf.space` | `https://john-reubenos.hf.space` |
|
| 151 |
+
| MCP Server (local) | Uses web interface URL | `REUBENOS_URL=https://john-reubenos.hf.space` |
|
| 152 |
+
| API Endpoints | `https://[username]-[space-name].hf.space/api/*` | `https://john-reubenos.hf.space/api/health` |
|
| 153 |
+
|
| 154 |
+
**Note**: The MCP server runs **locally** on your machine and communicates with your deployed Space via HTTPS. No ports need to be exposed for MCP functionality.
|
| 155 |
+
|
| 156 |
+
## π§ Deploying to Hugging Face Spaces
|
| 157 |
+
|
| 158 |
+
### Prerequisites
|
| 159 |
+
|
| 160 |
+
- Hugging Face account ([Sign up here](https://huggingface.co/join))
|
| 161 |
+
- Git installed on your local machine
|
| 162 |
+
- Node.js 20+ (for local MCP server)
|
| 163 |
+
|
| 164 |
+
### Deployment Steps
|
| 165 |
+
|
| 166 |
+
1. **Create a New Space**
|
| 167 |
+
- Go to [Hugging Face Spaces](https://huggingface.co/new-space)
|
| 168 |
+
- Select **Docker** as the Space SDK
|
| 169 |
+
- Choose a name for your Space (e.g., `reubenos`)
|
| 170 |
+
- Select **Public** or **Private** visibility
|
| 171 |
+
|
| 172 |
+
2. **Clone and Push**
|
| 173 |
+
```bash
|
| 174 |
+
# Clone this repository
|
| 175 |
+
git clone https://github.com/YOUR-REPO/reubenos.git
|
| 176 |
+
cd reubenos
|
| 177 |
+
|
| 178 |
+
# Add your Hugging Face Space as remote
|
| 179 |
+
git remote add hf https://huggingface.co/spaces/YOUR-USERNAME/reubenos
|
| 180 |
+
|
| 181 |
+
# Push to Hugging Face
|
| 182 |
+
git push hf main
|
| 183 |
+
```
|
| 184 |
+
|
| 185 |
+
3. **Configure Environment Variables** (Optional)
|
| 186 |
+
|
| 187 |
+
In your Space settings, add:
|
| 188 |
+
- `GEMINI_API_KEY` - For AI chat functionality
|
| 189 |
+
- `NODE_ENV` - Set to `production`
|
| 190 |
+
|
| 191 |
+
4. **Wait for Build**
|
| 192 |
+
- Hugging Face will automatically build your Docker container
|
| 193 |
+
- Build typically takes 5-10 minutes
|
| 194 |
+
- Check the logs tab for progress
|
| 195 |
+
|
| 196 |
+
5. **Access Your Space**
|
| 197 |
+
- Once built, your Space will be available at:
|
| 198 |
+
- `https://YOUR-USERNAME-reubenos.hf.space`
|
| 199 |
+
|
| 200 |
+
### Post-Deployment Configuration
|
| 201 |
+
|
| 202 |
+
**Update MCP Server URL:**
|
| 203 |
+
|
| 204 |
+
After deployment, update your local MCP configuration to point to your Hugging Face Space:
|
| 205 |
+
|
| 206 |
+
```json
|
| 207 |
+
{
|
| 208 |
+
"mcpServers": {
|
| 209 |
+
"reubenos": {
|
| 210 |
+
"command": "node",
|
| 211 |
+
"args": ["/path/to/mcp-server.js"],
|
| 212 |
+
"env": {
|
| 213 |
+
"REUBENOS_URL": "https://YOUR-USERNAME-reubenos.hf.space"
|
| 214 |
+
}
|
| 215 |
+
}
|
| 216 |
+
}
|
| 217 |
+
}
|
| 218 |
+
```
|
| 219 |
+
|
| 220 |
+
## π οΈ Development
|
| 221 |
+
|
| 222 |
+
### Local Development
|
| 223 |
+
|
| 224 |
+
```bash
|
| 225 |
+
# Install dependencies
|
| 226 |
+
npm install
|
| 227 |
+
|
| 228 |
+
# Run development server
|
| 229 |
+
npm run dev
|
| 230 |
+
|
| 231 |
+
# Build for production
|
| 232 |
+
npm run build
|
| 233 |
+
|
| 234 |
+
# Run production server
|
| 235 |
+
npm start
|
| 236 |
+
|
| 237 |
+
# Run MCP server locally
|
| 238 |
+
npm run mcp
|
| 239 |
+
```
|
| 240 |
+
|
| 241 |
+
### Project Structure
|
| 242 |
+
|
| 243 |
+
```
|
| 244 |
+
reubenos/
|
| 245 |
+
βββ app/ # Next.js app directory
|
| 246 |
+
β βββ api/ # API routes
|
| 247 |
+
β β βββ documents/ # Document processing endpoints
|
| 248 |
+
β β βββ sessions/ # Session management
|
| 249 |
+
β β βββ gemini/ # AI chat endpoints
|
| 250 |
+
β β βββ health/ # Health check endpoint
|
| 251 |
+
β βββ components/ # React components
|
| 252 |
+
β βββ page.tsx # Main desktop page
|
| 253 |
+
βββ backend/ # Python MCP server (alternative)
|
| 254 |
+
βββ mcp-server.js # Node.js MCP server
|
| 255 |
+
βββ public/ # Static assets
|
| 256 |
+
βββ Dockerfile # Docker configuration for HF Spaces
|
| 257 |
+
βββ next.config.mjs # Next.js configuration
|
| 258 |
+
βββ package.json # Node.js dependencies
|
| 259 |
+
```
|
| 260 |
+
|
| 261 |
+
### Environment Variables
|
| 262 |
+
|
| 263 |
+
Create a `.env.local` file for local development:
|
| 264 |
+
|
| 265 |
+
```env
|
| 266 |
+
GEMINI_API_KEY=your-gemini-api-key
|
| 267 |
+
REUBENOS_URL=http://localhost:3000
|
| 268 |
+
NODE_ENV=development
|
| 269 |
+
```
|
| 270 |
+
|
| 271 |
+
## π Security
|
| 272 |
+
|
| 273 |
+
### Session Management
|
| 274 |
+
- Each session has a unique key for authentication
|
| 275 |
+
- Sessions are isolated from each other
|
| 276 |
+
- Public files are accessible without authentication
|
| 277 |
+
- Private files require valid session keys
|
| 278 |
+
|
| 279 |
+
### Best Practices
|
| 280 |
+
- Never share your session keys publicly
|
| 281 |
+
- Use public folders only for non-sensitive data
|
| 282 |
+
- Regularly clean up unused sessions
|
| 283 |
+
- Keep your environment variables secure
|
| 284 |
+
|
| 285 |
+
## π API Reference
|
| 286 |
+
|
| 287 |
+
### REST API Endpoints
|
| 288 |
+
|
| 289 |
+
**Health Check**
|
| 290 |
+
```
|
| 291 |
+
GET /api/health
|
| 292 |
+
```
|
| 293 |
+
|
| 294 |
+
**Session Management**
|
| 295 |
+
```
|
| 296 |
+
POST /api/sessions/create
|
| 297 |
+
GET /api/sessions/files
|
| 298 |
+
POST /api/sessions/upload
|
| 299 |
+
GET /api/sessions/download
|
| 300 |
+
```
|
| 301 |
+
|
| 302 |
+
**Document Operations**
|
| 303 |
+
```
|
| 304 |
+
POST /api/documents/generate
|
| 305 |
+
POST /api/documents/process
|
| 306 |
+
```
|
| 307 |
+
|
| 308 |
+
### MCP Server Protocol
|
| 309 |
+
|
| 310 |
+
The MCP server communicates using the [Model Context Protocol](https://modelcontextprotocol.io/) specification, enabling AI assistants to:
|
| 311 |
+
- Create and manage sessions
|
| 312 |
+
- Upload and download files
|
| 313 |
+
- Generate various document types
|
| 314 |
+
- Process and analyze documents
|
| 315 |
+
|
| 316 |
+
## π€ Contributing
|
| 317 |
+
|
| 318 |
+
Contributions are welcome! Please feel free to submit a Pull Request.
|
| 319 |
+
|
| 320 |
+
1. Fork the repository
|
| 321 |
+
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
|
| 322 |
+
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
|
| 323 |
+
4. Push to the branch (`git push origin feature/AmazingFeature`)
|
| 324 |
+
5. Open a Pull Request
|
| 325 |
+
|
| 326 |
+
## π License
|
| 327 |
+
|
| 328 |
+
This project is licensed under the MIT License - see the LICENSE file for details.
|
| 329 |
+
|
| 330 |
+
## π Acknowledgments
|
| 331 |
+
|
| 332 |
+
- Built with [Next.js](https://nextjs.org/)
|
| 333 |
+
- Desktop UI inspired by macOS
|
| 334 |
+
- MCP protocol by [Anthropic](https://www.anthropic.com/)
|
| 335 |
+
- AI capabilities powered by Google Gemini
|
| 336 |
+
- Hosted on [Hugging Face Spaces](https://huggingface.co/spaces)
|
| 337 |
+
|
| 338 |
+
## π§ Support
|
| 339 |
+
|
| 340 |
+
- **Issues**: [GitHub Issues](https://github.com/YOUR-REPO/reubenos/issues)
|
| 341 |
+
- **Discussions**: [GitHub Discussions](https://github.com/YOUR-REPO/reubenos/discussions)
|
| 342 |
+
- **Email**: your-email@example.com
|
| 343 |
+
|
| 344 |
+
## πΊοΈ Roadmap
|
| 345 |
+
|
| 346 |
+
- [ ] Multi-user support
|
| 347 |
+
- [ ] Real-time collaboration
|
| 348 |
+
- [ ] Cloud storage integration
|
| 349 |
+
- [ ] Mobile responsive design
|
| 350 |
+
- [ ] Additional AI model support
|
| 351 |
+
- [ ] Plugin system for extensions
|
| 352 |
+
- [ ] Theming support
|
| 353 |
+
|
| 354 |
+
---
|
| 355 |
+
|
| 356 |
+
**Made with β€οΈ for the AI community**
|
| 357 |
+
|
| 358 |
+
*Deploy to Hugging Face Spaces and make AI-powered file management accessible to everyone!*
|
README.md
CHANGED
|
@@ -1,36 +1,89 @@
|
|
| 1 |
-
|
| 2 |
|
| 3 |
-
|
|
|
|
|
|
|
| 4 |
|
| 5 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 6 |
|
| 7 |
```bash
|
|
|
|
|
|
|
|
|
|
|
|
|
| 8 |
npm run dev
|
| 9 |
-
|
| 10 |
-
|
| 11 |
-
# or
|
| 12 |
-
pnpm dev
|
| 13 |
-
# or
|
| 14 |
-
bun dev
|
| 15 |
```
|
| 16 |
|
| 17 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 18 |
|
| 19 |
-
|
| 20 |
|
| 21 |
-
|
|
|
|
|
|
|
|
|
|
| 22 |
|
| 23 |
-
##
|
| 24 |
|
| 25 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
| 26 |
|
| 27 |
-
|
| 28 |
-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
| 29 |
|
| 30 |
-
|
| 31 |
|
| 32 |
-
|
| 33 |
|
| 34 |
-
|
| 35 |
|
| 36 |
-
|
|
|
|
| 1 |
+
# ReubenOS - AI Desktop Environment with MCP Integration
|
| 2 |
|
| 3 |
+
[](https://huggingface.co/spaces)
|
| 4 |
+
[](https://nextjs.org/)
|
| 5 |
+
[](https://www.docker.com/)
|
| 6 |
|
| 7 |
+
## π Overview
|
| 8 |
+
|
| 9 |
+
**ReubenOS** is a powerful AI-powered desktop environment that runs entirely in your browser. It features a complete file management system, document processing capabilities, and a built-in MCP (Model Context Protocol) server that allows AI assistants like Claude to interact with your files seamlessly.
|
| 10 |
+
|
| 11 |
+
### Key Features
|
| 12 |
+
|
| 13 |
+
- π₯οΈ **Desktop Environment**: Full macOS-inspired UI with windows, dock, and file management
|
| 14 |
+
- π **Session-Based File Management**: Isolated workspaces with secure access
|
| 15 |
+
- π **Document Processing**: Generate and process DOCX, PDF, PPT, Excel, and LaTeX
|
| 16 |
+
- π€ **AI Integration**: Gemini AI chat with voice transcription
|
| 17 |
+
- π **MCP Server**: Built-in server for AI assistant integration
|
| 18 |
+
- π **Online Access**: Deploy to Hugging Face Spaces for worldwide access
|
| 19 |
+
|
| 20 |
+
## π Quick Start
|
| 21 |
+
|
| 22 |
+
### Local Development
|
| 23 |
|
| 24 |
```bash
|
| 25 |
+
# Install dependencies
|
| 26 |
+
npm install
|
| 27 |
+
|
| 28 |
+
# Run development server
|
| 29 |
npm run dev
|
| 30 |
+
|
| 31 |
+
# Open http://localhost:3000
|
|
|
|
|
|
|
|
|
|
|
|
|
| 32 |
```
|
| 33 |
|
| 34 |
+
### Deploy to Hugging Face Spaces
|
| 35 |
+
|
| 36 |
+
This project is ready for deployment on [Hugging Face Spaces](https://huggingface.co/spaces):
|
| 37 |
+
|
| 38 |
+
1. Create a new Docker Space on Hugging Face
|
| 39 |
+
2. Clone and push this repository:
|
| 40 |
+
```bash
|
| 41 |
+
git remote add hf https://huggingface.co/spaces/YOUR-USERNAME/reubenos
|
| 42 |
+
git push hf main
|
| 43 |
+
```
|
| 44 |
+
3. Your app will be live at `https://YOUR-USERNAME-reubenos.hf.space`
|
| 45 |
+
|
| 46 |
+
For detailed deployment instructions, see **[README-HF.md](./README-HF.md)**
|
| 47 |
+
|
| 48 |
+
## π§ MCP Server Access
|
| 49 |
+
|
| 50 |
+
The MCP server allows AI assistants to manage files and generate documents. After deploying to Hugging Face Spaces, configure Claude Desktop:
|
| 51 |
+
|
| 52 |
+
```json
|
| 53 |
+
{
|
| 54 |
+
"mcpServers": {
|
| 55 |
+
"reubenos": {
|
| 56 |
+
"command": "node",
|
| 57 |
+
"args": ["/path/to/mcp-server.js"],
|
| 58 |
+
"env": {
|
| 59 |
+
"REUBENOS_URL": "https://YOUR-USERNAME-reubenos.hf.space"
|
| 60 |
+
}
|
| 61 |
+
}
|
| 62 |
+
}
|
| 63 |
+
}
|
| 64 |
+
```
|
| 65 |
|
| 66 |
+
## π Documentation
|
| 67 |
|
| 68 |
+
- **[README-HF.md](./README-HF.md)** - Complete Hugging Face Spaces deployment guide
|
| 69 |
+
- **[SESSION_SYSTEM.md](./SESSION_SYSTEM.md)** - Session management documentation
|
| 70 |
+
- **[CLAUDE_DESKTOP_SETUP.md](./CLAUDE_DESKTOP_SETUP.md)** - MCP server setup guide
|
| 71 |
+
- **[RUN_INSTRUCTIONS.md](./RUN_INSTRUCTIONS.md)** - Detailed running instructions
|
| 72 |
|
| 73 |
+
## π οΈ Technology Stack
|
| 74 |
|
| 75 |
+
- **Frontend**: Next.js 16, React 19, TailwindCSS
|
| 76 |
+
- **Backend**: Node.js with MCP SDK
|
| 77 |
+
- **Document Processing**: docx, pdfkit, exceljs, officegen
|
| 78 |
+
- **AI**: Google Gemini API
|
| 79 |
+
- **Deployment**: Docker, Hugging Face Spaces
|
| 80 |
|
| 81 |
+
## π License
|
|
|
|
| 82 |
|
| 83 |
+
MIT License - see LICENSE file for details
|
| 84 |
|
| 85 |
+
---
|
| 86 |
|
| 87 |
+
**Made with β€οΈ for the AI community**
|
| 88 |
|
| 89 |
+
*This project is optimized for Hugging Face Spaces deployment, making AI-powered file management accessible to everyone!*
|
app/api/health/route.ts
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
import { NextResponse } from 'next/server';
|
| 2 |
+
|
| 3 |
+
export async function GET() {
|
| 4 |
+
return NextResponse.json(
|
| 5 |
+
{
|
| 6 |
+
status: 'healthy',
|
| 7 |
+
timestamp: new Date().toISOString(),
|
| 8 |
+
service: 'ReubenOS',
|
| 9 |
+
version: '1.0.0',
|
| 10 |
+
},
|
| 11 |
+
{ status: 200 }
|
| 12 |
+
);
|
| 13 |
+
}
|
next.config.mjs
CHANGED
|
@@ -5,6 +5,14 @@ const nextConfig = {
|
|
| 5 |
|
| 6 |
// Transpile specific packages if needed
|
| 7 |
transpilePackages: ['react-pdf'],
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 8 |
}
|
| 9 |
|
| 10 |
export default nextConfig
|
|
|
|
| 5 |
|
| 6 |
// Transpile specific packages if needed
|
| 7 |
transpilePackages: ['react-pdf'],
|
| 8 |
+
|
| 9 |
+
// Enable standalone output for Docker deployment
|
| 10 |
+
output: 'standalone',
|
| 11 |
+
|
| 12 |
+
// Configure for Hugging Face Spaces deployment
|
| 13 |
+
experimental: {
|
| 14 |
+
outputFileTracingRoot: undefined,
|
| 15 |
+
},
|
| 16 |
}
|
| 17 |
|
| 18 |
export default nextConfig
|