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

Created Reporting issues (markdown)

Bill Zimmerman 2019-04-13 18:05:30 +02:00
parent a875c2b8b8
commit a211fc35fb
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
Reporting-issues.md Normal file

@ -0,0 +1,27 @@
### Preamble
RaspAP is a project currently led by one developer ([@billz](https://github.com/billz)) in his very limited spare time. As a result, please use issues for reporting bugs only. Troubleshooting requests will not be considered. If your issue is of a general nature (for example, "Is it possible to do 'x' with my RPi?") 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.
### Supported devices
RaspAP functions very well "out of the box" on fresh installs of the latest Raspbian distribution (currently Stretch; the Lite version is recommended) on recent hardware like the RPi 3 Model B/B+ and RPi Zero W. Alternate hardware platforms such as the Banana Pi and operating systems other than Raspbian are not supported.
If you have installed other software packages on top of RaspAP, particularly those related to networking such as TOR, OpenVPN 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 fuss. 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:
```
wget -q https://git.io/voEUQ -O /tmp/raspap && bash /tmp/raspap
```
Because of this, issues such as "hotspot isn't working" won't be considered. No hard feelings.
### Read the FAQ
The [FAQs](https://github.com/billz/raspap-webgui/wiki/FAQs) have answers to many common issues. Kindly check this before creating a new issue.
### 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.