158 lines
4.0 KiB
Markdown
158 lines
4.0 KiB
Markdown
Isso – Ich schrei sonst
|
||
=======================
|
||
|
||
You love static blog generators (especially [Acrylamid][1] *cough*) and the
|
||
only option to interact with the community is [Disqus][2]. There's nothing
|
||
wrong with it, but if you care about the privacy of your audience you are
|
||
better off with a comment system that is under your control. This is, where
|
||
Isso comes into play.
|
||
|
||
[1]: https://github.com/posativ/acrylamid
|
||
[2]: https://disqus.com/
|
||
|
||
**[Try Yourself!](http://posativ.org/isso/)**
|
||
|
||
|
||
Features
|
||
--------
|
||
|
||
* [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) comments written in Markdown
|
||
* SQLite backend, Disqus import
|
||
* client-side JS (currently 54kb minified, 18kb gzipped)
|
||
* I18N, available in german and english (also fallback)
|
||
|
||
|
||
Roadmap
|
||
-------
|
||
|
||
- Ping/TrackBack™ support
|
||
- simple admin interface (needs contributor)
|
||
- spam filtering
|
||
|
||
|
||
Installation
|
||
------------
|
||
|
||
- Python 2.6, 2.7 or 3.3
|
||
- a working C compiler
|
||
|
||
Install Isso with:
|
||
|
||
~> pip install isso
|
||
|
||
Set your database location and website:
|
||
|
||
~> cat my.cfg
|
||
[general]
|
||
dbpath = /var/lib/isso/comments.db
|
||
host = http://example.tld/
|
||
|
||
You can optionally import your comments from [Disqus.com](https://disqus.com/):
|
||
|
||
~> isso -c my.cfg import ~/Downloads/user-2013-09-02T11_39_22.971478-all.xml
|
||
[100%] 53 threads, 192 comments
|
||
|
||
You start the server via (try to visit [http://localhost:8080/check-ip]().
|
||
|
||
~> isso -c my.cfg run
|
||
2013-10-30 09:32:48,369 WARNING: unable to connect to SMTP server
|
||
2013-10-30 09:32:48,408 WARNING: connected to HTTP server
|
||
|
||
Make sure, Isso can connect to the server that hosts your blog, otherwise you
|
||
are not able to post comments.
|
||
|
||
|
||
Website Integration
|
||
-------------------
|
||
|
||
You can run Isso on a dedicated domain or behind a sub URI like `/isso`. It
|
||
makes actually no difference except for the webserver configuration (see
|
||
below).
|
||
|
||
Whatever method you prefer (just change the URL), you add comments to your
|
||
site, add:
|
||
|
||
```html
|
||
<head>
|
||
...
|
||
<script src="http://example.tld/js/embed.min.js"></script>
|
||
...
|
||
</head>
|
||
<body>
|
||
...
|
||
<div id="isso-thread"></div>
|
||
...
|
||
</body>
|
||
```
|
||
|
||
The JavaScript client will automatically detect the API endpoint.
|
||
To show the comment count for a post, add `#isso-thread` to the link:
|
||
|
||
```html
|
||
<head>
|
||
...
|
||
<script src="http://example.tld/js/count.min.js"></script>
|
||
...
|
||
</head>
|
||
<body>
|
||
...
|
||
<a href="/path/to/post#isso-thread">Comments</a>
|
||
...
|
||
</body>
|
||
```
|
||
|
||
This functionality is already included when you embed `embed.min.js`, do
|
||
*not* mix `embed.min.js` and `count.min.js` in a single document.
|
||
|
||
### Webserver configuration
|
||
|
||
* nginx configuration to run Isso on `/isso`:
|
||
|
||
```nginx
|
||
server {
|
||
listen [::]:80;
|
||
listen [::]:443 ssl;
|
||
server_name example.tld;
|
||
root /var/www/example.tld;
|
||
|
||
location /isso {
|
||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||
proxy_set_header X-Script-Name /isso;
|
||
proxy_pass http://localhost:8080;
|
||
}
|
||
}
|
||
```
|
||
|
||
* nginx configuration to run Isso on a dedicated domain:
|
||
|
||
```nginx
|
||
server {
|
||
listen [::]:8080;
|
||
server_name comments.example.tld;
|
||
|
||
location / {
|
||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||
proxy_pass http://localhost:8080;
|
||
}
|
||
}
|
||
```
|
||
|
||
|
||
Documentation
|
||
-------------
|
||
|
||
- [Configuration](https://github.com/posativ/isso/blob/master/docs/CONFIGURATION.rst)
|
||
- [API overview](https://github.com/posativ/isso/raw/master/docs/API.md)
|
||
- [uWSGI usage](https://github.com/posativ/isso/blob/master/docs/uWSGI.md)
|
||
- [Contributing](https://github.com/posativ/isso/blob/master/CONTRIBUTING.md)
|
||
- [Development](https://github.com/posativ/isso/blob/master/docs/DEVELOPMENT.md)
|
||
|
||
|
||
Alternatives
|
||
------------
|
||
|
||
- [talkatv](https://github.com/talkatv/talkatv) – Python
|
||
- [Juvia](https://github.com/phusion/juvia) – Ruby on Rails
|
||
- [Tildehash.com](http://www.tildehash.com/?article=why-im-reinventing-disqus) – PHP
|
||
- [SO: Unobtrusive, self-hosted comments](http://stackoverflow.com/q/2053217)
|