doc/admin/GettingStarted

main contributors - Pascale Blyth, Robin Jones. Last edited on 10 May 2008 by Pascale Blyth

Getting Started!

Congratulations - you now have a working wifidog installation but need to configure the last few parameters for your network.

The aim of this document is to provide you with enough knowledge to setup the auth server successfully. This document is still being completed. In addition, there are plans afoot to eventually integrated setup instructions with hover help.

Before you get started, it is recommended you keep a backup of your server image somewhere. It will save you doing a reinstall if something goes wrong.

You first need to log on as administrator to your network (at  http://yournetwork'sipaddress or www.yournetwork'sdomain if you have already configured DNS resolution).

At the top of the screen, you will be presented with a menu with the following options: find hotspots, network administration, node administration, server administration, user administration.

Mouseovering the options shows submenu options. How to use these to complete a basic wifidog configuration/customization will be explained below.

First, a few definitions

As you proceed through the configuration menus, you will encounter the following terms. These are referenced here to help you in your understanding of the configuration process; key to your long-term understanding and administration of wifidog.

Network

The management interface for a group of nodes with a common user list and portal

Node

Nodes are defined as a single installation of the WiFiDog Gateway and is usually referred to as a hotspot.

Virtual Host

The fully qualified domain name for a server also containing a google API key which can be sourced from  http://code.google.com

Authentication Parameters

The way in which a network handles its users, this can be with the local database, radius, LDAP or no user list.

Configuring a server for a single network setup with 1 node

Well, now you have a spanking new server installation, you are rearing to get see that first hotspot map and to see that network name on your welcome page. This is how you do it in a few easy steps - additional info is available at http://dev.wifidog.org/wiki/doc/admin/PortalAdministration

Configuring the name, address and GIS coordinates of the network

First, you need to go to Network Administration > Add a new Network on this server. Most default settings can be left as is, but you need to configure a few defaults. Here is a quick overview:

In Network Name, enter the name of your network (MyNetwork?). In Network's Website, enter the IP address of your network (for some reason when I tried my URL, it did not work).

In Technical Support email, enter a support email address (will only work if your mail server is configured - you can put it in later if you like).

In Network Properties > Is this network the default network? make sure the Yes box is ticked.

Enter your GIS data - latitude, longitude etc (see below for more details).

The full procedure

Creating a new network

Go to Network Administration > Add a new Network on this server.

You will need to add a Network ID (A unique identifier - this should contain no spaces or special characters) e.g. MyFirstNetwork? then click "Create Network".

You will now need to enter details about the network

Information about the network

Network name - a Friendly name for the network, the website on where the site will be hosted e.g. " http://auth.wifidog.org"

Technical support email - a support email address e.g. "support@…"

Network Authentication

Network authenticator class - for the moment, please leave this as "AuthenticatorLocalUser?", more advanced methods will be explained in another document.

Authenticator parameters - Please enter the same name as you did for Network ID encased in single quotes e.g. 'MyFirstNetwork?'

Network properties

Is this network the default network? - GOOD EXPLANATION NEEDED!!!

Theme Pack - At the moment there is only one theme pack which controls the look of WiFiDog, Please see http://dev.wifidog.org/wiki/doc/developer/PortalCustomization for information on how to create one. this option can be left blank for the moment.

Network's node properties

Splash-only nodes - Are nodes allowed to be set as splash-only (no login)?

Portal page redirection - Are nodes allowed to redirect users to an arbitrary web page instead of the portal?

Network's user verification

Validation grace period - The length of the validation grace period in seconds. A new user is granted Internet access for this period check his email and validate his account. the default is "1200" which is 20 minutes.

This will be the from address of the validation email - e.g. validation@…

Multiple connections - Can an account be connected more than once at the same time?

Access rights

In this area you can define people who will be able to manage this network using the "Edit NetworkNameHere?". the username of the person must already exist, this can be done by clicking the "Create new account" in the top left hand corner.

GIS data

Latitude - convention here is to write it in the form +/-00.000000.

Longitude - convention here is to write it in the form +/-00.000000.

Zoom level - use a value from 1 to 20 finding the right zoom to encompass all of your nodes.

Map type (satellite,etc - just select an option)

Maps, GoogleKey, etc and virtual networks

I have given an overview in the first section about how to configure the coordinates for your network. Now comes the exciting bit - entering your Google API to see that first map on your network.

So, go to Server Administration > Virtual Hosts in the navigation menu.

On the Virtual Hosts page, you will be given the option of either editing the existing virtual host (called localhost) or creating a new one. DO NOT delete or edit the "localhost" virtual host. Instead, create a new virtual host by entering its name (in the following form www.mynetworkname - no  http://) and clicking the "Add a new virtual host" button. This will open the virtual host configuration page for that virtual host. There, enter the Google API key. Click preview (you should see the map), close preview, and click Save VirtualHost.

Creating a new node

OK, now you have a new map, and a working server, you want some nodes to complete the fun. Here is how to do it:

Go to Node administration > Add Node

You will need to enter a Node ID (A unique identifier - this should contain no spaces or special characters), Address details, geographical information and a small amount of options.

Multiple networks on server

Explanation about how Google API key valid for subdomains? One virtual host for each network on server? Good explanations needed

Multiple networks with many nodes

A good explanation is needed.