Skip to content

Commit fe1e11f

Browse files
Merge pull request #3777 from raspberrypi/connect-account
Tighten up Connect documentation wording to better explain accounts and device linking
2 parents b04d843 + 2e4e4db commit fe1e11f

File tree

1 file changed

+30
-27
lines changed
  • documentation/asciidoc/services/connect

1 file changed

+30
-27
lines changed

documentation/asciidoc/services/connect/use.adoc

Lines changed: 30 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
== Link a Raspberry Pi with a Raspberry Pi ID
1+
== Link a Raspberry Pi device with a Connect account
22

3-
Now that you've installed Connect on your Raspberry Pi, you must associate your Raspberry Pi with your Raspberry Pi ID to use Connect.
3+
Now that you've installed Connect on your Raspberry Pi device, you must associate your device with your Connect account before you can use Connect.
44

5-
If you do not have a Raspberry Pi ID, xref:id.adoc#create-a-raspberry-pi-id[create one].
5+
If you do not have a Connect account:
66

7-
To link your Raspberry Pi with your Raspberry Pi ID, use Connect to generate a verification URL. Visit the URL and sign into your Raspberry Pi ID to add your Raspberry Pi to your account.
7+
. xref:id.adoc#create-a-raspberry-pi-id[Create a Raspberry Pi ID].
8+
. Visit https://connect.raspberrypi.com[connect.raspberrypi.com] and create a Connect account using your Raspberry Pi ID.
89

9-
You can generate the verification URL using the Connect icon on the Raspberry Pi Desktop or with the `rpi-connect` CLI.
10+
To link your device with your Connect account, use the Connect client software to generate a verification URL. Visit the URL and sign into your Connect account with your Raspberry Pi ID to add your device to your account.
11+
12+
To generate the verification URL, use the Connect icon on the Raspberry Pi Desktop or the `rpi-connect` CLI. Follow the instructions below:
1013

1114
=== via the Raspberry Pi Desktop
1215

@@ -18,11 +21,11 @@ Click on the Connect icon and choose "Sign in" from the drop-down menu.
1821

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

21-
This opens a verification URL you can use to link your Raspberry Pi to your Raspberry Pi ID.
24+
This opens a verification URL you can use to link your device to your Connect account.
2225

2326
=== via the command line
2427

25-
Use the following command to generate a link that will connect your Raspberry Pi with your Raspberry Pi ID:
28+
Use the following command to generate a link that will connect your device with your Connect account:
2629

2730
[source,console]
2831
----
@@ -35,7 +38,7 @@ This command should output something like the following:
3538
Complete sign in by visiting https://connect.raspberrypi.com/verify/XXXX-XXXX
3639
----
3740

38-
Visit the verification URL on any device and sign in to link your Raspberry Pi with your Raspberry Pi ID.
41+
Visit the verification URL on any device and sign in to your Raspberry Pi ID to link your device with your Connect account.
3942

4043
=== Finish linking your Raspberry Pi
4144

@@ -45,11 +48,11 @@ Sign in to Connect using your xref:id.adoc[Raspberry Pi ID].
4548

4649
image::images/login-with-id.png[width="80%"]
4750

48-
After authenticating, assign a name to your Raspberry Pi. Choose a name that will help you identify your device. Click the **Create device and sign in** button to continue.
51+
After authenticating, assign a name to your device. Choose a name that uniquely identifies the device. Click the **Create device and sign in** button to continue.
4952

5053
image::images/create-device.png[width="80%"]
5154

52-
You can now remotely connect to your Raspberry Pi. The Connect system tray icon will turn blue to indicate that your Raspberry Pi has been linked to the Connect service. You should receive an email notification indicating that a new device has signed into Connect.
55+
You can now remotely connect to your device. The Connect system tray icon will turn blue to indicate that your device is now signed in to the Connect service. You should receive an email notification indicating that a new device is linked to your Connect account.
5356

5457
image::images/sign-in-email.png[width="70%"]
5558

