https://github.com/browserstack/docker-browserstack-local
Docker official Image packaging for Browserstack Local Binary
https://github.com/browserstack/docker-browserstack-local
Last synced: 6 months ago
JSON representation
Docker official Image packaging for Browserstack Local Binary
- Host: GitHub
- URL: https://github.com/browserstack/docker-browserstack-local
- Owner: browserstack
- Created: 2019-08-05T10:58:51.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-07-28T11:52:34.000Z (over 2 years ago)
- Last Synced: 2025-02-03T17:46:47.338Z (about 1 year ago)
- Language: Dockerfile
- Size: 28.3 KB
- Stars: 13
- Watchers: 12
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docker-browserstack-local
Docker official Image packaging for Browserstack Local Binary
### Installation
- Clone the repository.
- Depending on the choice of `binary_version` / `platform`, choose the appropriate Dockerfile
- Run ``` docker build -t ```
- Eg. Build Image for Binary 8.9 on ubuntu platform.
- ```docker build -t local 8.9/ubuntu```
### Running the binary inside container with default command
- Run the docker container using
- ```docker run -it --key ```
- The default entrypoint runs the binary without any arguments.
- For achieving best local testing experience. You may choose to bind binary services to host.
- `docker run -it -p 127.0.0.1:45691:45691 -p 127.0.0.1:45690:45690 -p 127.0.0.1:45454:45454 -p 127.0.0.1:45954:45954 --key `
### Running the binary inside container with custom arguments
In order to run binary with custom [arguments](https://browserstack.com/local-testing) simply run the binary as follows.
`docker run -it `
Eg. Running binary inside container with force local and verbose 3 enabled
`docker run -it browserstack/local --key --verbose 3 --force-local`
### Running tests for a service running on the host.
Since the binary is running inside the docker container, it would try to resolve all the host requests internally. Following methods can be used in order to overcome this limitation.
### Method 1
#### For Linux
- Run the docker container with the following flag `–net=host`. By setting this flag the container’s network stack is not isolated from the Docker host. ( For additional information refer [here](https://docs.docker.com/network/host/)).
- Running container with host netwroking
```docker run --net=host -it browserstack/local ```
#### For Mac and Windows
- Since Docker runs its container on a virtual machine on Mac and Windows. The method used in linux would only isolate the network interface between the virtual machine and the container. Hence, docker provides a way to access the host network using the url `host.docker.internal`. (For additional information refer here ( [mac](https://docs.docker.com/docker-for-mac/networking/) | [windows](https://docs.docker.com/docker-for-windows/networking/) ).
- Additionally, the test scripts have to be modified to include the above url instead of localhost.
- Eg. If a service is running on port 3000, one can access the service by using host.docker.internal:3000.
#### Method 2
Run the server on a public interface (eg. 0.0.0.0 ) and use the public address in your test scripts.
(Disclaimer : Please do understand the risk of running a service on public interface before following this method ).
### FAQ's
* Can I run live and app-live using the binary running inside the container?
- Yes. For making live and app-live work, you need to bind 45691, 45690 ports with host.
- Docker run command `docker run -it -p 127.0.0.1:45691:45691 -p 127.0.0.1:45690:45690 --key `
* Can I access binary console dashboard from my host?
- Yes. You need to bind docker 45454, 45954 ports with host.
- Docker run command `docker run -it -p 127.0.0.1:45454:45454 -p 127.0.0.1:45954:45954 --key `