Here you learn how to do basic configuration of your new Sputnik.

After following the instructions on the Installation page, your Sputnik should be ready to run. However, there are a few changes that you might want to make. Sputnik uses a number of configuration parameters, which can be set in two places. Then see Configuration for more configuration options.

Bootstrapping Parameters

The first place is the launcher script (your sputnik.ws, sputnik.cgi or sputnik.fcgi file). For instance, your sputnik.cgi may look like this:

#! /bin/bash /home/yuri/sputnik/bin/wsapi.cgi
require('sputnik')
return sputnik.new_wsapi_run_fn{
   VERSIUM_PARAMS = { '/home/yuri/sputnik/wiki-data/' },
   BASE_URL       = '/usr/lib/cgi-bin/sputnik.cgi',
   PASSWORD_SALT  = 'dQyceRONUnA2yAB9LwpNxOq22C0NtxCxe1ziIdVs',
   TOKEN_SALT     = 'rmlPMNPn941wJioBLff5DHsHyRP7UBqbOBRqewEe',
}

This script sets four configuration parameters, of which three are required:

   VERSIUM_PARAMS = { '/tmp/sputnik/wiki-data/' }
   BASE_URL       = '/usr/lib/cgi-bin/sputnik.cgi',
   TOKEN_SALT     = 'rmlPMNPn941wJioBLff5DHsHyRP7UBqbOBRqewEe',

VERSIUM_PARAMS tells sputnik how to access storage. In the simplest case, it's just a path to a directory where the data will be stored. BASE_URL tells Sputnik how to create links that point back to itself. TOKEN_SALT is a secret code that will be used for encryption in cookies, etc. The one in your sputnik.cgi file will be different - it was generated randomly. Finally, the optional PASSWORD_SALT parameter is a secret code used for hashing passwords. If you later want to reuse your password file on a different Sputnik installation, you will need to use the same PASSWORD_TOKEN.

The Configuration Node

The second place where you can configure things is the sputnik/config node. Login as "Admin" (register as "Admin" if you haven't done so yet), then edit that node. In that node you can set:

NICE_URL: set to the "nice" form of your URL (see Nicer URLs for details).

DOMAIN: must be set to your domain for RSS to work.

SITE_TITLE: you can change this from "My New Wiki" to something more informative.

MAIN_COLOR: change the color scheme of your wiki by setting this parameter to different numbers betwee 0 and 360. (See Color Schemes.)

BODY_BG_COLOR: set this parameter to change the background color (you can set it to an HTML color name such as "white" or to a hexadecimal RBG code, such as "#f0f0f0").

For more configuration parameters, see Configuration.