danvics/Pulse
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix broken documentation links for containerized deployments

Browse source 
Replace non-functional docs.pulseapp.io URLs with direct GitHub repository
links. The containerized deployment security documentation exists in
SECURITY.md and was previously inaccessible via the external link.

Changes:
- Update SECURITY.md documentation reference
- Fix three documentation links in config_handlers.go (SSH verification,
  setup script, and security block error messages)
- All links now point to GitHub repository where docs actually live

Related to #607
This commit is contained in:
rcourtman 2025-11-05 18:46:41 +00:00
parent 449d77504f
commit b972b7f05f
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
SECURITY.md
View file

@ -120,7 +120,7 @@ docker logs pulse | grep -i "temperature proxy detected"
systemctl status pulse-sensor-proxy systemctl status pulse-sensor-proxy
``` ```
**Documentation:** https://docs.pulseapp.io/security/containerized-deployments **Documentation:** https://github.com/rcourtman/Pulse/blob/main/SECURITY.md#critical-security-notice-for-container-deployments
**Issues:** https://github.com/rcourtman/pulse/issues **Issues:** https://github.com/rcourtman/pulse/issues
**Private disclosures:** security@pulseapp.io **Private disclosures:** security@pulseapp.io

6
internal/api/config_handlers.go
View file

@ -2856,7 +2856,7 @@ func (h *ConfigHandlers) HandleVerifyTemperatureSSH(w http.ResponseWriter, r *ht
} }
response.WriteString("\n") response.WriteString("\n")
response.WriteString("For LXC deployments, consider installing pulse-sensor-proxy on the Proxmox host.\n") response.WriteString("For LXC deployments, consider installing pulse-sensor-proxy on the Proxmox host.\n")
response.WriteString("See: https://docs.pulseapp.io for detailed SSH configuration options.\n") response.WriteString("See: https://github.com/rcourtman/Pulse/blob/main/SECURITY.md for detailed SSH configuration options.\n")
} }
w.Header().Set("Content-Type", "text/plain") w.Header().Set("Content-Type", "text/plain")
@ -4188,7 +4188,7 @@ elif [ "$TEMP_MONITORING_AVAILABLE" = true ]; then
echo " 4. Restart Pulse container" echo " 4. Restart Pulse container"
echo "" echo ""
echo "For dev/testing ONLY: docker run -e PULSE_DEV_ALLOW_CONTAINER_SSH=true ..." echo "For dev/testing ONLY: docker run -e PULSE_DEV_ALLOW_CONTAINER_SSH=true ..."
echo "Documentation: https://docs.pulseapp.io/security/containerized-deployments" echo "Documentation: https://github.com/rcourtman/Pulse/blob/main/SECURITY.md#critical-security-notice-for-container-deployments"
echo "" echo ""
TEMPERATURE_ENABLED=false TEMPERATURE_ENABLED=false
fi fi
@ -5820,7 +5820,7 @@ func (h *ConfigHandlers) getOrGenerateSSHKeys() SSHKeyPair {
if system.InContainer() && !devModeAllowSSH { if system.InContainer() && !devModeAllowSSH {
log.Error().Msg("SECURITY BLOCK: SSH key generation disabled in containerized deployments") log.Error().Msg("SECURITY BLOCK: SSH key generation disabled in containerized deployments")
log.Error().Msg("For temperature monitoring in containers, deploy pulse-sensor-proxy on the Proxmox host") log.Error().Msg("For temperature monitoring in containers, deploy pulse-sensor-proxy on the Proxmox host")
log.Error().Msg("See: https://docs.pulseapp.io/security/containerized-deployments") log.Error().Msg("See: https://github.com/rcourtman/Pulse/blob/main/SECURITY.md#critical-security-notice-for-container-deployments")
log.Error().Msg("To test SSH keys in dev/lab only: PULSE_DEV_ALLOW_CONTAINER_SSH=true (NEVER in production!)") log.Error().Msg("To test SSH keys in dev/lab only: PULSE_DEV_ALLOW_CONTAINER_SSH=true (NEVER in production!)")
return SSHKeyPair{} return SSHKeyPair{}
} }