Skip to content

Commit a282973

Browse files
committed
docs: Add new unsafe port env vars to docs
1 parent 4ca0c61 commit a282973

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

docs/advanced/environment-variables/index.mdx

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,7 @@ The advanced deployments environment variables should only be used if you know w
7676

7777
| Environment Variable | Description |
7878
| ------------------------ | ----------- |
79-
| ``DB_MIGRATIONS_DISABLED`` | Disable db migrations. For example for helm charts |
79+
| ``DB_MIGRATIONS_DISABLED`` | Disable db migrations. For example for helm charts |
80+
| ``UNSAFE_WEB_PORT`` | Alter the port the webserver runs on, default of 3000 |
81+
| ``UNSAFE_WEBSOCKET_PORT`` | Alter the port the websocket server runs on, default of 3001 |
82+
| ``UNSAFE_CRON_JOB_PORT`` | Alter the port the tasks API server runs on, default of 3002 |

docs/getting-started/installation/source.mdx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,3 +41,19 @@ This method is only useful, when you want to develop on Homarr or extend it with
4141
<li>Run the server using `pnpm start`</li>
4242
<li>Open `http://localhost:3000` in your browser</li>
4343
</ol>
44+
45+
## Extra Configuration Variables
46+
47+
You may find that the default ports for Homarr services conflict with ports on your host. You can override
48+
these ports with the following variables.
49+
50+
<ul>
51+
<li>`UNSAFE_WEB_PORT` [defaults to 3000]. You must also set `PORT` or use the -p flag when invoking
52+
nextjs[^1],
53+
both are required</li>
54+
<li>`UNSAFE_WEBSOCKET_PORT` [defaults to 3001]</li>
55+
<li>`UNSAFE_CRON_JOB_PORT` [defaults to 3002]</li>
56+
</ul>
57+
58+
59+
[^1]: https://nextjs.org/docs/app/api-reference/cli/next#changing-the-default-port

0 commit comments

Comments
 (0)