diff --git a/README.md b/README.md index a2800bd..869afeb 100644 --- a/README.md +++ b/README.md @@ -12,16 +12,13 @@ Isso comes into play. **[Try Yourself!](http://posativ.org/isso/)** -Isso is not stable (pretty far from that state) and the database format may -change without any backwards compatibility. Just saying. - Features -------- * [CRUD](https://en.wikipedia.org/wiki/Create,_read,_update_and_delete) comments written in Markdown * SQLite backend, Disqus import -* client-side JS (currently 61kb minified, 21kb gzipped) +* client-side JS (currently 54kb minified, 18kb gzipped) * I18N, available in german and english (also fallback) @@ -37,96 +34,108 @@ Installation ------------ - Python 2.6, 2.7 or 3.3 -- easy_install or pip +- a working C compiler -Install Isso (and its dependencies) with: +Install Isso with: ~> pip install isso -Before you start, you may want to import comments from -[Disqus.com](https://disqus.com/): - - ~> isso import ~/Downloads/user-2013-09-02T11_39_22.971478-all.xml - [100%] 53 threads, 192 comments +Set your database location and website: -You start the server via (try to visit [http://localhost:8080/static/post.html]()). + ~> cat my.cfg + [general] + dbpath = /var/lib/isso/comments.db + host = http://example.tld/ - ~> isso run +You can optionally import your comments from [Disqus.com](https://disqus.com/): -If that is working, you may want to [edit the configuration](https://github.com/posativ/isso/blob/master/docs/CONFIGURATION.rst). + ~> 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](). -Webserver Configuration ------------------------ + ~> 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 -This part is not fun, I know. I have prepared two possible setups for nginx, -using Isso on the same domain as the blog, and on a different domain. Each -setup has its own benefits. +Make sure, Isso can connect to the server that hosts your blog, otherwise you +are not able to post comments. -### Isso on a Sub URI -Let's assume you want Isso on `/isso`, use the following nginx snippet: +Website Integration +------------------- -```nginx -server { - listen [::]:80; - listen [::]:443 ssl; - server_name example.tld; - root /var/www/example.tld; +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). - 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; - } -} -``` +Whatever method you prefer (just change the URL), you add comments to your +site, add: ```html - -
+ + ... + + ... + + + ... +
+ ... + ``` -### Isso on a Dedicated Domain - -Now, assuming you have your isso instance running on a different URL, such as -`http://example.tld:8080`, but your blog runs on `http://example.tld`: - - ~> cat example.cfg - [general] - host = http://example.tld/ - ~> isso -c example.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,409 INFO: * Running on http://localhost:8080/ - -Make sure, Isso can connect to server that hosts your blog, otherwise you are -not able to post comments. - -Integrate Isso with: +The JavaScript client will automatically detect the API endpoint. +To show the comment count for a post, add `#isso-thread` to the link: ```html - -
+ + ... + + ... + + + ... + Comments + ... + ``` -Also, put the plain isso server behind a real web server or [use uWSGI][3]. +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 -[3]: https://github.com/posativ/isso/blob/master/docs/uWSGI.md +* nginx configuration to run Isso on `/isso`: + ```nginx + server { + listen [::]:80; + listen [::]:443 ssl; + server_name example.tld; + root /var/www/example.tld; -Website Integration -------------------- + 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; + } + } + ``` -To enable comments, add a `
` or `