Syslifters / sysreptor

Fully customisable, offensive security reporting solution designed for pentesters, red teamers and other security-related people alike.
https://docs.sysreptor.com
Other
1.34k stars 131 forks source link

Inconsistent spell checking #288

Closed 7MinSec closed 1 month ago

7MinSec commented 1 month ago

Hello,

I'm relatively new to having a pro account and my understanding is spell check should be automatically on as I go about writing reports, right? I'm noticing several instances like this where the incorrectly spelled word will eventually get underlined, or might get underlined if I move to a different section of the report and come back again.

image

Is there anything I need to check or hard-set in the config file(s)? I see in my instance that I'm a couple versions behind the latest so I'll do an upgrade today too and see if that helps.

Thanks, Brian

aronmolnar commented 1 month ago

Here's some guidance to troubleshoot. Maybe you can provide more information after looking through all steps?

The spell check requires an additional docker container. Users who upgraded from Community might not have started this container. You can check if it runs using docker ps and see if the "sysreptor-languagetool" container is up and running (and healthy).

Additionally, the Spell check could be disabled using this button in markdown editors:

image

(The white frame means it's enabled.)

The editor sends your text to the languagetool docker container. You should see this in the network tab of your browser. The return status code should be 200 (otherwise, there is probably an error).

image

I see, however, that the spell check doesn't seem to work within the HTML tags like in your example.

image

(Line 1 is parsed correctly, line 2 not.)
We will have a look at this.

In your case, I don't think that is a configuration issue (find spell check related configuration options here).
Upgrading to the latest version might also help.

7MinSec commented 1 month ago

Hi there,

Thanks as always for your great help. Steps I took:

image

Unless you want to keep this open for the figcaption issue, I think I'm good to go and can close this.

Thanks again, Brian

MWedl commented 1 month ago

The reason why spellchecking words in figcaption does not work, is because we do not perform spellchecks inside HTML code blocks, only in markdown structures. This is a limitation of our markdown parser, as we do not further parse the HTML to separate tags from text.

7MinSec commented 1 month ago

OK I'll just keep a close eye on spelling for my captions. Thanks!