frodovdr/raspap-webgui
1
0
Fork 0
mirror of https://github.com/billz/raspap-webgui.git synced 2023-10-10 13:37:24 +02:00
Code Issues Releases Wiki Activity

Updated Reporting issues (markdown)

Bill Zimmerman 2021-01-25 11:05:02 +01:00
parent 45b453ba4b
commit c8f2cbfe8d
1 changed files with 0 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
Reporting-issues.md

@ -1,46 +1,3 @@
This wiki page has been sunsetted in favor of [RaspAP Docs](https://docs.raspap.com/). You will find an updated page at: This wiki page has been sunsetted in favor of [RaspAP Docs](https://docs.raspap.com/). You will find an updated page at:
### https://docs.raspap.com/issues/ ### https://docs.raspap.com/issues/
___
## Preamble
RaspAP is free software. It is delivered to you, at no cost, and with no guarantee. The [community of developers](https://github.com/billz/raspap-webgui/graphs/contributors) who contribute to this project make every effort to deliver defect-free code. That said, no software is perfect. You can help us improve this project by accurately describing your issue.
## Issue policy
This project is currently led by one developer ([@billz](https://github.com/billz)) in his very limited spare time. Please respect our developers' time by using issues for reporting bugs only. RaspAP is not a boxed product with a free troubleshooting hotline. If your issue is of a general nature and not directly related to a defect with this project, try searching the official [Raspberry Pi forums](https://www.raspberrypi.org/forums/) or [Raspberry Pi on Stack Exchange](https://raspberrypi.stackexchange.com/). Chances are your question has been discussed and answered before.
The project [FAQ](https://github.com/billz/raspap-webgui/wiki/FAQs) is continuously updated with answers to many common questions. Refer to this first before creating a new issue.
## Guidelines
You can help us improve this project by accurately describing defects. To that end, these guidelines have been established to streamline the reporting process:
1. The bug report template is there for a reason. Please use it.
2. Provide useful detail to reproduce your issue. "Doesn't work" or "not working" is not a valid report.
3. Issues created without the template will be labeled as `invalid` and closed immediately.
4. Log data can be very helpful in context, within reasonable limits.
5. If an issue is unclear or needs further information, it will be labeled with `question` and `awaiting-user`.
6. Issues that becomes stale due to inactivity are automatically managed by stale-bot.
## Supported devices
RaspAP functions very well "out of the box" on fresh installs of the latest Raspbian distribution (currently Buster; the Lite version is recommended) on recent hardware like the RPi 4, 3B+ and Zero W. The [version 2.3.1 release](https://github.com/billz/raspap-webgui/releases/tag/2.3.1) extends beta support to additional Debian-based distros, including Armbian and Ubuntu Server. Please note that "supported" is [not a guarantee](https://github.com/billz/raspap-webgui#supported-operating-systems).
If you have installed other software packages on top of RaspAP, particularly those related to networking such as TOR or Pi-hole, please test RaspAP first on a clean install before reporting an issue.
## Default settings
One of RaspAP's most popular features is the Quick Installer, which gets an AP up and running quickly and with a minimum of hassle. This works by applying a known-good [default configuration](https://github.com/billz/raspap-webgui/tree/master/config) that has been validated in testing with the project's supported devices. When the project [prerequisites](https://github.com/billz/raspap-webgui#prerequisites) are followed, an AP with wired ethernet (eth0) or managed mode (wlan0) Wifi client AP will be functional with the default settings.
**Important:** RaspAP gives you control over many of the settings for `hostapd`, `dhcpcd` and `dnsmasq`. Once these default settings are changed, it's possible that one or all of the above services will enter a failed state.
## Will RaspAP let me create a configuration that "breaks" my hotspot?
In a word, yes. While the Quick Installer automates most of the work of creating an AP, RaspAP does not automagically validate your custom configurations. As a result, you may observe anomalous behavior when restarting these services and/or rebooting your RPi.
When in doubt, simply run the Quick Installer again to restore the default settings:
```
curl -sL https://install.raspap.com | bash
```
Because of this, issues such as "hotspot isn't working" or "gui doesn't work" won't be considered. No hard feelings.
## Submitting an issue
If, after searching these community forums, consulting the FAQ and understanding the default settings, your issue still persists, please provide as much detailed information as possible. Use the provided issue template. Incomplete issue reports will not be considered.
Thanks.