testing/geckodriver/README.md

   1 geckodriver
   2 ===========
   3
   4 Proxy for using W3C [WebDriver] compatible clients to interact with
   5 Gecko-based browsers.
   6
   7 This program provides the HTTP API described by the [WebDriver
   8 protocol] to communicate with Gecko browsers, such as Firefox.  It
   9 translates calls into the [Marionette remote protocol] by acting
  10 as a proxy between the local- and remote ends.
  11
  12 [WebDriver protocol]: https://w3c.github.io/webdriver/#protocol
  13 [Marionette remote protocol]: https://firefox-source-docs.mozilla.org/testing/marionette/
  14 [WebDriver]: https://developer.mozilla.org/en-US/docs/Web/WebDriver
  15
  16
  17 Downloads
  18 ---------
  19
  20 * [Releases](https://github.com/mozilla/geckodriver/releases/latest)
  21 * [Change log](https://searchfox.org/mozilla-central/source/testing/geckodriver/CHANGES.md)
  22
  23
  24 Documentation
  25 -------------
  26
  27 * [WebDriver] (work in progress)
  28   * [Commands](https://developer.mozilla.org/en-US/docs/Web/WebDriver/Commands)
  29   * [Errors](https://developer.mozilla.org/en-US/docs/Web/WebDriver/Errors)
  30   * [Types](https://developer.mozilla.org/en-US/docs/Web/WebDriver/Types)
  31
  32 * [Cross browser testing](https://developer.mozilla.org/en-US/docs/Learn/Tools_and_testing/Cross_browser_testing)
  33
  34 * [Selenium](https://seleniumhq.github.io/docs/) (work in progress)
  35   * [C# API](https://seleniumhq.github.io/selenium/docs/api/dotnet/)
  36   * [JavaScript API](https://seleniumhq.github.io/selenium/docs/api/javascript/)
  37   * [Java API](https://seleniumhq.github.io/selenium/docs/api/java/)
  38   * [Perl API](https://metacpan.org/pod/Selenium::Remote::Driver)
  39   * [Python API](https://seleniumhq.github.io/selenium/docs/api/py/)
  40   * [Ruby API](https://seleniumhq.github.io/selenium/docs/api/rb/)
  41
  42 * [geckodriver usage](https://firefox-source-docs.mozilla.org/testing/geckodriver/Usage.html)
  43   * [Supported platforms](https://firefox-source-docs.mozilla.org/testing/geckodriver/Support.html)
  44   * [Firefox capabilities](https://firefox-source-docs.mozilla.org/testing/geckodriver/Capabilities.html)
  45   * [Capabilities example](https://firefox-source-docs.mozilla.org/testing/geckodriver/Capabilities.html#capabilities-example)
  46   * [Enabling trace logs](https://firefox-source-docs.mozilla.org/testing/geckodriver/TraceLogs.html)
  47   * [Analyzing crash data from Firefox](https://firefox-source-docs.mozilla.org/testing/geckodriver/CrashReports.html)
  48
  49 * [Contributing](https://firefox-source-docs.mozilla.org/testing/geckodriver/#for-developers)
  50   * [Building](https://firefox-source-docs.mozilla.org/testing/geckodriver/Building.html)
  51   * [Testing](https://firefox-source-docs.mozilla.org/testing/geckodriver/Testing.html)
  52   * [Releasing](https://firefox-source-docs.mozilla.org/testing/geckodriver/Releasing.html)
  53   * [Self-serving an ARM build](https://firefox-source-docs.mozilla.org/testing/geckodriver/ARM.html)
  54
  55
  56 Source code
  57 -----------
  58
  59 geckodriver is made available under the [Mozilla Public License].
  60
  61 Its source code can be found in [mozilla-central] under testing/geckodriver.
  62 This GitHub repository is only used for issue tracking and making releases.
  63
  64 [source code]: https://hg.mozilla.org/mozilla-unified/file/tip/testing/geckodriver
  65 [Mozilla Public License]: https://www.mozilla.org/en-US/MPL/2.0/
  66 [mozilla-central]: https://hg.mozilla.org/mozilla-central/file/tip/testing/geckodriver
  67
  68 Custom release builds
  69 ---------------------
  70
  71 If a binary is not available for your platform, it's possibe to create a custom
  72 build using the [Rust] toolchain. To do this, checkout the release tag for the
  73 version of interest and run `cargo build`. Alternatively the latest version may
  74 be built and installed from `crates.io` using `cargo install geckodriver`.
  75
  76 [Rust]: https://rustup.rs/
  77
  78 Contact
  79 -------
  80
  81 The mailing list for geckodriver discussion is
  82 https://groups.google.com/a/mozilla.org/g/dev-webdriver.
  83
  84 There is also an Element channel to talk about using and developing
  85 geckodriver on `#webdriver:mozilla.org <https://chat.mozilla.org/#/room/#webdriver:mozilla.org>`__