Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

feat: add API_HOST env

Carl-Gerhard Lindesvärd40b0774ef8bd
diff --git a/apps/api/src/index.ts b/apps/api/src/index.ts
index 941856d9c..b0829c0d3 100644
--- a/apps/api/src/index.ts
+++ b/apps/api/src/index.ts
@@ -63,6 +63,9 @@ declare module 'fastify' {
}
const port = Number.parseInt(process.env.API_PORT || '3000', 10);
+const host =
+ process.env.API_HOST ||
+ (process.env.NODE_ENV === 'production' ? '0.0.0.0' : 'localhost');
const startServer = async () => {
logger.info('Starting server');
@@ -263,10 +266,7 @@ const startServer = async () => {
});
}
- await fastify.listen({
- host: process.env.NODE_ENV === 'production' ? '0.0.0.0' : 'localhost',
- port,
- });
+ await fastify.listen({ host, port });
try {
// Notify when keys expires
diff --git a/apps/public/content/docs/self-hosting/environment-variables.mdx b/apps/public/content/docs/self-hosting/environment-variables.mdx
index e062c95f2..df823f0dd 100644
--- a/apps/public/content/docs/self-hosting/environment-variables.mdx
+++ b/apps/public/content/docs/self-hosting/environment-variables.mdx
@@ -744,6 +744,27 @@ Port for the API service to listen on.
API_PORT=3000
```
+### API_HOST
+
+**Type**: `string`
+**Required**: No
+**Default**: `0.0.0.0` (production) / `localhost` (development)
+
+Host address for the API service to bind to. Set to `::` to enable IPv6 support (useful for platforms like Railway that use IPv6 for internal networking).
+
+**Example**:
+```bash
+# Default IPv4 only
+API_HOST=0.0.0.0
+
+# IPv6 (dual-stack, accepts both IPv4 and IPv6)
+API_HOST=::
+```
+
+<Callout>
+Use `API_HOST=::` when deploying on platforms like Railway where private networking requires IPv6. The `::` address enables dual-stack mode, accepting both IPv4 and IPv6 connections on most systems.
+</Callout>
+
## Logging
### LOG_LEVEL