Merge pull request #16 from ruralmeltdown/2025-08_ruralmeltdown_issue-15

Introduce tabs to some documents, as well as some other minor tweaks

Author: billz

docs/defaults.md

@@ -20,7 +20,7 @@ The exception to this is `hostapd.conf` which is effectively rewritten depending
 Baseline configurations for `dhcpcd`, `dnsmasq` (described below) and bridged AP configurations are contained here.
 
 ## Managing config values
-The interface itself, default Linux file paths and so on may be changed by modifying the project's configuration file `config.php`. 
+The interface itself, default Linux file paths, and so on may be changed by modifying the project's configuration file `config.php`. 
 
 !!! note "Note"
     The file `config/config.php` is copied during the installation to `includes/config.php` and ignored by Git. This way, users can modify `includes/config.php` without `git pull` or upgrades complaining about local changes. The file `includes/defaults.php` loads corresponding default values if they are not set.

docs/docker.md

@@ -111,117 +111,119 @@ sudo usermod -aG docker $USER
 With these steps completed, you have successfully installed and started Docker Engine. We're now ready to deploy RaspAP.
 
 ## Deploying RaspAP
-With Docker Engine installed, you have two ways of deploying RaspAP in a Docker container. Each of these methods is described in the sections below.
+With Docker Engine installed, you have two ways of deploying RaspAP in a Docker container. Each of these methods is described in their resepective tabs below.
 
-### Using Docker compose
-This method lets us deploy the entire RaspAP application stack with a single command (`docker compose up`) as well as configure things like environment variables, network settings and so on in a centralized manner. Advanced users may also use this option to define a multi-container environment of which RaspAP is one component. This may be done with the `docker-compose.yml` file.
+=== "Using Docker compose"
+    This method lets us deploy the entire RaspAP application stack with a single command (`docker compose up`) as well as configure things like environment variables, network settings and so on in a centralized manner. Advanced users may also use this option to define a multi-container environment of which RaspAP is one component. This may be done with the `docker-compose.yml` file.
 
