Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Not possible to run nmap example without further steps #124

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

atiris
Copy link

@atiris atiris commented Apr 16, 2024

Currently, it is not possible to run the sudo /usr/bin/nmap -O {HOST.CONN} command given as an example in the Scripts section after a standard installation.

Such an example is, without further explanation, incorrect and problematic, since the fact that it does not work indicates to the user that something is wrong. In fact, it only needs to perform one more step on the server.

To clear up this confusion, I've added a description that clarifies that this kind of sudo command will only work if the server allows the zabbix user to run that command with sudo. An example is given in the Description field of script. The tests do not change in any way.

Explained all the steps needed to successfully execute the nmap command with sudo.
@jxlambda
Copy link

jxlambda commented Apr 16, 2024

It is not Zabbix's responsibility to teach you to set up and manage your system. This should not be included. Especially because that description is intended to describe the purpose of the scriptlet, not provide a help blurb.

@atiris
Copy link
Author

atiris commented Apr 16, 2024

Your answer could also be used as an argument to completely cancel all default entries in scripts. Or at least those that cannot be started since default scripts are not a user manual. (But really, why is the entry there if not to teach users how to configure and run such script?)

Of course, I learned it myself. By helping users see the necessary connections, I intended nothing more than to improve this software. You are right that the Description field should describe the purpose and functionality of the script. A note about the necessary steps to run the script is, I think, equally important. Since I think it's pretty counterproductive to give the user something that can't be run as an example, he could just have random words in the commands field and it would have a similar effect.

I'm sorry if my suggestion doesn't improve the user experience in any way, feel free to reject it, I'm not against it ;)

@jxlambda
Copy link

The scripts are there due to historic reasons, and were originally used for their purpose when some of the current day features didn't exist.

They are not there to teach anything either. That's what the user manual is for.

Again, this is not the right place to go about teaching people to configure and maintain their systems; that is the objective of your system's operator's handbook. Nor is the script description field appropriate for that purpose.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants