Akismet documentation

[datapolitical]

I've tried setting up akismet but even the "verified spam" submissions from their API keep getting through, so obviously it's not actually working.

I wish there was just a simple writeup with actual examples because the issues on here have conflicting information about how the akismet account should be set up (whether the site URL should be your Staticman instance or your website).

It feels like a lot of people want to use this, and it works, but no one who knows how to get it working has really taken the time to document exactly, step by step, how to do so with examples. Even the blogs about Staticman don't have much about it.

If something is a real feature the docs should be good enough that people can follow it easily and get it working, otherwise you're just asking for people to be frustrated.

[datapolitical]

Solved it. You need to set all the akismet variables in the docs for site config.

but now main.js isn’t handling a spam error properly.

[RyanTG]

Yeah, I'm either misunderstanding the docs or the docs aren't telling the full story.

https://staticman.net/docs/spam says to simply add the AKISMET_API_KEY and AKISMET_SITE into the staticman config variables (in heroku, in my case). And that's it.

But that's not working for me. Can you state more clearly what you also did? Did you add things to your jekyll config.yml and/or staticman.yml files (if you're using jekyll)?

I just looked up one of your repos, and saw that you have this in staticman.yml:

# Akismet spam detection
          akismet:
            enabled: true
            author: "name"
            authorEmail: "email"
            authorUrl: "url"
            content: "message"

Is that what fixed it? That is not in the official staticman sample yml, nor in the docs, so I wouldn't have known to do that.

[datapolitical]

Yes, you need to document for akismet what fields you are using basically.

it’s in the documentation on the staticman website I believe, but it’s not explained well. I think I figured it out only by looking at somebody else’s implementation.

[RyanTG]

Ha nice. Thanks for passing on the intel.

[alexwaibel]

Yes, you need to document for akismet what fields you are using basically.

it’s in the documentation on the staticman website I believe, but it’s not explained well. I think I figured it out only by looking at somebody else’s implementation.

The documentation website could definitely use some improvement, especially around the spam filtering options. Unfortunately I haven't had much time lately to tackle this but I'd happily accept a PR if you have suggestions to clear up any areas you found confusing.

https://github.com/eduardoboucas/staticman.net

[RyanTG]

Thanks, @alexwaibel. Overall the docs are good! But yeah, this section could use some additional info. I might have time for a PR in a little bit.

I also struggled with formatting the keys in heroku. So maybe I can help explain that better in the docs.

[anaxonda]

What is the correct URL to use for akismet? I have a page hosted on gitlab pages and am unable to get the default akismet spam comment to be blocked.

I have tried three URLs:

• gitlab.io/mywebsite (the default gitlab pages URL)
• mydomain.com (my personal domain where the site is accessed at)
• mystaticmanheroku.herokuapp.com (heroku instance where I have staticman hosted)

I have set AKISMET_API_KEY and AKISMET_SITE variables accordingly in my heroku instance, and updated my staticman.yml for the correct fields.

Does the akismet integration work with gitlab pages?

[datapolitical]

The correct URL is your domain, the full URL including https. Is your code public? It will be much easier to debug if we can actually look at the repository, or at least look at the website.

…

On Tue, Jan 11 2022 at 7:51 AM, anaxonda < ***@***.*** > wrote: What is the correct URL to use for akismet? I have a page hosted on gitlab pages and am unable to get it work. I have tried three URLs: * gitlab.io/mywebsite (the default gitlab pages URL) * mydomain.com (my personal domain where the site is accessed at) * mystaticmanheroku.herokuapp.com (heroku instance where I have staticman hosted) I have set AKISMET_API_KEY and AKISMET_SITE variables accordingly in my heroku instance, and updated my staticman.yml for the correct fields. Does the akismet integration work with gitlab pages? — Reply to this email directly, view it on GitHub ( #414 (comment) ) , or unsubscribe ( https://github.com/notifications/unsubscribe-auth/AAFKE7POAAEE4TLVE7KCD2TUVRGYRANCNFSM4ZDUE6JQ ). You are receiving this because you authored the thread. Message ID: <eduardoboucas/staticman/issues/414/1010097416 @ github. com>