Негізгі параметрлер (kor-elf-shield.toml)

Әдепкі бойынша негізгі параметрлер осында:

/etc/kor-elf-shield/kor-elf-shield.toml

Бірақ бағдарламаны жалауша арқылы --config іске қосуға және өз жолыңызды көрсетуге болады. Мысалы:

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

Бұл өзгерістер енгізу керек /etc/systemd/system/kor-elf-shield.service

[Unit]
Description=kor-elf-shield
After=network.target

[Service]
-ExecStart=/usr/sbin/kor-elf-shield start
-ExecStop=/usr/sbin/kor-elf-shield stop
+ExecStart=/usr/sbin/kor-elf-shield --config=/my/path/configs/kor-elf-shield.toml start
+ExecStop=/usr/sbin/kor-elf-shield --config=/my/path/configs/kor-elf-shield.toml stop

[Install]
WantedBy=sysinit.target

Және өңдеу /etc/kor-elf-shield.logrotate

/var/log/kor-elf-shield.log {
    rotate 3
    weekly
    compress
    maxsize 100M
    missingok
    notifempty
    postrotate
-        /usr/sbin/kor-elf-shield reopen_logger
+        /usr/sbin/kor-elf-shield --config=/my/path/configs/kor-elf-shield.toml reopen_logger
    endscript
}

Толыққанды көшірмесі параметрлер файлы (kor-elf-shield.toml) осында орналасқан.

Бұл файлда бірнеше бөлімдер бар:


Негізгі параметрлер

Бұл параметрлер файлдың басында: "Log", "ОЖ-ге тән Параметрлер", "басқа параметрлерге Жолдар"бөлімдеріне дейін болуы керек.

Параметр testing
Мағынасы true немесе false
Әдепкі бойынша true
Сипаттама Сынақ режимін қамтиды. Егер сынақ режимі қосулы болса, онда параметрде көрсетілген минуттардан "testing_interval"кейін nftables көмегімен ережелерді тазартатын бағдарлама өшіріледі.
true  - қамтиды
false - өшіреді
Мысалдар
testing = true
testing = false
Параметр testing_interval
Мағынасы 1-ден 30000-ға дейін
Әдепкі бойынша 5
Сипаттама Сынақ режимінде іске қосылған бағдарлама қанша минуттан кейін өшетінін көрсетіңіз.
Мысалдар
testing_interval = 1
testing_interval = 5
testing_interval = 60
testing_interval = 30000
Параметр language
Мағынасы ru, kk, en
Әдепкі бойынша ru
Сипаттама Тілді көрсетіңіз. Журналдарға әсер етпейді. Журналдар ағылшын тілінде жазылады.
Қазіргі уақытта тілдерге қолдау көрсетіледі:
ru  - орыс
kk - қазақ
en - ағылшын
Мысалдар
language = "ru"
language = "kk"
language = "en"
Параметр fallback_language
Мағынасы ru, kk, en
Әдепкі бойынша ru
Сипаттама Екінші тіл, егер кенеттен қазіргі тілде аударма болмаса. Опцияда бар барлық мәндер қол жетімді language. Бірақ біз көрсетуді ұсынамыз "ru"немесе "en".
Мысалдар
language = "ru"
language = "en"
Параметр pid_file
Мағынасы Файл жолын көрсетіңіз
Әдепкі бойынша /var/run/kor-elf-shield/kor-elf-shield.pid
Сипаттама Pid файлы жасалатын жол. Жол абсолютті болуы керек. Салыстырмалы жол қатені тудырады! Соңында міндетті түрде көрсетілуі керек .pid.
Мысалдар
pid_file = "/var/run/kor-elf-shield/kor-elf-shield.pid"
Параметр socket_file
Мағынасы Файл жолын көрсетіңіз
Әдепкі бойынша /var/run/kor-elf-shield/kor-elf-shield.sock
Сипаттама Розетка файлы жасалатын жол. Жол абсолютті болуы керек. Салыстырмалы жол қатені тудырады! Соңында міндетті түрде көрсетілуі керек .sock.
Мысалдар
socket_file = "/var/run/kor-elf-shield/kor-elf-shield.sock"
Параметр data_dir
Мағынасы Каталог жолын көрсетіңіз
Әдепкі бойынша /var/lib/kor-elf-shield/
Сипаттама Қолданбаның тұрақты деректер каталогы (state): жергілікті дерекқор, кэш/индекстер, күй файлдары және басқа қызметтік файлдар. Демон жұмыс істеп тұрған пайдаланушыға жазу үшін қол жетімді болуы керек. Егер каталог жоқ болса, ол жасалады.
Мысалдар
data_dir = "/var/lib/kor-elf-shield/"

