somratpro Claude Sonnet 4.6 commited on
Commit
0b075c6
Β·
1 Parent(s): b6e5beb

docs: add duplicate space button, secrets frontmatter, support section

Browse files

- Frontmatter: add secrets: block (LLM_MODEL, LLM_API_KEY, HF_TOKEN,
SERPER_API_KEY, AUTH_JWT_SECRET, CLOUDFLARE_WORKERS_TOKEN) β€” pre-fills
secret names and descriptions in the HF Spaces duplicate dialog
- Frontmatter: add license: mit field
- Quick Start: replace text step with clickable Duplicate Space SVG badge
+ add GitHub-style TIP callout for HF_TOKEN recommendation
- More Projects: expand to full table with HF Space + GitHub links for
all @somratpro projects (HuggingClip, HuggingClaw, HuggingMes,
Hugging8n, HuggingPost)
- Add Support / USDT section matching HuggingClip style

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

Files changed (1) hide show
  1. README.md +56 -17
README.md CHANGED
@@ -6,6 +6,20 @@ colorTo: blue
6
  sdk: docker
7
  app_port: 7860
8
  pinned: false
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
  ---
10
 
11
  <div align="center">
@@ -74,27 +88,33 @@ DeerFlow conducts multi-step research: it queries search engines, fetches web pa
74
 
75
  ## Quick Start
76
 
77
- ### Deploy on Hugging Face Spaces
78
 
79
- 1. **Duplicate this Space**
80
 
