cockpit README

The project's README from github.com/cockpit-project/cockpit. As one markdown file: README.md.

Cockpit logo
A sysadmin login session in a web browser


Latest version Flathub Version Packaging status Help translate

Matrix chat Mastodon Follow

What is Cockpit?

Cockpit is an interactive server admin interface. It is easy to use and very lightweight. Cockpit interacts directly with the operating system from a real Linux session in a browser.

Cockpit makes Linux discoverable, allowing sysadmins to easily perform tasks such as starting containers, storage administration, network configuration, inspecting logs and so on.

Jumping between the terminal and the web tool is no problem. A service started via Cockpit can be stopped via the terminal. Likewise, if an error occurs in the terminal, it can be seen in the Cockpit journal interface.

You can also easily add other machines that have Cockpit installed and are accessible via SSH and jump between these hosts.

Installation

[!NOTE] An installation guide can be found at cockpit-project.org/running.html. Some systems may need extra work, read about it in our FAQ

Cockpit is available in numerous Linux distributions and is usually packaged as cockpit.

Flatpak 'Cockpit Client'

We also provide a Flatpak app called Cockpit Client which includes SSH login support to Linux servers.

Screenshots

Light Dark
Screenshot of high-level overview in light mode Screenshot of high-level overview in dark mode
Screenshot of account management in light mode Screenshot of account management in dark mode
Screenshot of network management in light mode Screenshot of network management in dark mode

Contributors

To quickly make code contributions we have a HACKING.md that outlines the devel environment and running tests. For more in-depth we have a developer documentation that links to more resources about setting up the local environment, how designs are proposed, creating and running tests, and our overall contribution process.

Translations are managed in Weblate.

Security

Please see SECURITY.md.

Licenses

cockpit (cockpit-project/cockpit)

Searching Database…

15.2K ·GitHub
What is this?Cockpit is a web-based graphical interface for administering Linux servers: an interactive dashboard in your browser that talks directly to the operating system.
So is it a web app I deploy somewhere, or does it live on the server itself?It runs on the server itself and interacts with the OS from a real Linux session; your browser is just the window into it. There is no separate app server to deploy.
How do I get it on a server?It is packaged in numerous Linux distributions, usually under the package name 'cockpit'. A full installation guide lives at cockpit-project.org/running.html.
Does it install cleanly on every distro?Not necessarily — the README warns that some systems may need extra work and points to the project FAQ for those cases.
My workstation is Windows or macOS — can I still manage my Linux boxes with it?Yes — the interface is used from a browser, and there is also a Flatpak app called Cockpit Client that adds SSH login support to Linux servers from your desktop.
What can I actually do through the Cockpit interface?Everyday server admin work: starting containers, storage administration, network configuration and inspecting logs — the README's pitch is that this makes Linux discoverable for sysadmins.
Why use it instead of just SSH?Convenience: routine admin tasks become point-and-click instead of memorized commands, and switching between the web tool and a real Linux terminal session is seamless, so nothing from the SSH workflow is lost.
Size
275 MB
Stars
15.2K
Age
12y
Commits · 90 Days