(For the previous version of Sputnik, see Earth/Installation)
Sputnik can be installed many different ways. We describe here first the most straight-forward method. We then look at other the installation more generally in Custom Installation, which includes installation on Windows. Even if you want to try other methods, though, you might want to use this page as a guide for basic configuration, etc.
If you run into any problems, don't hesitate to ask on the mailing list.
Easy UNIX Installation with Xavante
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 would need basic Unix build tools such as make for this to work. On Ubuntu run "sudo apt-get install build-essential" and "sudo apt-get install zip".)
You are then ready to run Sputnik with Xavante, the built-in webserver.
cd ~/sputnik
./bin/sputnik.lua start-xavante sputnik.ws
For cgi, use the sputnik.cgi in ~/sputnik
If you are curious as to what is happening here, Xavante looks for "sputnik.ws" in ~/sputnik/kepler/htdocs directory.
sputnik.ws is a WSAPI application that looks like this:
require('sputnik')
return sputnik.wsapi_app.new{
VERSIUM_PARAMS = { '/tmp/sputnik3/wiki-data/' },
BASE_URL = '/sputnik.ws',
}
Note that this application just calls Sputnik setting two parameters: VERSIUM_PARAMS (which tells Sputnik where to store data) and BASE_URL (which tells Sputnik what its URL is).
Getting the latest source
If you got this far and want to try the absolutely latest version of Sputnik, you can upgrade your installation by following the instructions in Source.
Running Sputnik with CGI
You can also run Sputnik through CGI with a web server like Apache. When you ran sputnik.lua make-cgi, a sputnik.cgi file was created for you. Copy it wherever your server keeps the CGI files. For instance:
cd ..
sudo cp sputnik.cgi /usr/lib/cgi-bin/
If your cgi files are available via http://localhost/cgi-bin/ then you are done: just go to http://localhost/cgi-bin/sputnik.cgi.
If not, you'll need to edit sputnik.cgi, changing /cgi-bin/sputnik.cgi to whatever it needs to be changed to.
Note: If you do not have your server configured to run CGI, please read the documentation for your server. Unfortunately, configuring CGI varies from one server to another, and even for the same server between different distributions of Linux. We can't help you here.
Running Sputnik with FastCGI
To use FastCGI we need to install an extra rock:
./bin/luarocks install wsapi-fcgi
Then copy sputnik.cgi to your CGI directory as "sputnik.fcgi" and change ".cgi" to ".fcgi" everywhere in that file.
After the Installation
After the installation, register an account "Admin". Note that some of Sputnik's pages, such as "sputnik/navigation" are configured (by default) to only be editable by "Admin".
After that, go on to Basic Configuration.
For other installation scenarios, see Custom Install.