In this section we'll discuss
- zwiki requirements
- installing zwiki
- upgrading and downgrading zwiki
- related products
You only need to read part of it, depending on your situation:
- If you don't have or want a zope server right now, but want to try Zwiki
- If you just want to try out some things it's fine to do that on this wiki, at least for a while, under a personal page . Or, there are many other zwiki sites around the net.
- If you want to run your own wikis on a zope hosting provider or a zope server administered by someone else:
- You can get a free zope account and set up your own zwiki at
zope hosting providers
Do you see
Add ZWikiin the ZMI add menu ? If so, Zwiki's already installed - you may want to read up on ReleaseNotes and KnownIssues. Otherwise, ask your hosting provider or server admin to install it. Then, proceed to configuring.
- If you want to run your own wikis on your own desktop or server machine:
- You'll need administrative access, eg shell access to the server. (It may or may not be possible to install Zope and Zwiki on a server where you don't have root access.) Read on.
- If you already have Zwiki installed and want to install a newer version:
- Check the requirements below, and then jump to upgrading.
- If you're looking for additional products to complement your wiki:
- Read about related products .
Current Zwiki requires Zope 2, version 2.10 or greater. If you need to use an older Zope, check ZopeWiki:VersionsMatrix for required versions.
Zope is the powerful open-source web application framework on which Zwiki is built. You might wonder if it wouldn't be easier to use another wiki engine without this dependency, but note:
- by leveraging the power of Zope, Zwiki can do many things that other wikis can't, or do the same things more easily.
- despite being large and sophisticated, Zope is quick to install, easy to use, and robust.
- You can install Zope almost anywhere. Zwiki is cross-platform thanks to Zope and Python.
- Zope opens up a world of plug-in web apps (such as Plone). These tend to integrate well with Zwiki and each other.
- Zope is popular and continues to grow strongly, for good reason. There is a large and active community. You can learn all about it at http://zope.org and http://zopewiki.org .
On the downside:
- if you plan to install your own Zope server on a hosting account, be aware it performs best with plenty of memory. It will use at least 50M of ram growing towards 100M and towards 200M if you add a lot of content, very large wikis, multiple plone sites, etc.
- learning all of Zope is undeniably a big task. If you're just installing it to get some wikis running, though, this is a non-issue. You don't need to know much Zope to run Zwiki.
In general, you can download and install Zwiki in three ways: by using your platform's package management system if any (easiest), by downloading the tarball (latest stable version), or by cloning the latest development repo.
Here are platform-specific installation instructions:
- InstallingOnDebian, Ubuntu, etc.
- InstallingOnRedHat, Mandrake etc.
or generic instructions:
- Install Zope (http://zope.org , ZopeWiki:InstallingZope)
- Download the Zwiki tarball from FrontPage
- Unpack it in your Zope Products directory
- Restart zope.
You should now be able to choose
Add a ZWikior
Add a ZWiki Pagein the zope management interface.
- CMF/Plone users: install zwiki in your CMF or Plone site, as described
on Zwiki and Plone. You should now be able to add a
Wiki Pagein the plone contents view.
Some general installation faqs; see also FAQ.
- Where is my Zope Products directory?
- That depends on your platform and how you installed Zope. It's probably under your ZopeWiki:INSTANCE_HOME , but not always. Check the platform installation notes above.
- Why can't I add or view Wiki Pages in Plone ?
- Don't forget step 5 above.
Otherwise, proceed to configuring and we'll create a new wiki.
Or read on to find out about..
Here are some other products that you may want to install to enhance your zwikis:
- Plone (or CMF or CPS ) - provides easy member management, integrates zwiki within a content management system
- PlacelessTranslationService? - enables zwiki skin translations
- Epoz - enables WYSIWYG editing of HTML wiki pages
- ExternalEditor - allows editing of wiki pages with an editing tool of your choice
- MaildropHost? - guarantees no mail duplicates due to conflict errors (not usually needed)
- fit - allows python tests to be integrated within wiki pages
- LatexWiki and MathAction - allow typesetting and mathematical markup in wiki pages - latex, axiom, reduce, graphviz, etc. (These are plugins now, please read the corresponding README.txt files for additional installation steps.)
- DirectoryStorage? - allows wiki page objects to be stored as text files rather than in the ZODB
- ZSyncer - can be used to mirror a wiki from one zope server to another
- Zwiki for Zope 3 - a rewrite included in the Zope 3 code repository, only basic functionality at present
- CMFWiki - an older CMF-compatible version, now deprecated
- whether you need to install Zwiki
- how to install the stable or development version of Zwiki
- how to upgrade a Zwiki installation
- how to avoid problems by downgrading
- which other products might be useful
Next is configuring.