zephyr/samples/net/ws_console

.. _websocket-console-sample:

Websocket Console
#################

Overview
********

The websocket-console sample application for Zephyr implements a console
over a websocket. The websocket-console sample application listens for incoming
IPv4 or IPv6 HTTP(S) requests and provides Zephyr console to the browser over
a websocket.

The source code for this sample application can be found at:
:file:`samples/net/ws_console`.

Requirements
************

- :ref:`networking_with_qemu`

Building and Running
********************

There are multiple ways to use this application. One of the most common
usage scenario is to run websocket-console application inside QEMU. This is
described in :ref:`networking_with_qemu`.

Build ws_console sample application like this:

.. zephyr-app-commands::
   :zephyr-app: samples/net/ws_console
   :board: qemu_x86
   :goals: run
   :compact:

The default make BOARD configuration for this sample is ``qemu_x86``.

Connect to the console from your browser using these URLs http://[2001:db8::1]
or http://192.0.2.1 as configured in the project's ``prj.conf`` file.