arno/isso
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
Martin Zimmermann 2013-11-01 16:45:21 +01:00
parent afcfa91179
commit b115c00150
1 changed files with 20 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
README.md
View File

@ -2,7 +2,7 @@ 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
only option to interact with your 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.
@ -22,14 +22,6 @@ Features
* I18N, available in german and english (also fallback)
Roadmap
-------
- Ping/TrackBack™ support
- simple admin interface (needs contributor)
- spam filtering
Installation
------------
@ -47,16 +39,16 @@ Set your database location and website:
dbpath = /var/lib/isso/comments.db
host = http://example.tld/
You can optionally import your comments from [Disqus.com](https://disqus.com/):
Optional: you can 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]().
Now start the server:
~> 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
2013-10-30 09:32:48,408 INFO: connected to HTTP server
Make sure, Isso can connect to the server that hosts your blog, otherwise you
are not able to post comments.
@ -69,38 +61,30 @@ 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:
Whatever method you prefer (just change the URL), to embed comments add
```html
<script src="http://example.tld/js/embed.min.js"></script>
```
to your HTML (presumedly into `<head>`) and
```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:
below your post. That's all. The JavaScript client will automatically detect
the API endpoint.
To show the comment count for posts (but no comments), add
```html
<head>
...
<script src="http://example.tld/js/count.min.js"></script>
...
</head>
<body>
...
<a href="/path/to/post#isso-thread">Comments</a>
...
</body>
```
to your header and all links ending with `#isso-thread` are updated with the
current comment count.
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.
@ -142,10 +126,10 @@ 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)
- [uWSGI](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)
- [API overview](https://github.com/posativ/isso/raw/master/docs/API.md)
Alternatives