diff --git a/documentation/asciidoc/services/connect/images/browser-sign-in.png b/documentation/asciidoc/services/connect/images/browser-sign-in.png new file mode 100644 index 0000000000..87c50da7e8 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/browser-sign-in.png differ diff --git a/documentation/asciidoc/services/connect/images/create-device.png b/documentation/asciidoc/services/connect/images/create-device.png deleted file mode 100755 index f6d9a2a71c..0000000000 Binary files a/documentation/asciidoc/services/connect/images/create-device.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/device-details.png b/documentation/asciidoc/services/connect/images/device-details.png deleted file mode 100644 index 809a3539f1..0000000000 Binary files a/documentation/asciidoc/services/connect/images/device-details.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/device.png b/documentation/asciidoc/services/connect/images/device.png new file mode 100644 index 0000000000..0e4e6bbd21 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/device.png differ diff --git a/documentation/asciidoc/services/connect/images/devices.png b/documentation/asciidoc/services/connect/images/devices.png new file mode 100644 index 0000000000..73b5859ac7 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/devices.png differ diff --git a/documentation/asciidoc/services/connect/images/disallow-remote-shell.png b/documentation/asciidoc/services/connect/images/disallow-remote-shell.png new file mode 100644 index 0000000000..348d0ac0fd Binary files /dev/null and b/documentation/asciidoc/services/connect/images/disallow-remote-shell.png differ diff --git a/documentation/asciidoc/services/connect/images/disallow-screen-sharing.png b/documentation/asciidoc/services/connect/images/disallow-screen-sharing.png new file mode 100644 index 0000000000..52d4d17aae Binary files /dev/null and b/documentation/asciidoc/services/connect/images/disallow-screen-sharing.png differ diff --git a/documentation/asciidoc/services/connect/images/hero.png b/documentation/asciidoc/services/connect/images/hero.png index f26372ed5c..5f13e18a2a 100644 Binary files a/documentation/asciidoc/services/connect/images/hero.png and b/documentation/asciidoc/services/connect/images/hero.png differ diff --git a/documentation/asciidoc/services/connect/images/just_installed.png b/documentation/asciidoc/services/connect/images/just_installed.png deleted file mode 100644 index b45d997b39..0000000000 Binary files a/documentation/asciidoc/services/connect/images/just_installed.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/list-of-devices.png b/documentation/asciidoc/services/connect/images/list-of-devices.png deleted file mode 100644 index 17663d2406..0000000000 Binary files a/documentation/asciidoc/services/connect/images/list-of-devices.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/login-with-id-2.png b/documentation/asciidoc/services/connect/images/login-with-id-2.png deleted file mode 100755 index dd0a6deca2..0000000000 Binary files a/documentation/asciidoc/services/connect/images/login-with-id-2.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/login-with-id.png b/documentation/asciidoc/services/connect/images/login-with-id.png deleted file mode 100755 index 0ed21408c8..0000000000 Binary files a/documentation/asciidoc/services/connect/images/login-with-id.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/new-device.png b/documentation/asciidoc/services/connect/images/new-device.png new file mode 100644 index 0000000000..8753ada4f1 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/new-device.png differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-active.png b/documentation/asciidoc/services/connect/images/remote-shell-active.png deleted file mode 100644 index d51fb75104..0000000000 Binary files a/documentation/asciidoc/services/connect/images/remote-shell-active.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-connected.png b/documentation/asciidoc/services/connect/images/remote-shell-connected.png deleted file mode 100755 index 4bc7c01d46..0000000000 Binary files a/documentation/asciidoc/services/connect/images/remote-shell-connected.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-connecting.png b/documentation/asciidoc/services/connect/images/remote-shell-connecting.png deleted file mode 100644 index b23ceb6119..0000000000 Binary files a/documentation/asciidoc/services/connect/images/remote-shell-connecting.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-disabled-desktop.png b/documentation/asciidoc/services/connect/images/remote-shell-disabled-desktop.png deleted file mode 100644 index 90055b800a..0000000000 Binary files a/documentation/asciidoc/services/connect/images/remote-shell-disabled-desktop.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-disabled.png b/documentation/asciidoc/services/connect/images/remote-shell-disabled.png index d68049c9c8..991c1e295f 100644 Binary files a/documentation/asciidoc/services/connect/images/remote-shell-disabled.png and b/documentation/asciidoc/services/connect/images/remote-shell-disabled.png differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-end.png b/documentation/asciidoc/services/connect/images/remote-shell-end.png deleted file mode 100644 index 834f0b8282..0000000000 Binary files a/documentation/asciidoc/services/connect/images/remote-shell-end.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-ended.png b/documentation/asciidoc/services/connect/images/remote-shell-ended.png new file mode 100644 index 0000000000..0f4ce1f433 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/remote-shell-ended.png differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-in-progress.png b/documentation/asciidoc/services/connect/images/remote-shell-in-progress.png new file mode 100644 index 0000000000..b6eaaeceb3 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/remote-shell-in-progress.png differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-notification.png b/documentation/asciidoc/services/connect/images/remote-shell-notification.png new file mode 100644 index 0000000000..2bb47d88fa Binary files /dev/null and b/documentation/asciidoc/services/connect/images/remote-shell-notification.png differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell-start.png b/documentation/asciidoc/services/connect/images/remote-shell-start.png deleted file mode 100644 index 56212bc7ad..0000000000 Binary files a/documentation/asciidoc/services/connect/images/remote-shell-start.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/remote-shell.png b/documentation/asciidoc/services/connect/images/remote-shell.png new file mode 100644 index 0000000000..398165e17f Binary files /dev/null and b/documentation/asciidoc/services/connect/images/remote-shell.png differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-active.png b/documentation/asciidoc/services/connect/images/screen-sharing-active.png deleted file mode 100644 index 4b26a56267..0000000000 Binary files a/documentation/asciidoc/services/connect/images/screen-sharing-active.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-connected.png b/documentation/asciidoc/services/connect/images/screen-sharing-connected.png deleted file mode 100755 index 124f81ded9..0000000000 Binary files a/documentation/asciidoc/services/connect/images/screen-sharing-connected.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-connecting.png b/documentation/asciidoc/services/connect/images/screen-sharing-connecting.png deleted file mode 100644 index 0462b3b10f..0000000000 Binary files a/documentation/asciidoc/services/connect/images/screen-sharing-connecting.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-disabled-desktop.png b/documentation/asciidoc/services/connect/images/screen-sharing-disabled-desktop.png deleted file mode 100644 index 7403cf9288..0000000000 Binary files a/documentation/asciidoc/services/connect/images/screen-sharing-disabled-desktop.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-disabled.png b/documentation/asciidoc/services/connect/images/screen-sharing-disabled.png index b52d7fd5b1..f5a3d7d03c 100644 Binary files a/documentation/asciidoc/services/connect/images/screen-sharing-disabled.png and b/documentation/asciidoc/services/connect/images/screen-sharing-disabled.png differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-end.png b/documentation/asciidoc/services/connect/images/screen-sharing-end.png deleted file mode 100644 index d39e994a07..0000000000 Binary files a/documentation/asciidoc/services/connect/images/screen-sharing-end.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-ended.png b/documentation/asciidoc/services/connect/images/screen-sharing-ended.png new file mode 100644 index 0000000000..58c4190a51 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/screen-sharing-ended.png differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-in-progress.png b/documentation/asciidoc/services/connect/images/screen-sharing-in-progress.png new file mode 100644 index 0000000000..2c3398f9a7 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/screen-sharing-in-progress.png differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-notification.png b/documentation/asciidoc/services/connect/images/screen-sharing-notification.png new file mode 100644 index 0000000000..439d437483 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/screen-sharing-notification.png differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing-start.png b/documentation/asciidoc/services/connect/images/screen-sharing-start.png deleted file mode 100644 index febe603eb4..0000000000 Binary files a/documentation/asciidoc/services/connect/images/screen-sharing-start.png and /dev/null differ diff --git a/documentation/asciidoc/services/connect/images/screen-sharing.png b/documentation/asciidoc/services/connect/images/screen-sharing.png new file mode 100644 index 0000000000..94fc1e871e Binary files /dev/null and b/documentation/asciidoc/services/connect/images/screen-sharing.png differ diff --git a/documentation/asciidoc/services/connect/images/sign-in-email.png b/documentation/asciidoc/services/connect/images/sign-in-email.png index f04a55d008..0ed30d7fc5 100644 Binary files a/documentation/asciidoc/services/connect/images/sign-in-email.png and b/documentation/asciidoc/services/connect/images/sign-in-email.png differ diff --git a/documentation/asciidoc/services/connect/images/sign-in.png b/documentation/asciidoc/services/connect/images/sign-in.png index 897a08b277..7b66320e9a 100644 Binary files a/documentation/asciidoc/services/connect/images/sign-in.png and b/documentation/asciidoc/services/connect/images/sign-in.png differ diff --git a/documentation/asciidoc/services/connect/images/turn-on-connect.png b/documentation/asciidoc/services/connect/images/turn-on-connect.png new file mode 100644 index 0000000000..96c749c795 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/turn-on-connect.png differ diff --git a/documentation/asciidoc/services/connect/images/waiting-for-remote-shell.png b/documentation/asciidoc/services/connect/images/waiting-for-remote-shell.png new file mode 100644 index 0000000000..0197088f11 Binary files /dev/null and b/documentation/asciidoc/services/connect/images/waiting-for-remote-shell.png differ diff --git a/documentation/asciidoc/services/connect/images/waiting-for-screen-sharing.png b/documentation/asciidoc/services/connect/images/waiting-for-screen-sharing.png new file mode 100644 index 0000000000..87ba5fcecc Binary files /dev/null and b/documentation/asciidoc/services/connect/images/waiting-for-screen-sharing.png differ diff --git a/documentation/asciidoc/services/connect/install.adoc b/documentation/asciidoc/services/connect/install.adoc index d090452979..7c8224c220 100644 --- a/documentation/asciidoc/services/connect/install.adoc +++ b/documentation/asciidoc/services/connect/install.adoc @@ -1,7 +1,7 @@ [[install-connect]] == Install -To begin installation, open a Terminal window. Run the following command to update your system and packages: +If Connect isn't already installed in your version of Raspberry Pi OS, open a Terminal window. Run the following command to update your system and packages: [source,console] ---- @@ -16,14 +16,18 @@ Run the following command on your Raspberry Pi to install Connect: $ sudo apt install rpi-connect ---- -After installation, reboot your Raspberry Pi or xref:connect.adoc#manually-start-connect[manually start the Connect service] to use Connect: +You can also install Connect from the Recommended Software application. + +After installation, use the `rpi-connect` command line interface to start Connect for your current user: [source,console] ---- -$ sudo reboot +$ rpi-connect on ---- -Connect will automatically start the next time you log in to your Raspberry Pi. +Alternatively, click the Connect icon in the menu bar to open a dropdown menu and select *Turn On Raspberry Pi Connect*: + +image::images/turn-on-connect.png[width="80%"] === Connect Lite @@ -36,19 +40,29 @@ Run the following command on your Raspberry Pi to install Connect Lite: $ sudo apt install rpi-connect-lite ---- -Reboot your Raspberry Pi or xref:connect.adoc#manually-start-connect[manually start the Connect service] to use Connect. +After installation, use the `rpi-connect` command line interface to start Connect for your current user: + +[source,console] +---- +$ rpi-connect on +---- -Consider xref:connect.adoc#enable-remote-shell-at-all-times[enabling user lingering] to make your device accessible even when your user account isn't logged in. +xref:connect.adoc#enable-remote-shell-at-all-times[Enable user-lingering] to make your device accessible even when your user account isn't logged in. TIP: Lite commands use the same `rpi-connect` name as the full version of Connect. `rpi-connect-lite` is just a package name. -=== Manually start Connect +=== Manually start and stop Connect + +To start Connect from the command line, run the following command: -NOTE: By default, Connect automatically starts at login. You don't need to manually start Connect after it starts for the first time unless you remove it from your login items. +[source,console] +---- +$ rpi-connect on +---- -To start the service manually from the command line, run the following command: +To stop Connect, run the following command: [source,console] ---- -$ systemctl --user start rpi-connect +$ rpi-connect off ---- diff --git a/documentation/asciidoc/services/connect/introduction.adoc b/documentation/asciidoc/services/connect/introduction.adoc index 0c75e4e123..56db23adc2 100644 --- a/documentation/asciidoc/services/connect/introduction.adoc +++ b/documentation/asciidoc/services/connect/introduction.adoc @@ -4,7 +4,7 @@ Raspberry Pi Connect provides secure access to your Raspberry Pi from anywhere i image::images/hero.png[width="100%"] -To use Connect, xref:connect.adoc#install-connect[install the Connect software] on your Raspberry Pi. Then visit https://connect.raspberrypi.com[connect.raspberrypi.com] to access the desktop or a shell running on your Raspberry Pi in a browser window. +To use Connect, xref:connect.adoc#install-connect[install the Connect software] and xref:connect.adoc#link-connect[link your device with an account] on your Raspberry Pi. Then visit https://connect.raspberrypi.com[connect.raspberrypi.com] to access the desktop or a shell running on your Raspberry Pi in a browser window. Connect uses a secure, encrypted connection. By default, Connect communicates directly between your Raspberry Pi and your browser. However, when Connect can't establish a direct connection between your Raspberry Pi and your browser, we use a relay server. In such cases, Raspberry Pi only retains the metadata required to operate Connect. diff --git a/documentation/asciidoc/services/connect/troubleshooting.adoc b/documentation/asciidoc/services/connect/troubleshooting.adoc index 2a3398befe..78334e9e45 100644 --- a/documentation/asciidoc/services/connect/troubleshooting.adoc +++ b/documentation/asciidoc/services/connect/troubleshooting.adoc @@ -10,6 +10,63 @@ * 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. +* 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: ++ +[source,console] +---- +$ sudo apt install --only-upgrade rpi-connect +---- ++ +Alternatively, if you currently have `rpi-connect-lite` installed, run the following command: ++ +[source,console] +---- +$ sudo apt install --only-upgrade rpi-connect-lite +---- ++ +You should see output similar to the following during the upgrade, indicating that Connect's services have migrated to the version 2 format: ++ +[source,console] +---- +Replacing globally-enabled rpi-connect services with user-enabled ones... +---- + +=== Common issues + +==== Screen sharing not available + +If Connect states that screen sharing is unavailable, it cannot connect to the dedicated Connect WayVNC service. + +To find out more about the cause of the issue, run the following commands to check the status of the Connect WayVNC service: + +[source,console] +---- +$ systemctl --user status rpi-connect-wayvnc.service +$ journalctl --user --follow --unit rpi-connect-wayvnc.service +---- + +If the service fails to start or doesn't exist, ensure that your environment meets the following criteria: + +. You use `rpi-connect` version 1.1.0 or later. +. You do not use `rpi-connect-lite`, which lacks screen sharing support. +. You use a Wayland compositor such as wayfire or labwc, not X. You can control this setting via ``raspi-config``'s Advanced Options. +. 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. +. 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. + +==== Can't connect after restarting or ending SSH session + +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. + +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. + +==== Networking and firewall issues + +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: + +. 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. +. 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. +. 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. + === View Connect status To view the current status of the Connect service, run the following command: @@ -19,19 +76,29 @@ To view the current status of the Connect service, run the following command: $ rpi-connect status ---- +You should see output similar to the following: + +---- +Signed in: yes +Screen sharing: allowed (0 sessions active) +Remote shell: allowed (0 sessions active) +---- + 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. +If you see output including "Raspberry Pi Connect is not running, run rpi-connect on", run `rpi-connect on` to start Connect. + === Enable enhanced logging You can enable debug logging for both `rpi-connect` and its dedicated WayVNC server for a detailed account of local operations on your Raspberry Pi. ==== Enable enhanced logging in `rpi-connect` -Open the `rpi-connect` configuration file for editing with the following command: +Override the `rpi-connect` service definition with the following command: [source,console] ---- -$ systemctl --user edit rpi-connect +$ systemctl --user edit rpi-connect.service ---- Enter the following lines of configuration between the comments: @@ -45,23 +112,23 @@ ExecStart=/usr/bin/rpi-connectd -socket %t/rpi-connect-wayvnc.sock -v NOTE: You need **both** lines that begin with `ExecStart=`. -Finally, restart the service with the following command: +Finally, restart Connect with the following command: [source,console] ---- -$ systemctl --user restart rpi-connect +$ rpi-connect restart ---- ==== Enable enhanced logging in the dedicated `wayvnc` server -Open the configuration file for the dedicated WayVNC server associated with Connect: +Override the `rpi-connect-wayvnc` service definition with the following command: [source,console] ---- $ systemctl --user edit rpi-connect-wayvnc ---- -Enter the following lines of configuration between the comments: +Enter the following lines of configuration between the comments (including the `-Ldebug` flag): [source,bash] ---- @@ -72,11 +139,11 @@ ExecStart=/usr/bin/rpi-connect-env /usr/bin/wayvnc --config /etc/rpi-connect/way NOTE: You need **both** lines that begin with `ExecStart=`. -Finally, restart the service with the following command: +Finally, restart Connect with the following command: [source,console] ---- -$ systemctl --user restart rpi-connect-wayvnc +$ rpi-connect restart ---- === View Connect logs @@ -85,5 +152,5 @@ To view logs for the Connect service and its dedicated WayVNC server, run the fo [source,console] ---- -$ journalctl --user --follow --unit rpi-connect --unit rpi-connect-wayvnc +$ journalctl --user --follow --unit rpi-connect.service --unit rpi-connect-wayvnc.service ---- diff --git a/documentation/asciidoc/services/connect/use.adoc b/documentation/asciidoc/services/connect/use.adoc index 207afe6f3c..3c7ad302ce 100644 --- a/documentation/asciidoc/services/connect/use.adoc +++ b/documentation/asciidoc/services/connect/use.adoc @@ -1,27 +1,19 @@ +[[link-connect]] == Link a Raspberry Pi device with a Connect account -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. - -If you do not have a Connect account: - -. xref:id.adoc#create-a-raspberry-pi-id[Create a Raspberry Pi ID]. -. Visit https://connect.raspberrypi.com[connect.raspberrypi.com] and create a Connect account using your Raspberry Pi ID. - -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. - -To generate the verification URL, use the Connect icon on the Raspberry Pi Desktop or the `rpi-connect` CLI. Follow the instructions below: +Now that you've installed and started Connect on your Raspberry Pi device, you must associate your device with your Connect account. === via the Raspberry Pi Desktop -Once the `rpi-connect` service starts running, the Connect icon appears in the system tray. +If you're using the Connect plugin for the menu bar, clicking "Turn On Raspberry Pi Connect" for the first time will open your browser, prompting you to sign in with your Raspberry Pi ID: -image::images/just_installed.png[width="80%"] +image::images/browser-sign-in.png[width="80%"] -Click on the Connect icon and choose "Sign in" from the drop-down menu. +Alternatively, you can choose "Sign In..." from the dropdown menu: image::images/sign-in.png[width="80%"] -This opens a verification URL you can use to link your device to your Connect account. +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]. === via the command line @@ -42,23 +34,17 @@ Visit the verification URL on any device and sign in with your Raspberry Pi ID t === Finish linking your Raspberry Pi -Visit the verification URL generated in the previous step. - -Sign in to Connect using your xref:id.adoc[Raspberry Pi ID]. - -image::images/login-with-id.png[width="80%"] - 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. -image::images/create-device.png[width="80%"] +image::images/new-device.png[width="80%"] -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. +You can now remotely connect to your device. The Connect icon in your menu bar 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. image::images/sign-in-email.png[width="70%"] WARNING: If you receive an email that says a device that you do not recognise has signed into Connect, change your Raspberry Pi ID password immediately. 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. -Click the Connect system tray icon to open the Connect menu. This menu shows your current sign in status, an option to sign out, and options to enable or disable remote access methods. +Click the Connect icon in your menu bar to open the Connect menu. This menu allows you to turn Connect on and off, sign in and out, and allow or disallow remote access methods. TIP: Connect signs communication with your device serial number. Moving your SD card between devices will sign you out of Connect. @@ -76,39 +62,39 @@ Visit https://connect.raspberrypi.com[connect.raspberrypi.com] on any computer. 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 screen sharing show a grey **Screen sharing** badge below the name of the device. -image::images/list-of-devices.png[width="80%"] +image::images/devices.png[width="80%"] 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. -image::images/screen-sharing-connecting.png[width="80%"] +image::images/waiting-for-screen-sharing.png[width="80%"] 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. -image::images/screen-sharing-start.png[width="80%"] +image::images/screen-sharing.png[width="80%"] TIP: Use the **Copy from remote** and **Paste to remote** buttons above your desktop to transfer text between your local and remote clipboards. Once connected, a green dot appears next to the **Screen sharing** badge in the Connect dashboard. This indicates an active screen sharing session. Hover to see the current number of screen sharing sessions. -image::images/screen-sharing-active.png[width="80%"] +image::images/screen-sharing-in-progress.png[width="80%"] -The Connect icon in the system tray turns purple and displays a closed circle when a screen sharing session is in progress. +The Connect icon in the system tray turns purple and displays a closed circle when a screen sharing session is in progress. A desktop notification will appear whenever a screen sharing session starts. -image::images/screen-sharing-connected.png[width="80%"] +image::images/screen-sharing-notification.png[width="80%"] ==== Stop screen sharing To close a screen sharing session, click the **Disconnect** button above your desktop. -image::images/screen-sharing-end.png[width="80%"] +image::images/screen-sharing-ended.png[width="80%"] -==== Disable screen sharing +==== Disallow screen sharing -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. +To turn off screen sharing, click the Connect icon in the menu bar 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. -image::images/screen-sharing-disabled-desktop.png[width="80%"] +image::images/disallow-screen-sharing.png[width="80%"] -Alternatively, you can disable screen sharing with the following command: +Alternatively, you can disallow screen sharing with the following command: [source,console] ---- @@ -121,7 +107,7 @@ image::images/screen-sharing-disabled.png[width="80%"] To re-enable screen sharing, do one of the following: -* click the Connect system tray icon and select **Allow screen sharing** +* click the Connect icon in the menu bar and select **Allow Screen Sharing** * run the following command: + [source,console] @@ -131,33 +117,33 @@ $ rpi-connect vnc on === Remote shell -Connect includes the ability to access a shell running on your device from a browser. Use the following instructions to access the remote shell. +Connect includes the ability to start a shell running on your device from a browser. Use the following instructions to access the remote shell. Visit https://connect.raspberrypi.com[connect.raspberrypi.com] on any computer. 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. -image::images/list-of-devices.png[width="80%"] +image::images/devices.png[width="80%"] 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. -image::images/remote-shell-connecting.png[width="80%"] +image::images/waiting-for-remote-shell.png[width="80%"] You can now use your device as you would locally. -image::images/remote-shell-start.png[width="80%"] +image::images/remote-shell.png[width="80%"] TIP: On some operating systems, the browser intercepts key combinations like **Ctrl+Shift+C** and **Ctrl+C**. Instead, you can use the right click menu or **Ctrl+Insert** to copy and **Shift+Insert** to paste. Once connected, a green dot appears next to the **Remote shell** badge in the Connect dashboard. This indicates an active remote shell session. Hover to see the current number of remote shell sessions. -image::images/remote-shell-active.png[width="80%"] +image::images/remote-shell-in-progress.png[width="80%"] TIP: Every remote shell connection creates a brand new connection, just like SSH. To persist background commands and configuration across multiple sessions, use `screen` or `tmux`. -The Connect icon in the system tray turns purple and displays a closed circle when a remote shell session is in progress. +The Connect icon in the menu bar turns purple and displays a closed circle when a remote shell session is in progress. A desktop notification will appear whenever a remote shell session starts. -image::images/remote-shell-connected.png[width="80%"] +image::images/remote-shell-notification.png[width="80%"] TIP: The `CONNECT_TTY` environment variable indicates that a session uses a remote shell provided by Connect. @@ -165,15 +151,15 @@ TIP: The `CONNECT_TTY` environment variable indicates that a session uses a remo To close a remote shell session, run the `exit` command or close the window. -image::images/remote-shell-end.png[width="80%"] +image::images/remote-shell-ended.png[width="80%"] -==== Disable remote shell access +==== Disallow remote shell access -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. +To turn off remote shell access, click the Connect icon in the menu bar and unselect **Allow Remote Shell Access**. Your device remains signed into Connect, but you won't be able to create a remote shell session from the Connect dashboard. -image::images/remote-shell-disabled-desktop.png[width="80%"] +image::images/disallow-remote-shell.png[width="80%"] -Alternatively, you can disable remote shell access with the following command: +Alternatively, you can disallow remote shell access with the following command: [source,console] ---- @@ -186,7 +172,7 @@ image::images/remote-shell-disabled.png[width="80%"] To re-enable remote shell access, do one of the following: -* click the Connect system tray icon and select **Allow remote shell** +* click the Connect system tray icon and select **Allow Remote Shell Access** * run the following command: + [source,console] @@ -209,13 +195,13 @@ TIP: We recommend enabling user-lingering on all headless Raspberry Pi OS Lite s The Connect dashboard lists all of the devices linked with your Connect account and shows you the various ways you can access them. -image::images/list-of-devices.png[width="80%"] +image::images/devices.png[width="80%"] Click on a device name to open the device details page. This screen provides low-level information about your device. You can also edit the device name or remove the device from Connect. -image::images/device-details.png[width="80%"] +image::images/device.png[width="80%"] -Deleting a device from Connect automatically signs you out of Connect on the device. The Connect system tray icon turns grey and the menu only provides a **Sign in** option. +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. == Update @@ -227,12 +213,7 @@ $ sudo apt update $ sudo apt install --only-upgrade rpi-connect ---- -Reboot your device to put your update into effect: - -[source, console] ----- -$ sudo reboot ----- +TIP: If you installed Connect Lite, replace `rpi-connect` with `rpi-connect-lite` in the above command. == Disconnect a device from Connect @@ -243,11 +224,13 @@ Run the following command on your device to sign out of your Raspberry Pi ID, wh $ rpi-connect signout ---- +Alternatively, click the Connect icon in the menu bar and click "Sign Out". + TIP: To fully remove a device from your Connect account, xref:connect.adoc#manage-devices[remove it from the Connect dashboard]. == Uninstall -Run the following command to remove Connect software from a device: +Run the following command to stop and remove Connect from a device: [source,console] ---- diff --git a/documentation/images/Connect-SMALL.png b/documentation/images/Connect-SMALL.png deleted file mode 100644 index e22abf2aff..0000000000 Binary files a/documentation/images/Connect-SMALL.png and /dev/null differ diff --git a/documentation/images/full-sized/Connect.png b/documentation/images/full-sized/Connect.png deleted file mode 100755 index 98fc955d50..0000000000 Binary files a/documentation/images/full-sized/Connect.png and /dev/null differ