Uniqki Manual
Written by Huidae Cho
- Introduction
- Features
- File/Directory Structure
- Install
- Configuration
- User Actions
- Administrator Actions
- Syntax
Introduction
Uniqki is Unique Wiki written in Perl. Uniqki is a simple yet powerful website builder for minimalists and is mainly written for small private sites consisting of static HTML files. The basic philosophy behind Uniqki is the minimalism. Uniqki provides the user with the simplicity and portability of a website built upon it. To this end, Uniqki was designed not to depend on any other software except for Perl and, of course, any web server. The minimum requirement for Uniqki is as follows:
- Any web server with Perl CGI support
- Perl and Perl modules
- Digest::MD5 (for authentication): md5 or md5sum will be automatically used if this module is not found.
- Archive::Zip (for backup/restore): Not required if you don't use the built-in backup/restore feature.
Features
- Plain text format: No database required.
- Static HTML files for fast web browsing
- Single-file easy installation: Tiny and portable!
- Built-in backup/restore: Archive::Zip module required.
- Built-in revision control system
- Built-in search
- Anonymous comment box for simple message boards
- File upload
- Basic wiki-like syntax
- Powerful extensibility through in-page Perl scripting: The basic syntax allows a flexible plugin system so that your Perl scripts can be directly written on the web.
- Anonymous wiki pages with restricted file upload: Quick and simple wiki pages for your site
File/Directory Structure
Uniqki is a single-file CGI script, which automatically installs the following files:
- u.cgi: u.cgi itself
- u.cfg: config file
- u.pw: default password file. The user should change the default password immediately after installation.
- u.tpl: template directory
- header.tpl: common header
- footer.tpl: common footer
- login.tpl: login page
- admin.tpl: admin page
- display.tpl: display page
- edit.tpl: edit page
- updated.tpl: warning page for possible page update by another user
- wikidisplay.tpl: wiki display page
- wikiedit.tpl: wiki edit page
- uniqki.css: CSS file
Install
- Download and uncompress u.zip.
- Upload u.cgi to your web server.
- Run u.cgi. For example, http://foo.bar.com/u.cgi/index?login.
- Login with the default id "admin" and password "admin".
- You'll see the index?edit screen. Enter any message and save the page.
- Go to http://foo.bar.com/u.cgi/index?admin.
- Add your own user id and password.
-
DELETE "admin" ID USING THE EMPTY PASSWORD. IMPORTANT!
- Relogin using the new id just created: http://foo.bar.com/u.cgi/index?login.
Because Uniqki uses static HTML files, you have to click the "edit" button to check if you've successfully logged in.
Configuration
User Actions
Administrator Actions
Syntax