Skip to content
This repository was archived by the owner on Jan 7, 2026. It is now read-only.

Commit c14b3c8

Browse files
CopilotStolas
andcommitted
Update documentation and secrets file to reflect automatic socket detection
Co-authored-by: Stolas <[email protected]>
1 parent 73519a9 commit c14b3c8

File tree

2 files changed

+23
-10
lines changed

2 files changed

+23
-10
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ This project was 99% developed by AI assistants (Gemini and GitHub Copilot). The
1515
* **Security:** Uses `create_secrets.sh` to generate unique, random, 64-character passwords/tokens for sensitive environment variables.
1616
* **External Storage:** Includes logic to mount an **SMB/CIFS** share for Frigate recordings on the host machine.
1717
* **Resilience:** The `startup.sh` script continues running even if individual service starts fail, providing a complete status report. Nginx automatically adapts to only proxy running services.
18+
* **Automatic Podman Socket Detection:** Node-RED automatically detects and uses the podman socket for docker/container integration. If the socket is unavailable, Node-RED starts in standalone mode without crashing.
1819

1920
## System Requirements
2021

@@ -105,12 +106,10 @@ The script will ask you to choose between:
105106
After the automatic setup, you must manually edit the `secrets.env` file to configure:
106107

107108
* `ZIGBEE_DEVICE_PATH` - Update with the path to your Zigbee adapter (e.g., `/dev/ttyACM0` or `/dev/serial/by-id/...`)
108-
* `PODMAN_SOCKET_PATH` - Update for Node-RED integration. On modern Podman/Leap Micro systems, this is typically:
109-
110-
```bash
111-
PODMAN_SOCKET_PATH=/run/user/$(id -u)/podman/podman.sock
112-
```
113-
109+
* `PODMAN_SOCKET_PATH` - **OPTIONAL** for Node-RED integration. The startup script automatically detects the podman socket for the current user. If you need to specify a custom path, uncomment and update this variable. Common paths:
110+
* Rootless (recommended): `/run/user/$(id -u)/podman/podman.sock`
111+
* Rootful: `/run/podman/podman.sock`
112+
* **Note**: If the socket is not found, Node-RED will still start successfully but without podman/docker integration capabilities.
114113
* Other site-specific variables like `TZ` (timezone), `SMB_SERVER`, `SMB_SHARE`, `SMB_USER` (if using NVR), etc.
115114
* Nginx reverse proxy hostnames: `BASE_DOMAIN`, `GRAFANA_HOSTNAME`, `FRIGATE_HOSTNAME`, `NODERED_HOSTNAME`, `ZIGBEE2MQTT_HOSTNAME`, `COCKPIT_HOSTNAME`, `DOUBLETAKE_HOSTNAME`
116115

secrets.env-example

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
11
# GENERAL HOST CONFIGURATION
22

3-
# Rootful (system service): /run/podman/podman.sock
4-
# Rootless (user service, common on OpenSUSE Micro): /run/user/$(id -u)/podman/podman.sock
5-
6-
PODMAN_SOCKET_PATH=/run/podman/podman.sock
3+
# PODMAN SOCKET PATH (OPTIONAL - Auto-detected if not specified)
4+
#
5+
# The startup script automatically detects the podman socket for Node-RED integration.
6+
# If this variable is not set or the socket is not found, Node-RED will still start
7+
# successfully but without podman/docker integration (limited functionality).
8+
#
9+
# Common socket locations:
10+
# - Rootful (system service): /run/podman/podman.sock
11+
# - Rootless (user service, recommended): /run/user/$(id -u)/podman/podman.sock
12+
#
13+
# Auto-detection priority:
14+
# 1. Path specified here (if set)
15+
# 2. /run/user/$(id -u)/podman/podman.sock (detected dynamically)
16+
# 3. /run/podman/podman.sock (system-wide socket)
17+
#
18+
# You can leave this commented out to use automatic detection, or specify a custom path:
19+
# PODMAN_SOCKET_PATH=/run/podman/podman.sock
20+
PODMAN_SOCKET_PATH=/run/user/1000/podman/podman.sock
721

822
# Zigbee Adapter Path
923

0 commit comments

Comments
 (0)