'\" t
.\"     Title: cockpit-desktop
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 04/15/2023
.\"    Manual: cockpit-desktop
.\"    Source: cockpit
.\"  Language: English
.\"
.TH "COCKPIT\-DESKTOP" "1" "04/15/2023" "cockpit" "cockpit-desktop"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
cockpit-desktop \- Cockpit Desktop integration
.SH "SYNOPSIS"
.HP \w'\fBcockpit\-desktop\fR\ 'u
\fBcockpit\-desktop\fR {URLPATH} [SSH_HOST]
.SH "DESCRIPTION"
.PP
The
\fBcockpit\-desktop\fR
program provides secure access to Cockpit pages in an already running desktop session\&. It starts a web server (\fBcockpit\-ws\fR) and a web browser in an isolated network namespace, and a
\fBcockpit-bridge\fR(8)
in the running user session\&.
.PP
This avoids having to log into Cockpit, and having to enable
cockpit\&.socket
system\-wide\&. The network isolation ensures that no other user, and not even other processes in the user\*(Aqs session, can access this local web server\&.
.PP
URLPATH
is the Cockpit page to open, i\&. e\&. the path component of Cockpit URLs\&. It is highly recommended to only open a
\m[blue]\fBparticular page frame\fR\m[]\&\s-2\u[1]\d\s+2, not the entire Cockpit navigation and menu\&. For example, the path
/cockpit/@localhost/storage/index\&.html
will open the Storage page\&. It is also possible to give abbreviated forms of urls, such as "storage" or "network/firewall"\&.
.PP
SSH_HOST
is an optional SSH remote host specification (hostname
or
username@hostname)\&. If given,
cockpit\-bridge
will be started on the remote host through
\fBssh\fR(1)
instead, i\&. e\&. the Cockpit web browser will show that remote host\&. Note that this is more of an experimental/demo feature\&.
.SH "ENVIRONMENT"
.PP
The
BROWSER
environment variable specifies the browser command (and possibly options) that will be used to open the requested Cockpit page\&. If not set,
\fBcockpit\-desktop\fR
attempts to use an internal minimalistic WebKit browser, and failing that, will attempt to detect some reasonable alternatives\&.
.SH "BUGS"
.PP
Please send bug reports to either the distribution bug tracker or the
\m[blue]\fBupstream bug tracker\fR\m[]\&\s-2\u[2]\d\s+2\&.
.SH "AUTHOR"
.PP
Cockpit has been written by many
\m[blue]\fBcontributors\fR\m[]\&\s-2\u[3]\d\s+2\&.
.SH "SEE ALSO"
.PP
\fBcockpit-ws\fR(8),
\fBcockpit-bridge\fR(1)
.SH "NOTES"
.IP " 1." 4
particular page frame
.RS 4
\%https://cockpit-project.org/guide/latest/embedding.html
.RE
.IP " 2." 4
upstream bug tracker
.RS 4
\%https://github.com/cockpit-project/cockpit/issues/new
.RE
.IP " 3." 4
contributors
.RS 4
\%https://github.com/cockpit-project/cockpit/
.RE