Skip to content

Commit 24c6063

Browse files
author
rubytester
committed
Merge pull request SeleniumHQ#75 from meeroslaph/patch-1
README styling and readability updates.
2 parents 1e3a809 + 38aaf85 commit 24c6063

File tree

16 files changed

+38
-45
lines changed

16 files changed

+38
-45
lines changed

Base/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
1515

1616
## License
1717

18-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
18+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
1919

2020
## Getting Help
2121

Hub/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
3636

3737
## License
3838

39-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
39+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
4040

4141
## Getting Help
4242

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
The project is made possible by volunteer contributors who have put in thousands of hours of their own time, and made the source code freely available under the [Apache 2.0 license](https://raw.githubusercontent.com/SeleniumHQ/selenium/master/LICENSE).
1+
The project is made possible by volunteer contributors who have put in thousands of hours of their own time, and made the source code freely available under the [Apache License 2.0](https://raw.githubusercontent.com/SeleniumHQ/selenium/master/LICENSE).

NodeBase/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
2929

3030
## License
3131

32-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
32+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
3333

3434
## Getting Help
3535

NodeChrome/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
2929

3030
## License
3131

32-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
32+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
3333

3434
## Getting Help
3535

NodeChromeDebug/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
5252

5353
## License
5454

55-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
55+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
5656

5757
## Getting Help
5858

NodeDebug/README.template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
5252

5353
## License
5454

55-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
55+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
5656

5757
## Getting Help
5858

NodeFirefox/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
2929

3030
## License
3131

32-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
32+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
3333

3434
## Getting Help
3535

NodeFirefoxDebug/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
5252

5353
## License
5454

55-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
55+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
5656

5757
## Getting Help
5858

README.md

Lines changed: 23 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,24 @@
11
# Selenium Docker
22

3-
The project is made possible by volunteer contributors who have put in thousands of hours of their own time, and made the source code freely available under the [Apache 2.0 license](https://code.google.com/p/selenium/source/browse/COPYING).
3+
The project is made possible by volunteer contributors who have put in thousands of hours of their own time, and made the source code freely available under the [Apache License 2.0](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md).
44

55
## Docker images for Selenium Standalone Server Hub and Node configurations with Chrome and Firefox
66
[![Circle CI](https://circleci.com/gh/SeleniumHQ/docker-selenium.svg?style=svg)](https://circleci.com/gh/SeleniumHQ/docker-selenium)
77

88
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/SeleniumHQ/docker-selenium?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
99

1010
Images included:
11-
12-
- __selenium/base__: Base image which includes Java runtime and Selenium jar
11+
- __selenium/base__: Base image which includes Java runtime and Selenium JAR file
1312
- __selenium/hub__: Image for running a Selenium Grid Hub
14-
- __selenium/node-base__: Base image for Selenium Nodes which includes a virtual desktop environment and VNC support
15-
- __selenium/node-chrome__: Selenium node with Chrome installed, needs to be connected to a Selenium Hub
16-
- __selenium/node-firefox__: Selenium node with Firefox installed, needs to be connected to a Selenium Hub
13+
- __selenium/node-base__: Base image for Selenium Grid Nodes which includes a virtual desktop environment and VNC support
14+
- __selenium/node-chrome__: Selenium node with Chrome installed, needs to be connected to a Selenium Grid Hub
15+
- __selenium/node-firefox__: Selenium node with Firefox installed, needs to be connected to a Selenium Grid Hub
1716
- __selenium/standalone-chrome__: Selenium standalone with Chrome installed
1817
- __selenium/standalone-firefox__: Selenium standalone with Firefox installed
1918
- __selenium/standalone-chrome-debug__: Selenium standalone with Chrome installed and runs a VNC server
2019
- __selenium/standalone-firefox-debug__: Selenium standalone with Firefox installed and runs a VNC server
21-
- __selenium/node-chrome-debug__: Selenium node with Chrome installed and runs a VNC server, needs to be connected to a Selenium Hub
22-
- __selenium/node-firefox-debug__: Selenium node with Firefox installed and runs a VNC server, needs to be connected to a Selenium Hub
20+
- __selenium/node-chrome-debug__: Selenium node with Chrome installed and runs a VNC server, needs to be connected to a Selenium Grid Hub
21+
- __selenium/node-firefox-debug__: Selenium node with Firefox installed and runs a VNC server, needs to be connected to a Selenium Grid Hub
2322

2423
## Running the images
2524

@@ -31,17 +30,17 @@ $ docker run -d -p 4444:4444 selenium/standalone-chrome:2.46.0
3130
$ docker run -d -p 4444:4444 selenium/standalone-firefox:2.46.0
3231
```
3332

34-
Note: only one standalone image can run on port 4444 at a time.
33+
_Note: Only one standalone image can run on port_ `4444` _at a time._
3534

36-
To inspect visually what the browser is doing use the `standalone-chrome-debug` or `standalone-firefox-debug` images. [See debugging section for more...](#debugging)
35+
To inspect visually what the browser is doing use the `standalone-chrome-debug` or `standalone-firefox-debug` images. See [Debugging](#debugging) section for details.
3736

3837
### Selenium Grid Hub
3938

4039
``` bash
4140
$ docker run -d -p 4444:4444 --name selenium-hub selenium/hub:2.46.0
4241
```
4342

44-
### Chrome and Firefox Nodes
43+
### Chrome and Firefox Grid Nodes
4544

4645
``` bash
4746
$ docker run -d --link selenium-hub:hub selenium/node-chrome:2.46.0
@@ -58,7 +57,7 @@ $ docker run -d -p 4444:4444 -e JAVA_OPTS=-Xmx512m --name selenium-hub selenium/
5857

5958
## Building the images
6059

61-
Ensure you have the `ubuntu:14.04` base image downloaded, this step is _optional_ since docker takes care of downloading the parent base image automatically.
60+
Ensure you have the `ubuntu:14.04` base image downloaded, this step is _optional_ since Docker takes care of downloading the parent base image automatically.
6261

6362
``` bash
6463
$ docker pull ubuntu:14.04
@@ -70,11 +69,11 @@ Clone the repo and from the project directory root you can build everything by r
7069
$ VERSION=local make build
7170
```
7271

73-
_Note: omitting `VERSION=local` will build the images with the current version number thus overwriting the images downloaded from dockerhub._
72+
_Note: Omitting_ `VERSION=local` _will build the images with the current version number thus overwriting the images downloaded from [Docker Hub](https://registry.hub.docker.com/)._
7473

7574
## Using the images
7675

77-
##### e.g. Spawn a container for Chrome testing:
76+
##### Example: Spawn a container for testing in Chrome:
7877

7978
``` bash
8079
$ docker run -d --name selenium-hub -p 4444:4444 selenium/hub:2.46.0
@@ -83,13 +82,11 @@ $ CH=$(docker run --rm --name=ch \
8382
selenium/node-chrome:2.46.0)
8483
```
8584

86-
Note `-v /e2e/uploads:/e2e/uploads` is optional in case you are testing browser uploads on your webapp you'll probably need to share a directory for this.
87-
88-
I like to remove the containers after each e2e test with `--rm` since this docker container is not meant to preserve state, spawning a new one is less than 3 seconds. You need to think of your docker containers as single processes, not as running virtual machines, in case you are familiar with vagrant.
85+
_Note:_ `-v /e2e/uploads:/e2e/uploads` _is optional in case you are testing browser uploads on your web app you will probably need to share a directory for this._
8986

90-
##### e.g. Spawn a container for Firefox testing:
87+
##### Example: Spawn a container for testing in Firefox:
9188

92-
This command line is the same as for Chrome, remember that the selenium running container is able to launch either Chrome or Firefox, the idea around having 2 separate containers, one for each browser is for convenience plus avoid certain `:focus` issues you web app may encounter during e2e automation.
89+
This command line is the same as for Chrome. Remember that the Selenium running container is able to launch either Chrome or Firefox, the idea around having 2 separate containers, one for each browser is for convenience plus avoiding certain `:focus` issues your web app may encounter during end-to-end test automation.
9390

9491
``` bash
9592
$ docker run -d --name selenium-hub -p 4444:4444 selenium/hub:2.46.0
@@ -98,44 +95,41 @@ $ FF=$(docker run --rm --name=fx \
9895
selenium/node-firefox:2.46.0)
9996
```
10097

101-
## Debugging
98+
_Note: Since a Docker container is not meant to preserve state and spawning a new one takes less than 3 seconds you will likely want to remove containers after each end-to-end test with_ `--rm` _command. You need to think of your Docker containers as single processes, not as running virtual machines, in case you are familiar with [Vagrant](https://www.vagrantup.com/)._
10299

103-
In the event you wish to visually see what the browser is doing you will want to run the `debug` variant of node or standalone images.
100+
## Debugging
104101

102+
In the event you wish to visually see what the browser is doing you will want to run the `debug` variant of node or standalone images:
105103
``` bash
106104
$ docker run -d -P --link selenium-hub:hub selenium/node-chrome-debug:2.46.0
107105
$ docker run -d -P --link selenium-hub:hub selenium/node-firefox-debug:2.46.0
108106
```
109107

110108
And for standalone:
111-
112109
``` bash
113110
$ docker run -d -p 4444:4444 selenium/standalone-chrome-debug:2.46.0
114111
# OR
115112
$ docker run -d -p 4444:4444 selenium/standalone-firefox-debug:2.46.0
116113
```
117114

118115
You can acquire the port that the VNC server is exposed to by running:
119-
120116
``` bash
121117
$ docker port <container-name|container-id> 5900
122118
#=> 0.0.0.0:49338
123119
```
124120

125-
In case you have RealVNC binary `vnc` in your path, you can always take a look, view only to avoid messing around your tests with an unintended mouse click or keyboard.
126-
121+
In case you have [RealVNC](https://www.realvnc.com/) binary `vnc` in your path, you can always take a look, view only to avoid messing around your tests with an unintended mouse click or keyboard interrupt:
127122
``` bash
128123
$ ./bin/vncview 127.0.0.1:49160
129124
```
130125

131-
If you are running Boot2Docker on Mac then you already have a [VNC client](http://www.davidtheexpert.com/post.php?id=5) built-in. You can connect by entering `vnc://<boot2docker-ip>:49160` in Safari or [Alfred](http://www.alfredapp.com/)
132-
133-
When you are prompted for the password it is __secret__. If you wish to change this then you should either change it in the `/NodeBase/Dockerfile` and build the images yourself, or you can define a docker image that derives from the posted ones which reconfigures it:
126+
If you are running [Boot2Docker](https://docs.docker.com/installation/mac/) on OS X then you already have a [VNC client](http://www.davidtheexpert.com/post.php?id=5) built-in. You can connect by entering `vnc://<boot2docker-ip>:49160` in Safari or [Alfred](http://www.alfredapp.com/).
134127

128+
When you are prompted for the password it is `secret`. If you wish to change this then you should either change it in the `/NodeBase/Dockerfile` and build the images yourself, or you can define a Docker image that derives from the posted ones which reconfigures it:
135129
``` dockerfile
136130
#FROM selenium/node-chrome-debug:2.46.0
137131
#FROM selenium/node-firefox-debug:2.46.0
138-
# Choose the FROM statement that works for you.
132+
#Choose the FROM statement that works for you.
139133

140134
RUN x11vnc -storepasswd <your-password-here> /home/seluser/.vnc/passwd
141135
```
@@ -157,7 +151,6 @@ ubuntu 14.04 5506de2b643b 3 weeks
157151
### Troubleshooting
158152

159153
All output is sent to stdout so it can be inspected by running:
160-
161154
``` bash
162155
$ docker logs -f <container-id|container-name>
163156
```

Standalone/README.template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
3030

3131
## License
3232

33-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
33+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
3434

3535
## Getting Help
3636

StandaloneChrome/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
3030

3131
## License
3232

33-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
33+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
3434

3535
## Getting Help
3636

StandaloneDebug/README.template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
3131

3232
## License
3333

34-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
34+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
3535

3636
## Getting Help
3737

StandaloneDebugChrome/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
3131

3232
## License
3333

34-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
34+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
3535

3636
## Getting Help
3737

StandaloneDebugFirefox/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
3131

3232
## License
3333

34-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
34+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
3535

3636
## Getting Help
3737

StandaloneFirefox/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ See the Selenium [site](http://docs.seleniumhq.org/) for documation on usage wit
3030

3131
## License
3232

33-
View [license information](https://code.google.com/p/selenium/source/browse/COPYING) for the software contained in this image.
33+
View [license information](https://github.com/SeleniumHQ/docker-selenium/blob/master/LICENSE.md) for the software contained in this image.
3434

3535
## Getting Help
3636

0 commit comments

Comments
 (0)