!GitHub contributors

SoS

Sos is an extensible, portable, support data collection tool primarily aimed at Linux distributions and other UNIX-like operating systems.

This project is hosted at:

* https://github.com/sosreport/sos

For the latest version, to contribute, and for more information, please visit the project pages or join the mailing list.

To clone the current main (development) branch run:

git clone [email protected]:sosreport/sos.git

Reporting bugs

Please report bugs by opening an issue in the [GitHub Issue Tracker][4].

Chat

The SoS project has rooms in Matrix and in Libera.Chat.

Matrix Room: #sosreport:matrix.org

Libera.Chat: #sos

These rooms are bridged, so joining either is sufficient as messages from either will appear in both.

The Freenode #sos room is no longer used by this project.

Patches and pull requests

Patches can be submitted via the mailing list or as GitHub pull requests. If using GitHub please make sure your branch applies to the current main branch as a 'fast forward' merge (i.e. without creating a merge commit). Use the git rebase command to update your branch to the current main if necessary.

Please refer to the [contributor guidelines][0] for guidance on formatting patches and commit messages.

Before sending a [pull request][0], it is advisable to check your contribution against the flake8 & pylint linter, the unit tests, and the stage one avocado test suite:

# from within the git checkout
$ tox -e flake8
$ tox -e pylint
$ tox -e unit_tests
as root
tox -e stageone_tests

Note that the avocado test suite will generate and remove several reports over its execution, but no changes will be made to your local system.

All contributions must pass the entire test suite before being accepted.

Documentation

User and API [documentation][5] is automatically generated using [Sphinx][6] and [Read the Docs][7].

To generate HTML documents locally, run the following (by default this will build into docs/_build):

tox -e docs

For more in-depth information on the project's features and functionality, please see [the documentation][5].

If you are interested in contributing an entirely new plugin, or extending sos to support your distribution of choice, please see these pages:

• [How to write a plugin][1]
• [How to write a policy][2]
• [Plugin options][3]

Installation

Manual Installation

You can simply run from the git checkout now:

$ sudo ./bin/sos report

To see a list of all available plugins and plugin options, run

$ sudo ./bin/sos report -l

To install locally (as root):

# python3 setup.py install

Pre-built Packaging

Fedora/RHEL users install via dnf:

# dnf install sos

Debian users install via apt:

# apt install sosreport

Ubuntu (14.04 LTS and above) users install via apt:

# sudo apt install sosreport

Snap Installation

# snap install sosreport --classic

[0]: https://sos.readthedocs.io/en/main/user_docs/contribution_guidelines.html [1]: https://sos.readthedocs.io/en/main/user_docs/writing_a_plugin.html [2]: https://sos.readthedocs.io/en/main/user_docs/writing_a_policy.html [3]: https://sos.readthedocs.io/en/main/user_docs/plugin_options.html [4]: https://github.com/sosreport/sos/issues?state=open [5]: https://sos.readthedocs.io/en/main/ [6]: https://www.sphinx-doc.org/ [7]: https://readthedocs.org/