Skip to content

Commit 68f5616

Browse files
committed
Split out troubleshooting, update nav
1 parent d57a1e0 commit 68f5616

2 files changed

Lines changed: 5 additions & 80 deletions

File tree

‎docs/ap-basics.md‎

Lines changed: 0 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -163,82 +163,6 @@ Next, choose **Hotspot > Save settings** to parse this file and append your cust
163163
!!! tip "Tip"
164164
Direct manipulation of advanced `hostapd` settings may lead to your AP failing to start and/or other unanticipated behavior. For this reason, it's advisable to enable service logging on the **Hotspot > Logging** tab and monitor the log output for errors.
165165

166-
## Troubleshooting
167-
RaspAP gives you advanced control over several Linux networking-related services. As a result, your AP may fail to start for a variety of reasons. You may also encounter errors connecting clients to
168-
the AP, have no internet on AP clients, or observe clients being disconnected from the AP for no apparent reason.
169-
170-
If any of the above happens, one of the best diagnostic tools at your disposal is RaspAP's built-in service logging facility. You may enable the `hostapd` service log by sliding the **Logfile output** toggle on the **Hotspot > Logging** tab and choosing **Save settings**. Finally, choose
171-
**Restart hotspot** and check the log output.
172-
173-
![](https://user-images.githubusercontent.com/229399/116439036-5c56b080-a84f-11eb-87ee-318932347daf.png){: style="width:580px"}
174-
175-
Similarly, you may also enable DHCP server activity by sliding either of the two logging options on the **DHCP server > Logging** tab.
176-
177-
### Debug log
178-
In some situations, you may need more comprehensive information to self-diagnose a problem. RaspAP lets you generate a debug log with a detailed summary of your system including the installed OS, Linux kernel version, attached USB devices, RaspAP settings, network configuration and current state of several AP-related services.
179-
180-
![](https://github.com/RaspAP/raspap-webgui/assets/229399/66bf5cb5-3d77-44aa-92b8-5ebca6f003ad){: style="width:480px"}
181-
182-
To create this log, simply click or tap on the **Generate debug log** button from the **System > Tools** tab. You will be prompted to choose a location to store the generated `raspap_debug.log` file on your local computer or mobile device. An example portion of RaspAP's debug log is shown below:
183-
184-
```
185-
System Info
186-
===========
187-
Hardware: Raspberry Pi 3 Model B Rev 1.2
188-
Detected OS: Debian GNU/Linux 12 (bookworm) 64-bit
189-
Kernel: Linux raspberrypi 6.1.0-rpi4-rpi-v8 (2023-10-05) aarch64 GNU/Linux
190-
System Uptime: 4 days, 20 hours, 45 minutes
191-
Memory Usage: 29.0749%
192-
193-
Installed Packages
194-
==================
195-
PHP Version: 8.2.7 (cli) (built: Jun 9 2023 19:37:27) (NTS)
196-
Dnsmasq Version: 2.89
197-
dhcpcd Version: 9.4.1
198-
lighttpd Version: 1.4.69
199-
vnStat Version: 2.10
200-
201-
RaspAP Install
202-
==============
203-
RaspAP Version: 2.9.9
204-
RaspAP Installation Directory: /var/www/html
205-
RaspAP hostapd.ini contents:
206-
WifiInterface = wlan0
207-
```
208-
209-
!!! tip "Tip"
210-
If you are unable to perform a self-diagnosis and would like to share your debug log (or a portion of it) with another party, upload it to <a href="https://pastebin.com/" target="_blank">Pastebin</a> or <a href="https://paste.ubuntu.com/" target="_blank">Ubuntu Pastebin</a>. Please don't paste the log in its entirety to RaspAP's discussions, issues or other support channels.
211-
212-
RaspAP's debug log contains information about your system and local network configuration. However, no passwords or other senstive data are included.
213-
214-
### Diagnosing problems
215-
Look for any reported errors logged by the `hostapd`, `dhcpcd` or `dnsmasq` services. In most cases, errors thrown by one or more of these services have been discussed in various online forums.
216-
Start by searching the official [Raspberry Pi forums](https://www.raspberrypi.org/forums/) or [Raspberry Pi on Stack Exchange](https://raspberrypi.stackexchange.com/). Chances are the problems with your AP have been discussed and answered before.
217-
218-
For additional help and advice, the [FAQ](faq.md) is a rich source of troubleshooting info that is continuously updated with answers to the most commonly asked questions. For issues not covered in
219-
the FAQ, you may find many topics in [RaspAP discussions](https://github.com/RaspAP/raspap-webgui/discussions) and the [RaspAP subreddit](https://reddit.com/r/RaspAP).
220-
221-
!!! tip "Tip"
222-
Capture output from the Linux kernel's message buffer with `dmesg` to help diagnose failure events. Read the last 100 lines with `dmesg | tail -100` and look for any anomalies.
223-
224-
The performance of WiFi radios may be impacted by many factors, including, but not limited to:
225-
226-
1. Undervoltage due to inadequate power or too many peripherals connected to the USB bus
227-
2. Interference from a poorly shielded HDMI cable or using a [specific HDMI screen resolution](https://www.enricozini.org/blog/2019/himblick/raspberry-pi-4-loses-wifi-at-2560x1440-screen-resolution/)
228-
3. RF interference from overlapping WiFi networks on a crowded 2.4 GHz band.
229-
230-
Bear these things in mind if your AP exhibits unexpected behavior and do your best to mitigate them.
231-
232-
### Reverting to base settings
233-
It is generally advisable to begin with RaspAP's [default configuration](defaults.md), which has been rigorously tested and validated with the project's [supported operating systems](index.md#compatible-operating-systems). If, after modifying RaspAP's default settings, your AP no longer functions as expected, you may perform a [system reset](defaults.md#restoring-settings) to restore these defaults.
234-
235-
### Accessing backups
236-
Each time you revert to RaspAP's base settings, your existing service configuration files are automatically backed up to `/etc/raspap/backups`. In this way, you can compare differences between your files and the default configuration, if needed.
237-
There are many ways to do this in Linux, such as using the built-in GNU `diff` tool. Another option is to install `colordiff`, a wrapper for diff that produces the same output but with colored syntax highligting.
238-
Install `colordiff` with `sudo apt-get install colordiff`.
239-
240-
Similarly, the web files located in the default `/var/www/html` root are backed up to `/var/www` in a directory named with a timestamp. Therefore, any changes you've made to RaspAP's internals are preserved.
241-
242166
## Discussions
243167
Questions or comments about using access point settings? Join the [discussion here](https://github.com/RaspAP/raspap-webgui/discussions/).
244168

‎mkdocs.yml‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,12 @@ edit_uri: /RaspAP/raspap-docs/edit/master/docs
77
nav:
88
- Overview: index.md
99
- Quick Start:
10-
- Simple Setup: quick_start.md
10+
- Simple setup: quick_start.md
1111
- Default settings: defaults.md
1212
- Manual installation: manual.md
1313
- Quick installer: quick.md
1414
- Docker support: docker.md
15+
- Troubleshooting: troubleshooting.md
1516
- Core Features:
1617
- Ad blocking: adblock.md
1718
- Access point settings: ap-basics.md
@@ -34,12 +35,12 @@ nav:
3435
- Wireless LAN routing: wlanrouting.md
3536
- Experimental Features:
3637
- AP-STA mode: ap-sta.md
37-
- RestAPI: restapi.md
38-
- VPN Providers: providers.md
38+
- RESTful API: restapi.md
39+
- VPN providers: providers.md
3940
- SSL certificates: ssl.md
4041
- FAQ: faq.md
4142
- Reporting Issues: issues.md
42-
- Get Involved: get_involved.md
43+
- Get involved: get_involved.md
4344

4445
theme:
4546
name: material

0 commit comments

Comments
 (0)