Skip to content

Commit c3d643f

Browse files
authored
docs: direct users away from browser version (#2590)
1 parent 3019346 commit c3d643f

File tree

5 files changed

+27
-21
lines changed

5 files changed

+27
-21
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,21 @@ When inspecting a mobile app, the Inspector looks like this:
3737

3838
## Installation
3939

40-
Appium Inspector is released in 3 formats:
40+
Appium Inspector is released in two formats:
4141

4242
1. Standalone desktop application for macOS, Windows, and Linux - download it from the
4343
[**Releases**](https://github.com/appium/appium-inspector/releases) section
44-
2. Web application - **<https://inspector.appiumpro.com>** (note that
45-
[CORS must be enabled](https://appium.github.io/appium-inspector/latest/troubleshooting/#cannot-start-a-session-using-browser-inspector)
46-
in order to connect to an Appium server)
47-
3. Appium server plugin - see the [**plugin README**](./plugins/README.md) for details
44+
2. Appium server plugin - see the [**plugin README**](./plugins/README.md) for details
4845

4946
Check the [System Requirements](https://appium.github.io/appium-inspector/latest/quickstart/requirements/)
5047
and [Installation](https://appium.github.io/appium-inspector/latest/quickstart/installation/)
5148
documentation for more details.
5249

50+
> [!NOTE]
51+
>
52+
> The Inspector was also formerly released as a web application hosted at <https://inspector.appiumpro.com>. The Appium team no longer has developer access to this site, so even though it remains operational, it is highly unlikely to be updated to a newer Inspector version, and may be taken down without notice. We recommend migrating to the standalone app or the plugin version.
53+
> The Appium team is exploring the idea of hosting an up-to-date version of the web app in the future.
54+
5355
## Features
5456

5557
The Inspector has many features in addition to its app inspection abilities:

docs/menu-bar.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ hide:
55
title: Menu Bar
66
---
77

8-
The **Menu Bar** is the always shown either at the top of the application window (Windows) or in the
9-
system menu bar (macOS).
8+
The **Menu Bar** is the always shown either at the top of the application window (Windows/Linux) or
9+
in the system menu bar (macOS).
1010

1111
![macOS Menu Bar](assets/images/menu-bar-macos.png)
1212

1313
!!! note
1414

15-
The menu bar is not available in the [web app version](./overview.md#formats) of the Inspector.
15+
The menu bar is only available in the [standalone app version](./overview.md#formats) of the Inspector.
1616

1717
Several standard menu bar options are included, mainly related to window and text management.
1818
However, there are a few specific options as well:

docs/overview.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,18 @@ with a graphical user interface and additional features.
1414

1515
## Formats
1616

17-
The Inspector is distributed in 3 formats:
17+
The Inspector is distributed in two formats:
1818

1919
- Standalone desktop application for Windows, macOS, and Linux, available for download from
2020
[its GitHub repo](https://github.com/appium/appium-inspector/releases)
21-
- Web application, available at <https://inspector.appiumpro.com>
2221
- Appium server plugin, available for installation using
2322
[Appium's Extension CLI](https://appium.io/docs/en/latest/cli/extensions/)
2423

25-
Note that the web application may not be fully up-to-date with the desktop application.
24+
!!! note
25+
26+
The Inspector was also formerly released as a web application hosted at <https://inspector.appiumpro.com>. The Appium team no longer has developer access to this site, so even though it remains operational, it is highly unlikely to be updated to a newer Inspector version, and may be taken down without notice. We recommend migrating to the standalone app or the plugin version.
27+
28+
The Appium team is exploring the idea of hosting an up-to-date version of the web app in the future.
2629

2730
## GUI Overview
2831

docs/quickstart/installation.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,22 @@ Like all Appium plugins, the Inspector plugin can be installed and activated usi
2525
2. Launch the Appium server with the plugin activated:
2626

2727
```bash
28-
appium --use-plugins=inspector --allow-cors
28+
appium --use-plugins=inspector
2929
```
3030

3131
3. Open the Inspector URL in your web browser:
3232
```
33-
http://localhost:4723/inspector
33+
http://127.0.0.1:4723/inspector
3434
```
3535

3636
!!! info
3737

3838
Make sure the above **host URL** and **port** match those of the Appium server. The server's
3939
**base path** value is irrelevant, as the plugin always uses the `/inspector` path.
4040
41+
Check [the Troubleshooting guide](../troubleshooting.md#cannot-start-a-session-using-plugin-version)
42+
if you are unable to create a session.
43+
4144
## Desktop App
4245
4346
The app can be downloaded from [the Inspector's GitHub repository](https://github.com/appium/appium-inspector/releases).

docs/troubleshooting.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,17 @@ This page aims to act as a reference for issues that may be encountered when usi
1111

1212
Please refer to the [Installation guide](./quickstart/installation.md).
1313

14-
## Cannot start a session using browser Inspector
14+
## Cannot start a session using plugin version
1515

1616
The reason for this issue is [cross-origin resource sharing](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
17-
(CORS). Web browsers have security features which prevent CORS. The browser version of the Inspector
18-
needs to make requests to the Appium server directly from the browser via JavaScript, but these
19-
requests are typically not made to the same host (for example, the Inspector is accessed at
20-
`appiumpro.com`, whereas your local Appium server is `localhost:4723`).
17+
(CORS). The browser will prevent you from connecting to the Appium server if the base URLs of
18+
the Inspector and the Appium server do not match (typically `127.0.0.1`).
2119

22-
In this scenario, you will be unable to start a session, because the browser will prevent it. You
23-
can resolve this issue by starting your Appium server with the `--allow-cors` flag:
20+
If you want to access the Inspector using another base URL (such as `localhost`), you can do so by
21+
adding the `--allow-cors` flag when starting the server:
2422

2523
```
26-
appium --allow-cors
24+
appium --use-plugins=inspector --allow-cors
2725
```
2826

2927
This will instruct the server to sent the correct CORS-related headers, and it should be possible to

0 commit comments

Comments
 (0)