Skip to content

Install and Configuration

Jump to bottom
jammin84 edited this page Feb 1, 2016 · 2 revisions

Fresh Install

Requirements

  • MariaDB or Mysql
  • php5 (or newer)
  • php5-mysql
  • php5-gd
  • web server (ie apache)

Install

  • Clone the github dir.
git clone https://github.com/wind-project/wind.git
  • First, you must copy the folder config-sample/ to config/ located in the main project folder. (No need to change any variables here yet)
  • In your browser run the install and follow the steps.
http://<server-address>/install/
  • You may now customize any further config variables you wish. See "Website Community Configuration"
  • Done!

Upgrade a Pre-Exisiting Install of WiND or S-WiND

  • Note WiND updates prior to the fork of version 1.1-0-a1 are compatible with updates to S-WiND using this method.
  • Always Backup your database and WiND folders before upgrading (You've been warned)

Pull in the new version (providing you've installed via git clone above)

cd <dir-to-wind>/wind/
git pull

update the db

cd <dir-to-wind>/wind/tools/
php update.php

You will get output with something along the lines of

Connected to server "xxx" on database "xxx"
Schema is currently at v1.1 version
Database is already updated to latest version.
Schema is currently at v1.1 version
Upgrading DB Schema to v1.2...
  • Done!

Website Community Configuration

  • Below is a list of community defined variables and their explanation.

Customise Languages

config/language/LANGUAGE_overwrite.php

Where LANGUAGE replace with the language you want to overwrite values for.

You can create these files if you want to overwrite some language values to perfectly customize your site. For example you will probably need to change the 'site_title' or the email contents without touching the original language files.

In this way, the updates will be a piece of cake. :-)

Customise Startup Message (MOTD)

config/startup.html

This page will be displayed in the first page of the project.

Create a file named startup.html into config/ folder. You can place any information in (X)HTML format.

Customise Community Logo (Branding)

config/mylogo.png

This logo will be displayed by the selected template in the appropriate place (if it is supported).

Create a file named mylogo.png into config/ folder.

  • Must be PNG
  • Maximum recommended dimensions 220w x 90h

Website Variables

config/config.php

Database Configuration

  • (Completed by the install script.)

This section contains the information for the database that stores the project data.

'db' => array(
    'server' => "server.example.org",
	'username' => "youruser",
	'password' => "yourpassword",
	'database' => "yourdatabase",
	'version' => yourversion		//Ex. 4.0, 4.1, 5
	),

General Site Options

  • (Completed by the install script.)

This section contains your server domain name and url that hosts the project.

'site' => array(
	'domain' => 'server.example.org',
	'url' => 'http://server.example.org/'
	),

Cookies

You can set the expiration time for all cookies that are being used by the project. The time is in seconds.

'cookies' => array(
	'expire' => (60 * 60 * 24 * 30)
	),

Messages

You can set the delay time for all messages that are being displayed by the project. The time is in seconds.

'message' => array(
	'delay' => 5
	),

Smarty Engine

  • (Completed by the install script.)

You can set the place of the smarty class. If the Smarty library does not exist in your system, please visit http://www.smarty.net/ to download the latest version. Notice that version 2.x is recommended.

'smarty' => array(
	'class' => '/usr/share/php/smarty/libs/Smarty.class.php'
	),

HTML Templates

  • (Completed by the install script.)

This section defines the templates properties configuration.

  • path - The path that contains all the templates available. Each template must be in this folder inside a subdirectory.
  • compiled_path - The path that contains all the compiled files. It is recommended that you use a path outside the project main directory (for example you can use: /tmp/wind/). Don't forget to create the directory and properly configure the read-write permissions for this folder.
  • default - The name of the default template used by the project, if no other has been selected by the user.
'templates' => array(
	'path' => ROOT_PATH.'templates/',
	'compiled_path' => ROOT_PATH.'templates/_compiled/',
	'default' => 'basic'
	),

Language Selection

This section defines the language configuration.

  • default - The name of the default language used by the project, if no other has been selected by the user.
  • enabled - Array with the languages available in the project pages. Notice that the language files must exist in the globals/language/ directory.
'language' => array(
	'default' => 'greek',
	'enabled' => array(
		'greek' => TRUE,
		'english' => TRUE)
	),

Display Tables

You can set the maximun rows displayed per page into tables.

'constructor' => array(
	'max_rows' => 50
	),

DNS System

This section defines the dns zones configuration.

  • root_zone - The top level domain that your network uses.
  • ns_zone - The ns subdomain where all nameservers will be placed.
  • reverse_zone - The reverse zone. Propably nothing to set here.
  • forward_zone_schema & reverse_zone_schema - The schemas used by project to generate the zone files.
    • Be aware to set the read-write properties in the files, so that you can edit them via the administrator panel.
'dns' => array(
	'root_zone' => 'yourdomain',
	'ns_zone' => 'ns.yourdomain',
	'reverse_zone' => 'in-addr.arpa',
	'forward_zone_schema' => ROOT_PATH.'tools/dnszones-poller/yourdomain.schema',
	'reverse_zone_schema' => ROOT_PATH.'tools/dnszones-poller/10.in-addr.arpa.schema'
	),

User Photos

  • (Completed by the install script.)

Some folders used by the project.

  • photos - The project stores in this folder all the photos provided by the users. Be aware to set the read-write property in the folder, so that the project can have full access.
'folders' => array(
	'photos' => ROOT_PATH.'files/photos/'
	),

Mailing System

This section defines the mail properties.

  • smtp & smtp_port - Smtp server and port used by the project to send mails. Notice that this is only for Windows servers. GNU/Linux servers must setup their local mail server (eg. exim).
  • from - The from e-mail field for all outgoing e-mails.
  • from_name - The name displayed in all outgoing e-mails.
'mail' => array(
	'smtp' => '', // if not set default used from php.ini file
	'smtp_port' => '25',
	'from' => '[email protected]',
	'from_name' => 'WiND Hostmaster'
	),

SRTM - Data Files

  • (Completed by the install script.)

You can set the path that contains the NASA's SRTM data. You can download the files (that concerns your area) and place them manually into this path. These data files contain the elevation information needed by the project, to plot the line of sight between two nodes.

Currently only SRTM3 files are supported. You MUST download SRMT3 files ONLY. For your help we place here some paths from where you can download the files:

'srtm' => array(
	'path' => ROOT_PATH.'files/srtm/'
	),

Map

  • (Completed by the install script.)

This section setups Mapping functionality

  • bounds - Set the bound of your area that displayed by Maps. All bounds are in decimal format (ex. 37.1234567).
'gmap' => array(
	'bounds' => array(
		'min_latitude' => MINLAT_GPS_COORDINATE,
		'min_longitude' => MINLON_GPS_COORDINATE,
		'max_latitude' => MAXLAT_GPS_COORDINATE,
		'max_longitude' => MAXLON_GPS_COORDINATE
		)
	),

Debug Mode

You can enable/disable the WiND debug mode. Actually this is used by developers. You propably don't need it.

'debug' => array(
	'enabled' => FALSE
	)
Clone this wiki locally