Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
LoV432 authored Nov 5, 2023
1 parent 4485f65 commit b77c1e1
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Overview

This is a simple dashboard for OpenWrt that does the following things:
This is a simple dashboard for [OpenWrt](https://openwrt.org/) that does the following things:

1. Displays router uptime.
2. Keeps track of all PPPoE disconnects.
3. Monitors all devices that connect to the router*.
4. Shows real-time total bandwidth usage.
5. Provides real-time per-user bandwidth usage.
5. Shows real-time per-user bandwidth usage.

`*Note: Device tracking uses DHCP, so devices using static IP addresses will not show up.`

Expand Down Expand Up @@ -47,7 +47,7 @@ services:
restart: unless-stopped
```
After running this configuration, the WebUI will be accessible at `http://localhost:3000`.
After running this container, the WebUI will be accessible at `http://localhost:3000`.

## OpenWrt Setup

Expand Down Expand Up @@ -113,4 +113,4 @@ The script will generate a password, which you'll need to add to your `docker-co

### Additional Configuration

In some cases, you might need to disable DNS rebind protection. You can do this from the "Network > DHCP and DNS" settings in your OpenWrt router's configuration.
In some cases, you might need to disable DNS rebind protection. You can do this from the "Network > DHCP and DNS" settings in your OpenWrt router's web interface.

0 comments on commit b77c1e1

Please sign in to comment.