Fenchurch (000023)

Fenchurch is an iteration of Sputnik development in Fall 2008 and Winter 2009. It offers a simpler administration interface, built-in search and better responsiveness.

For the list of features added by Fenchurch see Fenchurch Features.

Fenchurch is stable. There are still a few small things we want to fix before making a proper release announcement, but this shouldn't prevent you from using it.

Installation on UNIX tuxosx

If you are using UNIX (including either Linux or OSX), you can install Sputnik using the "all-in-one" installer:

download sputnik-9.03.16-kaio.tar.gz

  1. Open the file with "tar xvzf", cd into the directory.
  2. Create a directory somewhere where you want to install sputnik, e.g. ~/sputnik/
  3. Run bash install.sh ~/sputnik/
  4. Go to ~/sputnik and run ./bin/sputnik.lua start-xavante

This will give you Sputnik running on Xavante, the build-in web server. You can, if you want, then change it to CGI.

If you want, you can update your installation to the very latest version from git using the Source (use "mainline").

Advanced Installation

There are many other ways you can install Sputnik. The instructions below break the installation process into several steps, showing you the different options you have at each point.

Step 1. Install Lua and Binary Dependencies

You will need Lua, luafilesystem, lpeg, md5, luasocket, rings. Those are binary libraries. You'll need to either compile them or get the binaries for your operating system. You have several options:

Option A: LuaRocks

UNIX

download kaio-1.1.1-2.tar.gz

After downloading:

tar zxvf kaio-1.1.1-2.tar.gz
bash kaio-1.1.1-2/kepler-install-1.1.1-2 --prefix=$HOME/sputnik/ --without-readline
cd ~/sputnik
./bin/luarocks --only-from=http://spu.tnik.org/rocks/fenchurch install md5

Windows

download kaio-1.1.1-2-win32.zip

After downloading, unpack the zip file, open a command prompt and go inside it, then run

C:\temp\kaio-1.1.1-2-win32> install

This will install Lua and LuaRocks at c:\LuaRocks, and Kepler support files at c:\LuaRocks\kepler.

Use luarocks to install md5.

Or, you can just download Lua and LuaRocks yourself, compile them, and the use it to install the needed rocks.

Option B: LuaForWindows

LuaForWindows provides a nice way of installing Lua on Windows and comes with the five libraries that you will need. (That's what I heard.)

Option C: Apt-Get

On Debian / Ubuntu systems, you can install Lua and all the libraries using apt-get. For instance, on Ubuntu 8.10:

sudo apt-get install lua5.1 liblua5.1-filesystem0 liblua5.1-lpeg1 \
     liblua5.1-md5-0 liblua5.1-socket2 liblua5.1-rings0

Step 2: Install Sputnik and It's Pure-Lua Dependencies

Option A: Use LuaRocks

If you installed LuaRocks in the step above, then you can use it to install Sputnik and Xavante.

./bin/luarocks --only-from=http://spu.tnik.org/rocks/fenchurch install sputnik
./bin/luarocks --only-from=http://spu.tnik.org/rocks/fenchurch install sputnik-markitup
./bin/luarocks --only-from=http://spu.tnik.org/rocks/fenchurch install xavante

(Remove ./bin if have luarocks in your path.)

Option B: Just Unpack the Lua Code

Alternatively, you can just get the Lua source for Sputnik and all of it's pure-Lua dependencies from sputnik-9.03.16-all-in-one.zip. Copy the the files and directories in the "lua" folder to some place where your Lua installation will find them, and those in "bin" to somewhere from where you can run them.

Step 3: Setup

Use Lua to generate configuration files:

./bin/sputnik.lua make-cgi

(If not using luarocks, skip -lluarocks.require and make sure your Lua paths include Sputnik.)

Then create a directory to store the data:

mkdir wiki-data && chmod -R a+rw wiki-data

(Or just do this by hand.)

Step 4: Run Sputnik Using Xavante

You are now ready to start an instance of Xavante configured to just run Sputnik:

./bin/sputnik.lua start-xavante

(There is no bin/xavante_start.sh anymore, but you can put the line above into a shell script.)

Optional Step 5: Deploy as CGI, etc.

If you don't want to deploy Sputnik using Xavante, you have many other options. See Installations on how to use CGI or FastCGI.

Powered by Sputnik | XHTML 1.1