mirror-cockpit-project-cockpit/README.md

<p align="center">
    <a href="https://cockpit-project.org/">
      <img src="https://cockpit-project.org/images/site/cockpit-logo-blue.svg" height="75" alt="Cockpit logo">
    </a>
    <br>
    <i>A sysadmin login session in a web browser</i>
</p>

---

[![Latest version](https://img.shields.io/github/v/release/cockpit-project/cockpit?sort=semver&logo=cockpit&style=for-the-badge&color=3c6eb4)](https://github.com/cockpit-project/cockpit/releases/latest)
[![Flathub Version](https://img.shields.io/flathub/v/org.cockpit_project.CockpitClient?style=for-the-badge&logo=flathub&color=3c6eb4)](https://flathub.org/en/apps/org.cockpit_project.CockpitClient)
[![Packaging status](https://img.shields.io/repology/repositories/cockpit?style=for-the-badge&logo=cockpit&color=3c6eb4)](https://repology.org/project/cockpit/versions)
[![Help translate](https://img.shields.io/badge/Help%20translate-Weblate-blue?style=for-the-badge&logo=weblate&logoColor=white)](https://translate.fedoraproject.org/projects/cockpit/cockpit/)

[![Matrix chat](https://img.shields.io/matrix/cockpit%3Afedoraproject.org?server_fqdn=matrix.org&fetchMode=summary&style=for-the-badge&logo=matrix)](https://matrix.to/#/#cockpit:fedoraproject.org)
[![Mastodon Follow](https://img.shields.io/mastodon/follow/109314390522064499?domain=fosstodon.org&style=for-the-badge&logo=mastodon&logoColor=white)](https://fosstodon.org/@Cockpit)


## 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](https://cockpit-project.org/running.html). Some systems may need extra work, read about it in our [FAQ](https://cockpit-project.org/faq.html#installation)

Cockpit is [available in numerous Linux distributions](https://repology.org/project/cockpit/versions) and is usually packaged as `cockpit`. 

### Flatpak 'Cockpit Client'

We also provide a Flatpak app called [Cockpit Client](https://flathub.org/en/apps/org.cockpit_project.CockpitClient) which includes SSH login support to Linux servers.

## Screenshots

| Light                                                                         | Dark                                                                        |
| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| ![Screenshot of high-level overview in light mode](./doc/overview-light.png)  | ![Screenshot of high-level overview in dark mode](./doc/overview-dark.png)  |
| ![Screenshot of account management in light mode](./doc/accounts-light.png)   | ![Screenshot of account management in dark mode](./doc/accounts-dark.png)   |
| ![Screenshot of network management in light mode](./doc/networking-light.png) | ![Screenshot of network management in dark mode](./doc/networking-dark.png) |

## Contributors

To quickly make code contributions we have a [HACKING.md](./HACKING.md) that outlines the devel environment and running tests. For more in-depth we have a [developer documentation](https://github.com/cockpit-project/cockpit/wiki/Contributing) 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](https://translate.fedoraproject.org/projects/cockpit/cockpit/).

## Security

Please see [SECURITY.md](https://github.com/cockpit-project/.github/blob/main/SECURITY.md).

## Licenses

* [LGPL-2.1 or later](./LICENSES/LGPL-2.1.txt)
* [GPL-3.0 or later](./LICENSES/GPL-3.0.txt)
* [BSD-3](./LICENSES/BSD-3-Clause.txt)
* [CC-BY-SA-3.0](./LICENSES/CC-BY-SA-3.0.txt)
* [MIT](./LICENSES/MIT.txt)

## Links

 * Matrix Channel: [`#cockpit:fedoraproject.org`](https://matrix.to/#/#cockpit:fedoraproject.org)
 * [Mailing List](https://lists.fedorahosted.org/admin/lists/cockpit-devel.lists.fedorahosted.org/)
 * [Guiding Principles](https://cockpit-project.org/ideals.html)
 * [Release Notes](https://cockpit-project.org/blog/category/release.html)
 * [Privacy Policy](https://cockpit-project.org/privacy.html)