Spaces:
Paused
Paused
Update README.md
Browse files
README.md
CHANGED
|
@@ -1,12 +1,49 @@
|
|
| 1 |
---
|
| 2 |
-
title:
|
| 3 |
-
emoji:
|
| 4 |
-
colorFrom:
|
| 5 |
-
colorTo:
|
| 6 |
sdk: docker
|
| 7 |
-
|
| 8 |
-
license: mit
|
| 9 |
-
short_description: a basic lobster implementation with hf inference providers
|
| 10 |
---
|
| 11 |
|
| 12 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
+
title: OpenClaw Gateway
|
| 3 |
+
emoji: 🦞
|
| 4 |
+
colorFrom: blue
|
| 5 |
+
colorTo: indigo
|
| 6 |
sdk: docker
|
| 7 |
+
app_port: 7860
|
|
|
|
|
|
|
| 8 |
---
|
| 9 |
|
| 10 |
+
# OpenClaw Gateway on Hugging Face Spaces
|
| 11 |
+
|
| 12 |
+
This Space runs the [OpenClaw](https://github.com/openclaw/openclaw) gateway so you can use the Control UI and connect clients over the internet.
|
| 13 |
+
|
| 14 |
+
## Quick start
|
| 15 |
+
|
| 16 |
+
1. **Create a new Space** at [huggingface.co/new-space](https://huggingface.co/new-space). Choose **Docker** as the SDK.
|
| 17 |
+
2. **Copy the contents of this folder** into your Space repo:
|
| 18 |
+
- This `README.md` (including the YAML block above)
|
| 19 |
+
- The `Dockerfile` from the same directory in the [openclaw repo](https://github.com/josephrp/openclaw/tree/hf-spaces/spaces/huggingface).
|
| 20 |
+
3. **Add a secret** in your Space **Settings → Secrets**:
|
| 21 |
+
- `OPENCLAW_GATEWAY_TOKEN` — set to a long random string (e.g. generate with `openssl rand -hex 24`). You’ll paste this into the Control UI to authenticate.
|
| 22 |
+
4. **Build and run** — push to the Space repo; the Space will build and start the gateway.
|
| 23 |
+
|
| 24 |
+
When the Space is running, open your Space’s URL (e.g. `https://your-username-openclaw-gateway.hf.space`) and paste the token in **Settings → token**.
|
| 25 |
+
|
| 26 |
+
## Keep it running 24/7
|
| 27 |
+
|
| 28 |
+
- **Free hardware:** The Space will **sleep after ~48 hours** of inactivity. Anyone opening the URL will wake it.
|
| 29 |
+
- **Paid hardware:** In **Settings → Hardware**, upgrade to a paid CPU (or other tier). Upgraded Spaces run **indefinitely** by default. You can set **Sleep time** to “Never” if desired.
|
| 30 |
+
|
| 31 |
+
## Persist config and workspace
|
| 32 |
+
|
| 33 |
+
Without persistent storage, config and workspace are lost when the Space restarts. To keep them:
|
| 34 |
+
|
| 35 |
+
1. In **Settings → Storage**, add **persistent storage** for the Space.
|
| 36 |
+
2. The Dockerfile already sets `OPENCLAW_HOME=/data`, so the gateway stores config and workspace under `/data/.openclaw`, which is persisted.
|
| 37 |
+
|
| 38 |
+
## Optional Space variables (build args)
|
| 39 |
+
|
| 40 |
+
You can set these in **Settings → Variables** (or as build args) to customize the build:
|
| 41 |
+
|
| 42 |
+
- `OPENCLAW_REPO` — Git URL of the OpenClaw repo (default: `https://github.com/openclaw/openclaw.git`).
|
| 43 |
+
- `OPENCLAW_REF` — Branch or tag to clone (default: `main`).
|
| 44 |
+
|
| 45 |
+
## More
|
| 46 |
+
|
| 47 |
+
- [OpenClaw docs](https://docs.openclaw.ai)
|
| 48 |
+
- [Docker install (generic)](https://docs.openclaw.ai/install/docker)
|
| 49 |
+
- [Hugging Face Spaces – Docker](https://huggingface.co/docs/hub/spaces-sdks-docker)
|