Skip to content

Commit 98faa52

Browse files
Apply suggestions from code review
1 parent 607cf01 commit 98faa52

File tree

3 files changed

+30
-28
lines changed

3 files changed

+30
-28
lines changed

documentation/asciidoc/services/connect/install.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,16 @@ Run the following command on your Raspberry Pi to install Connect:
1616
$ sudo apt install rpi-connect
1717
----
1818

19+
You can also install Connect from the Recommended Software application.
20+
1921
After installation, use the `rpi-connect` command line interface to start Connect for your current user:
2022

2123
[source,console]
2224
----
2325
$ rpi-connect on
2426
----
2527

26-
Alternatively, if the Connect plugin is running in your menu bar, you can choose "Turn On Raspberry Pi Connect" from the dropdown menu:
28+
Alternatively, click the Connect icon in the menu bar to open a dropdown menu and select *Turn On Raspberry Pi Connect*:
2729

2830
image::images/turn-on-connect.png[width="80%"]
2931

documentation/asciidoc/services/connect/troubleshooting.adoc

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,21 @@
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-
* 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:
1414
+
1515
[source,console]
1616
----
1717
$ sudo apt install --only-upgrade rpi-connect
1818
----
1919
+
20-
If you have rpi-connect-lite installed:
20+
Alternatively, if you currently have `rpi-connect-lite` installed, run the following command:
2121
+
2222
[source,console]
2323
----
2424
$ sudo apt install --only-upgrade rpi-connect-lite
2525
----
2626
+
27-
If successful, you should see the following output during the upgrade:
27+
You should see output similar to the following during the upgrade, indicating that Connect's services have migrated to the version 2 format:
2828
+
2929
[source,console]
3030
----
@@ -35,36 +35,37 @@ Replacing globally-enabled rpi-connect services with user-enabled ones...
3535

3636
==== Screen sharing not available
3737

38-
If Connect states that screen sharing is "unavailable" that means it cannot connect to its dedicated WayVNC service.
38+
If Connect states that screen sharing is unavailable, it cannot connect to the dedicated Connect WayVNC service.
3939

40-
The first step is to check the status of the WayVNC service:
40+
To find out more about the cause of the issue, run the following commands to check the status of the Connect WayVNC service:
4141

4242
[source,console]
4343
----
4444
$ systemctl --user status rpi-connect-wayvnc.service
4545
$ journalctl --user --follow --unit rpi-connect-wayvnc.service
4646
----
4747

48-
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:
4949

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.
5455

5556
==== Can't connect after restarting or ending SSH session
5657

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.
5859

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.
6061

6162
==== Networking and firewall issues
6263

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:
6465

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.
6869

6970
=== View Connect status
7071

@@ -73,20 +74,19 @@ To view the current status of the Connect service, run the following command:
7374
[source,console]
7475
----
7576
$ rpi-connect status
77+
----
78+
79+
You should see output similar to the following:
80+
81+
----
7682
Signed in: yes
7783
Screen sharing: allowed (0 sessions active)
7884
Remote shell: allowed (0 sessions active)
7985
----
8086

8187
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.
8288

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.
9090

9191
=== Enable enhanced logging
9292

@@ -128,7 +128,7 @@ Override the `rpi-connect-wayvnc` service definition with the following command:
128128
$ systemctl --user edit rpi-connect-wayvnc
129129
----
130130

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):
132132

133133
[source,bash]
134134
----

documentation/asciidoc/services/connect/use.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ If you're using the Connect plugin for the menu bar, clicking "Turn On Raspberry
99

1010
image::images/browser-sign-in.png[width="80%"]
1111

12-
Alternatively, you can choose "Sign In" from the dropdown menu:
12+
Alternatively, you can choose "Sign In..." from the dropdown menu:
1313

1414
image::images/sign-in.png[width="80%"]
1515

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].
1717

1818
=== via the command line
1919

@@ -201,7 +201,7 @@ Click on a device name to open the device details page. This screen provides low
201201

202202
image::images/device.png[width="80%"]
203203

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.
205205

206206
== Update
207207

0 commit comments

Comments
 (0)