# Gisgraphy installation guide

The Gisgraphy installation procedure is simple but needs Java, PostgreS and PostGIS to be already installed on your system.
If you are familiar with their installation, you can skip the 'Environment setup' and skip directly to reading the 'Gisgraphy installation' section.

## System requirements

> To install Gisgraphy you need a server with:
> - 280 Gb of free disk space if you import all the countries
> - Internet access to download data files (you can skip it)
> - Java 1.5 or greater (Oracle JVM is strongly recommended)
> - PostgreSQL with Postgis extensionS (It is HIGHLY recommended to have PostGIS 1.3.1 or greater, for good performance... more ).
> - Between 512M and 3 GB of RAM memory. The amount of memory needed depends of the amount of data - if you have imported all countries, you will needs 3Gb
> - A servlet container if you want to use it as a Servlet (not programmatically). Actually, Gisgraphy has been tested on Tomcat and Jetty but any servlet container should be OK

We strongly recommend that you install Gisgraphy (that uses SolR) on Linux or Unix. Due to a JVM bug and other reasons, Windows users will get less performance.
Once you have downloaded Gisgraphy, choose the right procedure for your operating system :

## Environment setup

> Windows system environment setup : a step-by-step guide to help you set up Java, PostgreS and PostGIS on windows.
> Linux / Unix system environment setup : a step-by-step guide to help you set up Java, PostgreS and PostGIS on Linux.
> Mac system environment setup : a step-by-step guide to help you set up PostgreS and PostGIS on Mac.

## Gisgraphy installation

> Gisgraphy installation guide. Once PostgreS, PostGIS and Java are installed, Gisgraphy takes 5 minutes to get installed. You just need to run some sql scripts.

## Run Gisgraphy

> Some scripts are provided to manage Gisgraphy, most of them are for Unix / Linux :
> - launch : run gisgraphy and output logs to the console.
> - start : starts Gisgraphy.
> - stop : Shutdown gisgraphy (clean way).
> - force-stop : kill gisgraphy (doesn't check the status).
> - status : tell whether gisgraphy is started or not.
> - logs : output logs file to the console.
> - respawn : check gisgraphy status and re-launch it if it has gone.
> - watch : run the respawner.
> - unwatch : stop the respawner.
> - startupscript : script to run gisgraphy as a daemon.
> - setGisgrapgyAsService : intall the startup script (unix only).