h1. Adjusting the settings

Take a look at the start.rb file in your wiki folder.  This can be used to change the settings such as port and url of this site, and to enable more advanced features such as calendars and automatic summaries.

h2. To restart your wiki

The soks-create-wiki.rb script will have created a folder in the directory in which you ran it (by default the folder is 'soks-wiki'). In that folder is a script 'start.rb' run it.
<code>
cd soks-wiki
ruby start.rb
</code>

h2. To make your site accessible beyond localhost

Open start.rb in your directory. Un-comment the lines
<code>
# :url => 'http://localhost:8000',
# :port => 8000,
</code>
and replace them with the url and port you wish the wiki to run on.

h2. To password protect your site.

Open start.rb in your wiki directory. Un-comment and edit the authenticators section and edit the array.  The format is [  [ first regexp to match against title, authenticator to use ],  [ second regexp to match against title, authenticator to use ] .... ]. For example:

# This matches against all the standard 'non editing commands' and doesn't ask for any authentication
<code>[ %r{/(view|rss|print|find|meta)/.*}, WEBrick::HTTPAuth::NoAuthenticationRequired.new ]</code>

# This doesn't permit any file or picture uploads
<code>[ %r{/upload/.*}, WEBrick::HTTPAuth::NotPermitted.new ]</code>

# This asks for a site wide password to edit or save changes to the home page
<code>[ %r{/(edit|save)/home page}, WEBrick::HTTPAuth::SiteWidePassword.new('password','You need to enter the site wide password to edit the home page') ]</code>

# This uses the standard WEBrick authentication system on any page whose name starts with private. The standard WEBrick authentication uses a database of usernames and passwords.  See [[ Gnome's Guide => http://shogo.homelinux.org/~ysantoso/webrickguide/html/html_webrick.html ]] for details.
<code>[ %r{/(view|edit|save)/private.*},WEBrick::HTTPAuth::BasicAuth.new( :UserDB => htpasswd, :Realm => realm ) ]</code>

# This is the default. For any page it just asks for a username, but the password can be left blank.
<code>[ %r{.*}, WEBrick::HTTPAuth::AskForUserName.new( 'No password, just enter a name') ]</code>						

Note a big bug is that viewing attached images and files is NOT password protected.  If someone knows how to make WEBrick::HTTPServlet::FileHandler use an authenticator, please let me know. 

h2. To edit the default site settings used by soks-create-wiki.rb

Edit template/start.rb in the directory where soks was installed.

h2. To change how often the wiki checks the content directory for any changes.

Open start.rb and add this to your CUSTOM_SETTINGS hash:
<code>:check_files_every => 60, # Seconds</code>

h2. To add a calendar and upcoming events page:

Open start.rb and uncomment:
<code>
# calendar = AutomaticCalendar.new( wiki ) # Adds a series of calendar pages to the wiki
# AutomaticUpcomingEvents.new( wiki, calendar ) # Creates a page with the next weeks events drawn from the calendar pages
</code>

h2. To add a page that summarises other pages:

See AutomaticSummary