81
- Go to [somratpro/HuggingFlow](https://huggingface.co/spaces/somratpro/HuggingFlow) β†’ **β‹― β†’ Duplicate Space**
82
 
83
- 2. **Add required secrets**
84
 
85
- Settings β†’ **Variables and Secrets** β†’ add `LLM_MODEL` and `LLM_API_KEY` (see [below](#required-secrets))
 
 
 
 
 
 
86
 
87
- 3. **Wait for build**
88
 
89
- First build pulls pre-built images β€” takes ~5 minutes. Subsequent restarts are instant.
90
 
91
- 4. **Create your admin account**
92
 
93
- Visit `https://<your-space>.hf.space/setup` β†’ create username + password
94
 
95
- 5. **Start researching**
96
 
97
- Open `/workspace` β€” you're live πŸŽ‰
98
 
99
  ---
100
 
@@ -300,17 +320,36 @@ Open `http://localhost:7860` for the dashboard, `http://localhost:7860/setup` to
300
 
301
  ## More Projects
302
 
303
- | Project | Description |
304
- |---------|-------------|
305
- | [HuggingFlow](https://github.com/somratpro/HuggingFlow) | This project β€” DeerFlow on HF Spaces |
306
- | [HuggingClip](https://github.com/somratpro/HuggingClip) | Open-source Clipper running on HF Spaces |
307
- | [DeerFlow](https://github.com/bytedance/deer-flow) | Upstream deep-research agent by ByteDance |
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
308
 
309
  ---
310
 
311
  ## Contributing
312
 
313
- Issues and PRs welcome. Please open an issue first for large changes.
314
 
315
  ```
316
  Fork β†’ branch β†’ commit β†’ PR
 
6
  sdk: docker
7
  app_port: 7860
8
  pinned: false
9
+ license: mit
10
+ secrets:
11
+ - name: LLM_MODEL
12
+ description: "Model in provider/model-name format β€” e.g. openai/gpt-4o, anthropic/claude-sonnet-4-5, google/gemini-2.5-flash"
13
+ - name: LLM_API_KEY
14
+ description: API key for the chosen LLM provider.
15
+ - name: HF_TOKEN
16
+ description: Hugging Face token (write access) β€” enables thread backup/restore to a private HF Dataset.
17
+ - name: SERPER_API_KEY
18
+ description: "Serper API key for real Google Search results (recommended). Free tier: 2,500 queries/month."
19
+ - name: AUTH_JWT_SECRET
20
+ description: "JWT signing secret β€” keeps sessions alive across restarts. Generate: openssl rand -base64 32"
21
+ - name: CLOUDFLARE_WORKERS_TOKEN
22
+ description: "Cloudflare API token β€” auto-creates an outbound proxy Worker and a keep-awake cron Worker."
23
  ---
24
 
25
  <div align="center">
 
88
 
89
  ## Quick Start
90
 
91
+ ### Step 1 β€” Duplicate this Space
92
 
93
+ [![Duplicate this Space](https://huggingface.co/datasets/huggingface/badges/resolve/main/duplicate-this-space-xl.svg)](https://huggingface.co/spaces/somratpro/HuggingFlow?duplicate=true)
94
 
95
+ ### Step 2 β€” Add required secrets
96
 
97
+ In your new Space β†’ **Settings β†’ Variables and Secrets**, add at minimum:
98
 
99
+ | Secret | Description |
100
+ |--------|-------------|
101
+ | `LLM_MODEL` | Model in `provider/model-name` format β€” e.g. `openai/gpt-4o` |
102
+ | `LLM_API_KEY` | API key for the chosen provider |
103
+
104
+ > [!TIP]
105
+ > Add `HF_TOKEN` (a token with write access to your account) to enable thread backup persistence. Without it, all research threads are lost on restart.
106
 
107
+ ### Step 3 β€” Wait for build
108
 
109
+ First build pulls pre-built GHCR images β€” takes ~5 minutes. Subsequent restarts are instant (no rebuild).
110
 
111
+ ### Step 4 β€” Create your admin account
112
 
113
+ Visit `https://<your-space>.hf.space/setup` β†’ create username + password.
114
 
115
+ ### Step 5 β€” Start researching
116
 
117
+ Open `/workspace` β€” you're live πŸŽ‰
118
 
119
  ---
120
 
 
320
 
321
  ## More Projects
322
 
323
+ Similar projects by [@somratpro](https://github.com/somratpro) β€” all free, one-click deploy on HF Spaces:
324
+
325
+ | Project | What it runs | HF Space | GitHub |
326
+ |---------|-------------|----------|--------|
327
+ | **HuggingClip** | Paperclip β€” AI agent orchestration | [Space](https://huggingface.co/spaces/somratpro/HuggingClip) | [Repo](https://github.com/somratpro/HuggingClip) |
328
+ | **HuggingClaw** | OpenClaw β€” Claude Code in the browser | [Space](https://huggingface.co/spaces/somratpro/HuggingClaw) | [Repo](https://github.com/somratpro/HuggingClaw) |
329
+ | **HuggingMes** | Hermes β€” self-hosted agent gateway | [Space](https://huggingface.co/spaces/somratpro/HuggingMes) | [Repo](https://github.com/somratpro/HuggingMes) |
330
+ | **Hugging8n** | n8n β€” workflow & automation platform | [Space](https://huggingface.co/spaces/somratpro/Hugging8n) | [Repo](https://github.com/somratpro/Hugging8n) |
331
+ | **HuggingPost** | Postiz β€” social media scheduler | [Space](https://huggingface.co/spaces/somratpro/HuggingPost) | [Repo](https://github.com/somratpro/HuggingPost) |
332
+
333
+ ---
334
+
335
+ ## ❀️ Support
336
+
337
+ If HuggingFlow saves you time, consider buying me a coffee to keep the projects alive!
338
+
339
+ **USDT (TRC-20 / TRON network only)**
340
+
341
+ ```
342
+ TELx8TJz1W1h7n6SgpgGNNGZXpJCEUZrdB
343
+ ```
344
+
345
+ > [!WARNING]
346
+ > Send **USDT on TRC-20 network only**. Sending other tokens or using a different network will result in permanent loss.
347
 
348
  ---
349
 
350
  ## Contributing
351
 
352
+ Contributions welcome! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
353
 
354
  ```
355
  Fork β†’ branch β†’ commit β†’ PR