Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2024-11-12 10:24:00 +01:00
Code Issues Projects Releases Wiki Activity

Update documentation for dashboard command (#3923)

Browse Source 
Document previously undocumented options `--address` and `--socket`
This commit is contained in:
Varun Madiath 2024-06-15 00:35:38 -04:00 committed by GitHub
parent 07264aada3
commit 8414dc7a63
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
guides/cli.rst
View File

@ -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.
@ -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
---------------------