Log

Алдымен осы бөлімнің параметрлерін көрсету [log]керек, содан кейін осы бөлімнің қалған параметрлерін көрсету керек. Мысал:

[log]
enabled = true
level = "info"
Параметр enabled
Мағынасы true немесе false
Әдепкі бойынша true
Сипаттама Журналдарды қамтиды.
true  - қамтиды
false - өшіреді
Мысалдар
enabled = true
enabled = false
***
Параметр level
Мағынасы debug, info, warn, error, fatal
Әдепкі бойынша info
Сипаттама Журналдарды жүргізу деңгейі:
debug - Отладкаға арналған журналдар және production-да таңдамау ұсынылады.
info  - Егжей-тегжейлі жүргізу ұясы. Іске қосу, тоқтату және т. б. туралы ақпаратты жазады.
warn-қолданбаға кедергі келтірмейтін, бірақ назар аударуды қажет ететін ықтимал проблемалық жағдайлар туралы ескертулер.
қате-жұмыс кезінде пайда болған, бірақ бағдарламаны тоқтатуға әкелмеген қателер.
fatal-маңызды қателер, содан кейін бағдарлама аяқталады.
Мысалдар
level = "debug"
level = "info"
level = "warn"
level = "error"
level = "fatal"
***
Параметр development
Мағынасы true немесе false
Әдепкі бойынша false
Сипаттама Сынақ ортасында жөндеу үшін қажет. The productionәрқашан өшіру керек.
true  - қамтиды
false - өшіреді
Мысалдар
development = false
development = true
***
Параметр encoding
Мағынасы json немесе text
Әдепкі бойынша json
Сипаттама Деректерді журналға қандай форматта жазу керек:
json - Форматта json.
text - Қарапайым мәтін форматында. Журналдағы әрбір параметр бос орынмен бөлінеді. (ұсынылмайды)
Мысалдар
encoding = json
encoding = text
***
Параметр paths
Мағынасы Журналға жолдарды көрсетіңіз
Әдепкі бойынша ["/var/log/kor-elf-shield.log"]
Сипаттама Негізгі ұяларға арналған орындардың тізімі. Бірнеше жолды көрсетуге болады. Жол абсолютті болуы керек. Салыстырмалы жол қатені тудырады! Соңында міндетті түрде көрсетілуі керек .log.
Ерекшелік "stdout" және "stderr" бұл консольге деректерді шығару.

Егер біз стандартты мәнді өзгертетін болсақ, онда файлды жаңа жолдарға қарау және өңдеу /etc/logrotate.d/kor-elf-shield ұсынылады.
Мысалдар
paths = ["/var/log/kor-elf-shield.log"]
paths = ["/var/log/kor-elf-shield.log", "stdout"]
paths = ["/var/log/kor-elf-shield.log", "/mnt/other-server/kor-elf-shield.log", "stdout"]
***
Параметр log_error_paths
Мағынасы Журналға жолдарды көрсетіңіз
Әдепкі бойынша ["stderr"]
Сипаттама Логикалық қателіктерге арналған орындардың тізімі. Мысалы, логгер кейбір деректерді жаза алмады. Бірнеше жолды көрсетуге болады. Жол абсолютті болуы керек. Салыстырмалы жол қатені тудырады! Соңында міндетті түрде көрсетілуі керек .log.
Ерекшелік "stdout" және "stderr" бұл консольге деректерді шығару.

Егер біз стандартты мәнді өзгертетін болсақ, онда файлды жаңа жолдарға қарау және өңдеу /etc/logrotate.d/kor-elf-shield ұсынылады.
Мысалдар
paths = ["stderr"]
paths = ["/var/log/kor-elf-shield-error.log", "stderr"]
paths = ["/var/log/kor-elf-shield-error.log", "/mnt/other-server/kor-elf-shield-error.log", "stderr"]

ОЖ-ға тән параметрлер

Алдымен осы бөлімнің параметрлерін көрсету [binaryLocations]керек, содан кейін осы бөлімнің қалған параметрлерін көрсету керек. Мысал:

