isso/Readme.md
2012-10-23 20:36:43 +02:00

2.5 KiB
Raw Blame History

Isso Ich schrei sonst

You love static blog generators (especially Acrylamid *cough*) and the only option to interact with the community is Disqus. There's nothing wrong with it, but if you care about the privacy of your audience you should better use a comment system that is under your control. This is, were Isso comes into play.

Current status: nosetests specs/. Ran 11 tests in 0.570s.

Features/Roadmap

  • transparent and lightweight backend (SQLite or plain text files)
  • simple JSON API (hence comments are JavaScript-only)
  • create comments and modify/delete within a time range
  • Ping/Trackback support (not implemented yet)
  • simple admin interface (work in progress)
  • easy integration, similar to Disqus (work in progress)
  • spam filtering using http:bl (not implemented yet)

Installation

TODO

Migrating from Disqus

Go to disqus.com and export your "forum" as XML. If you use Firefox and you get a 403, try a webkit browser, Disqus did something very weird with that download link. Next:

$ isso import /path/to/ur/dump.xml

That's it. Visit your admin page to see all threads. If it doesn't work for you, please file in a bug report *including* your dump.

API

fetch comments for /foo-bar/

$ curl -H "Accept: application/json" http://example.org/comment/foo-bar/

comment at /foo-bar/

$ curl -H "Accept: application/json" -X POST -d \
    '{
        "text": "Lorem ipsum ...",

        # optional
        "name": "Hans", "email": "foo@bla.org", "website": "http://blog/log/"
    }' http://example.org/comment/foo-bar/new

modify 12. comment at /foo-bar/

$ curl -H "Accept: application/json" -X PUT -d ... http://example.org/comment/foo-bar/12

You can only modify your own comment in a given time range (defaults to 15 minutes).

delete 2nd comment at /foo-bar/

$ curl -H ... -X DELETE http://example.org/comment/foo-bar/2

You can only delete your own comment in a given time range (defaults to 15 minutes). If your comment has been referenced by another comment, your comment will be cleared but not deleted to maintain depending comments.

Alternatives