blob: 324cdf0a5e5ef4071e1fe0aa2bb88c32e0c2368d (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
[](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.
## Developers
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.
## 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
```
to install locally (as root) ==> make install
to build an rpm ==> make rpm
to build a deb ==> make deb
```
### Pre-built Packaging
Fedora/RHEL users install via yum:
```
yum install sos
```
Debian(Sid) users install via apt:
```
apt-get install sosreport
```
Ubuntu(Saucy 13.10 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/
|
