[doc] update usage of env var to avoid conflict (vllm-project#5873)

xjpang · Jul 24, 2024 · 5c0e162 · 5c0e162
1 parent 77b4db9
commit 5c0e162
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/source/serving/env_vars.rst b/docs/source/serving/env_vars.rst
@@ -3,6 +3,9 @@ Environment Variables
 
 vLLM uses the following environment variables to configure the system:
 
+.. warning::
+    Please note that ``VLLM_PORT`` and ``VLLM_HOST_IP`` set the port and ip for vLLM's **internal usage**. It is not the port and ip for the API server. If you use ``--host $VLLM_HOST_IP`` and ``--port $VLLM_PORT`` to start the API server, it will not work.
+
 .. literalinclude:: ../../../vllm/envs.py
     :language: python
     :start-after: begin-env-vars-definition