blob: 3f6cbebc974650fb4a18b859c3d328f1ae5df83e (
plain) (
tree)
|
|
[](https://travis-ci.org/sosreport/sos)
# 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:
* http://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 master (development) branch run:
```
git clone git://github.com/sosreport/sos.git
```
## Reporting bugs
Please report bugs via the mailing list or by opening an issue in the [GitHub
Issue Tracker][5]
## Mailing list
The [sos-devel][4] is the mailing list for any sos-related questions and
discussion. Patch submissions and reviews are welcome too.
## 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 master as a
'fast forward' merge (i.e. without creating a merge commit). Use the `git
rebase` command to update your branch to the current master if necessary.
Please refer to the [contributor guidelines][0] for guidance on formatting
patches and commit messages.
## Documentation
User and API [documentation][6] is automatically generated using [Sphinx][7]
and [Read the Docs][8].
### Wiki
* [How to write a plugin][1]
* [How to write a policy][2]
* [Plugin options][3]
To help get your changes merged quickly with as few revisions as possible
please refer to the [Contributor Guidelines][0] when submitting patches or
pull requests.
## Installation
### Manual Installation
```
You can simply run from the git checkout now ==> Ex: sudo ./sosreport -a
or if you only have python3 installed ==> sudo python3 ./sosreport -a
to install locally (as root) ==> make install
to build an rpm ==> make rpm
```
### Pre-built Packaging
Fedora/RHEL users install via yum:
```
yum install sos
```
Debian(Sid) users install via apt:
```
apt-get install sosreport
```
Ubuntu(14.04 LTS and above) users install via apt:
```
sudo apt-get install sosreport
```
[0]: https://github.com/sosreport/sos/wiki/Contribution-Guidelines
[1]: https://github.com/sosreport/sos/wiki/How-to-Write-a-Plugin
[2]: https://github.com/sosreport/sos/wiki/How-to-Write-a-Policy
[3]: https://github.com/sosreport/sos/wiki/Plugin-options
[4]: https://www.redhat.com/mailman/listinfo/sos-devel
[5]: https://github.com/sosreport/sos/issues?state=open
[6]: http://sos.readthedocs.org/en/latest/index.html#
[7]: http://sphinx-doc.org/
[8]: https://www.readthedocs.org/
|
