h3n3/klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Offer alternatives to ssh/scp/sftp

Browse Source 
Try to make the Installation document more friendly to users not
familiar with the Linux command-line.  Offer some hints on how to
obtain ssh and how to edit the config file remotely.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor
2017-12-21 17:34:35 -05:00
parent d303e556ad
commit 522093ef00
2 changed files with 63 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/Contact.md
View File

@@ -4,23 +4,20 @@ developers.
Bug reporting
=============
Bug reports are submitted through github issues. All bug reports must
include the full /tmp/klippy.log log file from the session that
produced the error. To acquire this log file, ssh into the computer
running the klipper host software, and run:
Bug reports are submitted through github issues. **All bug reports
must include the full /tmp/klippy.log log file from the session that
produced the error.** An "scp" and/or "sftp" utility is needed to
acquire this log file. The "scp" utility comes standard with Linux and
MacOS desktops. There are freely available scp utilities for other
desktops (eg, WinSCP).
```
gzip -k /tmp/klippy.log
```
Then scp the resulting `/tmp/klippy.log.gz` file from the host machine
to your desktop. (If your desktop does not have scp installed, there
are a number of free scp programs available - just do a web search for
`windows scp` to find one.) Open a new issue at
Use the scp utility to copy the `/tmp/klippy.log` file from the host
machine to your desktop. Open a new issue at
https://github.com/KevinOConnor/klipper/issues , provide a description
of the problem, and attach the `klippy.log.gz` file to the issue (use
the blue "selecting them" link beneath the problem description on the
github issue page to attach files).
of the problem, and attach the `klippy.log` file to the issue (use the
blue "selecting them" link beneath the problem description on the
github issue page to attach files). It is a good idea to compress the
klippy.log file before posting it (eg, using zip or gzip).
If the Klipper software does something unexpected but does not produce
an error, then immediately issue an M112 command in the Octoprint