Update README.MD
This commit is contained in:
@@ -1,49 +1,132 @@
|
|||||||
# OpenWRT images 📦
|
# OpenWRT images 📦
|
||||||
|
|
||||||
Find the images under Releases section
|
Find the images under the Releases section.
|
||||||
|
|
||||||
## Whaaat ? 👾
|
## Whaaat ? 👾
|
||||||
|
|
||||||
This repository contains self-built OpenWRT images for LinkSys WRT1200-AC and Asus RT-AX53U devices.
|
This repository contains self-built OpenWRT images for Linksys WRT1200AC, Linksys WRT3200ACM, and Asus RT-AX53U devices.
|
||||||
|
|
||||||
OpenWRT is a Linux-based open-source operating system designed to run on a wide range of devices, including routers.
|
OpenWRT is a Linux-based open-source operating system designed to run on a wide range of devices, including routers.
|
||||||
|
|
||||||
|
|
||||||
## Usage 🔨
|
## Usage 🔨
|
||||||
|
|
||||||
|
To use these images, download the appropriate image file for your device and flash it onto your router.
|
||||||
|
|
||||||
To use these images, you'll need to download the appropriate image file for your device and flash it onto your router.
|
Please note that flashing your router can be risky, and you should only do so if you know what you are doing.
|
||||||
|
|
||||||
Please note that flashing your router can be risky, and you should only do so if you know what you're doing.
|
|
||||||
|
|
||||||
Make sure to follow the instructions carefully and make a backup of your current firmware before proceeding.
|
Make sure to follow the instructions carefully and make a backup of your current firmware before proceeding.
|
||||||
|
|
||||||
|
|
||||||
## Features ⛲
|
## Features ⛲
|
||||||
|
|
||||||
- Argon theme
|
- Argon theme
|
||||||
- Dashboard
|
- Dashboard
|
||||||
- Bandwith monitor
|
- Bandwidth monitor
|
||||||
|
- AdGuard Home
|
||||||
|
- banIP
|
||||||
|
- ClamAV
|
||||||
|
- DAWN
|
||||||
|
- File browser and file manager
|
||||||
|
- LuCI 2FA plugin
|
||||||
|
|
||||||
## Packages 📦
|
## Packages 📦
|
||||||
|
|
||||||
luci-mod-dashboard
|
- luci-app-adguardhome
|
||||||
luci-app-adblock
|
- luci-app-advanced-reboot
|
||||||
luci-app-advanced-reboot
|
- luci-app-banip
|
||||||
luci-app-attendedsysupgrade
|
- luci-app-commands
|
||||||
luci-app-banip
|
- luci-app-clamav
|
||||||
luci-app-commands
|
- luci-app-dawn
|
||||||
luci-app-clamav
|
- luci-app-filebrowser
|
||||||
luci-app-filebrowser
|
- luci-app-filemanager
|
||||||
luci-app-filemanager
|
- luci-app-nlbwmon
|
||||||
luci-app-nlbwmon
|
- luci-app-package-manager
|
||||||
luci-app-package-manager
|
- luci-app-statistics
|
||||||
luci-app-statistics
|
- luci-app-wifischedule
|
||||||
luci-app-wifischedule
|
- luci-mod-dashboard
|
||||||
|
- luci-plugin-2fa
|
||||||
|
|
||||||
## Disclamer ⚠️
|
## Post-install notes ⚙️
|
||||||
|
|
||||||
|
Some included services need to be configured manually after flashing.
|
||||||
|
|
||||||
|
### AdGuard Home
|
||||||
|
|
||||||
|
AdGuard Home is available at:
|
||||||
|
|
||||||
|
`http://router-ip:3000`
|
||||||
|
|
||||||
|
Replace `router-ip` with your router IP address.
|
||||||
|
|
||||||
|
AdGuard Home needs to be configured before use.
|
||||||
|
|
||||||
|
To allow AdGuard Home to listen on DNS port `53`, move `dnsmasq` away from port `53`:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
uci set dhcp.@dnsmasq[0].port='0'
|
||||||
|
uci commit dhcp
|
||||||
|
/etc/init.d/dnsmasq restart
|
||||||
|
```
|
||||||
|
|
||||||
|
After that, configure AdGuard Home and set it to listen on port `53`.
|
||||||
|
|
||||||
|
### banIP
|
||||||
|
|
||||||
|
banIP needs to be enabled manually over SSH:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
/etc/init.d/banip enable
|
||||||
|
/etc/init.d/banip start
|
||||||
|
```
|
||||||
|
|
||||||
|
After starting banIP, configure feeds and WAN interface in LuCI.
|
||||||
|
|
||||||
|
### ClamAV
|
||||||
|
|
||||||
|
ClamAV is included, but it still needs to be configured in LuCI.
|
||||||
|
|
||||||
|
Recommended things to check:
|
||||||
|
|
||||||
|
- database directory
|
||||||
|
- scan limits
|
||||||
|
- memory usage
|
||||||
|
- logging
|
||||||
|
- signature database updates
|
||||||
|
|
||||||
|
ClamAV on a router is mainly useful for scanning files, for example USB storage or shared files. It does not automatically scan all network traffic.
|
||||||
|
|
||||||
|
### LuCI 2FA
|
||||||
|
|
||||||
|
The LuCI 2FA plugin is included, but it needs to be configured manually.
|
||||||
|
|
||||||
|
Important note:
|
||||||
|
|
||||||
|
**2FA does not currently work with the Argon theme login page.**
|
||||||
|
|
||||||
|
Use the default Bootstrap theme when enabling LuCI 2FA.
|
||||||
|
|
||||||
|
If you get locked out after enabling 2FA, disable it over SSH:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
uci set luci_plugins.global.enabled='0'
|
||||||
|
uci set luci_plugins.global.auth_login_enabled='0'
|
||||||
|
uci commit luci_plugins
|
||||||
|
/etc/init.d/rpcd restart
|
||||||
|
/etc/init.d/uhttpd restart
|
||||||
|
```
|
||||||
|
|
||||||
|
## Notes 📝
|
||||||
|
|
||||||
|
The following plugins/services are included but need manual configuration after flashing:
|
||||||
|
|
||||||
|
- AdGuard Home
|
||||||
|
- banIP
|
||||||
|
- ClamAV
|
||||||
|
- LuCI 2FA
|
||||||
|
|
||||||
|
AdGuard Home also requires `dnsmasq` DNS to be disabled or moved away from port `53`.
|
||||||
|
|
||||||
|
## Disclaimer ⚠️
|
||||||
|
|
||||||
Use these images at your own risk.
|
Use these images at your own risk.
|
||||||
|
|
||||||
The author of this repository is not responsible for any damage or loss of data that may occur as a result of using these images.
|
The author of this repository is not responsible for any damage, bricked devices, configuration issues, or loss of data that may occur as a result of using these images.
|
||||||
Reference in New Issue
Block a user