-Begin by cloning the `raspap-docker` [GitHub repository](https://github.com/RaspAP/raspap-docker) into your home directory, then change into it:
+    Begin by cloning the `raspap-docker` [GitHub repository](https://github.com/RaspAP/raspap-docker) into your home directory, then change into it:
 
-```
-cd ~/
-git clone https://github.com/RaspAP/raspap-docker.git
-cd raspap-docker
-```
+    ```
+    cd ~/
+    git clone https://github.com/RaspAP/raspap-docker.git
+    cd raspap-docker
+    ```
 
-For ARM devices, such as the Raspberry Pi, we must uncomment the `cgroup: host` line in the `docker-compose.yaml` file:
-
-``` py hl_lines="9"
-version: "3.8"
-services:
-  raspap:
-    container_name: raspap
-    image: ghcr.io/raspap/raspap-docker:latest
-    #build: .
-    privileged: true
-    network_mode: host
-    cgroup: host # uncomment when using an ARM device 
-    cap_add:
-      - SYS_ADMIN
-    volumes:
-      - /sys/fs/cgroup:/sys/fs/cgroup:rw
-    restart: unless-stopped
-```
+    For ARM devices, such as the Raspberry Pi, we must uncomment the `cgroup: host` line in the `docker-compose.yaml` file:
+
+    ``` py hl_lines="9"
+    version: "3.8"
+    services:
+    raspap:
+        container_name: raspap
+        image: ghcr.io/raspap/raspap-docker:latest
+        #build: .
+        privileged: true
+        network_mode: host
+        cgroup: host # uncomment when using an ARM device 
+        cap_add:
+        - SYS_ADMIN
+        volumes:
+        - /sys/fs/cgroup:/sys/fs/cgroup:rw
+        restart: unless-stopped
+    ```
 
-Edit this file with `nano docker-compose.yaml`, change the line to appear as above, then use ++ctrl+o++ and press ++enter++ to save and exit the file.
+    Edit this file with `nano docker-compose.yaml`, change the line to appear as above, then use ++ctrl+o++ and press ++enter++ to save and exit the file.
 
-!!! warning "Important"
-    Do not use `docker-compose` but rather `docker compose`. If the latter isn't present on your system, refer to Docker's [installation steps](https://docs.docker.com/compose/install/).
+    !!! warning "Important"
+        Do not use `docker-compose` but rather `docker compose`. If the latter isn't present on your system, refer to Docker's [installation steps](https://docs.docker.com/compose/install/).
 
-With this configuration done, execute Docker compose like so:
+    With this configuration done, execute Docker compose like so:
 
-```
-docker compose up -d
-```
+    ```
+    docker compose up -d
+    ```
 
-You should see output similar to below to indicate the progress of RaspAP's Docker image being built: 
+    You should see output similar to below to indicate the progress of RaspAP's Docker image being built: 
 
-```
-docker compose up -d
-[+] Running 2/8
- ⠇ raspap 7 layers [⠀⡀⣿⣿⠀⠀⠀] 12.83MB/337.8MB Pulling
-   ⠋ 5665c1f9a9e1 Downloading [===>                        ]  3.547MB/49.59MB
-   ⠋ 4311202aff18 Downloading [=========>                  ]   4.98MB/24.95MB
-   ✔ ac4d205394f0 Download complete
-   ✔ baf57b850085 Download complete
-   ⠋ 18a1ed9b4ba8 Downloading [=>                          ]  4.307MB/263.3MB
-   ⠋ 5bed08c889b9 Waiting
-   ⠋ 09ed3fdeed88 Waiting
-```
+    ```
+    docker compose up -d
+    [+] Running 2/8
+    ⠇ raspap 7 layers [⠀⡀⣿⣿⠀⠀⠀] 12.83MB/337.8MB Pulling
+    ⠋ 5665c1f9a9e1 Downloading [===>                        ]  3.547MB/49.59MB
+    ⠋ 4311202aff18 Downloading [=========>                  ]   4.98MB/24.95MB
+    ✔ ac4d205394f0 Download complete
+    ✔ baf57b850085 Download complete
+    ⠋ 18a1ed9b4ba8 Downloading [=>                          ]  4.307MB/263.3MB
+    ⠋ 5bed08c889b9 Waiting
+    ⠋ 09ed3fdeed88 Waiting
+    ```
 
-During this process, a Docker image containing RaspAP's application stack will be created on your system. This build always pulls the [latest RaspAP release](https://github.com/RaspAP/raspap-webgui/releases/latest) from the main [GitHub repository](https://github.com/RaspAP/raspap-webgui/). 
+    During this process, a Docker image containing RaspAP's application stack will be created on your system. This build always pulls the [latest RaspAP release](https://github.com/RaspAP/raspap-webgui/releases/latest) from the main [GitHub repository](https://github.com/RaspAP/raspap-webgui/). 
 
-Behind the scenes, Docker has used the image it created to start a containerized RaspAP application stack. You may confirm this by executing the following:
+    Behind the scenes, Docker has used the image it created to start a containerized RaspAP application stack. You may confirm this by executing the following:
 
-```
-docker container ls
-CONTAINER ID   IMAGE           COMMAND                  CREATED        STATUS        PORTS     NAMES
-8d7b32b8373a   raspap:latest   "/bin/bash -c '/home…"   2 hours ago    Up 2 hours             raspap
-```
+    ```
+    docker container ls
+    CONTAINER ID   IMAGE           COMMAND                  CREATED        STATUS        PORTS     NAMES
+    8d7b32b8373a   raspap:latest   "/bin/bash -c '/home…"   2 hours ago    Up 2 hours             raspap
+    ```
 
-At this stage, the RaspAP application is running and you may access the web interface as you would normally. This will depend on the method you use to access your device, but is usually one of the following:
+    At this stage, the RaspAP application is running and you may access the web interface as you would normally. This will depend on the method you use to access your device, but is usually one of the following:
 
-- `http://raspberrypi.local`
-- `http://10.3.141.1`
-- `http://localhost`
+    - `http://raspberrypi.local`
+    - `http://10.3.141.1`
+    - `http://localhost`
 
-Take note that RaspAP and all its dependencies are wholly contained within the running Docker container. That is, the host system does not have any of the `apt` packages or application files used by RaspAP, unless you've explicitly installed them.
+    Take note that RaspAP and all its dependencies are wholly contained within the running Docker container. That is, the host system does not have any of the `apt` packages or application files used by RaspAP, unless you've explicitly installed them.
 
-### Using the container registry
-As an alternative to `docker compose`, described above, you may also deploy RaspAP using its hosted Docker container image. This is available as a `raspap-docker` package hosted on the [GitHub Container registry](https://ghcr.io/). With this method, a single container is defined from its base image, the environment is setup and the application is configured within the container.
+=== "Using the container registry"
+    As an alternative to `docker compose`, described above, you may also deploy RaspAP using its hosted Docker container image. This is available as a `raspap-docker` package hosted on the [GitHub Container registry](https://ghcr.io/). With this method, a single container is defined from its base image, the environment is setup and the application is configured within the container.
 
-Given that everything needed to deploy RaspAP is stored within this package, it isn't necessary to clone the `raspap-docker` respository. Instead, you may simply execute one of the following `docker run` commands:
+    Given that everything needed to deploy RaspAP is stored within this package, it isn't necessary to clone the `raspap-docker` respository. Instead, you may simply execute one of the following `docker run` commands:
 
-1. For ARM devices, the `cgroups` must be made writable.
-```
-docker run --name raspap -it -d --privileged --network=host --cgroupns=host -v /sys/fs/cgroup:/sys/fs/cgroup:rw --cap-add SYS_ADMIN ghcr.io/raspap/raspap-docker:latest
-```
-2. For non-ARM devices, execute the following.
-```
-docker run --name raspap -it -d --privileged --network=host -v /sys/fs/cgroup:/sys/fs/cgroup:ro --cap-add SYS_ADMIN ghcr.io/raspap/raspap-docker:latest
-```
+    1. For ARM devices, the `cgroups` must be made writable.
+    ```
+    docker run --name raspap -it -d --privileged --network=host --cgroupns=host -v /sys/fs/cgroup:/sys/fs/cgroup:rw --cap-add SYS_ADMIN ghcr.io/raspap/raspap-docker:latest
+    ```
+    2. For non-ARM devices, execute the following.
+    ```
+    docker run --name raspap -it -d --privileged --network=host -v /sys/fs/cgroup:/sys/fs/cgroup:ro --cap-add SYS_ADMIN ghcr.io/raspap/raspap-docker:latest
+    ```
 
-With either of the above commands, you should see output as below followed by progress indicating the state of the various package components as they are downloaded to your system:
+    With either of the above commands, you should see output as below followed by progress indicating the state of the various package components as they are downloaded to your system:
 
-```
-Unable to find image 'ghcr.io/raspap/raspap-docker:latest' locally
-latest: Pulling from raspap/raspap-docker
-```
+    ```
+    Unable to find image 'ghcr.io/raspap/raspap-docker:latest' locally
+    latest: Pulling from raspap/raspap-docker
+    ```
 
-When the container image download is completed, you may verify its operational state like so:
-```
-docker container ls
-CONTAINER ID   IMAGE                                 COMMAND                  CREATED          STATUS          PORTS     NAMES
-4257b8aa3c7e   ghcr.io/raspap/raspap-docker:latest   "/bin/bash -c '/home…"   32 minutes ago   Up 32 minutes             raspap
-```
+    When the container image download is completed, you may verify its operational state like so:
+    ```
+    docker container ls
+    CONTAINER ID   IMAGE                                 COMMAND                  CREATED          STATUS          PORTS     NAMES
+    4257b8aa3c7e   ghcr.io/raspap/raspap-docker:latest   "/bin/bash -c '/home…"   32 minutes ago   Up 32 minutes             raspap
+    ```
+
+    At this stage, the RaspAP application stack is running and you may access the web interface as you would normally. This will depend on the method you use to access your device, but is usually one of the following:
 
-At this stage, the RaspAP application stack is running and you may access the web interface as you would normally. This will depend on the method you use to access your device, but is usually one of the following:
+    - `http://raspberrypi.local`
+    - `http://10.3.141.1`
+    - `http://localhost`
 
-- `http://raspberrypi.local`
-- `http://10.3.141.1`
-- `http://localhost`
+    Take note that RaspAP and all its dependencies are wholly contained within the running Docker container. That is, the host system does not have any of the `apt` packages or application files used by RaspAP, unless you've explicitly installed them.
 
-Take note that RaspAP and all its dependencies are wholly contained within the running Docker container. That is, the host system does not have any of the `apt` packages or application files used by RaspAP, unless you've explicitly installed them.
+---
 
 ## Tips and tricks
 The following section has some general advice that users of RaspAP's Docker container have found useful. If you have a tip or trick to contribute, feel free to join our [discussions](docker.md#discussions). 

docs/dynamicdns.md

@@ -74,7 +74,7 @@ When you've completed your configuration, choose **Save settings** and **Start D
 ## Troubleshooting
 Behind the scenes, the `ddclient` daemon will determine your external IP using the method you've defined and send this to your DDNS provider. Your provider will then update the IP address corresponding to the DNS "A" (or "address") record for your domain.
 
-If your DDNS provider fails to report your current IP address, or you suspect there might be a problem with the `ddclient` configuration on your device, you may generate a detailed debug log.
+If your DDNS provider fails to report your current IP address, or you suspect there might be a problem with the `ddclient` configuration on your device, you may generate a detailed [debug log](troubleshooting.md#debug-log).
 
 From the **Logging** tab, use the **Generate log** button to invoke the `ddclient` daemon and output a troubleshooting log: 
 

docs/faq.md

@@ -38,6 +38,7 @@ If you would like to see a new FAQ that you feel would assist other users, [star
 * [RaspAP web UI fails to start or unable to save settings.](#webfail)
 * [Why do I receive an 'Invalid CSRF token' message and a blank screen?](#token)
 * [My hotspot's SSID appears intermittently or clients are unable to connect.](#intermittent)
+* [Why do I not see any data in 'Data Usage' for one of my interfaces?](#data-usage)
 
 ## Integrations
 * [How do I integrate RaspAP with Pi-hole?](#pihole)
@@ -461,6 +462,14 @@ In the vast majority of reports like this, the ultimate cause is interference of
 
 Other common forms of interference include nearby wireless networks. Survey your wireless neighborhood and take note of the channels (frequencies) being used to broadcast around you. Select an unused or less contested channel on RaspAP's **Hotspot > Basic** tab, and choose **Restart hotspot**. Enable logging on the **Logging** tab and monitor client connect activity.
 
+## <a name="data-usage"></a>Why do I not see any data in 'Data Usage' for one of my interfaces?
+This is likely due to the the `vnstat` service not having enough data for the interface(s). Try running the command `vnstat`, and look for the interface that is missing data. If you do not see the interface, run the command `sudo vnstat -i wlan1 --live` (replace `wlan1` with the desired interface). If you see data, then add the interface with the following command: `sudo vnstat -i wlan1 --add`. You should see the following output:
+```
+Adding interface "wlan1" to database for monitoring.
+vnStat daemon will automatically start monitoring "wlan1" within 5 minutes if the daemon process is currently running.
+```
+You can leave the service running as is, or restart it using the command `sudo service vnstat restart`. Eventually, you should see data for the desired interface when running the `vnstat` command, and will eventually see data in the graph(s).
+
 ## <a name="pihole"></a>How do I integrate RaspAP with Pi-hole?
 There have been several discussions around integrating RaspAP with Pi-hole, with the end goal of hosting a complete AP and ad-blocker on a single device. Both projects rely on `dnsmasq`, so integration between them is tricky. There are now several options available to users of RaspAP.
 
@@ -746,7 +755,7 @@ You may also use RaspAP's built-in WireGuard logging facility. On the **WireGuar
 output in the tab and look for any errors.
 
 !!! tip "Tip"
-    The debug log facility queries the `systemd` journal with a one-time execution of `journalctl --identifier wg-quick`. If you want to update this log output, simply enable the option again. You may also execute this command directly from the shell, if you wish.
+    The [debug log](troubleshooting.md#debug-log) facility queries the `systemd` journal with a one-time execution of `journalctl --identifier wg-quick`. If you want to update this log output, simply enable the option again. You may also execute this command directly from the shell, if you wish.
 
 Finally, you may check and verify the WireGuard config itself, including PostUp / PostDown rules, by executing `sudo cat /etc/wireguard/wg0.conf`.
 

docs/issues.md

@@ -17,7 +17,7 @@ You can help us improve this project by accurately describing defects. To that e
 
 1. Please read and follow the [Code of Conduct](https://github.com/RaspAP/raspap-webgui/blob/master/CODE_OF_CONDUCT.md). 
 2. Provide useful detail to reproduce your issue. "Doesn't work" or "not working" is not a valid report. Here's an example [model bug report](https://github.com/RaspAP/raspap-webgui/issues/1451) and [feature request](https://github.com/RaspAP/raspap-webgui/issues/1498) [[2]](https://github.com/RaspAP/raspap-webgui/issues/1734).
-3. Generate a [debug log](ap-basics.md#debug-log) and upload the contents to [Pastebin](https://pastebin.com/). 
+3. Generate a [debug log](troubleshooting.md#debug-log) and upload the contents to a text sharing service, like [Pastebin](https://pastebin.com/). 
 4. If an issue is unclear or needs further information, it will be labeled with `question` and `awaiting-user`.
 5. Issues that becomes stale due to inactivity are automatically managed by stale-bot.