Console commands

Attention: most commands require root access!

Launching the program

The program can be run directly from the command line.:

kor-elf-shield start

If you want to run a program where the configuration path will differ from the default:

kor-elf-shield --config=/my/path/configs/kor-elf-shield.toml start

Attention: if we run a program with a parameter --config, then this parameter will need to be specified in all console commands.

 

Stop the program

The program can be stopped from the command line:

kor-elf-shield stop

Attention: The program will stop and clear the nftables rules behind it.

 

Checking the program launch

To check and receive program startup data, you can run the command:

kor-elf-shield status

 

Checking the configuration

This command was added in version 0.14.0. After changing the settings and before restarting the program, you can check the correctness of the settings using the following command:

kor-elf-shield config test

 

Find out the program version

To find out the program version, run the command:

kor-elf-shield --version

kor-elf-shield -v

 

Find out the list of commands

Run the command:

kor-elf-shield --help
kor-elf-shield -h

 

Reopen the file for logging

Run the command:

kor-elf-shield reopen_logger

 

Notifications

To view the number of notifications in the deferred queue, run the command:

kor-elf-shield notifications queue count

To clear the notification queue, run the command:

kor-elf-shield notifications queue clear

 

Blocking

To add an IP address to the blocked list, run the command:

kor-elf-shield block add 192.168.1.1 
kor-elf-shield block add 192.168.1.1 --seconds=600
kor-elf-shield block add 192.168.1.1 --port 80/tcp
kor-elf-shield block add 192.168.1.1 --port 80/tcp --seconds=60

If you want to unblock an IP address that was added via a command "kor-elf-shield block add ..." or that was blocked by the password protection system, run the command:

kor-elf-shield block delete 192.168.1.1

If you want to unblock all IP addresses that were added via the command "kor-elf-shield block add ..." or that were blocked by the password protection system, run the command:

kor-elf-shield clear

 

Getting IP address data

Run the command:

kor-elf-shield geoip info 192.168.1.1

To manually update the GeoIP database, run the command:

kor-elf-shield geoip refresh