Skip to content

Commit 924e8ac

Browse files
committed
Update Connect troubleshooting guide
Note that upgrading Connect with Connect isn't supported and update console output to reflect changes in v2.5.
1 parent ef7c629 commit 924e8ac

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

documentation/asciidoc/services/connect/troubleshooting.adoc

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
* Browsers intercept certain keys and key combinations. As a result, you can't type these keys into your Connect window. Screen sharing includes a toolbar to simulate some of the most popular intercepted keys.
1212

13+
* Upgrading `rpi-connect` and `rpi-connect-lite` using Connect is not supported. The upgrade process will terminate all remote shell sessions and drop all connections.
14+
1315
* To upgrade from version 1 to version 2, you must first upgrade the package you currently have installed before switching between `rpi-connect` and `rpi-connect-lite`. This ensures that Connect's services properly migrate to the version 2 format. If you currently have `rpi-connect` installed, run the following command:
1416
+
1517
[source,console]
@@ -50,6 +52,7 @@ If all is well, you should see output similar to the following:
5052
Screen sharing is supported by this version of rpi-connect
5153
✓ Wayland compositor available
5254
✓ Screen sharing services enabled and active
55+
✓ Communication with Raspberry Pi Connect WebSocket server
5356
✓ Communication with Raspberry Pi Connect API
5457
✓ Authentication with Raspberry Pi Connect API
5558
✓ Peer-to-peer connection candidate via STUN
@@ -62,6 +65,7 @@ If there is an issue, you will see something like so:
6265
Screen sharing is supported by this version of rpi-connect
6366
✓ Wayland compositor available
6467
✗ Screen sharing services enabled and active - Please run rpi-connect on to enable and start all required services
68+
✓ Communication with Raspberry Pi Connect WebSocket server
6569
✓ Communication with Raspberry Pi Connect API
6670
✓ Authentication with Raspberry Pi Connect API
6771
✓ Peer-to-peer connection candidate via STUN
@@ -109,6 +113,7 @@ If Connect can communicate properly on your network, you should see output simil
109113
Screen sharing is supported by this version of rpi-connect
110114
✓ Wayland compositor available
111115
✓ Screen sharing services enabled and active
116+
✓ Communication with Raspberry Pi Connect WebSocket server
112117
✓ Communication with Raspberry Pi Connect API
113118
✓ Authentication with Raspberry Pi Connect API
114119
✓ Peer-to-peer connection candidate via STUN
@@ -117,7 +122,7 @@ Screen sharing is supported by this version of rpi-connect
117122

118123
If Connect can't communicate properly on your network, you'll see an "x" instead of a check next to the failing test case. Ask your network administrator to enable the following connections on your network:
119124

120-
* HTTPS requests to the Raspberry Pi Connect API on port 443 of `api.connect.raspberrypi.com`
125+
* HTTPS requests to the Raspberry Pi Connect API and WebSocket server on port 443 of `api.connect.raspberrypi.com` and `ws.connect.raspberrypi.com`
121126
* requests to Raspberry Pi Connect STUN or TURN servers on UDP port 3478 of all of the following:
122127
** `stun.raspberrypi.com`
123128
** `turn1.raspberrypi.com`
@@ -145,6 +150,7 @@ You should see output similar to the following:
145150

146151
----
147152
Signed in: yes
153+
Subscribed to events: yes
148154
Screen sharing: allowed (0 sessions active)
149155
Remote shell: allowed (0 sessions active)
150156
----

0 commit comments

Comments
 (0)