r-strips the configured URL unconditionally

This shows recent comments first in the admin panel.

.drone.yml

@@ -0,0 +1,47 @@
+---
+kind: pipeline
+name: default
+
+platform:
+  os: linux
+  arch: amd64
+
+steps:
+- name: publish
+  pull: default
+  image: plugins/docker:18.09
+  settings:
+    registry: https://registry.nixaid.com
+    repo: "registry.nixaid.com/${DRONE_REPO_NAMESPACE}/${DRONE_REPO_NAME}"
+    tags:
+    - latest
+    username:
+      from_secret: docker_username
+    password:
+      from_secret: docker_password
+    # storage_path: /drone/docker
+    # storage_driver: aufs
+    # ipv6: false
+    # debug: true
+  when:
+    branch:
+    - master
+    event:
+    - push
+    - tag
+
+- name: notify
+  pull: default
+  image: drillster/drone-email:latest
+  settings:
+    from: "Drone CI <noreply@nixaid.com>"
+    host: mx.nixaid.com
+    port: 587
+    subject: "NIXAID Drone Pipeline {{#success build.status}}SUCCESS{{else}}FAILURE{{/success}} Notification"
+  when:
+    event:
+    - push
+    - tag
+    status:
+    - success
+    - failure

.drone.yml.v08

