Skip to content

Commit

Permalink
docs: update symlinks in browser troubleshooting (#6051)
Browse files Browse the repository at this point in the history
  • Loading branch information
mschile authored Dec 16, 2024
1 parent 692d89e commit ad909e2
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions docs/app/references/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ For the current list, see
[packages/launcher](https://github.com/cypress-io/cypress/blob/develop/packages/launcher/lib/darwin/index.ts)
files.
**Note:** `chrome-for-testing` and `chromium` typically require the downloaded application file to be manually moved to the `/Applications` folder.
**Note:** `chrome-for-testing` and `chromium` typically require the downloaded application file to be manually moved to the `/Applications` folder to be auto-detected.
#### Linux
Expand All @@ -461,14 +461,13 @@ These binary names should work for most Linux distributions. If your
distribution packages browsers under a different binary name, you can add a
symlink using the expected binary name so that Cypress can detect it.
For example, if your distribution packages Google Chrome as `chrome`, you could
add a symlink to `google-chrome` like this:
For example, to create a symlink for the `chrome-for-testing` browser:
```shell
sudo ln `which chrome` /usr/local/bin/google-chrome
sudo ln -s /path/to/binary/chrome /usr/local/bin/chrome
```
**Note:** `chrome-for-testing` and `chromium` typically require the binary to be manually added to the `PATH` to be auto-detected.
**Note:** `chrome-for-testing` and `chromium` typically require the binary to be manually added to the `PATH` or a symlink created to be auto-detected.
#### Windows
Expand Down Expand Up @@ -497,9 +496,13 @@ To make a browser installed at a different path be auto-detected, create a
symlink using `mklink` in the location that Cypress expects to find your
browser.
[Read more about creating symbolic links on Windows](https://www.howtogeek.com/howto/16226/complete-guide-to-symbolic-links-symlinks-on-windows-or-linux/)
For example, to create a symlink for the `chrome-for-testing` browser:
**Note:** `chrome-for-testing` and `chromium` typically require the downloaded folder to either be moved and renamed to the location mentioned above or a symlink created as described above.
```shell
mklink /d "C:\Program Files\Google\Chrome for Testing" "C:\path\to\chrome\executable\folder"
```
**Note:** `chrome-for-testing` and `chromium` typically require the downloaded folder to either be moved and renamed to the location mentioned above or a symlink created as described above to be auto-detected.
Occasionally Cypress will have issues detecting the type of browser in Windows
environments. To manually detect the browser type, append the browser type to
Expand Down

0 comments on commit ad909e2

Please sign in to comment.