From 392d3bfb31770c1c1cafde89586d4d2738840827 Mon Sep 17 00:00:00 2001 From: Paul Mucur Date: Tue, 4 Feb 2025 14:21:28 +0000 Subject: [PATCH 1/3] Simplify Connect firewall requirements As there's no real distinction between authenticated and unauthenticated requests to the Connect API (aside from a one or two extra HTTP headers) from the perspective of a network administrator, combine those into a single list item. --- documentation/asciidoc/services/connect/troubleshooting.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/documentation/asciidoc/services/connect/troubleshooting.adoc b/documentation/asciidoc/services/connect/troubleshooting.adoc index d05876ab3..5c9157d28 100644 --- a/documentation/asciidoc/services/connect/troubleshooting.adoc +++ b/documentation/asciidoc/services/connect/troubleshooting.adoc @@ -82,8 +82,7 @@ If Connect can communicate properly on your network, you should see output simil 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: -* unauthenticated HTTPS requests to the Raspberry Pi Connect API on port 443 of `api.connect.raspberrypi.com` -* authenticated requests to the Raspberry Pi Connect API on port 443 of `api.connect.raspberrypi.com` +* HTTPS requests to the Raspberry Pi Connect API on port 443 of `api.connect.raspberrypi.com` * requests to Raspberry Pi Connect STUN or TURN servers on UDP port 3478 of all of the following: ** `stun.raspberrypi.com` ** `turn1.raspberrypi.com` From c25df8c51a941d3b48248fb0abdf0ccb5285dece Mon Sep 17 00:00:00 2001 From: Paul Mucur Date: Tue, 4 Feb 2025 14:22:37 +0000 Subject: [PATCH 2/3] Update documentation for rpi-connect doctor As of rpi-connect and rpi-connect-lite 2.4.0, rpi-connect doctor will now include checks for screen sharing support as well as connectivity testing. Document these extra checks and suggest its use if screen sharing is unexpectedly unavailable. --- .../services/connect/troubleshooting.adoc | 45 ++++++++++++++++--- 1 file changed, 40 insertions(+), 5 deletions(-) diff --git a/documentation/asciidoc/services/connect/troubleshooting.adoc b/documentation/asciidoc/services/connect/troubleshooting.adoc index 5c9157d28..61073f057 100644 --- a/documentation/asciidoc/services/connect/troubleshooting.adoc +++ b/documentation/asciidoc/services/connect/troubleshooting.adoc @@ -35,14 +35,47 @@ Replacing globally-enabled rpi-connect services with user-enabled ones... ==== Screen sharing not available -If Connect states that screen sharing is unavailable, it cannot connect to the dedicated Connect WayVNC service. +If Connect states that screen sharing is unavailable, one or more requirements for screen sharing support are not met. To help debug the problem, `rpi-connect` and `rpi-connect-lite` include the `rpi-connect doctor` to command to identify any issues with screen sharing. -To find out more about the cause of the issue, run the following commands to check the status of the Connect WayVNC service: +Run the following command: [source,console] ---- -$ systemctl --user status rpi-connect-wayvnc -$ journalctl --user --follow --unit rpi-connect-wayvnc +$ rpi-connect doctor +---- + +If all is well, you should see output similar to the following: + +---- +Screen sharing is supported by this version of rpi-connect +✓ Wayland compositor available +✓ Screen sharing services enabled and active +✓ Communication with Raspberry Pi Connect API +✓ Authentication with Raspberry Pi Connect API +✓ Peer-to-peer connection candidate via STUN +✓ Peer-to-peer connection candidate via TURN +---- + +If there is an issue, you will see something like so: + +---- +Screen sharing is supported by this version of rpi-connect +✓ Wayland compositor available +✗ Screen sharing services enabled and active - Please run rpi-connect on to enable and start all required services +✓ Communication with Raspberry Pi Connect API +✓ Authentication with Raspberry Pi Connect API +✓ Peer-to-peer connection candidate via STUN +✓ Peer-to-peer connection candidate via TURN + +✗ Some checks failed +---- + +If you have repeated issues trying to run Connect's required services, run the following commands to check their status in more detail: + +[source,console] +---- +$ systemctl --user status rpi-connect-wayvnc.service rpi-connect-wayvnc-watcher.path +$ journalctl --user --follow --unit rpi-connect-wayvnc.service --unit rpi-connect-wayvnc-watcher.path ---- If the service fails to start or doesn't exist, ensure that your environment meets the following criteria: @@ -63,7 +96,6 @@ For screen sharing, Connect can only share an existing graphical desktop session Connect usually communicates between devices without requiring changes to your network or firewall. However, especially restrictive networks can sometimes block Connect communication. To help debug problems with such networks, `rpi-connect` and `rpi-connect-lite` include the `rpi-connect doctor` command. `rpi-connect doctor` runs a series of tests to check that Connect communication functions properly on your network. - To run these tests on your device, run the following command: [source,console] @@ -74,6 +106,9 @@ $ rpi-connect doctor If Connect can communicate properly on your network, you should see output similar to the following: ---- +Screen sharing is supported by this version of rpi-connect +✓ Wayland compositor available +✓ Screen sharing services enabled and active ✓ Communication with Raspberry Pi Connect API ✓ Authentication with Raspberry Pi Connect API ✓ Peer-to-peer connection candidate via STUN From 0d3eaf70aea3b06d7d70a099dbaf6849cae81659 Mon Sep 17 00:00:00 2001 From: nate contino Date: Tue, 4 Feb 2025 14:29:15 +0000 Subject: [PATCH 3/3] Update documentation/asciidoc/services/connect/troubleshooting.adoc --- documentation/asciidoc/services/connect/troubleshooting.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/asciidoc/services/connect/troubleshooting.adoc b/documentation/asciidoc/services/connect/troubleshooting.adoc index 61073f057..16b9268c6 100644 --- a/documentation/asciidoc/services/connect/troubleshooting.adoc +++ b/documentation/asciidoc/services/connect/troubleshooting.adoc @@ -35,7 +35,7 @@ Replacing globally-enabled rpi-connect services with user-enabled ones... ==== Screen sharing not available -If Connect states that screen sharing is unavailable, one or more requirements for screen sharing support are not met. To help debug the problem, `rpi-connect` and `rpi-connect-lite` include the `rpi-connect doctor` to command to identify any issues with screen sharing. +If Connect states that screen sharing is unavailable, one or more requirements for screen sharing support are not met. To help debug the problem, `rpi-connect` and `rpi-connect-lite` include the `doctor` command. Use `rpi-connect doctor` to identify issues with screen sharing. Run the following command: