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.
Easy UNIX Installation
On UNIX (which would include Linux, as well as OSX if you have XCode) you can install Sputnik using the new "all-in-one" installer:
After downloading it, do this:
tar xvzf sputnik-9.03.16-kaio.tar.gz
cd sputnik-9.03.16-kaio/
mkdir ~/sputnik
bash install.sh ~/sputnik/
This should take less than a minute.
You are then ready to run Sputnik with Xavante, the built-in webserver.
cd ~/sputnik
./bin/sputnik.lua start-xavante
For cgi, use the sputnik.cgi in ~/sputnik
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. They cover Windows among other things.
Step 1. Install Lua and Binary Dependencies
You will need Lua and five binary libraries: luafilesystem, lpeg, md5, luasocket, rings. You will need to either compile them or get the binaries for your operating system. You have several options:
Option 1a: LuaRocks
LuaRocks is a cross-platform package installer for Lua. It can work on UNIX or Windows. You can get LuaRocks and 4 of the 5 binary libraries by installing Kepler.
UNIX, using Kepler-All-In-One
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
Then install the fifth library:
cd ~/sputnik
./bin/luarocks --only-from=http://spu.tnik.org/rocks/fenchurch install md5
Windows, using Kepler-All-In-One
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.
Then use luarocks to install md5.
LuaRocks, DIY
Alternatively, you can just download Lua and LuaRocks yourself, compile them, and the use it to install the needed rocks.
1b: 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.)
1c: 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 2a: Use Sputnik using 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 2c: Just Unpack the Lua Code
Alternatively, just get the Lua source for Sputnik and all of it's pure-Lua dependencies:
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
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.
Hint: Besides what's described in Installations, to make FastCGI work, you need to change "wsapi.cgi" to "wsapi.fastcgi" everywhere in the cgi script.