mirror of
https://github.com/openNDS/openNDS.git
synced 2026-01-14 14:27:53 -05:00
64 lines
2.3 KiB
ReStructuredText
64 lines
2.3 KiB
ReStructuredText
Installing openNDS
|
|
######################
|
|
|
|
OpenWrt
|
|
*******
|
|
|
|
* Have a router working with OpenWrt. At the time of writing, openNDS has been tested with OpenWrt 18.06.x, 19.7.x and Snapshot.
|
|
|
|
* It may or may not work on older versions of OpenWrt or on other kinds of Linux-based router firmware.
|
|
|
|
* Make sure your router is basically working before you try to install openNDS. In particular, make sure your DHCP daemon is serving addresses on the interface that openNDS will manage.
|
|
|
|
The default is br-lan but can be changed to any interface by editing the /etc/config/opennds file.
|
|
|
|
* To install openNDS, you may use the OpenWrt Luci web interface or alternatively, ssh to your router and run the command:
|
|
|
|
``opkg update``
|
|
|
|
followed by
|
|
|
|
``opkg install opennds``
|
|
|
|
* openNDS is enabled by default and will start automatically on reboot or can be started and stopped manually.
|
|
|
|
* If the interface that you want openNDS to manage is not br-lan,
|
|
edit /etc/config/opennds and set GatewayInterface.
|
|
|
|
* To start openNDS, run the following, or just reboot the router:
|
|
|
|
``service opennds start``
|
|
|
|
* To test the installation, connect a client device to the interface on your router that is managed by openNDS (for example, connect to the router's wireless lan).
|
|
|
|
Most client device operating systems and browsers support Captive Portal Detection (CPD) and the operating system or browser on that device will attempt to contact a pre defined port 80 web page.
|
|
|
|
CPD will trigger openNDS to serve the default splash page where you can click or tap Continue to access the Internet.
|
|
|
|
See the Authentication section for details of setting up a proper authentication process.
|
|
|
|
If your client device does not display the splash page it most likely does not support CPD.
|
|
|
|
You should then manually trigger openNDS by trying to access a port 80 web site (for example, google.com:80 is a good choice).
|
|
|
|
* To stop openNDS:
|
|
|
|
``service opennds stop``
|
|
|
|
* To uninstall openNDS:
|
|
|
|
``opkg remove opennds``
|
|
|
|
Debian
|
|
******
|
|
|
|
There isn't a package in the repository (yet). But we have support for a Debian package.
|
|
|
|
Requirements beside Debian tools are:
|
|
|
|
- libmicrohttpd-dev (>= 0.9.51) [avaiable in **stretch**]
|
|
|
|
But you can also compile libmicrohttpd your self if you're still running jessie or older.
|
|
|
|
To compile openNDS and create the Debian package, see the chapter "How to Compile openNDS".
|