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

remove installation and configuration from README

Browse Source
This commit is contained in:
Martin Zimmermann 2013-11-25 17:00:36 +01:00
parent a045c963bd
commit 350cf406c2
1 changed files with 4 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

122
README.md
View File

@ -21,127 +21,13 @@ 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)
* I18N, available in english, french, russian and german
Installation
------------
Setup
-----
- 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/
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
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 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.
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), to embed comments add
```html
<script src="http://example.tld/js/embed.min.js"></script>
```
to your HTML (presumedly into `<head>`) and
```html
<div id="isso-thread"></div>
```
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
<script src="http://example.tld/js/count.min.js"></script>
```
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.
### Client Configuration
### 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;
}
}
```
### Init Scripts
* SystemD: [isso.service](https://github.com/jgraichen/debian-isso/blob/master/debian/isso.service)
* SysVinit: [isso.init](https://github.com/jgraichen/debian-isso/blob/master/debian/isso.init)
* OpenBSD: [GH:Gist](https://gist.github.com/noqqe/7397719)
Documentation
-------------
- [Configuration](https://github.com/posativ/isso/blob/master/docs/CONFIGURATION.rst)
- [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)
For further help, join `#isso` on Freenode!
Please refer to the official documentation: <http://posativ.org/isso/docs>.
Alternatives