You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: documentation/asciidoc/services/connect/troubleshooting.adoc
+24-24Lines changed: 24 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,21 +10,21 @@
10
10
11
11
* 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.
12
12
13
-
* When upgrading from version 1 to version 2, ensure to upgrade whichever package you currently have installed before switching between rpi-connect and rpi-connect-lite. This will ensure Connect's services are migrated to the new format, i.e. if you currently have rpi-connect installed:
13
+
* 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:
14
14
+
15
15
[source,console]
16
16
----
17
17
$ sudo apt install --only-upgrade rpi-connect
18
18
----
19
19
+
20
-
If you have rpi-connect-lite installed:
20
+
Alternatively, if you currently have `rpi-connect-lite` installed, run the following command:
If it is failing to start or that service isn't found at all, please ensure the following:
48
+
If the service fails to start or doesn't exist, ensure that your environment meets the following criteria:
49
49
50
-
. You're using rpi-connect version 1.1.0 or later (and not rpi-connect-lite which lacks screen sharing support)
51
-
. You're using a Wayland compositor such as Wayfire (enabled via raspi-config's Advanced Options and on by default for Raspberry Pi 4 and 5 with Raspberry Pi OS Bookworm) and not X11
52
-
. You're using a desktop environment supported by WayVNC, e.g. Raspberry Pi Desktop. (Note that using KDE will switch your Wayland compositor to kwin, which is unsupported.)
53
-
. You have an active graphical desktop session running as the same user as the one you signed into (for most, this means enabling "Desktop Autologin" via raspi-config's System Options)
50
+
. You use `rpi-connect` version 1.1.0 or later.
51
+
. You do not use `rpi-connect-lite`, which lacks screen sharing support.
52
+
. You use a Wayland compositor such as wayfire or labwc, not X. You can control this setting via ``raspi-config``'s Advanced Options.
53
+
. You use a desktop environment supported by WayVNC, e.g. Raspberry Pi Desktop. For instance, using KDE switches your Wayland compositor to kwin, which is unsupported.
54
+
. You have an active graphical desktop session running as the same user as the one you signed into. For most, this means enabling "Desktop Autologin" via ``raspi-config``'s System Options.
54
55
55
56
==== Can't connect after restarting or ending SSH session
56
57
57
-
Connect runs as a user-level service and is therefore only available if there is an active session for the user signed into the service. If you want remote shell access without also having any other login session running, xref:connect.adoc#enable-remote-shell-at-all-times[enable user-lingering] for your user which will keep Connect running at all times.
58
+
Connect runs as a user-level service and is therefore only available if there is an active session for the user signed into the service. If you want remote shell access without also running another login session, xref:connect.adoc#enable-remote-shell-at-all-times[enable user-lingering] for your user, which will keep Connect running at all times.
58
59
59
-
For screen sharing, Connect can only share an existing graphical desktop session, it does not create entirely new sessions: therefore, there must already be a desktop session in progress. To start such a session automatically on boot, you'll need to enable Desktop Autologin via raspi-config's System Options.
60
+
For screen sharing, Connect can only share an existing graphical desktop session: it does not create entirely new sessions. There must already be a desktop session in progress. To start such a session automatically on boot, enable Desktop Autologin via ``raspi-config``'s System Options.
60
61
61
62
==== Networking and firewall issues
62
63
63
-
Connect is designed to avoid having to make changes to your network and firewall in order to establish a connection but if you have a restrictive network and are having trouble connecting, please check the following:
64
+
Connect avoids changing your network or firewall in order to establish a connection. However, if you have a restrictive network and experience trouble connecting, check the following:
64
65
65
-
. You can access the Connect API (required for authentication and negotiating the connection between your Raspberry Pi device and your browser), e.g. can you load https://api.connect.raspberrypi.com/up?
66
-
. You can access our STUN server (used to obtain a peer-to-peer connection through local or public networks) on stun.raspberrypi.com and UDP port 3478
67
-
. You can access our TURN servers (used to relay sessions if a peer-to-peer connection through local or public networks can't be made) on turn1.raspberrypi.com, turn2.raspberrypi.com and turn3.raspberrypi.com on TCP ports 3478 or 443, or UDP ports 3478, 443 and 49152-65535
66
+
. Can you access the Connect API, which Connect uses for authentication and connection negotiation between your Raspberry Pi and your browser? To check, load https://api.connect.raspberrypi.com/up?[https://api.connect.raspberrypi.com/up?] on your Raspberry Pi.
67
+
. Can you access the Connect STUN server, which Connect uses to obtain a peer-to-peer connection through local or public networks? To check, ping `stun.raspberrypi.com` on UDP port 3478.
68
+
. Can you access our TURN servers, which Connect uses to relay sessions when a peer-to-peer connection fails? To check, ping `turn1.raspberrypi.com`, `turn2.raspberrypi.com` and `turn3.raspberrypi.com` on TCP ports 3478 or 443, or UDP ports 3478, 443 and 49152 -> 65535.
68
69
69
70
=== View Connect status
70
71
@@ -73,20 +74,19 @@ To view the current status of the Connect service, run the following command:
73
74
[source,console]
74
75
----
75
76
$ rpi-connect status
77
+
----
78
+
79
+
You should see output similar to the following:
80
+
81
+
----
76
82
Signed in: yes
77
83
Screen sharing: allowed (0 sessions active)
78
84
Remote shell: allowed (0 sessions active)
79
85
----
80
86
81
87
The output of this command indicates whether or not you are currently signed in to Connect, as well as the remote services enabled on your Raspberry Pi.
82
88
83
-
If you see the following, you need to run `rpi-connect on` to start Connect:
84
-
85
-
[source,console]
86
-
----
87
-
$ rpi-connect status
88
-
✗ Raspberry Pi Connect is not running, run rpi-connect on
89
-
----
89
+
If you see output including "Raspberry Pi Connect is not running, run rpi-connect on", run `rpi-connect on` to start Connect.
90
90
91
91
=== Enable enhanced logging
92
92
@@ -128,7 +128,7 @@ Override the `rpi-connect-wayvnc` service definition with the following command:
128
128
$ systemctl --user edit rpi-connect-wayvnc
129
129
----
130
130
131
-
Enter the following lines of configuration between the comments (note the addition of the `-Ldebug` flag):
131
+
Enter the following lines of configuration between the comments (including the `-Ldebug` flag):
Copy file name to clipboardExpand all lines: documentation/asciidoc/services/connect/use.adoc
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,11 +9,11 @@ If you're using the Connect plugin for the menu bar, clicking "Turn On Raspberry
9
9
10
10
image::images/browser-sign-in.png[width="80%"]
11
11
12
-
Alternatively, you can choose "Sign In…" from the dropdown menu:
12
+
Alternatively, you can choose "Sign In..." from the dropdown menu:
13
13
14
14
image::images/sign-in.png[width="80%"]
15
15
16
-
If you don't already have a Raspberry Pi ID, you can xref:id.adoc#create-a-raspberry-pi-id[create one] by clicking "create one for free".
16
+
If you don't already have a Raspberry Pi ID, click *create one for free* to xref:id.adoc#create-a-raspberry-pi-id[create one].
17
17
18
18
=== via the command line
19
19
@@ -201,7 +201,7 @@ Click on a device name to open the device details page. This screen provides low
201
201
202
202
image::images/device.png[width="80%"]
203
203
204
-
Deleting a device from Connect automatically signs you out of Connect on the device. The Connect icon in the menu bar turns grey and the menu only provides a **Sign In…** option.
204
+
Deleting a device from Connect automatically signs you out of Connect on the device. The Connect icon in the menu bar turns grey and the menu only provides a **Sign In...** option.
0 commit comments