matrixcloud / deploy /hf-space /README.md
github-actions[bot]
Deploy from 4dfd54f2
857a91b
|
Raw
History Blame Contribute Delete
1.38 kB
---
title: MatrixCloud
emoji: 🟒
colorFrom: green
colorTo: indigo
sdk: docker
app_port: 8080
pinned: false
license: apache-2.0
short_description: Self-hostable execution plane for AI β€” MCP sandboxes, models, MatrixShell.
---
# MatrixCloud
The self-hostable **execution plane** for MatrixCloud: run MCP server sandboxes,
inspect Hugging Face models, use the MatrixShell operator terminal, and bring
your own HF token to run HF LLMs β€” all from one console.
This Space runs the single static `matrix-runtime` binary (API + embedded React
console) on port 8080.
## Configure (Space β†’ Settings β†’ Variables and secrets)
**Secrets**
- `MATRIXCLOUD_DATABASE_URL` β€” PostgreSQL/Neon DSN (durable accounts across
rebuilds). Without it, data lives in ephemeral `/tmp` and resets on restart.
- `MATRIXCLOUD_SECRET_KEY` β€” `openssl rand -hex 32` (stable encryption key for
BYO credentials).
- `RESEND_API_KEY` β€” optional; enables welcome/password-reset emails.
**Variables**
- `MATRIXCLOUD_DB_SCHEMA=matrixcloud`
- `MATRIXCLOUD_APP_URL=https://<owner>-matrixcloud.hf.space` (used in email links)
- `MATRIXCLOUD_EMAIL_FROM=MatrixCloud <noreply@matrixhub.io>` (if using Resend)
Open the Space URL, create an account, and you're in. To turn a duplicated
Space into a managed sandbox, use **Add a runtime β†’ Hugging Face Space** in the
console to mint a join token.