Skip to content

Update docs for Raspberry Pi Connect 1.3.0 #3763

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 4, 2024
Merged

Update docs for Raspberry Pi Connect 1.3.0 #3763

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d012a24
Update logging instructions for Connect 1.3.0
mudge Jul 4, 2024
35ecedb
Put user-lingering instructions with remote shell
mudge Jul 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion documentation/asciidoc/services/connect/troubleshooting.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,9 +39,11 @@ Enter the following lines of configuration between the comments:
[source,bash]
----
ExecStart=
ExecStart=/usr/bin/rpi-connect-start -v
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:

[source,console]
Expand Down
22 changes: 11 additions & 11 deletions documentation/asciidoc/services/connect/use.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,17 @@ To re-enable screen sharing, do one of the following:
$ rpi-connect shell on
----

== Enable remote shell at all times

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:

[source,console]
----
$ loginctl enable-linger
----

TIP: We recommend enabling user-lingering on all headless Raspberry Pi OS Lite setups to prevent your device from becoming unreachable after a remote reboot.

== Manage devices

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.
Expand All @@ -203,17 +214,6 @@ image::images/device-details.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.

== Enable remote shell at all times

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:

[source,console]
----
$ loginctl enable-linger
----

TIP: We recommend enabling user-lingering on all headless Raspberry Pi OS Lite setups to prevent your device from becoming unreachable after a remote reboot.

== Update

To update to the latest version of Connect, run the following command:
Expand Down