Skip to content

Commit

Permalink
Update README for CrossBrowserTestingTunnel
Browse files Browse the repository at this point in the history
  • Loading branch information
jason0x43 committed Oct 11, 2016
1 parent ad46861 commit 517240d
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,20 @@ the REST APIs of these services.
Dig Dug can run a local Selenium server, and it supports the following cloud testing services:

* [BrowserStack](http://www.browserstack.com)
* [CrossBrowserTesting](http://www.crossbrowsertesting.com)
* [Sauce Labs](http://www.saucelabs.com)
* [TestingBot](http://www.testingbot.com)

## Configuration

In many cases, the only configuration you'll need to do to create a tunnel is provide authentication data. This can be provided by setting properties on tunnels or via environment variables. The tunnels use the following environment variables:

Tunnel class | Environment variables
---------------------|----------------------------------------------------
`BrowserStackTunnel` | `BROWSERSTACK_USERNAME`, `BROWSERSTACK_ACCESS_KEY`
`SauceLabsTunnel` | `SAUCE_USERNAME`, `SAUCE_ACCESS_KEY`
`TestingBotTunnel` | `TESTINGBOT_KEY`, `TESTINGBOT_SECRET`
Tunnel class | Environment variables
----------------------------|----------------------------------------------------
`BrowserStackTunnel` | `BROWSERSTACK_USERNAME`, `BROWSERSTACK_ACCESS_KEY`
`CrossBrowserTestingTunnel` | `CBT_USERNAME`, `CBT_APIKEY`
`SauceLabsTunnel` | `SAUCE_USERNAME`, `SAUCE_ACCESS_KEY`
`TestingBotTunnel` | `TESTINGBOT_KEY`, `TESTINGBOT_SECRET`

Other properties, such as the local port the tunnel should serve on or the URL of a proxy server the tunnel should go through, can be passed to a tunnel constructor or set on a tunnel instance. See the pages for [Tunnel](Tunnel.html) and the tunnel subclasses for available properties.

Expand Down

0 comments on commit 517240d

Please sign in to comment.