Tags:
create new tag
, view all tags

TWiki for Personal use

TWikiPersonal is an all-in-one distribution of TWiki, intended to be used by one person on one computer.

Features

  • Based on TWiki 6.0.2, plus a few changes not yet released by TWiki.
  • Includes the default extensions, which as of version 6.0.3-alpha also includes the new TWikiSheetPlugin
  • More extensions can be added from http://twiki.org with TWiki's configure mechanism or "by hand" from a zip file.
  • Good performance by using a persistent interpreter (at the expense of longer startup time).
  • Works on Windows 7 (64Bit) and on Windows 8.1 (32Bit), even on a tablet.
  • Listens only to localhost, no exposure to other PCs near you even if you are sharing a LAN.

Installation and Use

TWiki Personal for Windows

Installation:

  1. Download TWiki-Personal-Win-6.0.3-alpha.zip (27MB)
  2. Unzip to the location of your choice. Needs about 49MB.
  3. Optional: create a shortcut to twiki.exe.
    • If you want a TWiki symbol for the shortcut, there's one available in pub\TWiki\TWikiLogos\favicon.ico.

Initial use:

  1. Start twiki.exe (or the shortcut)
  2. Point your browser to http://localhost:5000/
    • On first execution, you'll be asked to enter your configuration password. Even for a personal installation, it is a good idea to have some protection for critical actions. TWiki then guesses some configuration parameters, which you can just accept, or change right now or later. Just save the configuration, even if you didn't change anything.

Regular use:

  • Your usual entry point is http://localhost:5000/bin/view/.
  • For editing, either register a user or use the login admin and the password you provided during initial use.
    • Advanced configuration: If you don't want to register, yet want your name to appear in page signatures, change the values for AdminUserLogin (default: admin) and AdminUserWikiName (default: TWikiAdminUser) with http://localhost:5000/bin/configure. You need to check the "yes, I've read the documentation" disclaimer to see this option.
  • If you create a shortcut for twiki.exe, you can also provide parameters:
    • --access-log=some/location - Send the access log to a file, otherwise it is sent to the console
    • --port=1234 - If you want to use a port different from the default (5000)
    • ...and a lot more. See CPAN:plackup for a full description.

Known limitations and bugs

  • After installing an extension with configure, the pattern skin layout is crippled. Remedy: Restart the server. configure wasn't meant to be run in a persistent Perl environment. This should be fixed, but is not on top of my priority list.
  • Only a few extensions and not all features have been tested. There is a chance that any extension or feature needs a Perl module not included in Personal TWiki, or an external tool. Please report your observations in the Support web.
  • It is not (yet) possible to add extensions that bring their own bin or tools scripts.
  • Sending Mail is not enabled.
  • Only TemplateLogin is available as login mechanism.
  • The only way to stop TWiki Personal is to kill the console window, which leaves a nasty error dialog on Windows. There are no other bad effects.
  • Statistics doesn't work. In the default settings, TWiki doesn't log anything, so there's nothing to count.

Questions and Answers

How does it work without a web server, and even without Perl?
On Windows, the Perl interpreter is contained in the executable, as well as all Perl modules of Personal TWiki. These modules consist of TWiki itself, and of a web server written in Perl. A new TWiki engine based on PSGI instead of CGI acts as a glue between TWiki and the web server.
Where are the TWiki modules?
They are contained in the package. On startup, they are expanded to a temporary directory.
How are extensions added to Personal TWiki?
From the user's point of view, as in other TWiki installations. From a technical point of view, they are going into the lib directory of the distribution.
I have made a change in bin/view, and it doesn't take effect. Why?
The files in bin are not used by Personal TWiki.

Status

This is called an "alpha" release because:

  • It contains code not yet released, and it has not yet been extensively tested.
  • Some of the interfaces and defaults might change (if there's a good reason).
  • The behaviour during initial run, and configuration might get a more "personal" flavour.

-- Contributors: Harald Jörg - 2015-06-06

Discussion

Edit | Attach | Watch | Print version | History: r4 < r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r4 - 2016-08-20 - HaraldJoerg
 
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.