Skip to content

Commit

Permalink
Update documentation for dashboard command
Browse files Browse the repository at this point in the history
Document previously undocumented options `--address` and `--socket`
  • Loading branch information
vamega committed Jun 7, 2024
1 parent 52179ce commit 3aadfff
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion guides/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -197,10 +197,19 @@ The ``esphome dashboard <CONFIG>`` command starts the ESPHome dashboard server f
through a graphical user interface. This command accepts a configuration directory instead of a
single configuration file.

.. option:: --address ADDRESS

Manually set the address to bind to (defaults to 0.0.0.0)

.. option:: --port PORT

Manually set the HTTP port to open connections on (defaults to 6052)

.. option:: --socket SOCKET

Manually set the unix socket to bind to. If specified along with ``--address`` or ``--port`` the values
for those parameters will be ignored. Cannot be used along with ``--systemd-socket``.

.. option:: --username USERNAME

The optional username to require for authentication.
Expand All @@ -211,7 +220,8 @@ single configuration file.

.. option:: --open-ui

If set, opens the dashboard UI in a browser once the server is up and running.
If set, opens the dashboard UI in a browser once the server is up and running. Does not work when using
``--socket``.

``logs`` Command
---------------------
Expand Down

0 comments on commit 3aadfff

Please sign in to comment.