Cockpit Guide

Documentation for Cockpit 195 -- latest version available at: https://cockpit-project.org/guide/latest/

I. Deployment Guide

Manual pages

cockpit.conf — Cockpit configuration file
cockpit-ws — Cockpit web service
cockpit-desktop — Cockpit Desktop integration
remotectl — Remote Access Configuration
cockpit-bridge — Cockpit Host Bridge

SSL/TLS Usage

HTTPS Requirement
Certificates
SSL Versions and Ciphers

TCP Port and Address

Cockpit systemd Socket
SELinux Port
Firewalld Port

Process exit
Boot start up

Cockpit Authentication

Primary server authentication

Secondary server authentication

Password
Kerberos
Public key

Single Sign On

Server Requirements
Client Requirements

Privileges and Permissions

Customizing Polkit Privileges

II. Feature Internals

NetworkManager

Subscription Manager

Used in a standard Cockpit session
Used as a Kubernetes Pod
Used as an Openshift Pod

Multiple Machines

SELinux Policy

Tuned Profiles

Package Updates

Virtual Machines

Nested Virtualization
Managing VMs on system connection
Extensions

oVirt Virtual Machines

III. Developer Guide

Embedding and Integrating Cockpit

Embedding the Cockpit Interface
Integrating Cockpit Components into Web Applications
Deep Integration
Pinging Cockpit

Cockpit Packages

Layout of Package Files
Package Manifest
Package Links and Paths
Content Negotiation
Using Cockpit API
Bridges for specific tasks
Replacing an existing package

Cockpit URLs

Component URLs
Visible URLs

cockpit.js — Basic cockpit API to interact with the system
cockpit.js: DBus Client — DBus API communication
cockpit.js: File Access — Reading, writing, and watching files.
cockpit.js: HTTP Client — HTTP and REST API communication
cockpit.js: Spawning Processes — Spawning processes or scripts
cockpit.js: Metrics — Reading and streaming metric data
cockpit.js: Series Data — Representing series data
cockpit.js: Raw Channels — Raw communication channels
cockpit.js: Page Location and Jumping — Page location and navigation between components
cockpit.js: Localization — Localization and translations
cockpit.js: Errors — Problem codes and messages
cockpit.js: User Session — User information and login session state
cockpit.js: Utilities — Various utility functions
cockpit.js: Object Cache — Caching and sharing data
cockpit.js: Manifests — Manifest info
patternfly.css — Patternfly standard style sheets

API: docker

console.html — Container console component

index.html — Main cockpit shell, for a single machine

API: system

logs.html — System log component
terminal.html — Server terminal component