remote/doc/index.rst

   1 ================
   2 Remote Protocols
   3 ================
   4
   5 Firefox supports several remote protocols, which allow to inspect and control
   6 the browser, usually for automation purposes:
   7
   8 * :ref:`marionette-header`
   9 * :ref:`remote-protocol-cdp-header`
  10 * :ref:`webdriver-bidi-header`
  11
  12 Common documentation
  13 ====================
  14
  15 The following documentation pages apply to all remote protocols
  16
  17 .. toctree::
  18   :maxdepth: 1
  19
  20   Building.md
  21   Debugging.md
  22   Prefs.md
  23   Testing.md
  24   CodeStyle.md
  25   Security.md
  26   PuppeteerVendor.md
  27
  28 Protocols
  29 =========
  30
  31 .. _marionette-header:
  32
  33 Marionette
  34 ----------
  35
  36 Marionette is used both by internal tools and testing solutions, but also by
  37 geckodriver to implement the `WebDriver (HTTP) specification`_. The documentation
  38 for Marionette can be found under `testing/marionette`_.
  39
  40 .. _WebDriver (HTTP) specification: https://w3c.github.io/webdriver/
  41 .. _testing/marionette: /testing/marionette
  42
  43
  44 .. _remote-protocol-cdp-header:
  45
  46 Remote Protocol (CDP)
  47 ---------------------
  48
  49 Firefox implements a subset of the `Chrome DevTools Protocol`_ (CDP) in order to
  50 support third party automation tools such as `puppeteer`. The documentation for
  51 the remote protocol (CDP) implement can be found at `remote/cdp`_.
  52
  53 .. _Chrome DevTools Protocol: https://chromedevtools.github.io/devtools-protocol/
  54 .. _remote/cdp: cdp/
  55
  56
  57 .. _webdriver-bidi-header:
  58
  59 WebDriver BiDi
  60 --------------
  61
  62 `The WebDriver BiDi specification <https://w3c.github.io/webdriver-bidi>`_
  63 extends WebDriver HTTP to add bidirectional communication. Dedicated
  64 documentation will be added as the Firefox implementation makes progress.
  65
  66 Architecture
  67 ============
  68
  69 Message Handler
  70 ---------------
  71
  72 The documentation for the framework used to build WebDriver BiDi modules can be
  73 found at `remote/messagehandler`_.
  74
  75 .. _remote/messagehandler: messagehandler/
  76
  77
  78 Bugs
  79 ====
  80
  81 Bugs are tracked under the `Remote Protocol product`_.
  82
  83 .. _Remote Protocol product: https://bugzilla.mozilla.org/describecomponents.cgi?product=Remote%20Protocol
  84
  85
  86 Communication
  87 =============
  88
  89 See `Communication`_ on `our project wiki`_.
  90
  91 .. _Communication: https://wiki.mozilla.org/Remote#Communication
  92 .. _our project wiki: https://wiki.mozilla.org/Remote