yax
/
stacosys
mirror of https://github.com/kianby/stacosys
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Static sites need a Commenting System
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
182 Commits
1 Branch
11 Tags
1.7 MiB
Python 79.9%
HTML 16%
Makefile 2.1%
Dockerfile 1.6%
Shell 0.4%
 
 
 
 
 
main
2.0
2.0-b1
2.0b2
2.0b3
2.0b4
2.1
2.1-current
3.0
3.1
3.2
3.3
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e8c21cebc1'
${ noResults }
Go to file
Yax e8c21cebc1 Merge pull request #5 from kianby/dependabot/pip/urllib3-1.26.5 
Bump urllib3 from 1.26.4 to 1.26.5
 		3 years ago
dbmigration move db migration tool 4 years ago
stacosys add mail error logger 4 years ago
tests upgrade libs and follow linter recommandations 4 years ago
.gitignore upgrade libs and follow linter recommandations 4 years ago
LICENSE update README, licence GPL v2 upgraded to v3 4 years ago
README.md markdown joke 4 years ago
config.ini fix a couple of bugs 4 years ago
poetry.lock Bump urllib3 from 1.26.4 to 1.26.5 3 years ago
pyproject.toml 2.0 beta 4 4 years ago
run.py add mail error logger 4 years ago
run.sh move package root 4 years ago

README.md

Stacosys

Stacosys (aka STAtic blog COmment SYStem) is a fork of Pecosys trying to fix Pecosys design drawbacks and to provide an humble alternative to comment hosting services like Disqus. Stacosys protects your readers's privacy.

Stacosys works with any static blog or even a simple HTML page. It uses e-mails to communicate with the blog administrator. It doesn't sound hype but I'm an old-school guy. E-mails are reliable and an universal way to communicate. You can answer from any device using an e-mail client.

Features overview

Stacosys main feature is comment management.

Here is the workflow:

  • Readers submit comments via a comment form embedded in blog pages
  • Blog administrator receives an email notification from Stacosys when a comment is submitted
  • Blog administrator can approve or drop the comment by replying to e-mail
  • Stacosys stores approved comment in its database.

Privacy concerns: only surname, gravatar id and comment itself are stored in DB. E-mail is requested in submission form (but optional) to resolve gravatar id and it it not sent to stacosys.

Stacosys is localized (english and french).

Technically speaking, how does it work?

Stacosys can be hosted on the same server or on a different server than the blog. Stacosys offers a REST API to retrieve and post comments. Static blog is HTML-based and a piece of JavaScript code interacts with Stacosys using HTTP requests. Each page has a unique id and a simple request allows to retrieve comments for a given page. Similarly a form request allows to post a comment which is relayed to the administrator by e-mail. For this purpose a dedicated email is assigned to Stacosys.

Little FAQ

How do you block spammers?

  • Current comment form is basic: no captcha support but a honey pot.

Which database is used?

  • SQLite.

Which technologies are used?

Installation

Build is based on Poetry but you can also use published releases on GitHub or the Docker image.

Improvements

Stacosys fits my needs and it manages comments on my blog for a while. I don't have any plan to make big changes, it's more a python playground for me. So I strongly encourage you to fork the project and enhance the project if you need more features.