[binaryLocations]
nftables = "/usr/sbin/nft"
Параметр nftables
Мағынасы Жолды көрсетіңізnftables
Әдепкі бойынша /usr/sbin/nft
Сипаттама nftablesМүмкін сіздің ОЖ-де жол басқаша болуы мүмкін.
Мысалдар
nftables = "/usr/sbin/nft"
***
Параметр journalctl
Мағынасы Жолды көрсетіңіз journalctl
Әдепкі бойынша /bin/journalctl
Сипаттама journalctlМүмкін сіздің ОЖ-де жол басқаша болуы мүмкін.
Мысалдар
journalctl = "/bin/journalctl"
***
Параметр docker
Мағынасы Жолды көрсетіңіз docker
Әдепкі бойынша /usr/bin/docker
Сипаттама dockerМүмкін сіздің ОЖ-де жол басқаша болуы мүмкін.
Мысалдар
docker = "/usr/bin/docker"

Басқа параметрлерге жолдар

Алдымен осы бөлімнің параметрлерін көрсету [otherSettingsPath]керек, содан кейін осы бөлімнің қалған параметрлерін көрсету керек. Мысал:

[otherSettingsPath]
firewall = "/etc/kor-elf-shield/firewall.toml"
Параметр firewall
Мағынасы Параметрлерге жолды көрсетіңізfirewall
Әдепкі бойынша /etc/kor-elf-shield/firewall.toml
Сипаттама Firewall параметрлеріне жолды көрсетіңіз. Бұл параметрлерде біз қандай порттарды ашу немесе жабу керектігін көрсетеміз. Қандай IP мекенжайларын бұғаттауға болады немесе керісінше, олар ешқашан бұғатталмайды. Жол абсолютті болуы керек. Салыстырмалы жол қатені тудырады! Соңында міндетті түрде көрсетілуі керек .toml.
Параметрлер туралы firewall мына жерден танысуға болады.
Мысалдар
firewall = "/etc/kor-elf-shield/firewall.toml"
***
Параметр analyzer
Мағынасы Параметрлерге жолды көрсетіңіз analyzer
Әдепкі бойынша /etc/kor-elf-shield/analyzer.toml
Сипаттама Журналды талдау параметрлеріне жолды көрсетіңіз. Онда сіз парольді шамадан тыс қорғауды орната аласыз немесе журналдардағы аномалияға ескерту жасай аласыз. Жол абсолютті болуы керек. Салыстырмалы жол қатені тудырады! Соңында міндетті түрде көрсетілуі керек .toml.
Журналдарды талдау параметрлері туралы мына жерден танысуға болады.
Мысалдар
analyzer = "/etc/kor-elf-shield/analyzer.toml"
***
Параметр notifications
Мағынасы Параметрлерге жолды көрсетіңіз notifications
Әдепкі бойынша /etc/kor-elf-shield/notifications.toml
Сипаттама Хабарландыру параметрлеріне жолды көрсетіңіз. Жол абсолютті болуы керек. Салыстырмалы жол қатені тудырады! Соңында міндетті түрде көрсетілуі керек .toml.
Хабарландыру параметрлері туралы мына жерден танысуға болады.
Мысалдар
notifications = "/etc/kor-elf-shield/notifications.toml"
***
Параметр docker
Мағынасы Параметрлерге жолды көрсетіңіз docker
Әдепкі бойынша /etc/kor-elf-shield/docker.toml
Сипаттама Параметрлерге жол көрсетіңіз docker. Жол абсолютті болуы керек. Салыстырмалы жол қатені тудырады! Соңында міндетті түрде көрсетілуі керек .toml.
Хабарландыру параметрлері туралы мына жерден танысуға болады.
Мысалдар
docker = "/etc/kor-elf-shield/docker.toml"
***
Параметр blocklists
Мағынасы Параметрлерге жолды көрсетіңіз blocklists
Әдепкі бойынша /etc/kor-elf-shield/blocklists.toml
Сипаттама Құлыптау үшін IP мекенжайларының тізімдерін алу үшін параметрлерге жол көрсетіңіз. Салыстырмалы жол қатені тудырады! Соңында міндетті түрде көрсетілуі керек .toml.
Параметрлер туралы мына жерден танысуға болады.
Мысалдар
blocklists = "/etc/kor-elf-shield/blocklists.toml"
***
Параметр geoip
Мағынасы Параметрлерге жолды көрсетіңіз geoip
Әдепкі бойынша /etc/kor-elf-shield/geoip.toml
Сипаттама IP мекенжайлары туралы деректерді алу үшін параметрлерге жолды көрсетіңіз. Салыстырмалы жол қатені тудырады! Соңында міндетті түрде көрсетілуі керек .toml.
Параметрлер туралы мына жерден танысуға болады.
Мысалдар
geoip = "/etc/kor-elf-shield/geoip.toml"