Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/instrumentisto/geckodriver-docker-image

geckodriver Docker image
https://github.com/instrumentisto/geckodriver-docker-image

docker-geckodriver docker-webdriver docker-webdriver-firefox firefox geckodriver geckodriver-docker webdriver webdriver-docker webdriver-firefox webdriver-firefox-docker

Last synced: about 13 hours ago
JSON representation

geckodriver Docker image

Host: GitHub
URL: https://github.com/instrumentisto/geckodriver-docker-image
Owner: instrumentisto
License: other
Created: 2019-10-02T11:37:24.000Z (over 5 years ago)
Default Branch: main
Last Pushed: 2024-04-17T10:52:28.000Z (9 months ago)
Last Synced: 2024-04-17T12:04:15.182Z (9 months ago)
Topics: docker-geckodriver, docker-webdriver, docker-webdriver-firefox, firefox, geckodriver, geckodriver-docker, webdriver, webdriver-docker, webdriver-firefox, webdriver-firefox-docker
Language: Makefile
Homepage: https://firefox-source-docs.mozilla.org/testing/geckodriver
Size: 213 KB
Stars: 18
Watchers: 3
Forks: 5
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

        geckodriver Docker image

========================

[![Release](https://img.shields.io/github/v/release/instrumentisto/geckodriver-docker-image "Release")](https://github.com/instrumentisto/geckodriver-docker-image/releases)

[![CI](https://github.com/instrumentisto/geckodriver-docker-image/workflows/CI/badge.svg?branch=main "CI")](https://github.com/instrumentisto/geckodriver-docker-image/actions?query=workflow%3ACI+branch%3Amain)

[![Docker Hub](https://img.shields.io/docker/pulls/instrumentisto/geckodriver?label=Docker%20Hub%20pulls "Docker Hub pulls")](https://hub.docker.com/r/instrumentisto/geckodriver)

[Docker Hub](https://hub.docker.com/r/instrumentisto/geckodriver)

| [GitHub Container Registry](https://github.com/orgs/instrumentisto/packages/container/package/geckodriver)

| [Quay.io](https://quay.io/repository/instrumentisto/geckodriver)

[Changelog](https://github.com/instrumentisto/geckodriver-docker-image/blob/main/CHANGELOG.md)

## Supported tags and respective `Dockerfile` links

- [`133.0.3-driver0.35.0-r0-debian-bookworm`, `133.0.3-driver0.35.0-r0-debian`, `133.0.3-driver0.35.0-r0`, `133.0.3-driver0.35.0-debian-bookworm`, `133.0.3-driver0.35.0-debian`, `133.0.3-driver0.35.0`, `133.0.3-debian-bookworm`, `133.0.3-debian`, `133.0.3`, `debian-bookworm`, `debian`, `latest`][101]

## What is geckodriver?

[geckodriver] is a proxy for using W3C [WebDriver] compatible clients to interact with Gecko-based browsers.

This program provides the HTTP API described by the [WebDriver protocol] to communicate with Gecko browsers, such as [Firefox]. It translates calls into the [Marionette remote protocol] by acting as a proxy between the local and remote ends.

This image bundles [geckodriver] with [Firefox] and is suitable for running headless tests.

[Marionette remote protocol]: https://firefox-source-docs.mozilla.org/testing/marionette

[WebDriver]: https://developer.mozilla.org/en-US/docs/Web/WebDriver

[WebDriver protocol]: https://w3c.github.io/webdriver/#protocol

> [firefox-source-docs.mozilla.org/testing/geckodriver](https://firefox-source-docs.mozilla.org/testing/geckodriver)

## How to use this image

```bash

docker run -d -p 4444:4444 instrumentisto/geckodriver

```

After that you can connect to [geckodriver] that is listening on `127.0.0.1:4444`. Only headless mode is supported.

Consider using `--network=host` option for running image if you want to run tests on local server.

Consider to increase shared memory size (`--shm-size 2g` option), otherwise you may experience unexpected [Firefox] crashes.

### [Docker Compose] gotchas

Accessing via `127.0.0.1` works well once launched as a simple container. However, in a [Docker Compose] environment, there likely would be complications due to its [networking modes][201]. By default, `services` are reached by its name, which the launched [geckodriver] is unaware of. That's why the allowed hosts should be explicitly specified (either via `--host` argument, or `--allow-hosts` one for multiple entries):

```docker-compose

services:

  stuff:

    image: whatever

    environment:

      WEBDRIVER_URL: "http://webdriver:4444"

      #                      ^^^^^^^^^ using service name

  webdriver:

    image: instrumentisto/geckodriver

    command: "--host=webdriver --binary=/opt/firefox/firefox --log=debug"

    #         ^^^^^^^^^^^^^^^^ allow service name for geckodriver

```

Otherwise, [geckodriver] won't accept any incoming requests.

## Image tags

### `debian`

Latest tag of the latest [Firefox] and [geckodriver] versions on the latest stable [Debian] version.

### `debian-`

Latest tag of the latest [Firefox] and [geckodriver] versions on the latest `` [Debian] version.

### ``/``

Latest tag of the concrete `X.Y` (or `X.Y.Z`) [Firefox] version with the latest [geckodriver] version.

### `-driver`/`-driver`

Latest tag of the concrete `X.Y` (or `X.Y.Z`) [Firefox] version with the concrete `A.B.C` [geckodriver] version.

### `-driver-r`/`-driver-r`

Concrete `N` image revision tag of the concrete `X.Y` (or `X.Y.Z`) [Firefox] version with the concrete `A.B.C` [geckodriver] version.

Once built, it's never updated.

## License

[Firefox] and [geckodriver] are licensed under [Mozilla Public License 2.0].

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.

The [sources][3] for producing `instrumentisto/geckodriver` Docker image are licensed under [Blue Oak Model License 1.0.0][2].

## Issues

We can't notice comments in the [DockerHub] (or other container registries) so don't use them for reporting issue or asking question.

If you have any problems with or questions about this image, please contact us through a [GitHub issue][1].

[Debian]: https://www.debian.org

[DockerHub]: https://hub.docker.com

[Docker Compose]: https://docs.docker.com/compose

[Firefox]: https://www.mozilla.org/firefox

[geckodriver]: https://github.com/mozilla/geckodriver

[Mozilla Public License 2.0]: https://www.mozilla.org/en-US/MPL/2.0

[1]: https://github.com/instrumentisto/geckodriver-docker-image/issues

[2]: https://github.com/instrumentisto/geckodriver-docker-image/blob/main/LICENSE.md

[3]: https://github.com/instrumentisto/geckodriver-docker-image

[101]: https://github.com/instrumentisto/geckodriver-docker-image/blob/main/Dockerfile

[201]: https://docs.docker.com/compose/how-tos/networking