https://github.com/mcorbin/commentator

A simple commenting system for your blog.
https://github.com/mcorbin/commentator

blog comment commenting s3

Last synced: 3 months ago
JSON representation

A simple commenting system for your blog.

• Host: GitHub
• URL: https://github.com/mcorbin/commentator
• Owner: mcorbin
• License: epl-2.0
• Created: 2020-11-07T23:37:36.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-05-20T17:54:53.000Z (about 3 years ago)
• Last Synced: 2024-12-28T15:13:47.521Z (5 months ago)
• Topics: blog, comment, commenting, s3
• Language: HTML
• Homepage:
• Size: 7.15 MB
• Stars: 31
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Commentator

A commenting system for your blog or website. Comments are stored on any S3-compatible store.

I built commentator to provide an easy to use (and easy to host) free commenting system with advanced functionalities.

## Features

Commentator provides:

- [x] Multi website support: one instance of Commentator can manage comments for multiple websites.

- [x] An easy-to-use API to manage comments and events. A public API allows users to create or retrieve approved comments, and a admin API allows you to administrate comments (approve them or delete them for example).

Everytime a comment is added an event is generated into a dedicated file on S3. The API allows you to read and delete the events. You can use this file to be notified when a new comment is added.

- [x] Rate limiting, either by IP or using the requests `x-forwarded-for` header.

- [x] A "challenge" system to avoid spammers.

- [x] An in-memory cache for comments, for performances and to avoid hitting S3 too much.

- [x] Metrics about the applications exposed using the Prometheus format.

## Documentation

The documentation is available at https://www.commentator.mcorbin.fr/