-
Notifications
You must be signed in to change notification settings - Fork 227
/
Copy pathcockpit-desktop.1.html
103 lines (103 loc) · 5.08 KB
/
cockpit-desktop.1.html
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
---
layout: guide
---
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>cockpit-desktop</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Cockpit Guide">
<link rel="up" href="cockpit-manual.html" title="Manual pages">
<link rel="prev" href="cockpit-tls.8.html" title="cockpit-tls">
<link rel="next" href="cockpit-bridge.1.html" title="cockpit-bridge">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="cockpit-tls.8.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="cockpit-manual.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Cockpit Guide</th>
<td><a accesskey="n" href="cockpit-bridge.1.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="cockpit-desktop.1"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">cockpit-desktop</span></h2>
<p>cockpit-desktop — Cockpit Desktop integration</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<div class="cmdsynopsis"><p><code class="command">cockpit-desktop</code> {URLPATH} [SSH_HOST]</p></div>
</div>
<div class="refsect1">
<a name="cockpit-desktop-description"></a><h2>DESCRIPTION</h2>
<p>
The <span class="command"><strong>cockpit-desktop</strong></span> program provides secure access to
Cockpit pages in an already running desktop session. It starts a web server
(<span class="command"><strong>cockpit-ws</strong></span>) and a web browser in an isolated network
namespace, and a
<span class="citerefentry"><span class="refentrytitle">cockpit-bridge</span>(8)</span>
in the running user session.
</p>
<p>
This avoids having to log into Cockpit, and having to enable
<code class="filename">cockpit.socket</code> system-wide. The network isolation
ensures that no other user, and not even other processes in the user's
session, can access this local web server.
</p>
<p>
<code class="literal">URLPATH</code> is the Cockpit page to open, i. e. the path
component of Cockpit URLs. It is highly recommended to only open a
<a class="ulink" href="https://cockpit-project.org/guide/latest/embedding.html" target="_top">particular page frame</a>,
not the entire Cockpit navigation and menu. For example, the path
<code class="literal">/cockpit/@localhost/storage/index.html</code> will open the Storage
page. It is also possible to give abbreviated forms of urls, such as "<code class="literal">storage</code>"
or "<code class="literal">network/firewall</code>".
</p>
<p>
<code class="literal">SSH_HOST</code> is an optional SSH remote host specification
(<code class="code">hostname</code> or <code class="code">username@hostname</code>). If given,
<code class="literal">cockpit-bridge</code> will be started on the remote host through
<span class="citerefentry"><span class="refentrytitle">ssh</span>(1)</span>
instead, i. e. the Cockpit web browser will show that remote host.
Note that this is more of an experimental/demo feature.
</p>
</div>
<div class="refsect1">
<a name="cockpit-desktop-environment"></a><h2>ENVIRONMENT</h2>
<p>
The <code class="literal">BROWSER </code> environment variable specifies
the browser command (and possibly options) that will be used to open the
requested Cockpit page. If not set, <span class="command"><strong>cockpit-desktop</strong></span> attempts to use
an internal minimalistic WebKit browser, and failing that, will attempt to detect some
reasonable alternatives.
</p>
</div>
<div class="refsect1">
<a name="cockpit-desktop-bugs"></a><h2>BUGS</h2>
<p>
Please send bug reports to either the distribution bug tracker or the
<a class="ulink" href="https://github.com/cockpit-project/cockpit/issues/new" target="_top">upstream bug tracker</a>.
</p>
</div>
<div class="refsect1">
<a name="cockpit-desktop-author"></a><h2>AUTHOR</h2>
<p>Cockpit has been written by many
<a class="ulink" href="https://github.com/cockpit-project/cockpit/" target="_top">contributors</a>.</p>
</div>
<div class="refsect1">
<a name="cockpit-desktop-also"></a><h2>SEE ALSO</h2>
<p>
<span class="citerefentry"><span class="refentrytitle">cockpit-ws</span>(8)</span>,
<span class="citerefentry"><span class="refentrytitle">cockpit-bridge</span>(1)</span>
</p>
</div>
</div>
<div class="footer"><hr></div>
</body>
</html>