cockpit-ws(8)

1COCKPIT-WS(8)                     cockpit-ws                     COCKPIT-WS(8)
2
3
4

NAME

6       cockpit-ws - Cockpit web service
7

SYNOPSIS

9       cockpit-ws [--help] [--port PORT] [--no-tls] [--local-ssh]
10                  [--address ADDRESS]
11

DESCRIPTION

13       The cockpit-ws program is the web service component used for
14       communication between the browser application and various configuration
15       tools and services like cockpit-bridge(8).
16
17       Users or administrators should never need to start this program as it
18       automatically started by systemd(1) on bootup.
19

TRANSPORT SECURITY

21       To specify the TLS certificate the web service should use, simply drop
22       a file with the extension .cert in the /etc/cockpit/ws-certs.d
23       directory. If there are multiple files in this directory, then the
24       highest priority one is chosen after sorting.
25
26       The .cert file should contain at least two OpenSSL style PEM blocks.
27       First one or more BEGIN CERTIFICATE blocks for the server certificate
28       and intermediate certificate authorities and a last one containing a
29       BEGIN PRIVATE KEY or similar. The key may not be encrypted.
30
31       If there is no TLS certificate, a self-signed certificate is
32       automatically generated using openssl and stored in the
33       0-self-signed.cert file.
34
35       When enrolling into a FreeIPA domain, an SSL certificate is requested
36       from the IPA server and stored in 10-ipa.cert.
37
38       To check which certificate cockpit-ws will use, run the following
39       command.
40
41           $ sudo remotectl certificate
42
43       If using certmonger to manage certificates, following command can be
44       used to automatically prepare concatenated .cert file:
45
46           CERT_FILE=/etc/pki/tls/certs/$(hostname).pem
47           KEY_FILE=/etc/pki/tls/private/$(hostname).key
48
49           getcert request -f ${CERT_FILE} -k ${KEY_FILE} -D $(hostname --fqdn) -C "sed -n w/etc/cockpit/ws-certs.d/50-from-certmonger.cert ${CERT_FILE} ${KEY_FILE}"
50

TIMEOUT

52       When started via systemd(1) then cockpit-ws will exit after 90 seconds
53       if nobody logs in, or after the last user is disconnected.
54

OPTIONS

56       --help
57           Show help options.
58
59       --local-ssh
60           Normally cockpit-ws uses cockpit-session and PAM to authenticate
61           the user and start a user session. With this option enabled, it
62           will instead authenticate via SSH at 127.0.0.1 port 22.
63
64       --port PORT
65           Serve HTTP requests PORT instead of port 9090. Usually Cockpit is
66           started on demand by systemd socket activation, and this option has
67           no effect. Update the ListenStream directive cockpit.socket file in
68           the usual systemd manner.
69
70       --address ADDRESS
71           Bind to address ADDRESS instead of binding to all available
72           addresses. Usually Cockpit is started on demand by systemd socket
73           activation, and this option has no effect. In that case, update the
74           ListenStream directive in the cockpit.socket file in the usual
75           systemd manner.
76
77       --no-tls
78           Don't use TLS.
79

ENVIRONMENT

81       The cockpit-ws process will use the XDG_CONFIG_DIRS environment
82       variable from the XDG basedir spec[1] to find its cockpit.conf(5)
83       configuration file.
84
85       In addition the XDG_DATA_DIRS environment variable from the XDG basedir
86       spec[1] can be used to override the location to serve static files
87       from. These are the files that are served to a non-logged in user.
88

BUGS

90       Please send bug reports to either the distribution bug tracker or the
91       upstream bug tracker[2].
92

AUTHOR

94       Cockpit has been written by many contributors[3].
95

NOTES

100        1. XDG basedir spec
101           https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
102
103        2. upstream bug tracker
104           https://github.com/cockpit-project/cockpit/issues/new
105
106        3. contributors
107           https://github.com/cockpit-project/cockpit/
108
109
110
111cockpit                           03/13/2019                     COCKPIT-WS(8)