-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Update how Selenium Manager is described #1390
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
80 changes: 80 additions & 0 deletions
80
website_and_docs/content/documentation/selenium_manager.en.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,80 @@ | ||
--- | ||
title: "Selenium Manager (Beta)" | ||
linkTitle: "Selenium Manager" | ||
weight: 11 | ||
description: > | ||
The Selenium Manager is a binary generated with Rust that manages driver installation. | ||
--- | ||
|
||
## Applicability | ||
|
||
***Selenium bindings use this tool by default, so you do not need to download it or | ||
add anything to your code or do anything else to use it.*** | ||
|
||
If, however, you need to access drivers with `curl` or a REST client, | ||
use one of the unofficial Selenium implementations, | ||
have special network requirements, or just want to better | ||
understand what the tool is doing, please continue reading. | ||
|
||
## Usage | ||
|
||
The Selenium bindings use the Manager automatically so long as the following conditions are met: | ||
* The driver location isn't specified in a `Service` class | ||
* A 3rd party driver manager is not installed | ||
* No drivers exist in directories included in the `PATH` Environment Variable | ||
|
||
To use it with Selenium Grid: | ||
* Start the grid with this additional argument: `--selenium-manager true` | ||
|
||
## Status | ||
|
||
This tool is still in beta, and Selenium is slowly adding support for its features. | ||
The current implementation is a "fall-back" option, which means it should only get used | ||
if the code execution would otherwise fail. So long as you specify the location of the | ||
driver in the appropriate [Service class]({{< ref "webdriver/drivers/service.md" >}}) | ||
(or using System Properties in Java), the Selenium Manager will not be used. | ||
|
||
### History | ||
|
||
The first implementation of Selenium Manager was released in Selenium 4.6. We | ||
made an announcement about it [on our blog](https://www.selenium.dev/blog/2022/introducing-selenium-manager/). | ||
|
||
* Selenium 4.7 added support for IE Driver and improved error logging | ||
* Selenium 4.8 added support for beta and development versions of browsers | ||
* Selenium 4.9 added support for locating drivers based on provided location of browser binary | ||
|
||
### Future | ||
|
||
We are tracking the various features as a [GitHub Project](https://github.com/orgs/SeleniumHQ/projects/5/views/1). | ||
The major features we are looking to support: | ||
* Proxies | ||
* Warning/fixing problems with drivers on `PATH` | ||
* Browser downloads based on `browserVersion` provided in capabilities | ||
|
||
## Configuration | ||
|
||
Specific values can be overridden by specifying environment variables or by using a config file | ||
located by default at `~/.cache/selenium/selenium-manager-config.toml`. | ||
|
||
| CLI | Env Variable | Config File | | ||
titusfortner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|----------------------------------|----------------------------------------------------|-----------------------------------------------------| | ||
| --browser chrome | SE_BROWSER=chrome | browser = "chrome" | | ||
| --driver chromedriver | SE_DRIVER=chromedriver | driver = "chromedriver" | | ||
| --browser-version 106 | SE_BROWSER_VERSION=106 | browser-version = "106" | | ||
| --driver-version 106.05249.61 | SE_DRIVER_VERSION=106.0.5249.61 | driver-version = "106.0.5249.61" | | ||
| --browser-path /path/to/chromium | SE_BROWSER_PATH=/path/to/chromium | browser-path = "/path/to/chromium" | | ||
| | SE_OS=macos | os = "macos" | | ||
| | SE_ARCH=x64 | arch = "x64" | | ||
| --proxy user@pass:myproxy:8080 | SE_PROXY=user@pass:myproxy:8080 | proxy = "user@pass:myproxy:8080" | | ||
| --browser-ttl 0 | SE_BROWSER_TTL=0 | browser-ttl = 0 | | ||
| --driver-ttl 86400 | SE_DRIVER_TTL=86400 | driver-ttl = 86400 | | ||
| | SE_DRIVER_MIRROR=http://my-chromedriver-mirror.net | driver-mirror = "http://my-chromedriver-mirror.net" | | ||
| --clear-cache | | | | ||
| --clear-metadata | | | | ||
| | SE_CACHE_PATH=/my/custom/cache | cache-path = "/my/custom/cache" | | ||
| --debug | SE_DEBUG=true | debug true | | ||
| --trace | SE_TRACE=true | | | ||
|
||
## Development | ||
|
||
Selenium Manager is written in Rust and compiled into binaries using GitHub Actions. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.