| Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision |
| docs:guide-user:services:captive-portal:wireless.hotspot.nodogsplash [2018/11/16 16:28] – mwarning | docs:guide-user:services:captive-portal:wireless.hotspot.nodogsplash [2019/04/30 10:59] – [Nodogsplash Configuration File] someothertime |
|---|
| |
| Official documentation: https://nodogsplashdocs.readthedocs.io/en/stable/ | Official documentation: https://nodogsplashdocs.readthedocs.io/en/stable/ |
| | |
| | ===== Overview ===== |
| | |
| | The nodogsplash captive portal runs as a service that manages client traffic over a router by adjusting firewall rules based on client tracking tools that interact with a users browser and client network requests. |
| | |
| | In order to fully setup user and password authentication or more complex configuration. You will need to read the linked documentation to gain better understanding of the layers that are involved. |
| | |
| | Usually this will require some basic script/web source editing and web server setup and modification. On Openwrt if user credentials are to be local to the router this will also need to be considered. |
| | |
| |
| ===== Installation ===== | ===== Installation ===== |
| </code> | </code> |
| |
| By default nodogsplash is disabled after install; change "option enabled" in /etc/config/nodogsplash from 0 to 1 to enable it. | In **/etc/config/nodogsplash** ensure option enabled is 1 |
| | <code> |
| | option enabled 1 |
| | </code> |
| |
| Use "/etc/init.d/nodogsplash start" to start NDS. Use "/etc/init.d/nodogsplash enable" to auto-start it in the future. | Enable and start the nodogsplash ( NDS ) service. |
| | <code> |
| | /etc/init.d/nodogsplash enable |
| | /etc/init.d/nodogsplash start |
| | </code> |
| |
| Use "/usr/bin/ndsctl status" to check if nodogsplash is up. | Some useful commands are listed below. |
| | <code> |
| | /usr/bin/ndsctl status ( check if nodogsplash is up ) |
| | /usr/bin/ndsctl clients ( list connected clients and status ) |
| | /usr/bin/ndsctl deauth 192.168.1.10 ( useful for testing ) |
| | </code> |
| |
| See https://github.com/nodogsplash/nodogsplash#7-debugging-nodogsplash about how to debug start-up issues. | See https://github.com/nodogsplash/nodogsplash#7-debugging-nodogsplash about how to debug start-up issues. |
| Older versions use ''/etc/nodogsplash/nodogsplash.conf'', while versions starting at 0.9_beta9.9.9-5 in Chaos Calmer 15.05 use UCI with ''/etc/config/nodogsplash''. | Older versions use ''/etc/nodogsplash/nodogsplash.conf'', while versions starting at 0.9_beta9.9.9-5 in Chaos Calmer 15.05 use UCI with ''/etc/config/nodogsplash''. |
| |
| The "/etc/config/nodogsplash" config file can be seen [[https://github.com/openwrt-routing/packages/blob/master/nodogsplash/files/nodogsplash.config|here]], and is documented below. | The "/etc/config/nodogsplash" config file can be seen [[https://github.com/openwrt-routing/packages/blob/master/nodogsplash/files/nodogsplash.config|here]] or [[https://raw.githubusercontent.com/nodogsplash/nodogsplash/master/openwrt/nodogsplash/files/etc/config/nodogsplash|here]], and is documented below. |
| |
| Below is a documented version of the "/etc/config/nodogsplash" file. This UCI file is automatically turned into a temporary config file with the old format when nodogsplash starts. That file can be viewed in /tmp/etc/. | Below is a documented version of the "/etc/config/nodogsplash" file. This UCI file is automatically turned into a temporary config file with the old format when nodogsplash starts. That file can be viewed in /tmp/etc/. |