search

spamhaus / rspamd-dqs

Spamhaus code for RSPAMD Plugin. See https://docs.spamhaustech.com/40-real-world-usage/Rspamd/000-intro.html for instructions
Apache License 2.0
60 stars 11 forks source link

readme needs to be corrected ... #30

Closed urmel1960 closed 3 months ago

urmel1960 commented 3 months ago

The readme file of this repository contains a number of lines of code that the user should execute on his computer.

You can easily copy these lines of code by using the small icon on the top right.

Unfortunately, the specified commands also contain invalid things such as a "$" character at the beginning or the console output that is only generated when the actual command is entered and executed.

As a user, you only notice this when you follow the instructions and then regularly receive a series of complex error messages on your server console.

It would be great if the readme could be revised accordingly by someone who knows the correct commands.

ricalfieri commented 3 months ago

Hello,

if a user does not understand that he has to NOT copy the "$" or the "#" he is probably also not competent enough to run a mail server

urmel1960 commented 3 months ago

Arrogance is a strange disease. One of the worst symptoms is the conviction that you are better than others.

reinob commented 3 months ago

It is very common to prefix displayed commands (e.g. in instructions such as the README) with "$" or "#" to indicate whether the command should be run as user or as root, respectively (this is also explained in that very document).

The instructions are there to be read, and the reader can choose, if so desired, to copy/paste or to type the commands themselves. I don't know if github allows some form of markup to display the "$" or "#" but ignoring it when copying using the copy-button.

In any case, IMHO the "issue" is not with the content of the README (which is a text file you can read outside of github, with any text editor). The "issue" would be with the copy-button github provides.