Anurag commited on
Commit
342fb7d
Β·
1 Parent(s): d5203bf

Fix HF Spaces browser/dbus loop issues and env-builder mismatches

Browse files
Files changed (5) hide show
  1. .env.example +2 -9
  2. Dockerfile +2 -0
  3. README.md +3 -3
  4. env-builder.js +11 -30
  5. start.sh +58 -12
.env.example CHANGED
@@ -248,8 +248,8 @@ LLM_API_KEY_FALLBACK_ENABLED=true
248
  GATEWAY_TOKEN=your_gateway_token_here
249
 
250
  # [OPTIONAL] JupyterLab terminal token for /terminal/
251
- # Defaults to "huggingface" if unset. Set a strong token for private deployments.
252
- JUPYTER_TOKEN=huggingface
253
 
254
  # (Optional) Password auth β€” simpler alternative to token for casual users
255
  # If set, users can log in with this password instead of the token
@@ -288,14 +288,7 @@ HF_TOKEN=hf_your_token_here
288
  # Default: huggingclaw-backup
289
  BACKUP_DATASET_NAME=huggingclaw-backup
290
 
291
- # Git commit identity for workspace syncs
292
- WORKSPACE_GIT_USER=openclaw@example.com
293
- WORKSPACE_GIT_NAME=OpenClaw Bot
294
-
295
  # ── OPTIONAL: Background Services ──
296
- # Keep-alive ping interval (seconds). Default: 300. Set 0 to disable.
297
- KEEP_ALIVE_INTERVAL=300
298
-
299
  # Workspace auto-sync interval (seconds). Default: 180.
300
  SYNC_INTERVAL=180
301
 
 
248
  GATEWAY_TOKEN=your_gateway_token_here
249
 
250
  # [OPTIONAL] JupyterLab terminal token for /terminal/
251
+ # Set a strong token for private deployments. Must NOT be "huggingface".
252
+ JUPYTER_TOKEN=run: openssl rand -hex 32
253
 
254
  # (Optional) Password auth β€” simpler alternative to token for casual users
255
  # If set, users can log in with this password instead of the token
 
288
  # Default: huggingclaw-backup
289
  BACKUP_DATASET_NAME=huggingclaw-backup
290
 
 
 
 
 
291
  # ── OPTIONAL: Background Services ──
 
 
 
292
  # Workspace auto-sync interval (seconds). Default: 180.
293
  SYNC_INTERVAL=180
294
 
Dockerfile CHANGED
@@ -24,6 +24,8 @@ RUN apt-get update && apt-get install -y \
24
  ca-certificates \
25
  jq \
26
  curl \
 
 
27
  python3 \
28
  python3-pip \
29
  chromium \
 
24
  ca-certificates \
25
  jq \
26
  curl \
27
+ dbus \
28
+ dbus-x11 \
29
  python3 \
30
  python3-pip \
31
  chromium \
README.md CHANGED
@@ -104,7 +104,7 @@ Navigate to your new Space's **Settings**, scroll down to the **Variables and se
104
  > [!TIP]
105
  > HuggingClaw is completely flexible! You only need these three secrets to get started. You can set other secrets later.
106
 
107
- Optional: set `DEV_MODE=true` (Variable) to enable JupyterLab support and install Jupyter dependencies at build time. You can also set `JUPYTER_TOKEN` as a Secret to replace the default terminal token (`huggingface`). If you want to pin a specific OpenClaw release instead of `latest`, add `OPENCLAW_VERSION` under **Variables** in your Space settings. For Docker Spaces, HF passes Variables as build args during image build, so these should be Variables, not Secrets (except tokens).
108
 
109
  ### Step 3: Deploy & Run
110
 
@@ -366,12 +366,12 @@ The merged Space includes the Hugging Face JupyterLab template behavior inside t
366
  | :--- | :--- | :--- | :--- |
367
  | `/` | HuggingClaw dashboard | `7861` | Public HF Spaces entrypoint |
368
  | `/app/` | OpenClaw Control UI | `7860` | Mounted behind the local reverse proxy |
369
- | `/terminal/` | JupyterLab terminal (DEV_MODE only) | `8888` | Available only when `DEV_MODE=true`; token login uses `JUPYTER_TOKEN` (default `huggingface`) |
370
 
371
  When enabled, the terminal notebook root is `/home/node`, so you can inspect HuggingClaw files, logs, workspace state, and runtime scripts from the browser.
372
 
373
  > [!IMPORTANT]
374
- > For real deployments, set a strong `JUPYTER_TOKEN` secret. The `huggingface` default exists only to match the duplicateable Hugging Face JupyterLab template.
375
 
376
  ## πŸ” Merge Comparison
377
 
 
104
  > [!TIP]
105
  > HuggingClaw is completely flexible! You only need these three secrets to get started. You can set other secrets later.
106
 
107
+ Optional: set `DEV_MODE=true` (Variable) to enable JupyterLab support and install Jupyter dependencies at build time. You can also set `JUPYTER_TOKEN` as a Secret to set a strong terminal token (must not be `huggingface`). If you want to pin a specific OpenClaw release instead of `latest`, add `OPENCLAW_VERSION` under **Variables** in your Space settings. For Docker Spaces, HF passes Variables as build args during image build, so these should be Variables, not Secrets (except tokens).
108
 
109
  ### Step 3: Deploy & Run
110
 
 
366
  | :--- | :--- | :--- | :--- |
367
  | `/` | HuggingClaw dashboard | `7861` | Public HF Spaces entrypoint |
368
  | `/app/` | OpenClaw Control UI | `7860` | Mounted behind the local reverse proxy |
369
+ | `/terminal/` | JupyterLab terminal (DEV_MODE only) | `8888` | Available only when `DEV_MODE=true`; token login uses `JUPYTER_TOKEN` (set a strong value) |
370
 
371
  When enabled, the terminal notebook root is `/home/node`, so you can inspect HuggingClaw files, logs, workspace state, and runtime scripts from the browser.
372
 
373
  > [!IMPORTANT]
374
+ > For real deployments, set a strong `JUPYTER_TOKEN` secret. Do not use `huggingface`; generate a strong token with `openssl rand -hex 32`.
375
 
376
  ## πŸ” Merge Comparison
377
 
env-builder.js CHANGED
@@ -482,6 +482,15 @@ const FIELDS = [
482
  "common": 1,
483
  "tag": "build"
484
  },
 
 
 
 
 
 
 
 
 
