tao-shen Claude Opus 4.6 commited on
Commit
b26b9b6
·
1 Parent(s): 674e189

feat: restore architecture diagram with Docker/Sync/DNS layout, yellow+red theme

Browse files

- Architecture SVG: Docker Container with OpenClaw Engine, Sync Service, DNS Resolver
- Users panel on left, HF Dataset + LLM Provider on right
- Yellow (HF) + Red (OpenClaw) color scheme
- README: "the best way", "Why HuggingClaw?" section, 🔥 emoji

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Files changed (2) hide show
  1. README.md +16 -47
  2. assets/architecture.svg +111 -58
README.md CHANGED
@@ -1,8 +1,8 @@
1
  ---
2
  title: HuggingClaw
3
- emoji: 🐾
4
- colorFrom: purple
5
- colorTo: blue
6
  sdk: docker
7
  pinned: false
8
  license: mit
@@ -13,7 +13,7 @@ app_port: 7860
13
  <div align="center">
14
  <img src="HuggingClaw.png" alt="HuggingClaw" width="720"/>
15
  <br/><br/>
16
- <strong>The easiest way to deploy <a href="https://github.com/openclaw/openclaw">OpenClaw</a> on the cloud</strong>
17
  <br/>
18
  <sub>Zero hardware · Always online · Auto-persistent · One-click deploy</sub>
19
  <br/><br/>
@@ -24,13 +24,15 @@ app_port: 7860
24
 
25
  ---
26
 
27
- ## What is HuggingClaw?
28
 
29
- [OpenClaw](https://github.com/openclaw/openclaw) is a self-hosted AI assistant platform with Telegram, WhatsApp integration and a web-based Control UI. It's powerfulbut traditionally requires your own server.
30
 
31
- **HuggingClaw** solves this by packaging OpenClaw for **one-click cloud deployment** on HuggingFace Spaces. No server, no GPU, no DevOps just fork, configure secrets, and go.
32
 
33
- ### Why HuggingFace Spaces?
 
 
34
 
35
  | Feature | Detail |
36
  |---------|--------|
@@ -40,6 +42,12 @@ app_port: 7860
40
  | **HTTPS built-in** | Secure WebSocket connections out of the box |
41
  | **One-click deploy** | Fork → set secrets → done |
42
 
 
 
 
 
 
 
43
  ## Quick Start
44
 
45
  ### 1. Duplicate this Space
@@ -84,45 +92,6 @@ cp .env.example .env
84
  # Edit .env with your values
85
  ```
86
 
87
- ## Architecture
88
-
89
- ```
90
- HuggingFace Space (Docker)
91
-
92
- ├── OpenClaw Engine (Node.js)
93
- │ ├── Control UI ─────── Web dashboard (port 7860)
94
- │ ├── Telegram Plugin ── Bot integration
95
- │ ├── WhatsApp Plugin ── Messaging integration
96
- │ └── Agent Workflows ── AI assistants
97
-
98
- ├── Sync Service (sync_hf.py)
99
- │ └── Auto-backup ~/.openclaw ↔ HF Dataset repo
100
-
101
- ├── DNS Resolver (dns-resolve.py)
102
- │ └── Pre-resolve WhatsApp domains via DoH
103
-
104
- └── Entrypoint (entrypoint.sh)
105
- └── Orchestrate startup sequence
106
- ```
107
-
108
- **Data flow:**
109
-
110
- ```
111
- Users (Browser/Telegram/WhatsApp)
112
-
113
-
114
- ┌─────────────┐ ┌───────────────┐
115
- │ OpenClaw │────▶│ LLM Provider │
116
- │ Engine │◀────│ (OpenRouter) │
117
- └──────┬──────┘ └───────────────┘
118
-
119
-
120
- ┌─────────────┐ ┌───────────────┐
121
- │ Sync │────▶│ HF Dataset │
122
- │ Service │◀────│ (Backup) │
123
- └─────────────┘ └───────────────┘
124
- ```
125
-
126
  ## Local Development
127
 
128
  ```bash
 
1
  ---
2
  title: HuggingClaw
3
+ emoji: 🔥
4
+ colorFrom: yellow
5
+ colorTo: red
6
  sdk: docker
7
  pinned: false
8
  license: mit
 
13
  <div align="center">
14
  <img src="HuggingClaw.png" alt="HuggingClaw" width="720"/>
15
  <br/><br/>
16
+ <strong>The best way to deploy <a href="https://github.com/openclaw/openclaw">OpenClaw</a> on the cloud</strong>
17
  <br/>
18
  <sub>Zero hardware · Always online · Auto-persistent · One-click deploy</sub>
19
  <br/><br/>
 
24
 
25
  ---
26
 
27
+ ## Why HuggingClaw?
28
 
29
+ [OpenClaw](https://github.com/openclaw/openclaw) is a powerful self-hosted AI assistant platform supporting Telegram, WhatsApp, and 40+ messaging channels. But running it requires a server and not everyone has a Mac Mini or spare hardware sitting around.
30
 
31
+ Cloud hosting is an option, but most providers charge by the hour, and OpenClaw's Node.js runtime needs real resources (it runs comfortably at ~16 GB RAM). That rules out most free tiers.
32
 
33
+ **HuggingFace Spaces** offers the perfect fit: free CPU instances with 2 vCPU and 16 GB RAM, always-on HTTPS, and zero maintenance. There's just one catch — Space containers are **ephemeral**. Every restart wipes your data.
34
+
35
+ **HuggingClaw** solves this by using a private **HuggingFace Dataset** repo as persistent storage. Your conversations, credentials, and settings are automatically synced on a schedule, and restored on every cold start. You get all the benefits of free cloud hosting with none of the data loss.
36
 
37
  | Feature | Detail |
38
  |---------|--------|
 
42
  | **HTTPS built-in** | Secure WebSocket connections out of the box |
43
  | **One-click deploy** | Fork → set secrets → done |
44
 
45
+ ## Architecture
46
+
47
+ <div align="center">
48
+ <img src="assets/architecture.svg" alt="Architecture" width="720"/>
49
+ </div>
50
+
51
  ## Quick Start
52
 
53
  ### 1. Duplicate this Space
 
92
  # Edit .env with your values
93
  ```
94
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
95
  ## Local Development
96
 
97
  ```bash
assets/architecture.svg CHANGED