You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Two new layers added to enable installation of Raspberry Pi Connect
(with or without screen-sharing), plus Auth key support. An
accompanying companion document provides additional information.
Whether or not the client starts at boot is controlled via a config
variable which defaults to on (since embedded/industrial deployments
will typically want Connect to start automatically at boot).
/* Reduce spacing for paragraphs inside admonitions */
66
+
.admonitionblockp {
67
+
margin:0.25em0;
68
+
}
69
+
70
+
.admonitionblockp:first-child {
71
+
margin-top:0;
72
+
}
73
+
74
+
.admonitionblockp:last-child {
75
+
margin-bottom:0;
76
+
}
77
+
78
+
/* Specific admonition types */
79
+
.admonitionblock.note {
80
+
border-color:#17a2b8;
81
+
background:#d1ecf1;
82
+
}
83
+
84
+
.admonitionblock.note .title {
85
+
color:#0c5460;
86
+
}
87
+
88
+
.admonitionblock.tip {
89
+
border-color:#28a745;
90
+
background:#d4edda;
91
+
}
92
+
93
+
.admonitionblock.tip .title {
94
+
color:#155724;
95
+
}
96
+
97
+
.admonitionblock.important {
98
+
border-color:#ffc107;
99
+
background:#fff3cd;
100
+
}
101
+
102
+
.admonitionblock.important .title {
103
+
color:#856404;
104
+
}
105
+
106
+
.admonitionblock.warning,
107
+
.admonitionblock.caution {
108
+
border-color:#dc3545;
109
+
background:#f8d7da;
110
+
}
111
+
112
+
.admonitionblock.warning .title,
113
+
.admonitionblock.caution .title {
114
+
color:#721c24;
115
+
}
116
+
</style>
117
+
</head>
118
+
<body>
119
+
<divclass="back-link">
120
+
<ahref="index.html">← Back to Layer Index</a>
121
+
</div>
122
+
123
+
<divclass="header">
124
+
<h1>rpi-connect-lite</h1>
125
+
<spanclass="badge">service</span>
126
+
<spanclass="badge">v1.0.0</span>
127
+
<p>Raspberry Pi Connect client with remote shell access</p>
128
+
</div>
129
+
130
+
131
+
<divclass="section">
132
+
<h2>Additional Documentation</h2>
133
+
<divclass="companion-content">
134
+
<divclass="sect1">
135
+
<h2id="_installation">Installation</h2>
136
+
<divclass="sectionbody">
137
+
<divclass="paragraph">
138
+
<p>Configuration variable <code>IGconf_connect_on</code> provided by this layer dictates whether Raspberry Pi Connect is enabled at system start up. This is equivalent to running <code>rpi-connect on</code> from the device command line.</p>
<p>To link your device to your Raspberry Pi Connect account automatically, generate an Auth key in your account Settings and set <code>IGconf_connect_authkey</code> to either:</p>
147
+
</div>
148
+
<divclass="ulist">
149
+
<ul>
150
+
<li>
151
+
<p>An absolute path to a file containing the key, or</p>
152
+
</li>
153
+
<li>
154
+
<p>The key value itself</p>
155
+
</li>
156
+
</ul>
157
+
</div>
158
+
<divclass="paragraph">
159
+
<p>Like other variables, <code>IGconf_connect_authkey</code> can be set on the command line or via the config system. For example:</p>
<p>This layer enables user lingering for <code>IGconf_device_user1</code> so that Connect runs even if the user is not logged in. See <ahref="https://www.freedesktop.org/software/systemd/man/latest/loginctl.html" target="_blank" rel="noopener">systemd loginctl</a>.</p>
185
+
</div>
186
+
</div>
187
+
</div>
188
+
<divclass="sect1">
189
+
<h2id="_suitability">Suitability</h2>
190
+
<divclass="sectionbody">
191
+
<divclass="paragraph">
192
+
<p>Choose the layer that matches your deployment and needs:</p>
193
+
</div>
194
+
<divclass="ulist">
195
+
<ul>
196
+
<li>
197
+
<p><strong>rpi-connect-lite</strong> (no screen-sharing support: remote shell only)</p>
198
+
<divclass="ulist">
199
+
<ul>
200
+
<li>
201
+
<p>Headless devices or systems without a Desktop</p>
<p>When Desktop screen sharing is not required</p>
211
+
</li>
212
+
</ul>
213
+
</div>
214
+
</li>
215
+
<li>
216
+
<p><strong>rpi-connect</strong> (supports screen-sharing and remote shell)</p>
217
+
<divclass="ulist">
218
+
<ul>
219
+
<li>
220
+
<p>Remote access to the Desktop is required</p>
221
+
</li>
222
+
<li>
223
+
<p>Need the full feature set and widest compatibility</p>
224
+
</li>
225
+
</ul>
226
+
</div>
227
+
</li>
228
+
</ul>
229
+
</div>
230
+
<divclass="paragraph">
231
+
<p>If unsure: use the full client on Desktop systems; use the lite client on headless devices.</p>
232
+
</div>
233
+
<divclass="paragraph">
234
+
<p>Please refer to the <ahref="https://www.raspberrypi.com/documentation/services/connect.html" target="_blank" rel="noopener">Raspberry Pi Connect documentation</a> for further details.</p>
0 commit comments