Skip to content

Commit da3256b

Browse files
Merge pull request #421 from raspberrypi/develop
Docs 80 (#414)
2 parents 264a79d + fd7e485 commit da3256b

5 files changed

Lines changed: 63 additions & 16 deletions

File tree

1.96 MB
Loading
Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,49 @@
11
== Manually start and stop Connect
22

3-
To start Connect or Connect Lite from the command line, run the following command:
3+
You can turn Connect on and off from either the desktop or the command line:
44

5+
[tabs]
6+
======
7+
Desktop::
8+
+
9+
To turn on Connect:
10+
+
11+
From the Connect icon in the menu bar, select **Turn On Raspberry Pi Connect**.
12+
+
13+
If you aren't already signed in with your Raspberry Pi ID, a browser will open and you will be prompted to do so now. Once you've signed in, your Raspberry Pi links to your Connect account.
14+
+
15+
image::images/turn-on-connect.png[alt="The Connect interface, showing the Turn On Raspberry Pi Connect dropdown menu option.",width="80%"]
16+
+
17+
To turn off Connect:
18+
+
19+
From the Connect icon in the menu bar, select **Turn Off Raspberry Pi Connect**.
20+
+
21+
This stops Connect from running.
22+
+
23+
image::images/turn-off-connect.png[alt="The Connect interface, showing the Turn Off Raspberry Pi Connect dropdown menu option."width="80%"]
24+
25+
CLI::
26+
+
27+
To turn on Connect, run the following command:
28+
+
529
[source,console]
630
----
731
$ rpi-connect on
832
----
9-
33+
+
34+
This turns the Connect service on, but doesn't sign you in.
35+
+
36+
To sign in, run the following command:
37+
+
38+
[source,console]
39+
----
40+
$ rpi-connect signin
41+
----
42+
+
1043
To stop Connect, run the following command:
11-
44+
+
1245
[source,console]
1346
----
1447
$ rpi-connect off
1548
----
49+
======

documentation/asciidoc/services/connect/introduction.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Raspberry Pi Connect provides secure access to your Raspberry Pi from anywhere i
44

55
image::images/hero.png[width="100%"]
66

7-
Connect is installed by default in Raspberry Pi OS Desktop and Raspberry Pi OS Full (desktop with recommended software). An alternate *Lite* variant of Connect, that only supports remote shell access with no ability to screen share, is installed by default in Raspberry Pi OS Lite.
7+
Connect is installed by default in Raspberry Pi OS Desktop and Raspberry Pi OS Full (desktop with recommended software). An alternate *Lite* variant of Connect, which supports only remote shell access with no ability to screen share, is installed by default in Raspberry Pi OS Lite.
88

99
To use Connect, xref:connect.adoc#link-connect[link your device with a Connect account]. Visit https://connect.raspberrypi.com[connect.raspberrypi.com] to access the desktop or a shell running on your Raspberry Pi in a browser window.
1010

documentation/asciidoc/services/connect/troubleshooting.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44

55
* Screen sharing only supports sharing a single, primary display of your Raspberry Pi. When a Raspberry Pi is connected to multiple HDMI screens, Connect sometimes shares the contents of the secondary screen. You can work around this by right-clicking the desktop and changing the location of the taskbar in **Desktop Preferences...**.
66

7-
* Connect does not support on-screen keyboards. For full functionality, use a physical keyboard.
8-
97
* Connect requires a browser that implements https://caniuse.com/?search=es2022[ECMAScript 2022] (ES13) as it makes use of features unavailable in older browsers.
108

119
* 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.

documentation/asciidoc/services/connect/use.adoc

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ Desktop::
1111
+
1212
From the Connect icon in the menu bar, select **Turn On Raspberry Pi Connect**. This opens your browser, where you're prompted to sign in with your Raspberry Pi ID:
1313
+
14-
image::images/browser-sign-in.png[width="80%"]
14+
image::images/browser-sign-in.png[alt="The Connect page with a prompt to sign in to Connect with your Raspberry Pi ID.",width="80%"]
1515
+
1616
If you've already turned on Connect, choose **Sign In...** from the dropdown menu:
1717
+
18-
image::images/sign-in.png[width="80%"]
18+
image::images/sign-in.png[alt="The Connect page, showing sign in selected from the Raspberry Pi Connect drop down menu.",width="80%"]
1919
+
2020
If you don't already have a Raspberry Pi ID, select the *create one for free* link to xref:id.adoc#create-a-raspberry-pi-id[create one].
2121
@@ -70,17 +70,17 @@ If you save your auth key to `+.config/com.raspberrypi.connect/auth.key+` in you
7070

7171
After authenticating, assign a name to your device. Choose a name that uniquely identifies the device.
7272

73-
image::images/new-device.png[width="80%"]
73+
image::images/new-device.png[alt="The Connect page inviting you to create a new device and sign in.",width="80%"]
7474

7575
If you're an administrator of an xref:connect.adoc#connect-organisations[organisation], select whether to add this device to your personal account or to a specific organisation.
7676

77-
image::images/new-organisation-device.png[width="80%"]
77+
image::images/new-organisation-device.png[alt="The Connect page, showing the new device account selection screen.",width="80%"]
7878

7979
Select the **Create device and sign in** button to continue.
8080

8181
You can now remotely connect to your device. The Connect icon in your menu bar turns blue to indicate that your device is signed in to the Connect service. You should receive an email notification indicating that a new device is linked to your Connect account.
8282

83-
image::images/sign-in-email.png[width="70%"]
83+
image::images/sign-in-email.png[alt="The Connect page, showing the account sign in notification screen.",width="70%"]
8484

8585
WARNING: If you receive an email that says a device that you don't recognise has signed into Connect, change your Raspberry Pi ID password immediately. Follow the instructions in xref:connect.adoc#manage-devices[Remove the device from Connect] to permanently disassociate it from your account. Consider xref:id.adoc#enable-two-factor-authentication[enabling two-factor authentication] to keep your account secure.
8686

@@ -98,13 +98,13 @@ Connect lists all your linked devices on the *Devices* tab. For organisations, y
9898

9999
Sign in to https://connect.raspberrypi.com[connect.raspberrypi.com] and go to the **Devices** tab. Connect displays a list of linked devices.
100100

101-
image::images/devices.png[width="80%"]
101+
image::images/devices.png[alt="The Connect page, showing the linked devices screen.",width="80%"]
102102

103103
(Connect for Organisations only) To search for a device by its name, enter text in the *Search* field. Connect matches results as you type.
104104

105105
(Connect for Organisations only) To filter your device list, select *Filter* and choose from the available filter options. You can filter your devices by the device model, the amount of memory it has, or the installed operating system.
106106

107-
image::images/filters.png[width="80%"]
107+
image::images/filters.png[alt="The Connect page, showing the linked device screen with filters applied.",width="80%"]
108108

109109
This feature is available only for devices running the client version 2.9.0 or later. To update Connect on your devices, see <<update>>.
110110

@@ -124,15 +124,15 @@ Sign in to https://connect.raspberrypi.com[connect.raspberrypi.com] and go to th
124124

125125
Devices available for screen sharing show a grey **Screen sharing** badge below the name of the device.
126126

127-
image::images/devices.png[width="80%"]
127+
image::images/devices.png[alt="The Connect page, showing devices listed as available for screen sharing.",width="80%"]
128128

129129
Select the **Connect via** button to the right of the device you want to access. Select the **Screen sharing** option from the menu. This opens a browser window that displays your device's desktop.
130130

131-
image::images/waiting-for-screen-sharing.png[width="80%"]
131+
image::images/waiting-for-screen-sharing.png[alt="A browser window open with a message indicating that a response is being awaited from the Raspberry Pi device.",width="80%"]
132132

133133
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.
134134

135-
image::images/screen-sharing.png[width="80%"]
135+
image::images/screen-sharing.png[alt="The Connect page, showing the Raspberry Pi dropdown menu.",width="80%"]
136136

137137
TIP: Use the **Copy from remote** and **Paste to remote** buttons above your desktop to transfer text between your local and remote clipboards.
138138

@@ -144,6 +144,21 @@ The Connect icon in the system tray rotates when a screen sharing session is in
144144

145145
image::images/screen-sharing-notification.png[width="80%"]
146146

147+
==== Screen sharing interface
148+
149+
Connect's screen sharing interface is designed for both desktop and mobile devices.
150+
151+
image::images/screen-sharing.png[alt="The Raspberry Pi Connect screen sharing interface includes shortcut keys at the bottom left of the browser window.", width="100%"]
152+
153+
You can simulate common keyboard functions using the buttons at the bottom left of the interface:
154+
155+
* Keyboard. Toggles the on-screen keyboard. Displayed only on mobile devices.
156+
* Ctrl. Simulates holding down this key on a physical keyboard.
157+
* Super key. Simulates holding down this key on a physical keyboard.
158+
* Alt. Simulates holding down this key on a physical keyboard.
159+
* Esc. Simulates a single press - pressing and then releasing - of this key.
160+
* Tab. Simulates a single press - pressing and then releasing - of this key.
161+
147162
==== Stop screen sharing
148163

149164
To close a screen sharing session, select the **Disconnect** button above your desktop.

0 commit comments

Comments
 (0)