Skip to content

Commit d55582d

Browse files
committed
Addressed internal review comments.
1 parent 0e16d31 commit d55582d

File tree

1 file changed

+18
-35
lines changed

1 file changed

+18
-35
lines changed

user/browserstack.md

+18-35
Original file line numberDiff line numberDiff line change
@@ -33,21 +33,6 @@ Choose whether you want to store your access key as plain text or in a secure/en
3333
storing the access key in a secure form so that pull requests cannot use the keys stored in your .travis.yml.
3434
For more information see the [pull requests page](http://docs.travis-ci.com/user/pull-requests/#Security-Restrictions-when-testing-Pull-Requests).
3535

36-
37-
### Plain Text Access Key
38-
39-
40-
To store your access key in plain text format, add the following configuration to your .travis.yml file:
41-
42-
addons:
43-
browserstack:
44-
username: "Your BrowserStack username"
45-
access_key: "Your BrowserStack access key"
46-
47-
48-
Note: Other users that have access to your repository can read and use your plain text
49-
access keys to test on BrowserStack. If you want to prevent this you should encrypt your access key as explained below.
50-
5136
### Encrypted Access Key
5237

5338
To encrypt your access key for use in .travis.yml you can use `travis encrypt "your BrowserStack access key"`.
@@ -60,6 +45,18 @@ Once your access key is encrypted you can add the secure string:
6045
secure: "The secure string output of `travis encrypt`"
6146

6247

48+
### Plain Text Access Key
49+
50+
To store your access key in plain text format, add the following configuration to your .travis.yml file:
51+
52+
addons:
53+
browserstack:
54+
username: "Your BrowserStack username"
55+
access_key: "Your BrowserStack access key"
56+
57+
We **strongly** recommend storing your BrowserStack access keys in encrypted format, since other users that have access to your repository
58+
can read and use your plain text access keys to test on BrowserStack.
59+
6360
### Local Identifier
6461

6562
A Local Identifier is a unique identifier for each Local connection when multiple Local connections are connected.
@@ -87,21 +84,7 @@ Local identifiers are essential for [matrix builds][travis-matrix-builds]. Since
8784
the same VM, we need to add the Local Identifier when starting the connection to ensure that the correct local tunnel
8885
gets the right requests.
8986

90-
## Additional Features
91-
92-
### Folder Testing
93-
94-
Local testing also allows you to test HTML in local folders. To enable folder testing you need to set the
95-
name of the local folders as:
96-
97-
addons:
98-
browserstack: "Your BrowserStack username"
99-
access_key:
100-
secure: "The secure string output of `travis encrypt`"
101-
folder: "Absolute path of the folder containing HTML files"
102-
103-
You can then access the HTML files via the url
104-
`http://$BROWSERSTACK_USERNAME.browserstack.com/"Path to your HTML file with respect to the folder set."`
87+
## Additional Options
10588

10689
### Proxy
10790

@@ -112,10 +95,10 @@ through which all urls will be resolved:
11295
browserstack: "Your BrowserStack username"
11396
access_key:
11497
secure: "The secure string output of `travis encrypt`"
115-
proxy_host: "Proxy server host"
116-
proxy_port: "Proxy server port"
117-
proxy_user: "User to use when accessing proxy server"
118-
proxy_pass: "Password to use when accessing proxy server"
98+
proxyHost: "Proxy server host"
99+
proxyPort: "Proxy server port"
100+
proxyUser: "User to use when accessing proxy server"
101+
proxyPass: "Password to use when accessing proxy server"
119102

120103

121104
### More Options
@@ -130,7 +113,7 @@ Sample usage,
130113
browserstack: "Your BrowserStack username"
131114
access_key:
132115
secure: "The secure string output of `travis encrypt`"
133-
force_local: true
116+
forcelocal: true
134117
only: dev.example.com,80,0,*.example.org,80,0
135118

136119
The format for the **only** flag is, `"Host pattern,Host Port,Flag for SSL True(1)/False(0)" and repeat.

0 commit comments

Comments
 (0)