@@ -0,0 +1,85 @@
+# workspace:
+#   base: /workspace
+#   path: src/git.nixaid.com/arno/myapp/
+#
+# branches:
+#   - master
+
+pipeline:
+  restore_cache:
+    image: drillster/drone-volume-cache:latest
+    restore: true
+    mount:
+      - /drone/docker
+    # Set the ``DRONE_VOLUME=/tmp/drone-cache:/cache`` drone-server variable,
+    # so you can benefit from the caching.
+    # Otherwise you will have to make this repository trusted in Drone and use
+    # the volumes as follows.
+    # volumes:
+    #   - /tmp/drone-cache:/cache
+
+  # drone repo add arno/isso
+  # drone secret add/update --name docker_username --value arno --event push --event tag --event deployment arno/isso
+  # drone secret add/update --name docker_password --value "$(pass show vps/registry.nixaid.com | head -1)" --event push --event tag --event deployment arno/isso
+  publish:
+    image: plugins/docker:17.12
+    # repo: andrey01/${DRONE_REPO_NAME}
+    registry: registry.nixaid.com
+    repo: registry.nixaid.com/arno/${DRONE_REPO_NAME}
+    tags:
+      - latest
+      # - ${DRONE_COMMIT_SHA:0:7}
+    # group: docker
+    # dockerfile: Dockerfile
+    secrets: [docker_username, docker_password]
+    # Since we restore the docker image cache to /drone/docker
+    storage_path: /drone/docker
+    use_cache: true
+    when:
+      event: [push, tag]
+      branch: master
+
+  rebuild_cache:
+    image: drillster/drone-volume-cache:latest
+    rebuild: true
+    mount:
+      - /drone/docker
+    # Set the ``DRONE_VOLUME=/tmp/drone-cache:/cache`` drone-server variable,
+    # so you can benefit from the caching.
+    # Otherwise you will have to make this repository trusted in Drone and use
+    # the volumes as follows.
+    # volumes:
+    #   - /tmp/drone-cache:/cache
+
+  # # ca_cert comes from /srv/data/registry/certs/ca.crt
+  # claircheck:
+  #   # image: jmccann/drone-clair:1
+  #   image: andrey01/drone-clair
+  #   url: http://clair:6060
+  #   secrets: [ docker_username, docker_password ]
+  #   # ignore errors for now. This will work only in drone 0.9 https://github.com/drone/drone-runtime/commit/3e8bd99f60f4032226523320cd2b2321f9525159
+  #   err_ignore: true
+  #   scan_image: registry.nixaid.com/arno/${DRONE_REPO_NAME}:latest
+  #   ca_cert: |
+  #     -----BEGIN CERTIFICATE-----
+  #     MIIBOjCB4KADAgECAgkAzhpbLWXa4H0wCgYIKoZIzj0EAwIwEDEOMAwGA1UEAwwF
+  #     bXktQ0EwHhcNMTgwNzA5MjIzMTAzWhcNMjgwNzA2MjIzMTAzWjAQMQ4wDAYDVQQD
+  #     DAVteS1DQTBZMBMGByqGSM49AgEGCCqGSM49AwEHA0IABFIE8bTfQ76U5qG/Xgjw
+  #     BbQU0oRJLYlRxBIWF9MTNSJr2LoaoyrU8jrcWQGRrfKPoVuwUJWp2tp5SJy0AHH7
+  #     4fijIzAhMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQDAgKkMAoGCCqGSM49
+  #     BAMCA0kAMEYCIQCYbTbxRD2yX4LzGjh84fKPWPQM9ps8RE2nfwZjqdRUGgIhAOHb
+  #     USigh6FzqEPk2jiaV3t1wNtChRWRfupTKG6CD345
+  #     -----END CERTIFICATE-----
+
+  notify:
+    image: drillster/drone-email:latest
+    from: Drone CI <noreply@nixaid.com>
+    subject: NIXAID Drone Pipeline {{#success build.status}}SUCCESS{{else}}FAILURE{{/success}} Notification
+    host: mx.nixaid.com
+    port: 587
+    # username: arno
+    # secrets: [ email_username, email_password ]
+    # recipients: [ andrey.arapov@nixaid.com ]
+    when:
+      status: [success, failure] # changed
+      event: [push, tag]

.gitignore

@@ -3,15 +3,119 @@
 # For a project mostly in C, the following would be a good set of
 # exclude patterns (uncomment them if you want to use them):
 # *.[oa]
-# *~
+*~
 
 *.pyc
 .Python
+.sass-cache
+.vagrant
+
 /bin
 /include
 /lib
+/lib64
+/man
 /share
 /isso.egg-info/
 /isso/js/components
 /isso/js/embed.min.js
+/isso/js/embed.dev.js
 /isso/js/count.min.js
+/isso/js/count.dev.js
+
+/docs/_build
+/docs/_static/css/site.css
+
+/pip-selfcheck.json
+
+# github/gitignore
+Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+.venv/
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject

.travis.yml

@@ -0,0 +1,25 @@
+language: python
+matrix:
+  include:
+    - python: 3.5
+      env: TOX_ENV=py35
+    - python: 3.6
+      env: TOX_ENV=py36
+    - python: 3.7
+      dist: xenial
+      env: TOX_ENV=py37
+    - python: 3.8
+      dist: xenial
+      env: TOX_ENV=py38
+install:
+  - pip install -U pip
+  - pip install flake8 tox
+script:
+  - tox -e $TOX_ENV
+  - make flakes
+notifications:
+  irc:
+    channels:
+      - "chat.freenode.net#isso"
+    on_success: change
+    on_failure: always

.tx/config

@@ -0,0 +1,6 @@
+[main]
+host = https://www.transifex.com
+[isso.js]
+file_filter = .tx/js/<lang>
+source_lang = en
+type = KEYVALUEJSON

CHANGES.rst

@@ -1,10 +1,563 @@
 Changelog for Isso
 ==================
 
-0.2.1 (2013-10-30)
+0.12.3 (UNRELEASED)
+-------------------
+
+- New "flags" option in the [markdown] section to customize Misaka's Markdown
+  HTML rendering. By default, no flags are set.
+
+      [markup]
+      flags = skip-html, escape, hard-wrap
+
+  Check docs/configuration/server.rst for more details.
+
+0.12.2 (2019-01-21)
+-------------------
+
+- Revert use of labels instead of placeholders, since it breaks
+  mail notifications. #524
+
+0.12.1 (2019-01-19)
+-------------------
+
+- Revert fix for duplicate slashes, as it prevents isso from
+  starting in some cases. #523
+
+0.12.0 (2019-01-18)
+-------------------
+
+- Fix compatibility with new XML API.
+- Don't enable admin interface with default password by default.  #491
+- Add support and documentation for "generic" imports.
+- Remove potential duplicate slashes in URLs from
+  email links. #420
+- Add data-isso-reply-notifications to attributes in configuration.
+- Use default IP in imports if none is found. Fixes imports of some comments.
+- embed: fix feed link creation on older browsers.
+- Properly handle to field in mail notifications when using uWSGI spooler
+- css: fix vertical alignment of notification checkbox
+
+0.11.1 (2018-11-03)
+-------------------
+
+- Include pre-built minified JavaScript and CSS.
+
+0.11.0 (2018-11-03)
+-------------------
+
+Bugs & features:
+
+- Fix link in moderation mails if isso is setup on a sub-url (e.g. domain.tld/comments/)
+- Add reply notifications
+- Add admin interface
+- Add links highlighting in comments
+- Add apidoc
+- Add rc.d script for FreeBSD
+- Add the possibility to set CORS Origin through ISSO_CORS_ORIGIN environ variable
+- Add preview button
+- Add Atom feed at /feed?uri={thread-id}
+- Add optionnal gravatar support
+- Add nofollow noopener on links inside comments
+- Add Dockerfile
+- Upgraded to Misaka 2
+- Some tests/travis/documentation improvements and fixes + pep8
+
+Translations:
+
+- Fix Chinese translation & typo in CJK
+- Add Danish translation
+- Add Hungarian translation
+- Add Persian translation
+- Improvement on german translation
+
+0.10.6 (2016-09-22)
+-------------------
+
+- fix missing configuration field
+
+
+0.10.5 (2016-09-20)
+-------------------
+
+- add support for different vote levels, #260
+
+  List of vote levels used to customize comment appearance based on score.
+  Provide a comma-separated values (eg. `"0,5,10,25,100"`) or a JSON array (eg.
+  `"[-5,5,15]"`).
+
+  For example, the value `"-5,5"` will cause each `isso-comment` to be given
+  one of these 3 classes:
+
+  - `isso-vote-level-0` for scores lower than `-5`
+  - `isso-vote-level-1` for scores between `-5` and `4`
+  - `isso-vote-level-2` for scores of `5` and greater
+
+  These classes can then be used to customize the appearance of comments (eg.
+  put a star on popular comments).
+
+- add new post preview API endpoint, #254
+
+- add an option for mandatory author, #257
+
+- clients can now use `data-title` to get the HTML title for a new page, #252
+
+- add finish translation and other minor bugfixes
+
+
+0.10.4 (2016-04-12)
+-------------------
+
+- fix wrapper attribute when using data-isso-require-mail="true", #238
+- fix reponse for OPTIONS response on Python 3, #242
+
+
+0.10.3 (2016-02-24)
+-------------------
+
+- follow redirects, #193
+
+
+0.10.2 (2016-02-21)
+-------------------
+
+- fix getAttribute return value
+
+
+0.10.1 (2016-02-06)
+-------------------
+
+- fix empty author, email and website values when writing a comment
+
+
+0.10 (2016-02-06)
+-----------------
+
+- add new configuration section for hash handling.
+
+    [hash]
+    salt = Eech7co8Ohloopo9Ol6baimi
+    algorithm = pbkdf2
+
+  You can customize the salt, choose different hash functions and tweak the
+  parameters for PBKDF2.
+
+- Python 3.4+ validate TLS connections against the system's CA. Previously no
+  validation was in place, see PEP-446__ for details.
+
+- add `fenced_code` and `no_intra_emphasis` to default configuration.
+
+  Fenced code allows to write code without indentation using `~~~` delimiters
+  (optionally with language identifier).
+
+  Intra emphasis would compile `foo_bar_baz` to foo<em>bar</em>baz. This
+  behavior is very confusing for users not knowing the Markdown spec in detail.
+
+- new configuration to require an email when submitting comments, #199. Set
+
+    [guard]
+    require-email = true
+
+  and use `data-isso-require-email="true"` to enable this feature. Disabled by
+  default.
+
+- new Bulgarian translation by sahwar, new Swedish translation by Gustav
+  Näslund – #143, new Vietnamese translation by Đinh Xuân Sâm, new Croatian
+  translation by streger, new Czech translation by Jan Chren
+
+- fix SMTP setup without credentials, #174
+
+- version pin Misaka to 1.x, html5lib to 0.9999999
+
+.. __: https://www.python.org/dev/peps/pep-0466/
+
+
+0.9.10 (2015-04-11)
+-------------------
+
+- fix regression in SMTP authentication, #174
+
+
+0.9.9 (2015-03-04)
+------------------
+
+- several Python 3.x related bugfixes
+
+- don't lose comment form if the server rejected the POST request, #144
+
+- add localStorage fallback if QUOTA_EXCEEDED_ERR is thrown (e.g. Safari
+  private browsing)
+
+- add '--empty-id' flag to Disqus import, because Disqus' export sucks
+
+- (re)gain compatibility with Werkzeug 0.8 and really old html5lib versions
+  available in Debian Squeeze, #170 & #168
+
+- add User-Agent when Isso requests the URL, an alternate way to #151 (add
+  'X-Isso' when requesting).
+
+0.9.8 (2014-10-08)
+------------------
+
+- add compatibility with configparser==3.5.0b1, #128
+
+
+0.9.7 (2014-09-25)
+------------------
+
+- fix SMTP authentication using CRAM-MD5 (incorrect usage of
+  `smtplib`), #126
+
+
+0.9.6 (2014-08-18)
 ------------------
 
-- Nothing changed yet.
+- remember name, email and website in localStorage, #119
+
+- add option to hide voting feature, #115
+
+    data-isso-vote="true|false"
+
+- remove email field from JSON responses
+
+  This is a quite serious issue. For the identicon, an expensive hash is used
+  to avoid the leakage of personal information like a real email address. A
+  `git blame` reveals, the email has been unintenionally exposed since the very
+  first release of Isso :-/
+
+  The testsuite now contains a dedicated test to prevent this error in the
+  future.
+
+
+0.9.5 (2014-08-10)
+------------------
+
+- prevent no-break space (&nbsp;) insertion to enable manual line breaks using
+  two trailing spaces (as per Markdown convention), #112
+
+- limit request size to 256 kb, #107
+
+  Previously unlimited or limited by proxy server). 256 kb is a rough
+  approximation of the next database schema with comments limited to 65535
+  characters and additional fields.
+
+- add support for logging to file, #103
+
+    [general]
+    log-file =
+
+- show timestamp when hovering <time>, #104
+
+- fix a regression when editing comments with multiple paragraphs introduced
+  in 0.9.3 which would HTML escape manually inserted linebreaks.
+
+
+0.9.4 (2014-07-09)
+------------------
+
+- fixed a regression when using Isso and Gevent
+
+
+0.9.3 (2014-07-09)
+------------------
+
+- remove scrollIntoView while expanding further comments if a fragment is used
+  (e.g. #isso-thread brought you back to the top, unexpectedly)
+
+- implement a custom Markdown renderer to support multi-line code listings. The
+  extension "fenced_code" is now enabled by default and generates HTML
+  compatible with Highlight.js__.
+
+- escape HTML entities when editing a comment with raw HTML
+
+- fix CSS for input
+
+- remove isso.css from binary distribution to avoid confusion (it's still there
+  from the very first release, but modifications do not work)
+
+.. __: http://highlightjs.org/
+
+
+0.9 (2014-05-29)
+----------------
+
+- comment pagination by Srijan Choudhary, #15
+
+  Isso can now limit the amount of comments shown by default and add link to
+  show more. By default, all top-level comments are shown but only 5 nested
+  comments (per reply). You can override the settings:
+
+    isso-data-max-comments-top="N"
+    isso-data-max-comments-nested="N"
+
+  Where N is a number from 0 to infinity ("inf"). If you limit the amount of
+  shown top level comments, the overall comment count may be incorrect and a
+  known issue.
+
+  You can also configure the amount of comments shown per click (5 by default):
+
+    isso-data-reveal-on-click="N"
+
+  This feature also required a change in the comment structure. Previously, all
+  comments are stored tree-like but shown linearly. To ease the implementation
+  of pagination, the comment tree is now limited to a maximum depth of one.
+  Jeff Atwood explains, why `discussions are flat by design`__.
+
+  .. __: http://blog.codinghorror.com/web-discussions-flat-by-design/
+
+  When you upgrade, Isso will automatically normalize the tree and some
+  information gets lost. All new replies to a comment are now automatically a
+  direct child of the top-level comment.
+
+- style improvements by William Dorffer, #39, #84 #90 and #91
+
+  Isso now longer uses a fat SCSS library, but plain CSS instead. The design is
+  now responsive and no longer sets global CSS rules.
+
+- experimental WordPress import, #75
+
+  Isso should be able to import WXR 1.0-1.2 exports. The import code is based
+  on two WXR dumps I found (and created) and may not work for you. Please
+  report any failure.
+
+- avatar changes, #49
+
+  You can now configure the client to not show avatars:
+
+    data-isso-avatar="false"
+
+  Also there is no longer an avatar shown next to the comment box. This is due
+  to the new CSS and removes two runtime dependencies.
+
+- you may now set a full From header, #87
+
+    [smtp]
+    from = Foo Bar <spam@local>
+
+- SMTP (all caps) is now recognized for notifications, #95
+
+- Isso now ships a small demo site at /demo, #44
+
+- a few bugfixes: Disqus import now anonymizes IP addresses, uWSGI spooling for
+  Python 3, HTTP-Referer fallback for HTTP-Origin
+
+- remove Django's PBKDF2 implementation in favour of the PBKDF2 function
+  available in werkzeug 0.9 or higher. If you're still using werkzeug 0.8, Isso
+  imports passlib__ as fallback (if available).
+
+
+This release also features a new templating engine Jade__ which replaces
+Markup.js__. Jade can compile directly to JavaScript with a tiny runtime module
+on the client. Along with the removal of sha1.js and pbkdf2.js and a few build
+optimizations, the JS client now weighs only 40kb (12kb gzipped) – 52kb resp.
+17kb before.
+
+.. __: https://pypi.python.org/pypi/passlib
+.. __: http://jade-lang.com/
+.. __: https://github.com/adammark/Markup.js
+
+
+0.8 (2014-03-28)
+----------------
+
+- replace ``<textarea>`` with ``<div contentedtiable="true">`` to remove the
+  sluggish auto-resize on input feature. If you use a custom CSS, replace
+  ``textarea`` with ``.textarea`` and also set ``white-space: pre``.
+
+- remove superscript extension from Markdown defaults as it may lead to
+  unexpected behavior for certain smileys such as "^^". To enable the extension,
+  add
+
+    [markup]
+    options = superscript
+    allowed-elements = sup
+
+  to your configuration.
+
+- comment count requests are now bundled into a single POST request, but the old
+  API is still there (deprecated though).
+
+- store *session-key* in database (once generated on database creation). That
+  means links to activate, edit or delete comments are now always valid even
+  when you restart Isso.
+
+  Currently statically set session keys in ``[general]`` are automatically
+  migrated into the database on startup and you will get a notice that you can
+  remove this option.
+
+- fix undefined timestamp when client time differs for more than 1 second.
+  The human-readable "time ago" deltas have been refined to match `Moment.js`_
+  behavior.
+
+- avatar colors and background can now be customized:
+
+  * ``data-isso-avatar-bg="#f0f0f0"`` sets the background color
+  * ``data-isso-avatar-fg="#9abf88 #5698c4 #e279a3 #9163b6 ..."`` sets possible
+    avatar colors (up to 8 colors are possible).
+
+- new [markup] section to customize Misaka's Markdown generation (strikethrough,
+  superscript and autolink enabled by default). Furthermore, you can now allow
+  certain HTML elemenets and attributes in the generated output, e.g. to enable
+  images, set
+
+      [markup]
+      allowed-elements = img
+      allowed-attributes = src
+
+  Check docs/configuration/server.rst for more details.
+
+- replace requirejs-domready with a (self-made) HTML5 idiom, #51
+
+.. _Moment.js: http://momentjs.com/docs/#/displaying/fromnow/
+
+
+0.7 (2014-01-29)
+----------------
+
+- fix malicious HTML injection (due to wrong API usage). All unknown/unsafe
+  HTML tags are now removed from the output (`html5lib` 0.99(9) or later) or
+  properly escaped (older `html5lib` versions).
+
+  See 36d702c and 3a1f92b for more details.
+
+- remove kriskowal/q JS library (promises implementation) in favour of a
+  self-made 50 LoC implementation to ease packaging (for Debian), #51
+
+- add documentation to display a comment counter, #56 and #57
+
+- SMTP notifications now support STARTTLS and use this transport security
+  by default, #48 and #58. This also changes the configuration option from
+  `ssl = [yes|no]` to `security = [none|starttls|ssl]`.
+
+- translation can now be made (and updated) with Transifex_. If you want to
+  take ownership for a language, contact me on IRC.
+
+- fix french pluralform
+
+- the (by default random) session-key is now shown on application startup
+  to make different keys per startup more visible
+
+- use `threading.lock` by default for systems without semaphore support
+
+.. _Transifex: https://www.transifex.com/projects/p/isso/
+
+
+0.6 (2013-12-16)
+----------------
+
+Major improvements:
+
+- override thread discovery with data-isso-id="...", #27
+
+  To use the same thread for different URLs, you can now add a custom
+  ``data-isso-id="my-id"`` attribute which is used to identify and retrieve
+  comments (defaults to current URL aka `window.location.pathname`).
+
+- `isso.dispatch` now dispatches multiple websites (= configurations) based on
+  URL prefixes
+
+- fix a cross-site request forgery vulnerability for comment creation, voting,
+  editing and deletion, #40
+
+- show modal dialog to confirm comment deletion and activation, #36
+
+- new, comprehensive documentation based on reST + Sphinx:
+  http://posativ.org/docs (or docs/ in the repository). Also includes an
+  annotated `example.conf`, #43
+
+- new italian and russian translations
+
+Minor improvements:
+
+- move `isso:application` to `isso.run:application` to avoid uneccessary
+  initialization in some cases (change module if you use uWSGI or Gunicorn)
+- add Date header to email notifications, #42
+- check for blank text in new comment, #41
+- work around IE10's HTML5 abilities for custom data-attributes
+- add support for Gunicorn (and other pre-forking WSGI servers)
+
+
+0.5 (2013-11-17)
+----------------
+
+Major improvements:
+
+- `listen` option replaces `host` and `port` to support UNIX domain sockets, #25
+
+  Instead of `host = localhost` and `port = 8080`, use
+  `listen = http://localhost:8080`. To listen on a UNIX domain socket, replace
+  `http://` with `unix://`, e.g. `unix:///tmp/isso.sock`.
+
+- new option `notify` (in the general section) is used to choose (one or more)
+  notification backends (currently only SMTP is available, though). Isso will
+  no longer automatically use SMTP for notifications if the initial connection
+  succeeds.
+
+- new options to control the client integration
+
+  * ``data-isso-css="false"`` prevents the client from appending the CSS to the
+    document. Enabled by default.
+
+  * ``data-isso-lang="de"`` overrides the useragent's preferred language (de, en
+    and fr are currently supported).
+
+  * ``data-isso-reply-to-self="true"`` should be set, when you allow reply to
+    own comments (see server configuration for details).
+
+- add support for `gevent <http://www.gevent.org/>`_, a coroutine-based Python
+  networking library that uses greenlets (lightweight threads). Recommended
+  WSGI server when not running with uWSGI (unfortunately stable gevent is not
+  yet able to listen on a UNIX domain socket).
+
+- fix a serious issue with the voters bloomfilter. During an Isso run, the
+  ip addresses from all commenters accumulated into the voters bloomfilter
+  for new comments. Thus, previous commenters could no longer vote other
+  comments. This fixes the rare occurences of #5.
+
+  In addition to this fix, the current voters bloomfilter will be re-initialized
+  if you are using Isso 0.4 or below (this is not necessary, but on the
+  other hand, the current bloomfilter for each comment is sort-of useless).
+
+- french translation (thanks to @sploinga), #38
+
+- support for multiple sites, part of #34
+
+Minor improvements:
+
+- `ipaddr` is now used as `ipaddress` fallback for Python 2.6 and 2.7, #32
+- changed URL to activate and delete comments to `/id/<N:int>/activate` etc.
+- import command uses `<link>` tag instead of `<id>` to extract the relative
+  URL path, #37
+- import command now uses `isDeleted` to mark comments as deleted (and
+  eventually remove stale comments). This seems to affect only a few comments
+  from a previous WordPress import into Disqus.
+- import command lists orphaned comments after import.
+- import command now has a ``--dry-run`` option to do no actual operation on
+  the database.
+
+
+0.4 (2013-11-05)
+----------------
+
+- Isso now handles cross-domain requests and cookies, fixes #24
+- Isso for Python 2.x now supports werkzeug>=0.8
+- limit email length to 254 to avoid Hash-DDoS
+- override Isso API location with ``data-isso="..."`` in the script tag
+- override HTML title parsing with a custom ``data-title="..."`` attribute
+  in ``<div id="isso-thread"></div>``
+
+
+0.3 (2013-11-01)
+----------------
+
+- improve initial comment loading performance in the client
+- cache slow REST requests, see #18
+- add a SQLite trigger that detects and removes stale threads (= threads,
+  with all comments being removed) from the database when a comment is
+  removed.
+- PyPi releases now include an uncompressed version of the JavaScript
+  files -- `embed.dev.js` and `count.dev.js` -- to track down errors.
+- use uWSGI's internal locking instead of a self-made shared memory lock
 
 
 0.2 (2013-10-29)

