Skip to content

An open source, self-hosted, real-time port monitoring and discovery tool.

feat: add HOST_OVERRIDE env var for reverse proxy support (fixes #51) (#76)

Mostafa Wahiedaf3ccd7099d8
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 9753986..80fb4c7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,10 @@ All notable changes to portracker will be documented in this file.
## [Unreleased]
+### Added
+
+- **Reverse Proxy Support**: New `HOST_OVERRIDE` environment variable allows specifying the hostname used in port links when running behind a reverse proxy (fixes #51)
+
### UI
- **Favicon**: Dark mode support - favicon now adapts to system theme (black on light, white on dark)
diff --git a/backend/index.js b/backend/index.js
index a75b856..68e17f8 100644
--- a/backend/index.js
+++ b/backend/index.js
@@ -35,6 +35,7 @@ const RESP_TTL_PORTS = parseInt(process.env.ENDPOINT_CACHE_PORTS_TTL_MS || '3000
const PORT_SUGGEST_MIN = parseInt(process.env.GENERATE_PORT_MIN || '30000', 10);
const PORT_SUGGEST_MAX = parseInt(process.env.GENERATE_PORT_MAX || '60999', 10);
const PORT_SUGGEST_BIND_HOST = process.env.GENERATE_PORT_BIND_HOST || '0.0.0.0';
+const HOST_OVERRIDE = process.env.HOST_OVERRIDE || '';
const PORT_SUGGEST_MAX_RANDOM_ATTEMPTS = 60;
if (isAuthEnabled()) {
@@ -2450,6 +2451,12 @@ app.get("/api/health", (req, res) => {
}
});
+app.get("/api/config", (req, res) => {
+ res.json({
+ hostOverride: HOST_OVERRIDE || null
+ });
+});
+
app.get('/api/changelog', (req, res) => {
logger.debug("Changelog requested");
try {
diff --git a/docker-compose.yml b/docker-compose.yml
index db4bbcd..5d2aa8c 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -61,6 +61,13 @@ services:
# If not set, a random secret is generated (sessions won't persist across restarts)
# - SESSION_SECRET=your-random-secret-here-change-this
+ # REVERSE PROXY SUPPORT (Optional)
+ # When running behind a reverse proxy, port links will use the proxy hostname
+ # Set HOST_OVERRIDE to your actual server hostname so port links work correctly
+ # Example: Your server is server.local, but you access Portracker via proxy.domain.com
+ # Set HOST_OVERRIDE=server.local so port links point to server.local:PORT instead
+ # - HOST_OVERRIDE=your-server-hostname
+
# PERFORMANCE SETTINGS (Optional)
# Cache duration - increase for better performance, decrease for fresher data
# - CACHE_TIMEOUT_MS=60000
diff --git a/frontend/src/App.jsx b/frontend/src/App.jsx
index b7202d5..09e01be 100644
--- a/frontend/src/App.jsx
+++ b/frontend/src/App.jsx
@@ -61,6 +61,7 @@ export default function App() {
const [groups, setGroups] = useState([]);
const [loading, setLoading] = useState(true);
const [error, setError] = useState(null);
+ const [hostOverride, setHostOverride] = useState(null);
const [noteModalOpen, setNoteModalOpen] = useState(false);
const [modalSrvId, setModalSrvId] = useState("");
@@ -745,6 +746,13 @@ export default function App() {
fetchAll();
}, [fetchAll, auth.loading, auth.authEnabled, auth.authenticated]);
+ useEffect(() => {
+ fetch("/api/config")
+ .then(res => res.ok ? res.json() : null)
+ .then(data => { if (data?.hostOverride) setHostOverride(data.hostOverride); })
+ .catch(() => {});
+ }, []);
+
useEffect(() => {
try {
const params = new URLSearchParams(window.location.search);
@@ -1761,7 +1769,7 @@ export default function App() {
p.host_ip === "127.0.0.1" ||
p.host_ip === "[::]" ||
p.host_ip === "[::1]")) {
- hostForCopy = window.location.hostname;
+ hostForCopy = hostOverride || window.location.hostname;
}
else if (
server.id !== "local" &&
@@ -1809,6 +1817,7 @@ export default function App() {
}
}}
serverUrl={server.url}
+ hostOverride={hostOverride}
platformName={server.platformName}
systemInfo={server.systemInfo}
vms={server.vms}
@@ -1925,6 +1934,7 @@ export default function App() {
onAdd={addServer}
onDelete={deleteServer}
loading={loading}
+ hostOverride={hostOverride}
/>
}
>
diff --git a/frontend/src/components/layout/Sidebar.jsx b/frontend/src/components/layout/Sidebar.jsx
index 49c3f6e..c0d6573 100644
--- a/frontend/src/components/layout/Sidebar.jsx
+++ b/frontend/src/components/layout/Sidebar.jsx
@@ -61,6 +61,7 @@ const ServerCard = React.memo(function ServerCard({
onSelect,
onEdit,
onDelete,
+ hostOverride,
children,
}) {
const name = server.server || "Unknown Server";
@@ -76,7 +77,7 @@ const ServerCard = React.memo(function ServerCard({
const getHostDisplay = () => {
if (!server.url) {
- return window.location.host || "localhost";
+ return hostOverride || window.location.host || "localhost";
}
try {
@@ -217,6 +218,7 @@ export function Sidebar({
onAdd,
onDelete,
loading,
+ hostOverride,
}) {
const [mode, setMode] = useState("list");
const [form, setForm] = useState({
@@ -500,6 +502,7 @@ export function Sidebar({
onSelect={onSelect}
onEdit={setMode}
onDelete={setServerToDelete}
+ hostOverride={hostOverride}
>
{children.length > 0 && level < maxIndentLevel && (
<div className="mt-4 pt-4 border-t border-slate-200 dark:border-slate-700/50 space-y-3">
diff --git a/frontend/src/components/server/PortCard.jsx b/frontend/src/components/server/PortCard.jsx
index 37ba986..6575969 100644
--- a/frontend/src/components/server/PortCard.jsx
+++ b/frontend/src/components/server/PortCard.jsx
@@ -50,6 +50,7 @@ function PortCardComponent({
onRename,
serverId,
serverUrl,
+ hostOverride,
forceOpenDetails,
notifyOpenDetails,
notifyCloseDetails,
@@ -67,7 +68,7 @@ function PortCardComponent({
let hostForUi;
if (port.host_ip === "0.0.0.0" || port.host_ip === "127.0.0.1") {
if (serverId === "local") {
- hostForUi = window.location.hostname;
+ hostForUi = hostOverride || window.location.hostname;
} else if (serverUrl) {
try {
hostForUi = new URL(serverUrl).hostname;
diff --git a/frontend/src/components/server/PortGridItem.jsx b/frontend/src/components/server/PortGridItem.jsx
index 5e3e463..89d8ab6 100644
--- a/frontend/src/components/server/PortGridItem.jsx
+++ b/frontend/src/components/server/PortGridItem.jsx
@@ -49,6 +49,7 @@ export function PortGridItem({
port,
serverId,
serverUrl,
+ hostOverride,
searchTerm,
actionFeedback,
onCopy,
@@ -72,7 +73,7 @@ export function PortGridItem({
let hostForUi;
if (port.host_ip === "0.0.0.0" || port.host_ip === "127.0.0.1") {
if (serverId === "local") {
- hostForUi = window.location.hostname;
+ hostForUi = hostOverride || window.location.hostname;
} else if (serverUrl) {
try {
hostForUi = new URL(serverUrl).hostname;
diff --git a/frontend/src/components/server/PortTable.jsx b/frontend/src/components/server/PortTable.jsx
index 9238a44..645d31a 100644
--- a/frontend/src/components/server/PortTable.jsx
+++ b/frontend/src/components/server/PortTable.jsx
@@ -11,6 +11,7 @@ export function PortTable({
ports,
serverId,
serverUrl,
+ hostOverride,
searchTerm,
actionFeedback,
onCopy,
@@ -153,6 +154,7 @@ export function PortTable({
port={port}
serverId={serverId}
serverUrl={serverUrl}
+ hostOverride={hostOverride}
searchTerm={searchTerm}
actionFeedback={actionFeedback}
onCopy={onCopy}
diff --git a/frontend/src/components/server/PortTableRow.jsx b/frontend/src/components/server/PortTableRow.jsx
index 3aa3028..e561ef1 100644
--- a/frontend/src/components/server/PortTableRow.jsx
+++ b/frontend/src/components/server/PortTableRow.jsx
@@ -44,6 +44,7 @@ function PortTableRowComponent({
port,
serverId,
serverUrl,
+ hostOverride,
searchTerm,
actionFeedback,
onCopy,
@@ -67,7 +68,7 @@ function PortTableRowComponent({
let hostForUi;
if (port.host_ip === "0.0.0.0" || port.host_ip === "127.0.0.1") {
if (serverId === "local") {
- hostForUi = window.location.hostname;
+ hostForUi = hostOverride || window.location.hostname;
} else if (serverUrl) {
try {
hostForUi = new URL(serverUrl).hostname;
diff --git a/frontend/src/components/server/ServerSection.jsx b/frontend/src/components/server/ServerSection.jsx
index e88df54..6955f97 100644
--- a/frontend/src/components/server/ServerSection.jsx
+++ b/frontend/src/components/server/ServerSection.jsx
@@ -67,6 +67,7 @@ function ServerSectionComponent({
onRename,
onCopy,
serverUrl,
+ hostOverride,
platformName,
systemInfo,
vms,
@@ -257,7 +258,7 @@ function ServerSectionComponent({
const getHostDisplay = () => {
if (!serverUrl) {
- return window.location.host || "localhost";
+ return hostOverride || window.location.host || "localhost";
}
try {
@@ -777,6 +778,7 @@ function ServerSectionComponent({
onRename={onRename}
serverId={id}
serverUrl={serverUrl}
+ hostOverride={hostOverride}
forceOpenDetails={deepLinkContainerId && port.container_id === deepLinkContainerId}
notifyOpenDetails={(cid) => onOpenContainerDetails && onOpenContainerDetails(cid)}
notifyCloseDetails={() => onCloseContainerDetails && onCloseContainerDetails()}
@@ -848,6 +850,7 @@ function ServerSectionComponent({
onRename={onRename}
serverId={id}
serverUrl={serverUrl}
+ hostOverride={hostOverride}
forceOpenDetails={deepLinkContainerId && port.container_id === deepLinkContainerId}
notifyOpenDetails={(cid) => onOpenContainerDetails && onOpenContainerDetails(cid)}
notifyCloseDetails={() => onCloseContainerDetails && onCloseContainerDetails()}
@@ -864,6 +867,7 @@ function ServerSectionComponent({
ports={portsToDisplay}
serverId={id}
serverUrl={serverUrl}
+ hostOverride={hostOverride}
searchTerm={searchTerm}
actionFeedback={actionFeedback}
onCopy={onCopy}