G3W-ADMIN

Admin server for G3W-SUITE written in Python, based on Django LTS (v3.2) and QGIS Server LTR (v3.28)

Versions and Branches

Software releases follow theese main branches as described in the compatibility table:

Branch	Python	Django	QGIS	client	First release	Status
dev	3.10	3.2	3.28	dev	Unreleased	⚠️️ Unstable
v.3.6.x	3.10	3.2	3.28	3.8.5	May 2023	🪲️ Bug fixing
v.3.5.x	3.10	2.2	3.22	3.7	Nov 2022	🪲️ Bug fixing
v.3.4.x	3.8	2.2	3.22	3.4	Mar 2022	🚨 End of Life
v.3.3.x	3.6	2.2	3.16	3.3	Sep 2021	🚨 End of Life
v.3.2.x	3.6	2.2	3.16	3.2	Apr 2021	🚨 End of Life
v.3.1.x	3.6	2.2	3.10	3.1	Nov 2020	🚨 End of Life
v.3.0.x	3.6	2.2	3.10	3.0	Nov 2020	🚨 End of Life
dj22-py3	3.6	2.2	🔗			🚨 End of Life
py2	2.7	1.11	🔗			🚨 End of Life

Project setup

Docker Compose

It's strongly recommended to follow the g3w-suite-docker installation instructions (which already bundles a full blown NGINX + PostgreSQL setup), as such installation method speed up development and deployment and would cause you fewer issues in terms of compatibility and portability in the short and long term.

Barebone server

If you will opt for the raw installation you will need to configure your own web server in order to run a Django project, some common setups are:

To figure out which to choose, see also: deploying django

Then in your development environment:

download and install Node.js and Yarn
get a Python version that is compatible with the table above
install and activate a database that fits your needs
(optional) install Paver for developing locally

After that you can clone this repository:

cd /path/to/your/development/workspace

git clone https://github.com/g3w-suite/g3w-admin.git --single-branch --branch dev ./g3w-admin

Create and activate virtualenv within your g3w-admin local repository:

cd ./g3w-admin

python3 -m venv --system-site-packages [--prompt g3w-admin] venv

# Linux / Mac OS
source venv/bin/activate

# Windows
.\venv\Scripts\activate

Create the following configuration file from the available template:

/g3w-admin/g3w-admin/base/settings/local_settings.py ← local_settings_example.py

And check that the following parameters are set accordingly:

# /g3w-admin/g3w-admin/base/settings/local_settings.py

DATASOURCE_PATH     = '<static_path_to_gis_data_source>'
MEDIA_ROOT          = '<path_to_media_root>'
SESSION_COOKIE_NAME = '<unique_session_id>'
DATABASES           = {
    'default': {
        'ENGINE': 'django.contrib.gis.db.backends.postgis',
        'NAME': '<db_name>',
        'USER': '<db_user>',
        'PASSWORD': '<db_user_password>',
        'HOST': '<db_host>',
        'PORT': '<db_port>',
    }
}