CONTRIBUTING.md

@@ -1,89 +0,0 @@
-Contributing
-============
-
-I appreciate any help and love pull requests. Here are some things
-you need to respect:
-
-* no hard-wired external services
-* no support for ancient browsers (e.g. IE6-9)
-
-Reporting Issues
-----------------
-
-### Disqus import fails
-
-If `isso import /path/to/disqus.xml` fails, please do *NOT* attach the raw
-dump file to GH:Issues. Please anonymize all IP addresses inside the `<ipAddress>`
-tag first, as second step, replace all email addresses with a generic one (
-email tag).
-
-### embed.min.js-related issues
-
-In case of a JavaScript traceback, please setup Isso in development mode
-described below. Otherwise it is very hard to "guess" the reason.
-
-### isso-related issues
-
-Copy and paste traceback into a ticket and provide some details of your usage.
-
-
-Development
------------
-
-If you want to hack on Isso or track down issues, there's an alternate
-way to set up Isso. It requires a lot more dependencies and effort.
-
-Requirements:
-
-- Python 2.6, 2.7 or 3.3
-- Ruby 1.8 or higher
-- Node.js, [NPM](https://npmjs.org/) and [Bower](http://bower.io/)
-
-On Debian/Ubuntu install the following packages
-
-    ~> sudo aptitude install python-setuptools python-dev npm ruby
-    ~> ln -s /usr/bin/nodejs /usr/bin/node
-
-Get the repository:
-
-    ~> git clone https://github.com/posativ/isso.git
-    ~> cd isso/
-
-Install `virtualenv` and create a new environment for Isso (recommended):
-
-    ~> pip install virtualenv
-    ~> virtualenv .
-    ~> source ./bin/activate
-
-Install Isso dependencies:
-
-    ~> python setup.py develop
-    ~> isso run
-
-Compile SCSS to CSS:
-
-    ~> gem install sass
-    ~> scss --watch isso/css/isso.scss
-
-Install JS components:
-
-    ~> cd isso/js
-    ~> bower install almond q requirejs requirejs-domready requirejs-text
-
-
-Integration
------------
-
-```html
-<script src="/isso/js/config.js"></script>
-<script data-main="/isso/js/embed" src="/isso/js/components/requirejs/require.js"></script>
-```
-
-
-Optimization
-------------
-
-    ~> npm install -g requirejs uglifyjs
-    ~> cd isso/js
-    ~> r.js -o build.embed.js
-    ~> r.js -o build.count.js

CONTRIBUTING.rst

@@ -0,0 +1 @@
+docs/contribute.rst

CONTRIBUTORS.txt

@@ -0,0 +1,121 @@
+# Contributions to Isso
+
+## Creator & Maintainer
+
+* Martin Zimmermann <info@posativ.org>
+
+## Co-Maintainers
+
+* Benoît Latinier @blatinier <benoit@latinier.fr>
+
+* Jelmer Vernooij <jelmer@jelmer.uk>
+
+## Contributors
+
+In chronological order:
+
+* Florian Baumann <flo@noqqe.de>
+  * Documentation fixes in the early days
+
+* Federico Ceratto <federico.ceratto@gmail.com>
+  * Support for ipaddr
+  * Added a sample configuration file
+
+* Sploinga <xavier@sploing.be>
+  * French translation
+
+* Laurent Arnoud <laurent@spkdev.net>
+  * Make Isso not accept blank comments
+
+* Chimo <chimo@chromic.org>
+  * STARTTLS for SMTP notifications
+
+* Jocelyn Delande <jocelyn at delalande dot fr>
+  * Documentation for comment counter and API
+  * Default SMTP security to STARTTLS
+
+* Srijan Choudhary <srijan4@gmail.com>
+  * Correct nginx examples in documentation
+  * Added comment pagination feature
+  * Provide a demo site
+
+* William Dorffer <schoewilliam@gmail.com>
+  * Convert SCSS to plain CSS
+  * Refresh style, make it responsive
+
+* Baptiste Darthenay
+  * Esperanto translation
+
+* Matías Ducasa <https://github.com/matiasducasa>
+  * Spanish translation
+
+* Daniel Gräber <https://github.com/albohlabs>
+  * Added ansible for provisioning
+
+* Nick Hu <https://github.com/NickHu>
+  * Added configuration to require email addresses (no validation)
+  * Fix Vagrantfile
+
+* Benoît Latinier @blatinier <benoit@latinier.fr>
+  * Fix thread discovery
+  * Added mandatory author
+  * Added admin interface
+
+* Ivan Pantic <ivanpantic82@gmail.com>
+  * Added vote levels
+
+* Martin Schenck @schemar
+  * Improvement in the german translation
+
+* @cclauss
+  * Pep8 and drop of legacy supports (old python & debian version tested in travis)
+  * Make travis use pyflakes
+
+* Lucas Cimon @Lucas-C
+  * Added the possibility to define CORS origins through ISSO_CORS_ORIGIN environment variable
+  * Fix a bug with <a> in <svg>
+  * Fixing likes counter of replies not being displayed
+  * Adding contrib/dump_comments.py
+  * Adding a [server] proxy-fix-enable-x-prefix configuration option
+  * Using .access_route instead of .remote_addr to take into account HTTP_X_FORWARDED_FOR header
+
+* Yuchen Pei @ycpei
+  * Fix link in moderation emails when isso is installed in a sub URL
+
+* @Rocket1184
+  * Fix typo in CJK translations
+
+* @vincentbernat
+  * Added documentation about data-isso-id attribute (overriding the standard isso-thread-id)
+  * Added multi-staged Dockerfile
+  * Added atom feed
+  * Added a nofollow/noopener on links inside comments to protect against bots
+  * Added a preview using the existing preview endpoint
+
+* @p-vitt & @M4a1x
+  * Documentation on troubleshooting for uberspace users
+
+* Facundo Batista <facundo@taniquetil.com.ar>
+  * Added a generic way to migrate from a json file
+
+* @benjhess
+  * Optionnal gravatar support
+
+* Steffen Prince @sprin
+  * Upgrade to Misaka 2
+
+* Rocka <i@rocka.me>
+  * Implementation and documentation about async comment loading
+
+* Pelle Nilsson @pellenilsson
+  * Reply notifications
+
+* Craig P Hicks @craigphicks
+  * Fix sub urls configurations on admin interface
+
+* Chris Warrick @Kwpolska
+  * Update Polish translation
+  * Redirect to comment after moderation
+
+* [Your name or handle] <[email or website]>
+  * [Brief summary of your changes]

Dockerfile

@@ -0,0 +1,34 @@
+# First, compile JS stuff
+FROM node:dubnium-buster
+WORKDIR /src/
+COPY . .
+RUN npm install -g requirejs uglify-js jade bower \
+ && make init js
+
+# Second, create virtualenv
+FROM python:3.8-buster
+WORKDIR /src/
+COPY --from=0 /src .
+RUN python3 -m venv /isso \
+ && . /isso/bin/activate \
+ && pip3 install --no-cache-dir --upgrade pip \
+ && pip3 install --no-cache-dir gunicorn cffi flask \
+ && python setup.py install \
+ && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/*
+
+# Third, create final repository
+FROM python:3.8-slim-buster
+WORKDIR /isso/
+COPY --from=1 /isso .
+
+# Configuration
+VOLUME /db /config
+EXPOSE 8080
+ENV ISSO_SETTINGS /config/isso.cfg
+CMD ["/isso/bin/gunicorn", "-b", "0.0.0.0:8080", "-w", "4", "--preload", "isso.run", "--worker-tmp-dir", "/dev/shm"]
+
+# Example of use:
+#
+# docker build -t isso .
+# docker run -it --rm -v /opt/isso:/config -v /opt/isso:/db -v $PWD:$PWD isso /isso/bin/isso -c \$ISSO_SETTINGS import disqus.xml
+# docker run -d --rm --name isso -p 8080:8080 -v /opt/isso:/config -v /opt/isso:/db isso

MANIFEST.in

@@ -1,5 +1,19 @@
+include man/man1/isso.1
+include man/man5/isso.conf.5
+
+include share/isso.conf
+
 include isso/js/embed.min.js
+include isso/js/embed.dev.js
 include isso/js/count.min.js
+include isso/js/count.dev.js
+include isso/js/admin.js
+
+include isso/defaults.ini
 
+include isso/templates/admin.html
+include isso/templates/disabled.html
+include isso/templates/login.html
+include isso/css/admin.css
 include isso/css/isso.css
-include isso/static/post.html
+include isso/img/isso.svg

Makefile

@@ -0,0 +1,75 @@
+# INSTALLATION: pip install sphinx && npm install --global node-sass
+
+ISSO_JS_SRC := $(shell find isso/js/app -type f) \
+	       $(shell ls isso/js/*.js | grep -vE "(min|dev)") \
+	       isso/js/lib/requirejs-jade/jade.js
+
+ISSO_JS_DST := isso/js/embed.min.js isso/js/embed.dev.js \
+	       isso/js/count.min.js isso/js/count.dev.js
+
+ISSO_CSS := isso/css/isso.css
+
+ISSO_PY_SRC := $(shell git ls-files | grep -E "^isso/.+.py$$")
+
+DOCS_RST_SRC := $(shell find docs/ -type f -name '*.rst') \
+		$(wildcard docs/_isso/*) \
+	        docs/index.html docs/conf.py docs/docutils.conf \
+		share/isso.conf
+
+DOCS_CSS_SRC := docs/_static/css/site.scss
+
+DOCS_CSS_DEP := $(shell find docs/_static/css/neat -type f) \
+		$(shell find docs/_static/css/bourbon -type f)
+
+DOCS_CSS_DST := docs/_static/css/site.css
+
+DOCS_MAN_DST := man/man1/isso.1 man/man5/isso.conf.5
+
+DOCS_HTML_DST := docs/_build/html
+
+RJS = r.js
+
+SASS = node-sass
+
+all: man js site
+
+init:
+	(cd isso/js; bower --allow-root install almond requirejs requirejs-text jade)
+
+flakes:
+	flake8 . --count --max-line-length=127 --show-source --statistics
+
+isso/js/%.min.js: $(ISSO_JS_SRC) $(ISSO_CSS)
+	$(RJS) -o isso/js/build.$*.js out=$@
+
+isso/js/%.dev.js: $(ISSO_JS_SRC) $(ISSO_CSS)
+	$(RJS) -o isso/js/build.$*.js optimize="none" out=$@
+
+js: $(ISSO_JS_DST)
+
+man: $(DOCS_RST_SRC)
+	sphinx-build -b man docs/ man/
+	mkdir -p man/man1/ man/man5
+	mv man/isso.1 man/man1/isso.1
+	mv man/isso.conf.5 man/man5/isso.conf.5
+
+${DOCS_CSS_DST}: $(DOCS_CSS_SRC) $(DOCS_CSS_DEP)
+	$(SASS) --no-cache $(DOCS_CSS_SRC) $@
+
+${DOCS_HTML_DST}: $(DOCS_RST_SRC) $(DOCS_CSS_DST)
+	sphinx-build -b dirhtml docs/ $@
+
+site: $(DOCS_HTML_DST)
+
+coverage: $(ISSO_PY_SRC)
+	nosetests --with-doctest --with-coverage --cover-package=isso --cover-html isso/
+
+test: $($ISSO_PY_SRC)
+	python3 setup.py nosetests
+
+clean:
+	rm -f $(DOCS_MAN_DST) $(DOCS_CSS_DST) $(ISSO_JS_DST)
+	rm -rf $(DOCS_HTML_DST)
+
+.PHONY: clean site man init js coverage test
+

README.md

@@ -1,147 +1,12 @@
-Isso – Ich schrei sonst
-=======================
+[![Build Status](https://drone.nixaid.com/api/badges/arno/isso/status.svg)](https://drone.nixaid.com/arno/isso)
 
-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.
+Isso – a commenting server similar to Disqus
+============================================
 
-[1]: https://github.com/posativ/acrylamid
-[2]: https://disqus.com/
+Isso – *Ich schrei sonst* – is a lightweight commenting server written in
+Python and JavaScript. It aims to be a drop-in replacement for
+[Disqus](http://disqus.com).
 
-**[Try Yourself!](http://posativ.org/isso/)**
+![Isso in Action](http://posativ.org/~tmp/isso-sample.png)
 
-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)
-* 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
-- easy_install or pip
-
-Install Isso (and its dependencies) 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
-
-You start the server via (try to visit [http://localhost:8080/static/post.html]()).
-
-    ~> isso run
-
-If that is working, you may want to [edit the configuration](https://github.com/posativ/isso/blob/master/docs/CONFIGURATION.rst).
-
-
-Webserver Configuration
------------------------
-
-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.
-
-### Isso on a Sub URI
-
-Let's assume you want Isso on `/isso`, use the following nginx snippet:
-
-```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;
-    }
-}
-```
-
-```html
-<script src="http://example.tld/isso/js/embed.min.js"></script>
-<div id="isso-thread"></div>
-```
-
-### 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:
-
-```html
-<script src="http://example.tld:8080/js/embed.min.js"></script>
-<div id="isso-thread"></div>
-```
-
-Also, put the plain isso server behind a real web server or [use uWSGI][3].
-
-[3]: https://github.com/posativ/isso/blob/master/docs/uWSGI.md
-
-
-Website Integration
--------------------
-
-To enable comments, add a `<div id="isso-thread"></div>` or `<section id="isso-thread" ...`
-below your post.
-
-To add comment count links to your index page, include `count.min.js` at the
-very bottom of your document. All links followed by `#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.
-
-
-
-Other Documents
----------------
-
-- [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)
-
-
-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)
+See [posativ.org/isso](http://posativ.org/isso/) for more details.

Vagrantfile

@@ -0,0 +1,65 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# This is the Vagrant config file for setting up an environment for Isso development.
+# It requires:
+#
+# * Vagrant (https://vagrantup.com)
+# * A VM engine, like VirtualBox (https://virtualbox.org)
+# * The Vagrant-Hostmanager plugin (https://github.com/smdahlen/vagrant-hostmanager)
+# * Ansible (https://www.ansible.com)
+#
+# With them installed, cd into this directory and do 'vagrant up'. It's possible Vagrant will
+# ask for your root password so it can update your /etc/hosts file. Once it's happily churning out
+# console output, go get a coffee :)
+#
+# The resulting VM should be accessible at http://isso-dev.local/ so you can try the demo page out.
+# Edit files in your checkout as usual. If you need to look at log files and stuff, 'vagrant ssh'
+# to get into the VM. Useful info about it:
+#
+# * Running Ubuntu 14.04
+# * Isso is running on uWSGI
+# * Actual webserver is Nginx to talk to uWSGI over a unix socket
+# * uWSGI log file is /var/log/uwsgi/apps/isso.log
+# * Isso DB file is /var/isso/comments.db
+# * Isso log file is /var/log/isso.log
+#
+# When the VM is getting rebooted vagrant mounts the shared folder after uWSGI is getting startet. To fix this issue for
+# the moment you need to 'vagrant ssh' into the VM and execute 'sudo service uwsgi restart'.
+#
+# For debugging with _pudb_ stop uWSGI service and start it manually
+# 'sudo uwsgi --ini /etc/uwsgi/apps-available/isso.ini'.
+#
+# Enjoy!
+
+Vagrant.configure(2) do |config|
+
+  # The most common configuration options are documented and commented below.
+  # For a complete reference, please see the online documentation at
+  # https://docs.vagrantup.com.
+
+  config.vm.box = "ubuntu/trusty32"
+
+  config.vm.hostname = 'isso-dev.local'
+  config.vm.network "private_network", type: "dhcp"
+
+  config.hostmanager.enabled = true
+  config.hostmanager.manage_host = true
+  config.hostmanager.ignore_private_ip = false
+  config.hostmanager.include_offline = true
+  config.hostmanager.ip_resolver = proc do |machine|
+    result = ""
+    machine.communicate.execute("ifconfig eth1") do |type, data|
+      result << data if type == :stdout
+    end
+    (ip = /inet addr:(\d+\.\d+\.\d+\.\d)/.match(result)) && ip[1]
+  end
+
+  config.vm.provision "ansible" do |ansible|
+    ansible.playbook = "ansible/site.yml"
+    ansible.limit = "all"
+    ansible.verbose = "v"
+  end
+
+  config.vm.post_up_message = "Browse to http://isso-dev.local/demo/index.html to start."
+end

ansible/files/nginx.conf

@@ -0,0 +1,39 @@
+user root;
+worker_processes 4;
+worker_rlimit_nofile 8192;
+
+error_log  /var/log/nginx/error.log warn;
+pid        /run/nginx.pid;
+
+events {
+    worker_connections 2014;
+    multi_accept on;
+    use epoll;
+}
+
+http {
+    include       /etc/nginx/mime.types;
+    default_type  application/octet-stream;
+
+    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+                      '$status $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for"';
+
+    log_format  timed  '$remote_addr - $remote_user [$time_local] "$request" '
+                      '$status $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for" '
+                      '$request_time $upstream_response_time $upstream_addr '
+                      ' $upstream_status $upstream_cache_status $pipe';
+
+    access_log  /var/log/nginx/access.log  timed;
+
+    sendfile        on;
+    tcp_nopush     on;
+
+    keepalive_timeout  30;
+
+    gzip  on;
+
+    include /etc/nginx/conf.d/*.conf;
+    include /etc/nginx/sites-enabled/*;
+}

ansible/files/nginx.vhost.conf

@@ -0,0 +1,13 @@
+server {
+    client_max_body_size 20M;
+    listen 80 default_server;
+    server_name isso-dev.local;
+
+    root /vagrant/isso/demo;
+
+    location / {
+        # uwsgi_pass unix:///run/uwsgi/app/isso/socket;
+        uwsgi_pass 127.0.0.1:8080;
+        include uwsgi_params;
+    }
+}

ansible/files/uwsgi.ini

@@ -0,0 +1,24 @@
+[uwsgi]
+plugins = python
+
+chdir = /vagrant
+
+uid = root
+gid = root
+
+socket = :8080
+
+master = true
+processes = 4
+cache2 = name=hash,items=10240,blocksize=32
+spooler = /var/isso/spool
+module = isso.run
+env = ISSO_SETTINGS=/vagrant/share/isso-dev.conf
+env = PYTHON_EGG_CACHE=/tmp
+
+# uncomment for debugging
+# daemonize = /var/log/uwsgi/uwsgi.log
+py-autoreload = 1
+
+# prevent uWSGI from remapping stdin to /dev/null
+honour-stdin = true

ansible/site.yml

@@ -0,0 +1,85 @@
+---
+
+- name: Provision development server
+  hosts: all
+  sudo: true
+  tasks:
+
+    - name: Apt | Add nodesource keys
+      apt_key: url=https://deb.nodesource.com/gpgkey/nodesource.gpg.key state=present
+
+    - name: Apt | Add nodesource sources list deb
+      apt_repository: repo='deb https://deb.nodesource.com/node {{ ansible_distribution_release }} main' state=present
+
+    - name: Apt | Add nodesource sources list deb src
+      apt_repository: repo='deb-src https://deb.nodesource.com/node {{ ansible_distribution_release }} main' state=present
+
+    - name: Apt | Install packages
+      apt: pkg={{ item }} state=latest update_cache=true
+      with_items:
+        - build-essential
+        - curl
+        - htop
+        - vim
+        - git
+        - python-dev
+        - python-software-properties
+        - python-setuptools
+        - python-pip
+        - nginx
+        - uwsgi
+        - uwsgi-plugin-python
+        - supervisor
+        - sqlite3
+        - nodejs
+        - libffi-dev
+
+    - name: NPM | Install packages
+      npm: name={{ item }} global=yes
+      with_items:
+        - bower
+        - requirejs
+        - uglify-js
+        - jade
+
+    - name: Python | Install egg
+      shell: cd /vagrant; python setup.py develop
+
+    - name: Make
+      shell: cd /vagrant; {{ item }}
+      with_items:
+        - make init
+        - make js
+
+    - name: Spool | Create directory
+      file: path=/var/isso/spool state=directory mode=0777
+
+    - name: uwsgi | Deploy configuration
+      copy: src=files/uwsgi.ini dest=/etc/uwsgi/apps-available/isso.ini
+
+    - name: uwsgi | Enable app
+      file: src=/etc/uwsgi/apps-available/isso.ini dest=/etc/uwsgi/apps-enabled/isso.ini state=link
+
+    - name: uwsgi | Restart service daemon
+      service: name=uwsgi state=restarted enabled=yes
+
+    - name: uwsgi | Chmod logfile
+      file: path=/var/log/uwsgi/uwsgi.log state=touch mode="a+r"
+
+    - name: nginx | Deploy nginx.conf
+      copy: src=files/nginx.conf dest=/etc/nginx/nginx.conf
+
+    - name: nginx | Delete default vhost
+      action: file path=/etc/nginx/sites-enabled/default state=absent
+
+    - name: nginx | Deploy vhost config
+      copy: src=files/nginx.vhost.conf dest=/etc/nginx/sites-available/isso.conf
+
+    - name: nginx | Enable vhost
+      file: src=/etc/nginx/sites-available/isso.conf dest=/etc/nginx/sites-enabled/000-isso state=link
+
+    - name: nginx | Chmod logfile
+      file: path=/var/log/nginx mode="a+rx" state=directory recurse=true
+
+    - name: nginx | Restart service daemon
+      service: name=nginx state=restarted enabled=yes

apidoc.json

@@ -0,0 +1,11 @@
+{
+		"name": "isso",
+		"description": "a Disqus alternative",
+		"title": "isso API",
+		"order": ["Thread",  "Comment"],
+		"template": {
+			"withCompare": false
+		}
+
+}
+

bin/tx-pull

@@ -0,0 +1,13 @@
+#!/usr/bin/env fish
+
+set -g TRANSIFEX ".tx/js/"
+set -g JS "isso/js/app/i18n/%s.js"
+
+# fetch latest translations to .tx/<ressource>/<lang>
+tx pull -a
+
+for lang in (ls $TRANSIFEX)
+    printf "define(" > (printf $JS $lang)
+    cat .tx/js/$lang >> (printf $JS $lang)
+    printf ");\n" >> (printf $JS $lang)
+end

bin/tx-push

@@ -0,0 +1,34 @@
+#!/usr/bin/env fish
+
+set TRANSIFEX "https://www.transifex.com/api/2"
+
+if [ (count $argv) -ne 1 ]
+    echo "tx-push FILE"
+    exit 2
+end
+
+if [ ! -f ~/.transifexrc ]
+    echo "no ~/.transifexrc found"
+    exit 1
+end
+
+set user (cat ~/.transifexrc | grep -E "^username" | awk -F " ?= ?" '{ print $2 }')
+set pass (cat ~/.transifexrc | grep -E "^password" | awk -F " ?= ?" '{ print $2 }')
+
+set lang (echo $argv | cut -d / -f 5 | cut -d . -f 1)
+set trans (mktemp -t tx.XXX)
+
+if [ $lang = "en" ]
+    set url "$TRANSIFEX/project/isso/resource/js/content/"
+else
+    set url "$TRANSIFEX/project/isso/resource/js/translation/$lang/"
+end
+
+printf '{"content":' > $trans
+cat $argv \
+ | sed "s,^define(,,g;\$ s,);,,g" \
+ | python -c 'import json,sys; print json.dumps(sys.stdin.read())' \
+ >> $trans
+printf '}' >> $trans
+
+curl -L -u $user:$pass -XPUT $url -H "Content-Type: application/json" -d @$trans

contrib/dump_comments.py

@@ -0,0 +1,128 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+#
+# The MIT License (MIT)
+#
+# Copyright (c) 2020 Lucas Cimon.
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+"""Dump isso comments as text
+
+The script can be run like this:
+
+    contrib/dump_comments.py .../path/to/isso.db --sort-by-last-reply
+
+To get a list of all available options:
+
+    contrib/dump_comments.py --help
+
+By installing the optional colorama dependency, you'll get a colored output.
+An example of output can be found at https://github.com/posativ/isso/issues/634
+"""
+
+import argparse
+import sqlite3
+from collections import defaultdict, namedtuple
+from datetime import date
+from textwrap import indent
+
+
+class ColorFallback():
+    __getattr__ = lambda self, name: ''  # noqa: E731
+
+
+try:
+    from colorama import Fore, Style, init
+    init()  # needed for Windows
+except ImportError:  # fallback so that the imported classes always exist
+    Fore = Style = ColorFallback()
+
+
+Comment = namedtuple('Comment', ('uri', 'id', 'parent', 'created', 'text', 'author', 'email', 'website', 'likes', 'dislikes', 'replies'))
+
+INDENT = '    '
+QUERY = 'SELECT uri, comments.id, parent, created, text, author, email, website, likes, dislikes FROM comments INNER JOIN threads on comments.tid = threads.id'
+
+
+def main():
+    args = parse_args()
+    if not args.colors:
+        global Fore, Style
+        Fore = Style = ColorFallback()
+    db = sqlite3.connect(args.db_path)
+    comments_per_uri = defaultdict(list)
+    for result in db.execute(QUERY).fetchall():
+        comment = Comment(*result, replies=[])
+        comments_per_uri[comment.uri].append(comment)
+    root_comments_per_sort_date = {}
+    for comments in comments_per_uri.values():
+        comments_per_id = {comment.id: comment for comment in comments}
+        root_comments, sort_date = [], None
+        for comment in comments:
+            if comment.parent:  # == this is a "reply" comment
+                comments_per_id[comment.parent].replies.append(comment)
+                if args.sort_by_last_reply and (sort_date is None or comment.created > sort_date):
+                    sort_date = comment.created
+            else:
+                root_comments.append(comment)
+                if sort_date is None or comment.created > sort_date:
+                    sort_date = comment.created
+        root_comments_per_sort_date[sort_date] = root_comments
+    for _, root_comments in sorted(root_comments_per_sort_date.items(), key=lambda pair: pair[0]):
+        print(Fore.MAGENTA + args.url_prefix + root_comments[0].uri + Fore.RESET)
+        for comment in root_comments:
+            print_comment(INDENT, comment)
+            for comment in comment.replies:
+                print_comment(INDENT * 2, comment)
+        print()
+
+
+def print_comment(prefix, comment):
+    author = comment.author or 'Anonymous'
+    email = comment.email or ''
+    website = comment.website or ''
+    when = date.fromtimestamp(comment.created)
+    popularity = ''
+    if comment.likes:
+        popularity = '+{.likes}'.format(comment)
+    if comment.dislikes:
+        if popularity:
+            popularity += '/'
+        popularity = '-{.dislikes}'.format(comment)
+    print(prefix + '{Style.BRIGHT}{author}{Style.RESET_ALL} {Style.DIM}- {email} {website}{Style.RESET_ALL} {when} {Style.DIM}{popularity}{Style.RESET_ALL}'.format(Style=Style, **locals()))
+    print(indent(comment.text, prefix))
+
+
+def parse_args():
+    parser = argparse.ArgumentParser(description='Dump all Isso comments in chronological order, grouped by replies',
+                                     formatter_class=ArgparseHelpFormatter)
+    parser.add_argument('db_path', help='File path to Isso Sqlite DB')
+    parser.add_argument('--sort-by-last-reply', action='store_true', help='By default comments are sorted by "parent" comment date, this sort comments based on the last replies')
+    parser.add_argument('--url-prefix', default='', help='Optional domain name to prefix to pages URLs')
+    parser.add_argument('--no-colors', action='store_false', dest='colors', default=True, help='Disabled colored output')
+    return parser.parse_args()
+
+
+class ArgparseHelpFormatter(argparse.RawTextHelpFormatter, argparse.ArgumentDefaultsHelpFormatter):
+    pass
+
+
+if __name__ == '__main__':
+    main()

contrib/import_blogger.py

@@ -0,0 +1,123 @@
+#!/usr/bin/env python
+# -*- encoding: utf-8 -*-
+
+"""Comment importer from Blogger
+
+This python script can convert comments posted to a Blogger-powered blog to a
+JSON file with can then be imported into Isso (by following the procedure
+explained in docs/docs/extras/advanced-migration.rst.
+
+The script can be run like this:
+
+    python import_blogger.py -p 'http://myblog.com/' blogger.xml out.json
+
+where `blogger.xml` is a dump of the blog produced by the Blogger platform, and
+the URL following the `-p` option is a prefix that will be applied to all post
+URLs: the original host will be stripped and the path will be appended to the
+string you specify here (this can be useful in the case that your blog moved to
+a different domain, subdomain, or just into a new directory).
+The `out.json` file is the file which will be generated by this tool, and which
+can then be fed into isso:
+
+    isso -c /path/to/isso.cfg import -t generic out.json
+"""
+
+from __future__ import unicode_literals
+
+import json
+
+import feedparser
+import time
+from urllib.parse import urlparse
+
+
+class Post:
+    def __init__(self, url):
+        self.url = url
+        self.title = None
+        self.comments = []
+
+    def add_comment(self, comment):
+        comment['id'] = len(self.comments) + 1
+        self.comments.append(comment)
+
+
+def encode_post(post):
+    ret = {}
+    ret['id'] = post.url
+    ret['title'] = post.title
+    ret['comments'] = post.comments
+    return ret
+
+
+class ImportBlogger:
+    TYPE_COMMENT = 'http://schemas.google.com/blogger/2008/kind#comment'
+    TYPE_POST = 'http://schemas.google.com/blogger/2008/kind#post'
+
+    def __init__(self, filename_in, filename_out, prefix):
+        self.channel = feedparser.parse(filename_in)
+        self.filename_out = filename_out
+        self.prefix = prefix
+
+    def run(self):
+        self.posts = {}
+        for item in self.channel.entries:
+            terms = [tag.term for tag in item.tags]
+            if not terms:
+                continue
+            if terms[0] == self.TYPE_COMMENT:
+                post = self.ensure_post(item)
+                post.add_comment(self.process_comment(item))
+            elif terms[0] == self.TYPE_POST:
+                self.process_post(item)
+
+        data = [encode_post(p) for p in self.posts.values() if p.comments]
+        with open(self.filename_out, 'w') as fp:
+            json.dump(data, fp, indent=2)
+
+    def process_post(self, item):
+        pid = self.post_id(item)
+        if pid in self.posts:
+            post = self.posts[pid]
+        else:
+            post = Post(pid)
+            self.posts[pid] = post
+        post.title = item.title
+
+    def ensure_post(self, item):
+        pid = self.post_id(item)
+        post = self.posts.get(pid, None)
+        if not post:
+            post = Post(pid)
+            self.posts[pid] = post
+        return post
+
+    def process_comment(self, item):
+        comment = {}
+        comment['author'] = item.author_detail.name
+        comment['email'] = item.author_detail.email
+        comment['website'] = item.author_detail.get('href', '')
+        t = time.strftime('%Y-%m-%d %H:%M:%S', item.published_parsed)
+        comment['created'] = t
+        comment['text'] = item.content[0].value
+        comment['remote_addr'] = '127.0.0.1'
+        return comment
+
+    def post_id(self, item):
+        u = urlparse(item.link)
+        return self.prefix + u.path
+
+
+if __name__ == '__main__':
+    import argparse
+    parser = argparse.ArgumentParser(
+        description='Convert comments from blogger.com')
+    parser.add_argument('input', help='input file')
+    parser.add_argument('output', help='output file')
+    parser.add_argument('-p', dest='prefix',
+                        help='prefix to be added to paths (ID)',
+                        type=str, default='')
+    args = parser.parse_args()
+
+    importer = ImportBlogger(args.input, args.output, args.prefix)
+    importer.run()

docs/API.md

@@ -1,100 +0,0 @@
-Isso API
-========
-
-The Isso API uses HTTP and JSON as primary communication protocol.
-
-
-## JSON format
-
-When querying the API you either get an error, an object or list of objects
-representing the comment. Here's a example JSON returned from Isso:
-
-```json
-{
-    "text": "Hello, World!",
-    "author": "Bernd",
-    "website": null,
-    "votes": 0,
-    "mode": 1,
-    "id": 1,
-    "parent": null,
-    "hash": "68b329da9893e34099c7d8ad5cb9c940",
-    "created": 1379001637.50,
-    "modified": null
-}
-```
-
-text
-: required, comment as HTML
-
-author
-: author's name, may be `null`
-
-website
-: author's website, may be `null`
-
-votes
-: sum of up- and downvotes, defaults to zero.
-
-mode
-: * 1, accepted comment
-  * 2, comment in moderation queue
-  * 4, comment deleted, but is referenced
-
-id
-: unique comment number per thread
-
-parent
-: answer to a parent id, may be `null`
-
-hash
-: user identification, used to generate identicons
-
-created
-: time in seconds sinde epoch
-
-modified
-: last modification time in seconds, may be `null`
-
-
-## List comments
-
-List all visible comments for a thread. Does not include deleted and
-comments currently in moderation queue.
-
-    GET /?uri=path
-
-You must encode `path`, e.g. to retrieve comments for `/hello-world/`:
-
-    GET /?uri=%2Fhello-world%2F
-
-To disable automatic Markdown-to-HTML conversion, pass `plain=1` to the
-query URL:
-
-    GET /?uri=...&plain=1
-
-As response, you either get 200, 400, or 404, which are pretty self-explanatory.
-
-    GET /
-    400 BAD REQUEST
-
-    GET /?uri=%2Fhello-world%2F
-    404 NOT FOUND
-
-    GET /?uri=%2Fcomment-me%2F
-    [{comment 1}, {comment 2}, ...]
-
-
-## Create comments
-
-...
-
-
-## Delete comments
-
-...
-
-
-## Up- and downvote comments
-
-...

docs/CONFIGURATION.rst

@@ -1,188 +0,0 @@
-Isso Configuration
-==================
-
-The Isso configuration file is an `INI-style`__ textfile.  Below is an example for
-a basic Isso configuration. Each section has its own documentation.
-
-.. code-block:: ini
-
-    [general]
-    dbpath = /var/lib/isso/comments.db
-    host = https://example.tld/
-    [server]
-    port = 1234
-
-You can point Isso to your configuration file either witg a command-line parameter
-or using an environment variable:
-
-.. code-block:: sh
-
-    ~> isso -c path/to/isso.cfg
-    ~> env ISSO_SETTINGS=path/to/isso.cfg isso
-
-__ https://en.wikipedia.org/wiki/INI_file
-
-
-General
--------
-
-In this section, you configure most comment-related options such as database path,
-session key and hostname. Here are the default values for this section:
-
-.. code-block:: ini
-
-    [general]
-    dbpath = /tmp/isso.db
-    host = http://localhost:8080/
-    max-age = 15m
-    session-key = ... # python: binascii.b2a_hex(os.urandom(24))
-
-dbpath
-    file location to the SQLite3 database, highly recommended to change this
-    location to a non-temporary location!
-
-host
-    URL to your website. When you start Isso, it will probe your website with
-    a simple ``GET /`` request to see if it can reach the webserver. If this
-    fails, Isso may not be able check if a web page exists, thus fails to
-    accept new comments.
-
-    You can supply more than one host:
-
-    .. code-block:: ini
-
-        [general]
-        host =
-            http://localhost/
-            https://localhost/
-
-    This is useful, when your website is available on HTTP and HTTPS.
-
-session-key
-    private session key to validate client cookies. If you restart the
-    application several times per hour for whatever reason, use a fixed
-    key.
-
-max-age
-    time range that allows users to edit/remove their own comments. See
-    :ref:`Appendum: Timedelta <appendum-timedelta>` for valid values.
-
-
-Moderation
-----------
-
-Enable moderation queue and handling of comments still in moderation queue
-
-.. code-block:: ini
-
-    [moderation]
-    enabled = false
-    purge-after = 30d
-
-enabled
-    enable comment moderation queue. This option only affects new comments.
-    Comments in modertion queue are not visible to other users until you
-    activate them.
-
-purge-after
-    remove unprocessed comments in moderation queue after given time.
-
-
-Server
-------
-
-HTTP server configuration, does **not** apply to uWSGI.
-
-.. code-block:: ini
-
-    [server]
-    host = localhost
-    port = 8080
-    reload = off
-
-host
-    listen on specified interface
-
-port
-    application port
-
-reload
-    reload application, when the source code has changed. Useful for
-    development (don't forget to use a fixed `session-key`).
-
-
-SMTP
-----
-
-Isso can notify you on new comments via SMTP. In the email notification, you
-also can moderate comments. If the server connection fails during startup, a
-null mailer is used.
-
-.. code-block:: ini
-
-    [smtp]
-    username =
-    password =
-    host = localhost
-    port = 465
-    ssl = on
-    to =
-    from =
-
-username
-    self-explanatory, optional
-
-password
-    self-explanatory (yes, plain text, create a dedicated account for
-    notifications), optional.
-
-host
-    SMTP server
-
-port
-    SMTP port
-
-ssl
-    use SSL to connect to the server. Python probably does not validate the
-    certificate. Needs research, though. But you should use a dedicated
-    email account anyways.
-
-to
-    recipient address, e.g. your email address
-
-from
-    sender address, e.g. isso@example.tld
-
-
-Guard
------
-
-Enable basic spam protection features, e.g. rate-limit per IP address (``/24``
-for IPv4, ``/48`` for IPv6).
-
-.. code-block:: ini
-
-    [guard]
-    enabled = true
-    ratelimit = 2
-
-enabled
-    enable guard, recommended in production. Not useful for debugging
-    purposes.
-
-ratelimit: N
-    limit to N new comments per minute.
-
-
-Appendum
----------
-
-.. _appendum-timedelta:
-
-Timedelta
-    A human-friendly representation of a time range: `1m` equals to 60
-    seconds. This works for years (y), weeks (w), days (d) and seconds (s),
-    e.g. `30s` equals 30 to seconds.
-
-    You can add different types: `1m30s` equals to 90 seconds, `3h45m12s`
-    equals to 3 hours, 45 minutes and 12 seconds (12512 seconds).

docs/_isso/layout.html

@@ -0,0 +1,124 @@
+<!DOCTYPE html>
+{%- set url_root = pathto('', 1) %}
+{# XXX necessary? #}
+{%- if url_root == '#' %}{% set url_root = '' %}{% endif %}
+
+{%- macro script() %}
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '{{ url_root }}',
+        VERSION:     '{{ release|e }}',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
+        HAS_SOURCE:  {{ has_source|lower }},
+        SOURCELINK_SUFFIX:  '{{ sourcelink_suffix }}'
+      };
+    </script>
+    {%- for scriptfile in script_files %}
+    <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
+    {%- endfor %}
+{%- endmacro %}
+
+{%- macro css() %}
+    <!--link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" /-->
+    <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
+    <link rel="stylesheet" href="{{ pathto('_static/css/site.css', 1) }}"/>
+    {%- for cssfile in css_files %}
+    <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
+    {%- endfor %}
+{%- endmacro %}
+
+<html>
+  <head>
+    <meta charset="utf-8">
+    {{ metatags }}
+    {%- block htmltitle %}
+    <title>{{ title|striptags|e }}</title>
+    {%- endblock %}
+    {{ css() }}
+    {%- if not embedded %}
+    {{ script() }}
+    {%- if use_opensearch %}
+    <link rel="search" type="application/opensearchdescription+xml"
+          title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
+          href="{{ pathto('_static/opensearch.xml', 1) }}"/>
+    {%- endif %}
+    {%- if favicon %}
+    <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
+    {%- endif %}
+    {%- endif %}
+{%- block linktags %}
+    {%- if hasdoc('about') %}
+    <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
+    {%- endif %}
+    {%- if hasdoc('genindex') %}
+    <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
+    {%- endif %}
+    {%- if hasdoc('search') %}
+    <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
+    {%- endif %}
+    {%- if hasdoc('copyright') %}
+    <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
+    {%- endif %}
+    <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
+    {%- if parents %}
+    <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" />
+    {%- endif %}
+    {%- if next %}
+    <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
+    {%- endif %}
+    {%- if prev %}
+    <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
+    {%- endif %}
+{%- endblock %}
+{%- block extrahead %} {% endblock %}
+</head>
+<body>
+    <div class="wrapper">
+        <div class="header">
+            <header>
+                <img class="logo" src="{{ pathto('_static/isso.svg', 1) }}" alt="Wynaut by @veekun"/>
+                <div class="title">
+                    <a href="{{ pathto(".") }}">
+                        <h1>Isso</h1>
+                        <h2>a commenting server similar to Disqus</h2>
+                    </a>
+                </div>
+            </header>
+            <nav>
+                <ul>
+                    <li><a href="{{ pathto('faq') }}">FAQ</a></li>
+                    <li><a href="{{ pathto('contribute') }}">Contribute</a></li>
+                    <li><a href="{{ pathto('docs') }}">Documentation</a></li>
+                </ul>
+            </nav>
+        </div>
+
+        <div class="outer">
+            {% block header %} {% endblock %}
+        </div>
+
+
+        <main>
+        {% block body %} {% endblock %}
+        </main>
+
+        <div class="push"></div>
+    </div>
+
+    <div class="outer footer">
+        {%- block footer %}
+        <footer>
+        &copy; Copyright {{ copyright }}.
+
+        {%- if last_updated %}
+            Last updated on {{ last_updated }}.
+        {%- endif %}
+
+        Made with <a href="http://sphinx-doc.org/">Sphinx</a>.
+        </footer>
+    </div>
+
+{%- endblock %}
+  </body>
+</html>

docs/_isso/page.html

@@ -0,0 +1,16 @@
+{%- extends "layout.html" %}
+{% block header  %}
+    <header>
+        <h1>{{- title -}}</h1>
+    </header>
+{% endblock %}
+{% block body %}
+    <div class="sidebar">
+    {% if pagename.startswith("docs/") %}
+        {% include "sidebar-docs.html" %}
+    {% endif %}
+    </div>
+    <div class="docs">
+        {{ body }}
+    </div>
+{% endblock %}

docs/_isso/remove_heading.py

@@ -0,0 +1,11 @@
+
+from docutils import nodes
+from sphinx.writers.html import HTMLTranslator
+
+
+class IssoTranslator(HTMLTranslator):
+
+    def visit_title(self, node):
+        if self.section_level == 1:
+            raise nodes.SkipNode
+        HTMLTranslator.visit_title(self, node)

docs/_isso/search.html

@@ -0,0 +1,54 @@
+{% extends "layout.html" %}
+{% block header %}
+    <header>
+        <h1>Search</h1>
+    </header>
+{% endblock %}
+{% set title = _('Search') %}
+{% set script_files = script_files + ['_static/searchtools.js'] %}
+{% block extrahead %}
+  <script type="text/javascript">
+    jQuery(function() { Search.loadIndex("{{ pathto('searchindex.js', 1) }}"); });
+  </script>
+  {# this is used when loading the search index using $.ajax fails,
+     such as on Chrome for documents on localhost #}
+  <script type="text/javascript" id="searchindexloader"></script>
+  {{ super() }}
+{% endblock %}
+{% block body %}
+  <div id="fallback" class="admonition warning">
+  <script type="text/javascript">$('#fallback').hide();</script>
+  <p>
+    {% trans %}Please activate JavaScript to enable the search
+    functionality.{% endtrans %}
+  </p>
+  </div>
+  <p>
+    {% trans %}From here you can search these documents. Enter your search
+    words into the box below and click "search". Note that the search
+    function will automatically search for all of the words. Pages
+    containing fewer words won't appear in the result list.{% endtrans %}
+  </p>
+  <form action="" method="get">
+    <input type="text" name="q" value="" />
+    <input type="submit" value="{{ _('search') }}" />
+    <span id="search-progress" style="padding-left: 10px"></span>
+  </form>
+  {% if search_performed %}
+    <h2>{{ _('Search Results') }}</h2>
+    {% if not search_results %}
+      <p>{{ _("Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories.") }}</p>
+    {% endif %}
+  {% endif %}
+  <div id="search-results">
+  {% if search_results %}
+    <ul>
+    {% for href, caption, context in search_results %}
+      <li><a href="{{ pathto(item.href) }}">{{ caption }}</a>
+        <div class="context">{{ context|e }}</div>
+      </li>
+    {% endfor %}
+    </ul>
+  {% endif %}
+  </div>
+{% endblock %}

docs/_isso/searchbox.html

@@ -0,0 +1,12 @@
+{%- if pagename != "search" %}
+<div id="searchbox" style="display: none">
+  <h2>{{ _('Quick search') }}</h2>
+    <form class="search" action="{{ pathto('search') }}" method="get">
+      <input type="text" name="q" />
+      <input type="submit" value="{{ _('Go') }}" />
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+{%- endif %}

docs/_isso/sidebar-docs.html

@@ -0,0 +1,32 @@
+{% macro doc(path, title) %}
+    {%- if pagename == path -%}
+    <li class="active">
+    {% else %}
+    <li>
+    {%- endif -%}
+    <a href="{{ pathto(path) }}">{{ title }}</a></li>
+{% endmacro %}
+
+<strong>Getting Started</strong>
+<ul>
+    {{ doc("docs/install", "Installation") }}
+    {{ doc("docs/quickstart", "Quickstart") }}
+    {{ doc("docs/troubleshooting", "Troubleshooting") }}
+</ul>
+<strong>Advanced Setup</strong>
+<ul>
+    {{ doc("docs/setup/sub-uri", "Sub URI") }}
+    {{ doc("docs/setup/multiple-sites", "Multiple Sites") }}
+</ul>
+<strong>Configuration</strong>
+<ul>
+    {{ doc("docs/configuration/server", "Server") }}
+    {{ doc("docs/configuration/client", "Client") }}
+</ul>
+<strong>Extras</strong>
+<ul>
+    {{ doc("docs/extras/deployment", "Deployment") }}
+    {{ doc("docs/extras/advanced-integration", "Advanced Integration") }}
+    {{ doc("docs/extras/api", "API") }}
+    {{ doc("docs/extras/contribs", "Community tools") }}
+</ul>

docs/_isso/theme.conf

@@ -0,0 +1,3 @@
+[theme]
+inherit = basic
+stylesheet = css/site.css