Skip to content

Commit aa60664

Browse files
titusfortnerdiemol
titusfortner
and
diemol
authored
Move wiki content to docs (#877) [deploy site]
* direct copy of JSON Wire Protocol from wiki * moving content from wiki into documentation Co-authored-by: Diego Molina <[email protected]>
1 parent 9073e78 commit aa60664

File tree

11 files changed

+5182
-0
lines changed

11 files changed

+5182
-0
lines changed

‎website_and_docs/content/documentation/legacy/capabilities.en.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
title: "Legacy Selenium Capabilities"
3+
linkTitle: "Capabilities"
4+
weight: 3
5+
---
6+
(Previously located: https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities)
7+
8+
See [JSON Wire Protocol]({{< ref "json_wire_protocol.md#capabilities-json-object" >}}) for common capabilities
9+
10+
## Remote Driver Specific
11+
<table><thead><th> <b>Key</b> </th><th> <b>Type</b> </th><th> <b>Description</b> </th></thead><tbody>
12+
<tr><td> webdriver.remote.sessionid </td><td> string </td><td> WebDriver session ID for the session. Readonly and only returned if the server implements a server-side webdriver-backed selenium. </td></tr>
13+
<tr><td> webdriver.remote.quietExceptions </td><td> boolean </td><td> Disable automatic screnshot capture on exceptions. This is False by default. </td></tr></tbody></table>
14+
15+
## Grid Specific
16+
<table><thead><th> <b>Key</b> </th><th> <b>Type</b> </th><th> <b>Description</b> </th></thead><tbody>
17+
<tr><td> path </td><td> string </td><td> Path to route request to, or maybe listen on. </td></tr>
18+
<tr><td> seleniumProtocol </td><td> string </td><td> Which protocol to use. Accepted values: WebDriver, Selenium. </td></tr>
19+
<tr><td> maxInstances </td><td> integer </td><td> Maximum number of instances to allow to connect to grid </td></tr>
20+
<tr><td> environment </td><td> string </td><td> Possible duplicate of browserName? See RegistrationRequest </td></tr></tbody></table>
21+
22+
## Selenium RC Specific
23+
| Key | Type | Description |
24+
|:-------------------------|:------------------|:------------------------------------------------------------------------------------------------------------------------------|
25+
| proxy_pac | boolean | Legacy proxy mechanism. Do not use. |
26+
| commandLineFlags | string | Flags to pass to browser command line. |
27+
| executablePath | string | Path to browser executable. |
28+
| timeoutInSeconds | long integer | Timeout to wait for the browser to launch, in seconds. |
29+
| onlyProxySeleniumTraffic | boolean | Whether to only proxy selenium traffic. See browserlaunchers.Proxies |
30+
| avoidProxy | boolean | ??? See browserlaunchers.Proxies |
31+
| proxyEverything | boolean | ??? See browserlaunchers.Proxies |
32+
| proxyRequired | boolean | ??? See browserlaunchers.Proxies |
33+
| browserSideLog | boolean | ??? See AbstractBrowserLauncher. |
34+
| optionsSet | boolean | ??? See BrowserOptions. |
35+
| singleWindow | boolean | Whether to enable single window mode. |
36+
| dontInjectRegex | javascript RegExp | Regular expression that proxy injection mode can use to know when to bypss injection. Ignored if not in proxy injection mode. |
37+
| userJSInjection | boolean | ??? Whether to inject user JS. Ignored if not in proxy injection mode. |
38+
| userExtensions | string | Path to a JavaScript file that will be loaded into selenium. |
39+
40+
## Selenese-Backed-WebDriver specific
41+
| Key | Type | Description |
42+
|:-------------------------|:------------------|:------------------------------------------------------------------------------------------------------------------------------|
43+
| selenium.server.url | string | URL of Selenium server to use, to back this WebDriver |
44+
45+
## Firefox specific
46+
| Key | Type | Description |
47+
|:-----|:-------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
48+
| captureNetworkTraffic | boolean | Whether to capture network traffic. |
49+
| addCustomRequestHeaders | boolean | Whether to add custom request headers. |
50+
| trustAllSSLCertificates | boolean | Whether to trust all SSL certificates. |
51+
| changeMaxConnections | boolean | ??? See FirefoxChromeLauncher. |
52+
| firefoxProfileTemplate | string | ??? See FirefoxChromeLauncher. |
53+
| profile | string | ??? See FirefoxChromeLauncher |
54+
55+
### FirefoxProfile settings
56+
Preferences accepted by the FirefoxProfile with special meaning, in the WebDriver API:
57+
58+
| **Key** | **Type** | **Description** |
59+
|:--------|:---------|:----------------|
60+
| webdriver\_accept\_untrusted\_certs | boolean | Whether to trust all SSL certificates. TODO: Maybe in some way different to the acceptSslCerts or trustAllSSLCertificates capabilities. |
61+
| webdriver\_assume\_untrusted\_issuer | boolean | Whether to trust all SSL certificate issuers. TODO: Maybe in some way different to the acceptSslCerts or trustAllSSLCertificates capabilities. |
62+
| webdriver.log.driver | string | Level at which to log FirefoxDriver logging statements to a temporary file, so that they can be retrieved by a getLogs command. Available options; DEBUG, INFO, WARNING, ERROR, OFF. Defaults to OFF. |
63+
| webdriver.log.file | string | Path to file to which to copy firefoxdriver logging output. Defaults to no file (like /dev/null). |
64+
| webdriver.load.strategy | string | Experimental API. Defines different strategies for how long to wait until a page is loaded. Values: unstable, conservative. Defaults to conservative. |
65+
| webdriver\_firefox\_port | integer | Port to listen on for WebDriver commands. Defaults to 7055. |
66+
67+
## IE specific
68+
| Key | Type | Description |
69+
|:-----|:-------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
70+
| killProcessesByName | boolean | Whether to try to kill processes by name, instead (or addition) to killing processes we happen to have handles to. |
71+
| honorSystemProxy | boolean | Whether to honor the system proxy. |
72+
| ensureCleanSession | boolean | Whether to make sure the session has no cookies or temporary internet files on Windows. I believe this is passed to the IEDriver as well, but ignored by it. |
73+
74+
## Safari specific
75+
| Key | Type | Description |
76+
|:-----|:-------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
77+
| honorSystemProxy | boolean | Whether to honour the sysem proxy. |
78+
| ensureCleanSession | boolean | Whether to make sure the session has no cookies, cache entries. And that any registry and proxy settings are restored after the session. |
79+
80+

‎website_and_docs/content/documentation/legacy/developers/_index.en.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: "Legacy developer documentation"
3+
linkTitle: "Developers"
4+
weight: 14
5+
aliases: ["/documentation/en/legacy_docs/"]
6+
---
7+
8+
Legacy instructions for developers.

0 commit comments

Comments
 (0)