Spaces:
Sleeping
Sleeping
docs: reorganize dashboard documentation and improve table formatting in README
Browse files
README.md
CHANGED
|
@@ -26,7 +26,6 @@ license: mit
|
|
| 26 |
- [π± Telegram Setup *(Optional)*](#-telegram-setup-optional)
|
| 27 |
- [π¬ WhatsApp Setup *(Optional)*](#-whatsapp-setup-optional)
|
| 28 |
- [πΎ Workspace Backup *(Optional)*](#-workspace-backup-optional)
|
| 29 |
-
- [π Dashboard & Monitoring](#-dashboard--monitoring)
|
| 30 |
- [π Webhooks *(Optional)*](#-webhooks-optional)
|
| 31 |
- [π Security & Advanced *(Optional)*](#-security--advanced-optional)
|
| 32 |
- [π€ LLM Providers](#-llm-providers)
|
|
@@ -81,6 +80,15 @@ Optional: if you want to pin a specific OpenClaw release instead of `latest`, ad
|
|
| 81 |
|
| 82 |
That's it! The Space will build the container and start up automatically. You can monitor the build process in the **Logs** tab.
|
| 83 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 84 |
## π± Telegram Setup *(Optional)*
|
| 85 |
|
| 86 |
To chat via Telegram:
|
|
@@ -119,14 +127,6 @@ For persistent chat history and configuration, HuggingClaw can sync your workspa
|
|
| 119 |
> [!TIP]
|
| 120 |
> This backup also stores a hidden copy of your WhatsApp session credentials, allowing paired logins to survive Space restarts automatically.
|
| 121 |
|
| 122 |
-
## π Dashboard & Monitoring
|
| 123 |
-
|
| 124 |
-
HuggingClaw now features a built-in dashboard at `/dashboard`, served from the same public HF Space URL as the Control UI:
|
| 125 |
-
|
| 126 |
-
- **Uptime Tracking:** Real-time uptime monitoring.
|
| 127 |
-
- **Sync Status:** Visual indicators for workspace backup operations.
|
| 128 |
-
- **Model Info:** See which LLM is currently powering your assistant.
|
| 129 |
-
|
| 130 |
## π Webhooks *(Optional)*
|
| 131 |
|
| 132 |
Get notified when your Space restarts or if a backup fails:
|
|
@@ -151,7 +151,7 @@ Configure password access and network restrictions:
|
|
| 151 |
HuggingClaw supports **all providers** from OpenClaw. Set `LLM_MODEL=<provider/model>` and the provider is auto-detected. For example:
|
| 152 |
|
| 153 |
| Provider | Prefix | Example Model | API Key Source |
|
| 154 |
-
|---------------
|
| 155 |
| **Anthropic** | `anthropic/` | `anthropic/claude-sonnet-4-6` | [Anthropic Console](https://console.anthropic.com/) |
|
| 156 |
| **OpenAI** | `openai/` | `openai/gpt-5.4` | [OpenAI Platform](https://platform.openai.com/) |
|
| 157 |
| **Google** | `google/` | `google/gemini-2.5-flash` | [AI Studio](https://ai.google.dev/) |
|
|
|
|
| 26 |
- [π± Telegram Setup *(Optional)*](#-telegram-setup-optional)
|
| 27 |
- [π¬ WhatsApp Setup *(Optional)*](#-whatsapp-setup-optional)
|
| 28 |
- [πΎ Workspace Backup *(Optional)*](#-workspace-backup-optional)
|
|
|
|
| 29 |
- [π Webhooks *(Optional)*](#-webhooks-optional)
|
| 30 |
- [π Security & Advanced *(Optional)*](#-security--advanced-optional)
|
| 31 |
- [π€ LLM Providers](#-llm-providers)
|
|
|
|
| 80 |
|
| 81 |
That's it! The Space will build the container and start up automatically. You can monitor the build process in the **Logs** tab.
|
| 82 |
|
| 83 |
+
### Step 4: Monitor & Manage
|
| 84 |
+
|
| 85 |
+
HuggingClaw features a built-in dashboard at `/dashboard` (served from the same URL as the Control UI) to track:
|
| 86 |
+
|
| 87 |
+
- **Uptime:** Real-time uptime monitoring.
|
| 88 |
+
- **Sync Status:** Visual indicators for workspace backup operations.
|
| 89 |
+
- **Chat Status:** Real-time connection status for WhatsApp and Telegram.
|
| 90 |
+
- **Model Info:** See which LLM is currently powering your assistant.
|
| 91 |
+
|
| 92 |
## π± Telegram Setup *(Optional)*
|
| 93 |
|
| 94 |
To chat via Telegram:
|
|
|
|
| 127 |
> [!TIP]
|
| 128 |
> This backup also stores a hidden copy of your WhatsApp session credentials, allowing paired logins to survive Space restarts automatically.
|
| 129 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 130 |
## π Webhooks *(Optional)*
|
| 131 |
|
| 132 |
Get notified when your Space restarts or if a backup fails:
|
|
|
|
| 151 |
HuggingClaw supports **all providers** from OpenClaw. Set `LLM_MODEL=<provider/model>` and the provider is auto-detected. For example:
|
| 152 |
|
| 153 |
| Provider | Prefix | Example Model | API Key Source |
|
| 154 |
+
| :--------------- | :-------------- | :------------------------------------ | :--------------------------------------------------- |
|
| 155 |
| **Anthropic** | `anthropic/` | `anthropic/claude-sonnet-4-6` | [Anthropic Console](https://console.anthropic.com/) |
|
| 156 |
| **OpenAI** | `openai/` | `openai/gpt-5.4` | [OpenAI Platform](https://platform.openai.com/) |
|
| 157 |
| **Google** | `google/` | `google/gemini-2.5-flash` | [AI Studio](https://ai.google.dev/) |
|