File: sharing-desktop.page

package info (click to toggle)
gnome-user-docs 48.2-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 142,176 kB
  • sloc: xml: 829; makefile: 532; sh: 514
file content (230 lines) | stat: -rw-r--r-- 8,276 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<page xmlns="http://projectmallard.org/1.0/"
      xmlns:ui="http://projectmallard.org/ui/1.0/"
      xmlns:its="http://www.w3.org/2005/11/its"
      type="topic" style="task" version="1.0 ui/1.0"
      id="sharing-desktop">

  <info>
    <link type="guide" xref="sharing"/>
    <link type="guide" xref="prefs-sharing"/>

    <revision pkgversion="3.33.3" date="2019-07-21" status="review"/>
    <revision version="gnome:42" status="final" date="2022-04-09"/>
    <revision version="gnome:46" status="final" date="2024-03-02"/>
    <revision version="gnome:46" status="draft" date="2024-04-21"/>
    <credit type="author">
      <name>Marie Stará</name>
      <email>413827@mail.muni.cz</email>
    </credit>
    <credit type="author">
      <name>Ekaterina Gerasimova</name>
      <email>kittykat3756@gmail.com</email>
    </credit>
    <credit type="editor">
      <name>Michael Hill</name>
      <email>mdhillca@gmail.com</email>
    </credit>
    <credit type="author">
      <name>Jim Campbell</name>
      <email>jcampbell@gnome.org</email>
    </credit>
    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>

    <desc>Let other people view and interact with your desktop using RDP.</desc>
  </info>

  <title>Share your desktop</title>

  <comment>
    <cite date="2022-07-27">Andre Klapper</cite>
    <p>GNOME 42 moved from VNC to RDP in https://gitlab.gnome.org/GNOME/gnome-control-center/-/merge_requests/1205</p>
    <p>TODO: See also https://gitlab.gnome.org/GNOME/gnome-user-docs/-/issues/135</p>
  </comment>
  <comment>
    <cite date="2022-04-09">Michael Hill</cite>
    <p>Referencing Pascal Nowack's comments on #135 (above) and the RDP setup
    guide, https://gitlab.gnome.org/-/snippets/1778, particularly his comment of
    2022-02-26.</p>
    <p>TODO: Add Connections, the GNOME client, to the Connecting: Linux
    section when it's ready for RDP.</p>
  </comment>
  <comment>
    <cite date="2024-04-22">Marie Stará</cite>
    <p>I've added Connections. It might need a reality check.</p>
  </comment>

  <p>You can let other people view and control your desktop from another
  device with a desktop viewing application. Configure <gui>Desktop Sharing
  </gui> to allow others to access your desktop and set the security
  preferences.</p>

  <p>If you want to log in to your user account remotely, see
  <link xref="remote-login">Remote Login</link>.</p>

  <steps>
    <item>
      <p>Open the <gui xref="shell-introduction#activities">Activities</gui>
      overview and start typing <gui>System</gui>.</p>
    </item>
    <item>
      <p>Select <guiseq><gui>Settings</gui><gui>System</gui></guiseq> from the
      results. This will open the <gui>System</gui> panel.</p>
    </item>
    <item>
      <p>Select <gui>Remote Desktop</gui> to open the
      <gui>Desktop Sharing</gui> panel.</p>
    </item>
    <item>
      <p>To let others view your desktop, switch on <gui>Desktop Sharing</gui>.
      This means that others will be able to try and connect to your device and view
      your screen.</p>
    </item>
    <item>
      <p>To let others interact with your desktop switch on <gui>Remote Control</gui>.
      This may allow the other person to move your cursor, run applications, and
      browse your files, depending on the security settings which you are currently
      using.</p>
    </item>
  </steps>

  <section id="connecting">
  <title>Connecting</title>

  <p>The <gui>How to Connect</gui> section displays the
  <gui>Hostname</gui> and <gui>Port</gui> that can be used
  on the connecting device. Click the button next to each entry if you want to
  place it in the clipboard. A connection can also be established using your
  <link xref="net-findip">IP address</link>.</p>

  <note style="important">
    <p>If you also enable <link xref="remote-login">Remote Login</link>, it will set its port
    number to 3389. This means <gui>Desktop Sharing</gui> will use a different port, for
    example, 3390.</p>
    <p>If the port number is not 3389, specify it when connecting.</p>
  </note>


  <p>When the other device is successfully connected to your desktop, you
  will see the <gui>Screen is being shared</gui> icon
  <media its:translate="no" type="image" src="figures/topbar-screen-shared.svg" style="floatend"/> in your system status area.</p>

  <note style="info"><p>If the text set as <gui>Device Name</gui> can be edited,
  you can <link xref="about-hostname">change</link>
  the name of your device on the network.</p></note>

  </section>

  <section id="authentication">
  <title>Authentication</title>

  <p>The <gui>Login Details</gui> section displays the user name and password to be used in the
  client software used for connecting to your desktop.</p>

  <note style="tip">
    <p>Click <gui>Verify Encryption</gui> to display the encryption
    fingerprint. Compare it with the value displayed by the client when
    connecting: they should be identical.</p>
  </note>
  </section>

  <section id="clients">
  <title>Clients</title>

  <p>To connect to your desktop from another device, the following clients are
  known to work.</p>
  <terms>
    <item>
      <title>From Linux:</title>
      <list>
        <item><p><app>Remmina</app>, a GTK client, is available as a package in
        most distributions, and also as a
        <link href="https://flathub.org/apps/details/org.remmina.Remmina">flatpak</link>.
        Use default settings, particularly <gui>Color depth</gui> “Automatic”
        in the connection profile settings.</p>
        </item>
        <item><p><app>Connections</app>, a GTK client, is available as a package
        in most distributions, and also as a <link href="https://flathub.org/apps/org.gnome.Connections">flatpak</link>.</p>
        </item>
        <item><p><app>xfreerdp</app> is a command line client available as a
        package in most distributions. The option <cmd>/network:auto</cmd>
        should be passed to the client on the command line.</p>
        </item>
      </list>
    </item>
    <item>
      <title>From Microsoft Windows:</title>
      <list>
        <item><p><app>mstsc</app> is the built-in Windows client. Default
        settings are recommended.</p>
        </item>
      </list>
    </item>
    <item>
      <title>From Linux, Windows, or macOS:</title>
      <list>
        <item><p><app>Thincast</app> is a proprietary client. The Linux version
        is available as a <link href="https://flathub.org/apps/details/com.thincast.client">flatpak</link>.
        Default settings are recommended.</p>
        </item>
      </list>
    </item>
  </terms>
  </section>

  <section id="checking-connection">
  <title>Checking connection</title>
  <steps>
    <item>
      <p>In your chosen client, enter the <gui>Hostname</gui> or IP address.</p>
     <note style="tip">
      <p>If the port number differs from 3389, specify it (address:port).</p>
      <p>On many networks you need to add a “.local” suffix to the computer's name
      for the connection to work.</p>
    </note>
    </item>
    <item>
      <p>Fill in the user name and password for Desktop Sharing.</p>
    </item>
  </steps>
  </section>

  <section id="disconnect">
  <title>Stop sharing your desktop</title>

  <p>To disconnect someone who is viewing your desktop, follow the steps below.</p>

  <steps>
    <item>
      <p>Click the system menu on the right side of the top bar.</p>
    </item>
    <item>
      <p>Click <gui>Screen is being shared</gui>.</p>
    </item>
    <item>
      <p>Click <gui>Turn off</gui>.</p>
    </item>
  </steps>

  </section>

  <section id="advanced" ui:expanded="false">
  <title>Advanced Topics</title>

  <terms>
    <item>
      <title>Command line configuration</title>
      <p>The <cmd>grdctl</cmd> utility allows you to configure your host
      settings in a console window. For usage details, type
      <cmd>grdctl --help</cmd>.</p>
    </item>
    <item>
      <title>H.264</title>
      <p>H.264 video encoding heavily reduces bandwidth.
      <app>GNOME Remote Desktop</app> will use H.264 when: the graphics pipeline
      is used (a requirement of the protocol), the client supports it, and
      NVENC (NVIDIA's encoder) is available.</p>
    </item>
  </terms>
  </section>

</page>