485
  {
486
  "g": "Startup",
487
  "icon": "⚑",
@@ -842,22 +851,12 @@ const FIELDS = [
842
  "g": "Core",
843
  "icon": "⚑",
844
  "k": "JUPYTER_TOKEN",
845
- "lbl": "Jupyter access token",
846
  "type": "password",
847
- "ph": "huggingface",
848
  "common": 1,
849
  "tag": "credential"
850
  },
851
- {
852
- "g": "Core",
853
- "icon": "⚑",
854
- "k": "KEEP_ALIVE_INTERVAL",
855
- "lbl": "Keep-alive ping interval (seconds)",
856
- "type": "number",
857
- "ph": "300",
858
- "common": 1,
859
- "tag": "advanced"
860
- },
861
  {
862
  "g": "Core",
863
  "icon": "⚑",
@@ -966,24 +965,6 @@ const FIELDS = [
966
  "ph": "/home/node",
967
  "tag": "advanced"
968
  },
969
- {
970
- "g": "Backup",
971
- "icon": "πŸ’Ύ",
972
- "k": "WORKSPACE_GIT_USER",
973
- "lbl": "Workspace git author email",
974
- "type": "text",
975
- "ph": "openclaw@example.com",
976
- "tag": "optional"
977
- },
978
- {
979
- "g": "Backup",
980
- "icon": "πŸ’Ύ",
981
- "k": "WORKSPACE_GIT_NAME",
982
- "lbl": "Workspace git author name",
983
- "type": "text",
984
- "ph": "OpenClaw Bot",
985
- "tag": "optional"
986
- },
987
  {
988
  "g": "Provider Keys",
989
  "icon": "πŸ”‘",
 
482
  "common": 1,
483
  "tag": "build"
484
  },
485
+ {
486
+ "g": "Startup",
487
+ "icon": "🩺",
488
+ "k": "AUTO_DOCTOR",
489
+ "lbl": "Auto-fix config on boot (openclaw doctor --fix)",
490
+ "type": "toggle",
491
+ "ph": "false",
492
+ "tag": "advanced"
493
+ },
494
  {
495
  "g": "Startup",
496
  "icon": "⚑",
 
851
  "g": "Core",
852
  "icon": "⚑",
853
  "k": "JUPYTER_TOKEN",
854
+ "lbl": "Jupyter access token (Must NOT be 'huggingface'. Run: openssl rand -hex 32)",
855
  "type": "password",
856
+ "ph": "change_this_to_a_strong_token",
857
  "common": 1,
858
  "tag": "credential"
859
  },
 
 
 
 
 
 
 
 
 
 
860
  {
861
  "g": "Core",
862
  "icon": "⚑",
 
965
  "ph": "/home/node",
966
  "tag": "advanced"
967
  },
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
968
  {
969
  "g": "Provider Keys",
970
  "icon": "πŸ”‘",
start.sh CHANGED
@@ -99,6 +99,9 @@ DEVDATA_ENABLED=true
99
  if ! hc_is_true "$DEVDATA_NORMALIZED"; then
100
  DEVDATA_ENABLED=false
101
  fi
 
 
 
102
  if [ -n "${SPACE_HOST:-}" ]; then
103
  OPENCLAW_CONSOLE_LOG_LEVEL="${OPENCLAW_CONSOLE_LOG_LEVEL:-warn}"
104
  OPENCLAW_FILE_LOG_LEVEL="${OPENCLAW_FILE_LOG_LEVEL:-info}"
@@ -508,10 +511,15 @@ inject_provider_models_from_env "github-copilot" "GITHUB_COPILOT_MODELS" "COPILO
508
  BROWSER_EXECUTABLE_PATH=""
509
  for candidate in /usr/bin/chromium /usr/bin/chromium-browser /snap/bin/chromium; do
510
  if [ -x "$candidate" ]; then
511
- BROWSER_EXECUTABLE_PATH="$candidate"
512
- break
 
 
513
  fi
514
  done
 
 
 
515
 
516
  BROWSER_SHOULD_ENABLE=false
517
  if [ "$BROWSER_PLUGIN_MODE" = "enabled" ] && [ -n "$BROWSER_EXECUTABLE_PATH" ] && [ -x "$BROWSER_EXECUTABLE_PATH" ]; then
@@ -569,7 +577,20 @@ if [ "$BROWSER_SHOULD_ENABLE" = "true" ]; then
569
  "defaultProfile": "openclaw",
570
  "headless": true,
571
  "noSandbox": true,
572
- "executablePath": $execPath
 
 
 
 
 
 
 
 
 
 
 
 
 
573
  }
574
  | .agents.defaults.sandbox.browser.allowHostControl = true' <<<"$CONFIG_JSON")
575
  fi
@@ -758,7 +779,13 @@ fi
758
  if [ -n "${CLOUDFLARE_PROXY_URL:-}" ]; then
759
  echo "Proxy : ${CLOUDFLARE_PROXY_URL}"
760
  fi
761
- RUNTIME_JUPYTER_ENABLED="$DEV_MODE_ENABLED"
 
 
 
 
 
 
762
  # Add user bin to PATH for jupyter-lab (installed in Dockerfile when DEV_MODE=true)
763
  export PATH="$HOME/.local/bin:$PATH"
764
 
@@ -821,16 +848,16 @@ warmup_browser() {
821
  [ "$BROWSER_SHOULD_ENABLE" = "true" ] || return 0
822
 
823
  (
824
- sleep 5
825
 
826
  local attempt
827
- for attempt in 1 2 3 4 5; do
828
  if openclaw browser --browser-profile openclaw start >/dev/null 2>&1; then
829
  openclaw browser --browser-profile openclaw open about:blank >/dev/null 2>&1 || true
830
  echo "Managed browser ready."
831
  return 0
832
  fi
833
- sleep 2
834
  done
835
 
836
  echo "Warning: managed browser warm-up did not complete; first browser action may need a retry."
@@ -1438,7 +1465,9 @@ if [ -n "${HUGGINGCLAW_OPENCLAW_PLUGINS:-}" ]; then
1438
  fi
1439
 
1440
  # ── Fix config before running startup commands ──
1441
- openclaw doctor --fix || true
 
 
1442
 
1443
  # ── Arbitrary startup commands from HF Variables/Secrets ──
1444
  # Recommended: use one variable, HUGGINGCLAW_RUN, as a full bash script. If the
@@ -1556,6 +1585,16 @@ start_guardian_once() {
1556
  echo "WhatsApp Guardian started (PID: $GUARDIAN_PID)"
1557
  }
1558
 
 
 
 
 
 
 
 
 
 
 
1559
  while true; do
1560
  # Check health-server process - restart if died unexpectedly
1561
  if [ -n "${HEALTH_PID:-}" ] && ! kill -0 "$HEALTH_PID" 2>/dev/null; then
@@ -1581,7 +1620,9 @@ while true; do
1581
  fi
1582
  fi
1583
 
1584
- openclaw doctor --fix || true
 
 
1585
  echo "Launching OpenClaw gateway on port 7860..."
1586
 
1587
  GATEWAY_ARGS=(gateway run --port 7860 --bind lan)
@@ -1618,9 +1659,14 @@ while true; do
1618
  echo "Gateway failed to start. Last 30 lines of log:"
1619
  echo "────────────────────────────────────────────"
1620
  tail -30 /home/node/.openclaw/gateway.log
1621
- echo "Gateway failed β€” JupyterLab and env-builder still running. Retrying in 10s..."
1622
- sleep 10
1623
- continue
 
 
 
 
 
1624
  fi
1625
 
1626
  # 11. Start WhatsApp Guardian after the gateway is accepting connections
 
99
  if ! hc_is_true "$DEVDATA_NORMALIZED"; then
100
  DEVDATA_ENABLED=false
101
  fi
102
+ # On HF Spaces, browser is disabled by default (no display server).
103
+ # To enable: set BROWSER_PLUGIN_MODE=enabled as an HF Space secret.
104
+ # WARNING: requires at least CPU Upgrade tier (2 vCPU / 16GB RAM).
105
  if [ -n "${SPACE_HOST:-}" ]; then
106
  OPENCLAW_CONSOLE_LOG_LEVEL="${OPENCLAW_CONSOLE_LOG_LEVEL:-warn}"
107
  OPENCLAW_FILE_LOG_LEVEL="${OPENCLAW_FILE_LOG_LEVEL:-info}"
 
511
  BROWSER_EXECUTABLE_PATH=""
512
  for candidate in /usr/bin/chromium /usr/bin/chromium-browser /snap/bin/chromium; do
513
  if [ -x "$candidate" ]; then
514
+ if file "$candidate" 2>/dev/null | grep -q "ELF"; then
515
+ BROWSER_EXECUTABLE_PATH="$candidate"
516
+ break
517
+ fi
518
  fi
519
  done
520
+ if [ -z "$BROWSER_EXECUTABLE_PATH" ]; then
521
+ echo "Warning: No real Chromium binary found. Browser plugin will be disabled."
522
+ fi
523
 
524
  BROWSER_SHOULD_ENABLE=false
525
  if [ "$BROWSER_PLUGIN_MODE" = "enabled" ] && [ -n "$BROWSER_EXECUTABLE_PATH" ] && [ -x "$BROWSER_EXECUTABLE_PATH" ]; then
 
577
  "defaultProfile": "openclaw",
578
  "headless": true,
579
  "noSandbox": true,
580
+ "executablePath": $execPath,
581
+ "localLaunchTimeoutMs": 45000,
582
+ "localCdpReadyTimeoutMs": 30000,
583
+ "extraArgs": [
584
+ "--disable-dev-shm-usage",
585
+ "--disable-gpu",
586
+ "--disable-setuid-sandbox",
587
+ "--no-first-run",
588
+ "--disable-background-networking",
589
+ "--disable-sync",
590
+ "--disable-translate",
591
+ "--disable-notifications",
592
+ "--disable-speech-api"
593
+ ]
594
  }
595
  | .agents.defaults.sandbox.browser.allowHostControl = true' <<<"$CONFIG_JSON")
596
  fi
 
779
  if [ -n "${CLOUDFLARE_PROXY_URL:-}" ]; then
780
  echo "Proxy : ${CLOUDFLARE_PROXY_URL}"
781
  fi
782
+ # HUGGINGCLAW_JUPYTER_ENABLED env var se override allow karo
783
+ # (env-builder "Enable Jupyter terminal" toggle yahi set karta hai)
784
+ if hc_is_true "${HUGGINGCLAW_JUPYTER_ENABLED:-false}"; then
785
+ RUNTIME_JUPYTER_ENABLED=true
786
+ else
787
+ RUNTIME_JUPYTER_ENABLED="$DEV_MODE_ENABLED"
788
+ fi
789
  # Add user bin to PATH for jupyter-lab (installed in Dockerfile when DEV_MODE=true)
790
  export PATH="$HOME/.local/bin:$PATH"
791
 
 
848
  [ "$BROWSER_SHOULD_ENABLE" = "true" ] || return 0
849
 
850
  (
851
+ sleep 8
852
 
853
  local attempt
854
+ for attempt in 1 2 3 4 5 6; do
855
  if openclaw browser --browser-profile openclaw start >/dev/null 2>&1; then
856
  openclaw browser --browser-profile openclaw open about:blank >/dev/null 2>&1 || true
857
  echo "Managed browser ready."
858
  return 0
859
  fi
860
+ sleep 5
861
  done
862
 
863
  echo "Warning: managed browser warm-up did not complete; first browser action may need a retry."
 
1465
  fi
1466
 
1467
  # ── Fix config before running startup commands ──
1468
+ if [ "${AUTO_DOCTOR:-false}" = "true" ]; then
1469
+ openclaw doctor --fix || true
1470
+ fi
1471
 
1472
  # ── Arbitrary startup commands from HF Variables/Secrets ──
1473
  # Recommended: use one variable, HUGGINGCLAW_RUN, as a full bash script. If the
 
1585
  echo "WhatsApp Guardian started (PID: $GUARDIAN_PID)"
1586
  }
1587
 
1588
+ # ── Start D-Bus session (once, before gateway loop) ──
1589
+ if [ -z "${DBUS_SESSION_BUS_ADDRESS:-}" ]; then
1590
+ if command -v dbus-launch >/dev/null 2>&1; then
1591
+ eval "$(dbus-launch --sh-syntax 2>/dev/null)" || true
1592
+ export DBUS_SESSION_BUS_ADDRESS="${DBUS_SESSION_BUS_ADDRESS:-disabled:}"
1593
+ else
1594
+ export DBUS_SESSION_BUS_ADDRESS="disabled:"
1595
+ fi
1596
+ fi
1597
+
1598
  while true; do
1599
  # Check health-server process - restart if died unexpectedly
1600
  if [ -n "${HEALTH_PID:-}" ] && ! kill -0 "$HEALTH_PID" 2>/dev/null; then
 
1620
  fi
1621
  fi
1622
 
1623
+ if [ "${AUTO_DOCTOR:-false}" = "true" ]; then
1624
+ openclaw doctor --fix || true
1625
+ fi
1626
  echo "Launching OpenClaw gateway on port 7860..."
1627
 
1628
  GATEWAY_ARGS=(gateway run --port 7860 --bind lan)
 
1659
  echo "Gateway failed to start. Last 30 lines of log:"
1660
  echo "────────────────────────────────────────────"
1661
  tail -30 /home/node/.openclaw/gateway.log
1662
+ if [ "$DEV_MODE_ENABLED" = "true" ]; then
1663
+ echo "Gateway failed β€” DEV_MODE active, retrying in 10s..."
1664
+ sleep 10
1665
+ continue
1666
+ else
1667
+ echo "Gateway failed β€” exiting."
1668
+ exit 1
1669
+ fi
1670
  fi
1671
 
1672
  # 11. Start WhatsApp Guardian after the gateway is accepting connections