@@ -59,13 +62,13 @@ Click the Connect system tray icon to open the Connect menu. This menu shows you
5962

6063
TIP: Connect signs communication with your device serial number. Moving your SD card between devices will sign you out of Connect.
6164

62-
== Access your Raspberry Pi
65+
== Access your Raspberry Pi device
6366

64-
Now that your Raspberry Pi appears on your Connect dashboard, you can access your Raspberry Pi from anywhere using only a browser. Connect provides multiple ways to interact with your Raspberry Pi remotely.
67+
Now that your device appears on your Connect dashboard, you can access your device from anywhere using only a browser. Connect provides multiple ways to interact with your device remotely.
6568

6669
=== Screen sharing
6770

68-
Connect includes the ability to share your Raspberry Pi's screen in a browser. Use the following instructions to share your Raspberry Pi's screen.
71+
Connect includes the ability to share your device's screen in a browser. Use the following instructions to share your device's screen.
6972

7073
NOTE: Screen sharing requires the **Wayland** window server. By default, Raspberry Pi OS only uses Wayland for **64-bit** distributions of Raspberry Pi OS **Bookworm** on Raspberry Pi 5, 4, or 400. Screen sharing is **not** compatible with Raspberry Pi OS Lite or systems that use the X window server.
7174

@@ -75,11 +78,11 @@ Connect redirects you to the Raspberry Pi ID service to sign in. After signing i
7578

7679
image::images/list-of-devices.png[width="80%"]
7780

78-
Click the **Connect via** button to the right of the device you would like to access. Select the **Screen sharing** option from the menu. This opens a browser window that displays the desktop of your Raspberry Pi.
81+
Click the **Connect via** button to the right of the device you would like to access. Select the **Screen sharing** option from the menu. This opens a browser window that displays your device's desktop.
7982

8083
image::images/screen-sharing-connecting.png[width="80%"]
8184

82-
You can now use your Raspberry Pi as you would locally. For more information about the connection, hover your mouse over the padlock icon immediately to the right of the **Disconnect** button.
85+
You can now use your device as you would locally. For more information about the connection, hover your mouse over the padlock icon immediately to the right of the **Disconnect** button.
8386

8487
image::images/screen-sharing-start.png[width="80%"]
8588

@@ -101,7 +104,7 @@ image::images/screen-sharing-end.png[width="80%"]
101104

102105
==== Disable screen sharing
103106

104-
To turn off screen sharing, click the Connect system tray icon and unselect **Allow screen sharing**. Your Raspberry Pi remains signed into Connect, but you won't be able to create a screen sharing session from the Connect dashboard.
107+
To turn off screen sharing, click the Connect system tray icon and unselect **Allow screen sharing**. Your device remains signed into Connect, but you won't be able to create a screen sharing session from the Connect dashboard.
105108

106109
image::images/screen-sharing-disabled-desktop.png[width="80%"]
107110

@@ -128,19 +131,19 @@ $ rpi-connect vnc on
128131

129132
=== Remote shell
130133

131-
Connect includes the ability to access a shell running on your Raspberry Pi from a browser. Use the following instructions to access the remote shell.
134+
Connect includes the ability to access a shell running on your device from a browser. Use the following instructions to access the remote shell.
132135

133136
Visit https://connect.raspberrypi.com[connect.raspberrypi.com] on any computer.
134137

135138
Connect redirects you to the Raspberry Pi ID service to sign in. After signing in, Connect displays a list of linked devices. Devices available for remote shell access show a grey **Remote shell** badge below the name of the device.
136139

137140
image::images/list-of-devices.png[width="80%"]
138141

139-
Click the **Connect via** button to the right of the device you would like to access. Select the **Remote shell** option from the menu. This opens a shell session on your Raspberry Pi.
142+
Click the **Connect via** button to the right of the device you would like to access. Select the **Remote shell** option from the menu. This opens a shell session on your device.
140143

141144
image::images/remote-shell-connecting.png[width="80%"]
142145

