docs: update secrets in README frontmatter
Browse files- OUTBOUND_PROXY_GUIDE.md +4 -1
- README.md +8 -1
OUTBOUND_PROXY_GUIDE.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
| 1 |
# π Outbound Proxy Guide
|
| 2 |
|
| 3 |
-
Hugging Face Spaces officially blocks outgoing connections to specific services like **Telegram**, **WhatsApp**, and **Discord** on the free tier.
|
| 4 |
|
| 5 |
Hugging8n includes a built-in **Transparent Outbound Proxy** that allows you to bypass these restrictions using a single Cloudflare Worker.
|
| 6 |
|
|
@@ -9,6 +9,7 @@ Hugging8n includes a built-in **Transparent Outbound Proxy** that allows you to
|
|
| 9 |
## π Setup in 2 Minutes
|
| 10 |
|
| 11 |
### Step 1: Deploy your Cloudflare Worker
|
|
|
|
| 12 |
1. Log in to [dash.cloudflare.com](https://dash.cloudflare.com/).
|
| 13 |
2. Go to **Workers & Pages** -> **Create Worker**.
|
| 14 |
3. Name it (e.g., `h8n-proxy`).
|
|
@@ -17,6 +18,7 @@ Hugging8n includes a built-in **Transparent Outbound Proxy** that allows you to
|
|
| 17 |
6. Copy your Worker URL (e.g., `h8n-proxy.yourname.workers.dev`).
|
| 18 |
|
| 19 |
### Step 2: Configure Hugging8n
|
|
|
|
| 20 |
Go to your Space **Settings** -> **Variables** and add:
|
| 21 |
|
| 22 |
1. **`OUTBOUND_PROXY_URL`**:
|
|
@@ -27,6 +29,7 @@ Go to your Space **Settings** -> **Variables** and add:
|
|
| 27 |
- **Wildcard Mode**: Set this to `*` to proxy **every single request** n8n makes to the outside world. This is the most reliable way to ensure no node ever gets blocked.
|
| 28 |
|
| 29 |
### Step 3: Restart Space
|
|
|
|
| 30 |
Hugging8n will now automatically intercept all requests to the blocked domains and route them through your worker. **You do not need to change any URLs inside your n8n workflows.**
|
| 31 |
|
| 32 |
---
|
|
|
|
| 1 |
# π Outbound Proxy Guide
|
| 2 |
|
| 3 |
+
Hugging Face Spaces officially blocks outgoing connections to specific services like **Telegram**, **WhatsApp**, and **Discord** on the free tier.
|
| 4 |
|
| 5 |
Hugging8n includes a built-in **Transparent Outbound Proxy** that allows you to bypass these restrictions using a single Cloudflare Worker.
|
| 6 |
|
|
|
|
| 9 |
## π Setup in 2 Minutes
|
| 10 |
|
| 11 |
### Step 1: Deploy your Cloudflare Worker
|
| 12 |
+
|
| 13 |
1. Log in to [dash.cloudflare.com](https://dash.cloudflare.com/).
|
| 14 |
2. Go to **Workers & Pages** -> **Create Worker**.
|
| 15 |
3. Name it (e.g., `h8n-proxy`).
|
|
|
|
| 18 |
6. Copy your Worker URL (e.g., `h8n-proxy.yourname.workers.dev`).
|
| 19 |
|
| 20 |
### Step 2: Configure Hugging8n
|
| 21 |
+
|
| 22 |
Go to your Space **Settings** -> **Variables** and add:
|
| 23 |
|
| 24 |
1. **`OUTBOUND_PROXY_URL`**:
|
|
|
|
| 29 |
- **Wildcard Mode**: Set this to `*` to proxy **every single request** n8n makes to the outside world. This is the most reliable way to ensure no node ever gets blocked.
|
| 30 |
|
| 31 |
### Step 3: Restart Space
|
| 32 |
+
|
| 33 |
Hugging8n will now automatically intercept all requests to the blocked domains and route them through your worker. **You do not need to change any URLs inside your n8n workflows.**
|
| 34 |
|
| 35 |
---
|
README.md
CHANGED
|
@@ -9,7 +9,11 @@ pinned: true
|
|
| 9 |
license: mit
|
| 10 |
secrets:
|
| 11 |
- name: HF_TOKEN
|
| 12 |
-
description: HuggingFace token with write access. Used for automatic backup.
|
|
|
|
|
|
|
|
|
|
|
|
|
| 13 |
---
|
| 14 |
|
| 15 |
# π Hugging8n
|
|
@@ -35,6 +39,7 @@ secrets:
|
|
| 35 |
### Step 2: Configure Secrets
|
| 36 |
|
| 37 |
Go to **Settings > Secrets** and add:
|
|
|
|
| 38 |
- `HF_TOKEN`: Your HuggingFace token with **Write** access.
|
| 39 |
|
| 40 |
### Step 3: Initialize n8n
|
|
@@ -59,6 +64,7 @@ You can customize Hugging8n using Environment Variables (Settings > Variables):
|
|
| 59 |
## π Authentication & Security
|
| 60 |
|
| 61 |
Hugging8n uses n8n's native user management.
|
|
|
|
| 62 |
- The first person to access the n8n editor on a fresh install becomes the **Owner**.
|
| 63 |
- **Important:** If you delete the Space and haven't set up `HF_TOKEN`, your users and workflows will be lost.
|
| 64 |
- **Permissions:** The startup script uses `umask 0077` to ensure all sensitive data is restricted to the node user.
|
|
@@ -66,6 +72,7 @@ Hugging8n uses n8n's native user management.
|
|
| 66 |
## πΎ Persistent Backup
|
| 67 |
|
| 68 |
Hugging8n automatically creates and maintains a private dataset in your Hugging Face account named `hugging8n-backup`.
|
|
|
|
| 69 |
- **Sync Status:** You can check the current sync health directly on the Hugging8n Dashboard.
|
| 70 |
- **Restoration:** On every startup, Hugging8n pulls the latest state from your dataset before launching n8n.
|
| 71 |
|
|
|
|
| 9 |
license: mit
|
| 10 |
secrets:
|
| 11 |
- name: HF_TOKEN
|
| 12 |
+
description: HuggingFace token with write access (Settings > Tokens). Used for automatic backup.
|
| 13 |
+
- name: N8N_ENCRYPTION_KEY
|
| 14 |
+
description: (Optional) Secret key to encrypt your n8n credentials. Generate with 'openssl rand -hex 32'.
|
| 15 |
+
- name: OUTBOUND_PROXY_URL
|
| 16 |
+
description: (Optional) Your Cloudflare Worker URL to bypass platform blocks (Telegram/Discord).
|
| 17 |
---
|
| 18 |
|
| 19 |
# π Hugging8n
|
|
|
|
| 39 |
### Step 2: Configure Secrets
|
| 40 |
|
| 41 |
Go to **Settings > Secrets** and add:
|
| 42 |
+
|
| 43 |
- `HF_TOKEN`: Your HuggingFace token with **Write** access.
|
| 44 |
|
| 45 |
### Step 3: Initialize n8n
|
|
|
|
| 64 |
## π Authentication & Security
|
| 65 |
|
| 66 |
Hugging8n uses n8n's native user management.
|
| 67 |
+
|
| 68 |
- The first person to access the n8n editor on a fresh install becomes the **Owner**.
|
| 69 |
- **Important:** If you delete the Space and haven't set up `HF_TOKEN`, your users and workflows will be lost.
|
| 70 |
- **Permissions:** The startup script uses `umask 0077` to ensure all sensitive data is restricted to the node user.
|
|
|
|
| 72 |
## πΎ Persistent Backup
|
| 73 |
|
| 74 |
Hugging8n automatically creates and maintains a private dataset in your Hugging Face account named `hugging8n-backup`.
|
| 75 |
+
|
| 76 |
- **Sync Status:** You can check the current sync health directly on the Hugging8n Dashboard.
|
| 77 |
- **Restoration:** On every startup, Hugging8n pulls the latest state from your dataset before launching n8n.
|
| 78 |
|