https://github.com/oofnikj/docker-openwrt
OpenWrt running in Docker
https://github.com/oofnikj/docker-openwrt
docker openwrt raspberry-pi router
Last synced: 2 days ago
JSON representation
OpenWrt running in Docker
- Host: GitHub
- URL: https://github.com/oofnikj/docker-openwrt
- Owner: oofnikj
- License: gpl-2.0
- Created: 2020-02-18T08:01:53.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-19T12:21:53.000Z (almost 2 years ago)
- Last Synced: 2024-11-12T12:48:21.367Z (6 months ago)
- Topics: docker, openwrt, raspberry-pi, router
- Language: Shell
- Homepage:
- Size: 117 KB
- Stars: 310
- Watchers: 14
- Forks: 63
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - oofnikj/docker-openwrt - OpenWrt running in Docker (raspberry-pi)
README
# OpenWrt in Docker
[](https://gitlab.com/oofnik/docker-openwrt/-/commits/master)
Inspired by other projects that run `hostapd` in a Docker container. This goes one step further and boots a full network OS intended for embedded devices called [OpenWrt](https://openwrt.org/), so you can manage all aspects of your network from a user-friendly web UI.
For Raspberry Pi-specific instructions, see [Building on Raspberry Pi](docs/rpi.md).
## Dependencies
* docker
* iw
* iproute2
* envsubst (part of `gettext` or `gettext-base` package)
* dhcpcd
## Build
Pre-built images are available on Docker Hub at `oofnik/openwrt`. Alternatively, build the image yourself using the `make build` target:
```
$ make build
```
If you want additional OpenWrt packages to be present in the base image, add them to the Dockerfile. Otherwise you can install them with `opkg` after bringing up the container.
A searchable package list is available on [openwrt.org](https://openwrt.org/packages/table/start).
## Configure
Initial configuration is performed using a config file, `openwrt.conf`. Values read from this file at runtime are used to generate OpenWrt format config files from templates in `etc/config/*.tpl`.
You can use the included `openwrt.conf.example` as a baseline, which explains the values.
It is also possible to make persistent changes in the UI and download a backup of your full router configuration by navigating to System > Backup / Flash Firmware and clicking Backup.
## Run
Prepare your `openwrt.conf` file as explained above and execute the `make run` target:
```
$ make run
```
If you arrive at `* Ready`, point your browser to http://openwrt.home (or whatever you set in `LAN_DOMAIN`) and you should be presented with the login page. The default login is `root` with the password set as `ROOT_PW`.
To shut down the router, press `Ctrl+C`. Any settings you configured or additional packages you installed will persist until you run `make clean`, which will delete the container.
## Install / Uninstall
```
$ make install
```
Install and uninstall targets for `systemd` have been included in the Makefile.
Installing will create and enable a service pointing to wherever you cloned this directory and execute `run.sh` on boot.
## Cleanup
```
$ make clean
```
This will delete the container and all associated Docker networks so you can start fresh if you screw something up.
---
## Notes
### Hairpinning
In order for WLAN clients to see one another, OpenWrt bridges all interfaces in the LAN zone and sets hairpin mode (aka [reflective relay](https://lwn.net/Articles/347344/)) on the WLAN interface, meaning packets arriving on that interface can be 'reflected' back out through the same interface.
`run.sh` tries to handle this if `WIFI_HAIRPIN` is set to true, and prints a warning if it fails.
Hairpin mode may not be needed in all cases, but if you experience an issue where Wi-Fi clients are unable to see each other despite AP isolation being disabled, this may fix it.
### Network namespace
For `hostapd` running inside the container to have access to the physical wireless device, we need to set the device's network namespace to the PID of the running container. This causes the interface to 'disappear' from the primary network namespace for the duration of the container's parent process. `run.sh` checks if the host is using NetworkManager to manage the wifi interface, and tries to steal it away if so.
### Addtional Docker services
Additional containers that are run alongside OpenWrt on the same physical host are directly accessible on the LAN. No port forwarding to the host is necessary. It's recommended to add static hostnames to be able to resolve local services on your LAN.
See [Monitoring with InfluxDB + Grafana](monitoring/README.md) for example.
### Upgrading
Read the [upgrade guide](docs/upgrade.md).
---
### Troubleshooting
Logs are redirected to `stdout` so the Docker daemon can process them. They are accessible with:
```
$ docker logs ${CONTAINER} [-f]
```
As an alternative to installing debug packages inside your router, it's possible to execute commands available to the host inside the network namespace. A symlink is created in `/var/run/netns/` for convenience:
```
$ sudo ip netns exec ${CONTAINER} tcpdump -vvi any
```
---
## [OpenVPN Howto](docs/vpn.md)
## [Bandwidth Monitoring Howto](docs/monitoring.md)
## [Monitoring with InfluxDB + Grafana](monitoring/README.md)
## [IPv6 Notes](docs/ipv6.md)