Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

use sos report, not foreman-debug to get help #2180

Merged
merged 1 commit into from
Sep 23, 2024
Merged

use sos report, not foreman-debug to get help #2180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 3 additions & 15 deletions _includes/manuals/3.12/7.3_getting_help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,9 @@ An online discussion forum is available at https://community.theforeman.org/. Mu
* [Release Announcements](https://community.theforeman.org/c/release-announcements)

### Gathering information
In order to troubleshoot and get relevant data use foreman-debug which collects information about your OS, Foreman and related components.
If you installed from packages, the command is available to root:

# foreman-debug
In order to troubleshoot and get relevant data use `sos report` which collects information about your OS, Foreman and related components:

If you installed from git, you can find it in the Foreman directory:
# sos report

# script/foreman-debug

If you run it without any options, it will collect data, filter out possible
passwords or tokens and create a tarball which can be safely handed over to
us.

To upload the tarball to our public server via rsync use:

# foreman-debug -u

This is a write-only directory (readable only by Foreman core developers), please note that the rsync transmission is UNENCRYPTED.
It will collect data, filter out possible passwords or tokens and create a tarball which can be safely handed over to us.
18 changes: 3 additions & 15 deletions _includes/manuals/nightly/7.3_getting_help.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,9 @@ An online discussion forum is available at https://community.theforeman.org/. Mu
* [Release Announcements](https://community.theforeman.org/c/release-announcements)

### Gathering information
In order to troubleshoot and get relevant data use foreman-debug which collects information about your OS, Foreman and related components.
If you installed from packages, the command is available to root:

# foreman-debug
In order to troubleshoot and get relevant data use `sos report` which collects information about your OS, Foreman and related components:

If you installed from git, you can find it in the Foreman directory:
# sos report

# script/foreman-debug

If you run it without any options, it will collect data, filter out possible
passwords or tokens and create a tarball which can be safely handed over to
us.

To upload the tarball to our public server via rsync use:

# foreman-debug -u

This is a write-only directory (readable only by Foreman core developers), please note that the rsync transmission is UNENCRYPTED.
It will collect data, filter out possible passwords or tokens and create a tarball which can be safely handed over to us.