Install

Recommended

Step-by-step guides

Dependencies

Hatta Wiki requires Werkzeug (at least version 0.3) and Mercurial (at least 1.0) to work. It also benefits from having Pygments installed. Oh, of course it also requires a working Python at least 2.5.

Note: The development version may occasionally break compatibility with some versions of libraries – especially the older ones. This is due to their changing APIs. These incompatibilities are supposed to be fixed before releases, though.

Users and permissions

Hatta doesn't have any user management or page permission facilities, but it's written in such a way, that you can use the authentication mechanisms of your web server.

Private wiki

You can simply configure your web server to require a password when accessing the wiki. Hatta will even fill in the user name in the editor automatically from that information! You can use the same password for everyone or configure different accounts for different users. Some web servers will even allow you to authenticate in LDAP or through PAM. And all without me having to write a single line of code, isn't it great? :D

Read-only wiki

Instead of setting the password for the whole wiki, you can set the password for the /edit/ URLs, and if you don't want your users to be able to revert to old revisions, also /history/ (will be changed to /undo/ in newer versions). This way users only have to log in to edit the wiki.

(>)# See also Config for a more convenient way to lock single pages from editing.

As of version 1.3.0 you can also set the read_only option to prevent page editing.


Question: how might I provide a read-only wiki, but require users to login if they want to edit pages? Would it be reasonable for two copies of Hatta to run concurrently on the same docs tree, where one is read-only and the other requires upfront authentication? Could Mercurial handle this case? – Randy