143-
You can now use your Raspberry Pi as you would locally.
146+
You can now use your device as you would locally.
144147

145148
image::images/remote-shell-start.png[width="80%"]
146149

@@ -166,7 +169,7 @@ image::images/remote-shell-end.png[width="80%"]
166169

167170
==== Disable remote shell access
168171

169-
To turn off remote shell access, click the Connect system tray icon and unselect **Allow remote shell**. Your Raspberry Pi remains signed into Connect, but you won't be able to create a remote shell session from the Connect dashboard.
172+
To turn off remote shell access, click the Connect system tray icon and unselect **Allow remote shell**. Your device remains signed into Connect, but you won't be able to create a remote shell session from the Connect dashboard.
170173

171174
image::images/remote-shell-disabled-desktop.png[width="80%"]
172175

@@ -193,7 +196,7 @@ $ rpi-connect shell on
193196

194197
== Enable remote shell at all times
195198

196-
Connect runs as a user-level service, not as root. As a result, Connect only works when your user account is currently logged in on your Raspberry Pi. This can make your Raspberry Pi unreachable if you reboot with automatic login disabled. To continue running Connect even when you aren't logged into your device, enable **user-lingering**. Run the following command from your user account to enable user-lingering:
199+
Connect runs as a user-level service, not as root. As a result, Connect only works when your user account is currently logged in on your device. This can make your device unreachable if you reboot with automatic login disabled. To continue running Connect even when you aren't logged into your device, enable **user-lingering**. Run the following command from your user account to enable user-lingering:
197200

198201
[source,console]
199202
----
@@ -204,7 +207,7 @@ TIP: We recommend enabling user-lingering on all headless Raspberry Pi OS Lite s
204207

205208
== Manage devices
206209

207-
The Connect dashboard lists all of the Raspberry Pi devices linked with your Raspberry Pi ID and shows you the various ways you can access them.
210+
The Connect dashboard lists all of the devices linked with your Connect account and shows you the various ways you can access them.
208211

209212
image::images/list-of-devices.png[width="80%"]
210213

@@ -233,18 +236,18 @@ $ sudo reboot
233236

234237
== Disconnect a device from Connect
235238

236-
Run the following command on your Raspberry Pi to sign out of your Raspberry Pi ID, which will disable your device on the Connect screen:
239+
Run the following command on your device to sign out of your Raspberry Pi ID, which will disable your device on the Connect screen:
237240

238241
[source,console]
239242
----
240243
$ rpi-connect signout
241244
----
242245

243-
TIP: To fully remove a Raspberry Pi from your Connect account, xref:connect.adoc#manage-devices[remove it from the Connect dashboard].
246+
TIP: To fully remove a device from your Connect account, xref:connect.adoc#manage-devices[remove it from the Connect dashboard].
244247

245248
== Uninstall
246249

247-
Run the following command to remove Connect software from a Raspberry Pi:
250+
Run the following command to remove Connect software from a device:
248251

249252
[source,console]
250253
----
@@ -253,6 +256,6 @@ $ sudo apt remove --purge rpi-connect
253256

254257
TIP: If you installed Connect Lite, replace `rpi-connect` with `rpi-connect-lite` in the above command.
255258

256-
After uninstalling, the serial number of the Raspberry Pi remains linked with your Raspberry Pi ID. The device still appears in the Connect dashboard, but can't be used for remote access. If you install Connect again, even with a different SD card, on the same Raspberry Pi, it will reuse the existing device name in the Connect dashboard.
259+
After uninstalling, the serial number of the device remains linked with your Connect account. The device still appears in the Connect dashboard, but can't be used for remote access. If you install Connect again, even with a different SD card, on the same device, it will reuse the existing device name in the Connect dashboard.
257260

258-
To sever the link between a Raspberry Pi and a Raspberry Pi ID, remove the Raspberry Pi from the list of devices in the Connect dashboard.
261+
To sever the link between a device and a Connect account, remove the device from the list of devices in the Connect dashboard.

0 commit comments

Comments
 (0)