NxFilter Tutorial

Install NxFilter on Linux

NxFilter can run on Linux and other Unix-like operating systems. We provide installation packages in DEB and RPM formats, and you can also install it manually using the ZIP package.

We've found that some Linux systems are missing the 127.0.0.1 loopback address. If your system doesn't have 127.0.0.1 configured, NxFilter may not function properly.

Using the auto-install script

For Debian-based systems, you can run the auto-install script directly from our website with the following command:


	bash -c "$(curl -s https://nxfilter.org/scripts/install-nxfilter-ubuntu.sh)"

We have a Youtube video tutorial for using the auto-install script, Install NxFilter on Ubuntu by auto-install script

We also have the auto-install scripts for other products, Running auto-install, auto-update scripts from NxFilter website.

Using the DEB package

Starting with Ubuntu 18.04, the systemd-resolved service occupies UDP/53 port. You need to disable this service and configure an alternative DNS server before installing NxFilter. To stop and disable systemd-resolved, run the following commands:


	sudo service systemd-resolved stop
	sudo systemctl disable systemd-resolved
	sudo rm /etc/resolv.conf
	sudo sh -c "echo nameserver 8.8.8.8 > /etc/resolv.conf"

You may need to install JRE if you don't have it.


	sudo apt install openjdk-11-jre-headless

Download the latest package using curl, and then install it with apt.


	curl -O http://pub.nxfilter.org/nxfilter-4.7.3.9.deb
	sudo apt install ./nxfilter-4.7.3.9.deb

After installing it, enable and start the service.


	sudo systemctl enable nxfilter
	sudo systemctl start nxfilter

You can monitor the startup process by running the following command:


	tail -f /nxfilter/log/nxfilter.log

When you install NxFilter for the first time, it needs to create the Jahaslist database and populate it. This process may take up to a minute. During this time, you may not be able to access the admin GUI. Do not stop the service until the initialization process is complete.

When you install NxCloud or NxRelay using the DEB package, use 'nxcloud' or 'nxrelay' for your systemctl commands instead of 'nxfilter'.

Using the ZIP package

You can install NxFilter on other Linux or Unix-like systems using the ZIP package.

Download nxfilter-4.7.3.9.zip
Extract the zip file into /nxfilter
Go to /nxfilter/bin and run 'chmod +x *.sh'
Run startup.sh with root permission

To run NxFilter as a daemon, add the -d flag when starting it: /nxfilter/bin/startup.sh -d.

DEB and RPM repository

Rob Asher has created and currently maintains dedicated DEB and RPM package repositories for NxFilter, available at: https://github.com/DeepWoods/DeepWoods-Repositories

In this page