2.4 KiB
Port Configuration Guide
Pulse supports multiple ways to configure the frontend port (default: 7655).
Development tip: The hot-reload scripts (
scripts/dev-hot.sh,scripts/hot-dev.sh, andmake dev-hot) load.env,.env.local, and.env.dev. SetFRONTEND_PORTorPULSE_DEV_API_PORTthere to run the backend on a different port while keeping the generatedcurlcommands and Vite proxy in sync.
Recommended Methods
1. During Installation (Easiest)
The installer prompts for the port. To skip the prompt, use:
FRONTEND_PORT=8080 curl -fsSL https://raw.githubusercontent.com/rcourtman/Pulse/main/install.sh | bash
2. Using systemd override (For existing installations)
sudo systemctl edit pulse
Add these lines:
[Service]
Environment="FRONTEND_PORT=8080"
Then restart: sudo systemctl restart pulse
3. Using system.json (Alternative method)
Edit /etc/pulse/system.json:
{
"frontendPort": 8080
}
Then restart: sudo systemctl restart pulse
4. Using environment variables (Docker)
For Docker deployments:
docker run -e FRONTEND_PORT=8080 -p 8080:8080 rcourtman/pulse:latest
Priority Order
Pulse checks for port configuration in this order:
FRONTEND_PORTenvironment variablePORTenvironment variable (legacy)frontendPortin system.json- Default: 7655
Environment variables always override configuration files.
Why not .env?
The /etc/pulse/.env file is reserved exclusively for authentication credentials:
API_TOKEN- API authentication token (hashed)PULSE_AUTH_USER- Web UI usernamePULSE_AUTH_PASS- Web UI password (hashed)
Keeping application configuration separate from authentication credentials:
- Makes it clear what's a secret vs what's configuration
- Allows different permission models if needed
- Follows the principle of separation of concerns
- Makes it easier to backup/share configs without exposing credentials
Troubleshooting
Port not changing after configuration?
-
Check which service name is in use:
systemctl list-units | grep pulseIt might be
pulseorpulse-backenddepending on your installation method. -
Verify the configuration is loaded:
sudo systemctl show pulse | grep Environment -
Check if another process is using the port:
sudo lsof -i :8080