Download & Installation

Compatibility Notes

webgen should run on any platform which supports Ruby. It has been successfully tested on the following platforms:

  • Linux with Ruby 1.8.6
  • Mac OSX with Ruby 1.8.6 and 1.8.7
  • Windows XP with latest Ruby 1.8.6 from One-Click-Installer

See the platform specific installation notes for more information!

Furthermore, webgen should also run on jruby 1.1.3 and ruby 1.9.1 but that has not been extensively tested.

Platform Specific Installation Instructions

Linux

There are a variety of Linux distributions out there with different package management systems. So I will focus on instructions for Ubuntu 9.04 here (which should also work for any recent Debian based distribution).

After running the following commands, webgen and all the mandatory dependencies are installed:

sudo aptitude install ruby rubygems
sudo gem1.8 install webgen

You will also need to add export PATH=$PATH:/var/lib/gems/1.8/bin to your ~/.bashrc because this is the binary path the executable files get installed.

Ubuntu has a package for the old 0.4.7 version of webgen. If you want to use that, you just need to run

sudo aptitude install webgen0.4

Mac OS X

Mac OS Leopard comes with Ruby and Rubygems preinstalled. However, the Rubygems version is rather old and needs to be updated. This can be done by running the following commands:

sudo gem install rubygems-update
sudo update_rubygems

After that your system is ready for installing webgen:

sudo gem install webgen

Windows

You need to install Ruby first. This can easily be done by using the One-Click-Installer - just download the latest installation binary from the files section of the One-Click-Installer homepage and run it. After that open a command shell (select Start -> Run..., then enter cmd and click on Ok) and type in the following:

gem install webgen

Generic Installation Instructions

Using Rubygems

If you are using Rubygems, installing the latest version of webgen is as simple as executing

gem install webgen

After this command has finished, everything is ready for creating websites. Be sure to have a look at the optional dependencies which provide additional functionality.

Rubygems 1.2.0 has a bug that prevents the correct resolution of development dependencies. Therefore you should upgrade to at least 1.3.3 which fixes this and some other bugs. Otherwise you will have to use the following command to install webgen:

gem install --development webgen

Manual Installation

The latest version of webgen can always be downloaded from webgen’s files section on Rubyforge. After the download the package needs to be decompressed and then you can install webgen using the included setup.rb installation method:

$ ruby setup.rb config
$ ruby setup.rb setup
$ ruby setup.rb install

Make sure that you also install the mandatory and, if you need them, the optional dependencies.

Using the repository version

webgen uses git as its versioning system and webgen’s repository is hosted primarily on Rubyforge but I have also created a clone of it on GitHub. The repositories always contains a clean state of the current development version of webgen, i.e. webgen should always work when checked out from the repository. To check out webgen use one of the following commands:

 git clone git://rubyforge.org/webgen.git
 git clone git://github.com/gettalong/webgen.git

Dependencies

The following list shows all mandatory and optional dependencies for webgen. If you use Rubygems, the mandatory dependencies are automatically installed. webgen can make use of the optional dependencies if they are installed. Note that webgen was tested against the specified versions but it should normally work with newer versions, too!

  • (mandatory) Ruby version 1.8.6 or 1.8.7. Since webgen is written in Ruby, you need the Ruby interpreter to run webgen.

  • (mandatory) cmdparse version 2.0.2 or higher

  • (mandatory) kramdown version 0.10.0

  • (mandatory for webgui) ramaze version 2009.04

  • (optional for webgui) launchy version 0.3.2

  • (optional) rake version 0.8.3 or higher for using the created website Rakefiles

  • (optional) RedCloth version 4.1.9 or higher for Textile support

  • (optional) maruku version 0.6.0 or higher

  • (optional) haml version 3.0.12 or higher for haml, sass and scss support

  • (optional) builder version 2.1.0 or higher for programmatic xml generation support

  • (optional) rdoc version 2.4.3 or higher for RDoc markup support

  • (optional) coderay version 0.8.312 or higher for syntax highlighting

  • (optional) erubis version 2.6.5 or higher for Erubis (enhanced ERB) support

  • (optional) rdiscount version 1.3.5 or higher for fast Markdown support

  • (optional) archive-tar-minitar version 0.5.2 or higher for (gzipped) tar archives as sources

All these libraries can be installed via Rubygems (which I recommend).