README.md

GeoQ

Geographic Work Queueing and Tasking System

GeoQ is an open source (MIT License) geographic tasking system that allows teams to collect geographic structured observations across a large area, but manage the work in smaller geographic regions. Large areas can be quickly broken up into small 1km squares and assigned to a team. System transparency informs all groups about workflow to avoid duplication of effort.

The GeoQ software was developed at the National Geospatial-Intelligence Agency (NGA) in collaboration with [The MITRE Corporation] (http://www.mitre.org). The government has "unlimited rights" and is releasing this software to increase the impact of government investments by providing developers with the opportunity to take things in new directions. The software use, modification, and distribution rights are stipulated within the [MIT] (http://choosealicense.com/licenses/mit/) license.

Pull Requests

If you'd like to contribute to this project, please make a pull request. We'll review the pull request and discuss the changes. All pull request contributions to this project will be released under the MIT license.

Software source code previously released under an open source license and then modified by NGA staff is considered a "joint work" (see 17 USC § 101); it is partially copyrighted, partially public domain, and as a whole is protected by the copyrights of the non-government authors and must be released according to the terms of the original open source license.

In the News

For current news regarding GeoQ, see our Wiki Page

Screenshots

###This project relies heavily on open source packages, particularly:### Django under [BSD] (https://github.com/django/django/blob/master/LICENSE)

Leaflet under [BSD] (https://github.com/Leaflet/Leaflet/blob/master/LICENSE)

Postgres under [PostgreSQL license] (http://www.postgresql.org/about/licence/)

PostGIS under [GPL version 2] (http://opensource.org/licenses/gpl-2.0.php)

GeoQ Configuration

The geoq/settings.py file contains installation-specific settings. The Database name/pw and server URLs will need to be configured here.

GeoQ Installation

Docker Installation::

1. A new docker implementation has been developed and is available at https://hub.docker.com/r/stephenrjones/geoq-django10. This is an upgraded version of the server and has not yet been fully tested.

Cloud Installation::

1. You can optionally deploy GeoQ with all dependencies to a Virtual Machine or a cloud VM (such as an Amazon Web Services EC2 box) by using the chef installer at https://github.com/ngageoint/geoq-chef-installer

2. Chef scripts are our preferred method of automating cloud builds

Mac OSX Development Build Instructions::

1. Install PostGIS 2.0 using instructions at https://docs.djangoproject.com/en/dev/ref/contrib/gis/install/#macosx. There are several options there, but for most, the easiest option is to follow the Homebrew instructions. If you don't have Homebrew installed, you can either buid it securely yourself or follow the quick (yet not secure) one line instruction at http://brew.sh.

   Note for MITRE users: To install software by downloading from Internet, the computer should be connected to Outernet.

   One exception: Instead of using brew to install postgres, it's usually easier to install Postgres.app from postgresapp.com. After installing, add the app's bin directory (/Applications/Postgres.app/Contents/Versions/X.Y/bin) to your PATH. After Postgres.app is installed, postGIS, gdal, and libgeoip need to be installed using the following commands:

    $ brew install postgis
    $ brew install gdal
    $ brew install libgeoip
   

   Note: Homebrew needs to be installed to run these commands.

2. (Optional) Install a Geoserver (we recommend the OGC Geoserver at https://github.com/geoserver)

3. Make sure Python, Virtualenv, npm, and Git are installed

    % Note that some distros (Debian) might need additional libraries:
    % sudo pip install psycopg2
    % (optional) sudo apt-get install sendmail
   

4. Install and setup geoq:

    % mkdir -p ~/pyenv
    % virtualenv --no-site-packages ~/pyenv/geoq
    % source ~/pyenv/geoq/bin/activate
    % git clone https://github.com/ngageoint/geoq
   

5. Create the database and sync dependencies and data:

    % cd geoq
    % pip install paver
    % paver install_dependencies
    % paver createdb
    % paver create_db_user
    % paver sync
   

6. Modify local settings (Modify entries below based on your system settings. Hit Ctl + D to save local settings file.):

    % cd geoq
    % cat > local_settings.py
    
      EMAIL_BACKEND = 'django.core.mail.backends.smtp.EmailBackend'
      EMAIL_PORT = 25
      EMAIL_HOST = "localhost"
      DEFAULT_FROM_EMAIL = "[email protected]"
      MEDIA_ROOT = '/opt/src/pyenv/geoq/geoq-django'
      STATIC_URL_FOLDER = ''
      STATIC_ROOT = '{0}{1}'.format('/usr/src/static/', STATIC_URL_FOLDER)
      GAMIFICATION_SERVER = ''
      GAMIFICATION_PROJECT = ''
      GEOSERVER_WFS_JOB_LAYER = ''
   

   Note: To test GeoQ front page after starting GeoQ server, set STATIC_ROOT as follows: STATIC_ROOT = '{0}{1}'.format('~/geoq-static/static/', STATIC_URL_FOLDER)

7. (Optional) Load development fixtures:

    % paver install_dev_fixtures # creates an admin/admin superuser
   

8. Build user accounts:

    % python manage.py createsuperuser
   

9. Install less and add its folder ("type -p less") to your bash profile:

    % sudo npm install -g less
    % sudo python manage.py collectstatic
   

10. Start it up!

     % paver start_django
    

CentOS Development build instructions (tested on CentOS 6.6)::

Dependencies

• Python 2.6+
• Postgres 9.X (stock pg_hba.conf configuration)
• virtualenv
• node / npm

The following commands worked on a 64-bit CentOS 6.x system (as a privileged user):

	% yum update
	% yum localinstall https://download.postgresql.org/pub/repos/yum/9.4/redhat/rhel-6-x86_64/pgdg-centos94-9.4-3.noarch.rpm
	% rpm -Uvh http://download.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm
	% yum install postgresql94-server postgresql94-plpython postgresql94-devel postgis2_94 postgis2_94-devel python-virtualenv python-pip nodejs nodejs-devel npm git mod_wsgi gcc
	% service postgresql-9.4 initdb && service postgresql-9.4 start

From a shell:

* If accessing the Internet through a proxy, set the http_proxy and https_proxy environment settings
export http_proxy=<your proxy setting>
export https_proxy=<your proxy setting>

cd /usr/local/
sudo chown centos src 
cd src
mkdir geoq
virtualenv ./geoq
cd geoq
source bin/activate
git clone https://github.com/ngageoint/geoq.git
cd geoq
sudo -u postgres psql << EOF
create role geoq login password 'geoq';
create database geoq with owner geoq;
\c geoq
create extension postgis;
create extension postgis_topology;
EOF

export PATH=$PATH:/usr/pgsql-9.4/bin
pip install paver packaging appdirs
# Modify geoq/requirements.txt so that the line 'six==1.4.1' reads 'six>=1.6.0'
paver install_dependencies


sudo su
vi /var/lib/pgsql/9.4/data/pg_hba.conf # modify /var/lib/pgsql/9.4/data/pg_hba.conf, BOTH 'ident' for IPv4 and IPV6 become 'md5'
service postgresql-9.4 restart
exit

* Before executing the following commands, make sure the configuration for PostgreSQL allows the connection
* This can be done by modifying /var/lib/pgsql/9.4/data and changing the connection METHOD near the bottom of the file for 
* the 'local' connections. Changing the METHOD from 'ident' to 'md5' should be sufficient
* Restart postgresql (or reload config) afterwards


paver sync
paver install_dev_fixtures

npm install -g less

* Static files will be installed in a location where a web server can access them. This can be changed depending on your server
* If necessary, create the local directory ('/var/www/html' in this case)
cat << EOF > geoq/local_settings.py
STATIC_URL_FOLDER = '/static'
STATIC_ROOT = '{0}{1}'.format('/var/www/html', STATIC_URL_FOLDER)
EOF
sudo chown centos /var/www/html
python manage.py collectstatic

All that's left is to create a super user account => python manage.py createsuperuser and then you're ready to start GEOQ!

paver start_django