Change default search function

G3W-SUITE-DOCKER

Run a self hosted web-gis application with Docker Compose

⬆️ How to upgrade from v3.7 to v3.8

Since v3.8 PostgreSQL/PostGIS changed from v11/2.5 to v16/3.4, to upgrade follow below steps:

# NB:
# • (ENV = dev)      → docker-compose-dev.yml
# • (ENV = prod)     → docker-compose.yml
# • (ENV = consumer) → docker-compose-consumer.yml

### BACKUP (v3.7.x) ###

docker compose up -f docker-compose-dev.yml up -d

git fetch
git checkout v3.8.x

make db-backup ID=11 ENV=prod

### RESTORE (v3.8.x) ###

make db-restore ID=11 ENV=prod

### OPTIONAL (delete old DB) ###

docker compose exec g3w-suite bash -c 'rm -r /shared-volume/11'
docker compose exec g3w-suite bash -c 'rm -r /shared-volume/backup/11'

🌍 Deploying your webgis app

Install docker compose.

Clone this repository:

git clone https://github.com/g3w-suite/g3w-suite-docker/
cd g3w-suite-docker

Create a .env file starting from .env.example and tailor it to your needs:

# CHANGE ME: PostGIS DB password

- G3WSUITE_POSTGRES_PASS='89#kL8y3D'
+ G3WSUITE_POSTGRES_PASS=<your__password>

Start containers:

docker-compose up -d

or, if you intend to use huey (batch processing)

docker-compose -f docker-compose-consumer.yml up -d

NB: at the very first start, have a lot of patience 😴 → the system must finalize the installation. *

After some time the suite will be available at:

http://localhost:8080 (user: admin, pass: admin)

* in case of faulty container (eg. the first time you didn't wait long enough before trying to access):

# 🚨 deletes all data
make db-reset ENV=prod

# or
# make db-reset ENV=consumer

💻 How to access into a container

login into a service

$ make run-postgis ENV=prod

# make run-g3w-suite ENV=prod
# make run-nginx ENV=prod
# make run-redis ENV=prod

perform your administrative tasks (eg. connect to postgis as "postgres" user):

root@84ef6a8d23e6:/# su - postgres

postgres@84ef6a8d23e6:~$ psql
psql (11.2 (Debian 11.2-1.pgdg90+1))
Type "help" for help.

postgres=#

🔒 HTTPS

To enable https with LetsEncrypt::

uncomment ssl section within config/nginx/nginx.conf
update WEBGIS_PUBLIC_HOSTNAME environment variable within the .env and config/nginx/nginx.conf files
launch sudo make renew-ssl
make sure the certs are renewed by adding a cron job with sudo crontab -e and add the following line: 0 3 * * * /<path_to_your_docker_files>/run_certbot.sh

📦 Docker image

Docker compose will usually download images from: https://hub.docker.com/u/g3wsuite

A custom (local) docker image for the suite can be created with:

docker build -f Dockerfile.g3wsuite.dockerfile -t g3wsuite/g3w-suite:dev --no-cache .

# OPTIONAL:
# docker build -f Dockerfile.g3wsuite-deps.ltr.dockerfile -t g3wsuite/g3w-suite-deps-ltr:dev --no-cache .

The image is build on latest Ubuntu and QGIS LTR, following this execution order:

Dockerfile.g3wsuite-deps.ltr.dockerfile ← installs Ubuntu and QGIS LTR
Dockerfile.g3wsuite.dockerfile ← run "setup.sh" and "docker-entrypoint.sh"
scripts/setup.sh ← install g3w-admin and some other python plugins
scripts/docker-entrypoint.sh ← start gunicorn

🎨 Style customization

custom templates folder: config/g3w-suite/overrides/templates → a Docker service restart is required to make the changes effective.
custom logo (see: docs): config/g3w-suite/settings_docker.py → a Docker service restart is required to make the changes effective.
custom CSS: config/g3w-suite/overrides/static/style.css → changes are effective immediately

🚀 Performance optimizations

set scale-dependent visibility for the entire layer or for some filtered features (example: show only major roads until at scale 1:1E+6)
when using rule-based/categorized classification or scale-dependent visibility create indexes on the column(s) involved in the rule expression (example: "create index idx_elec_penwell_ious on elec_penwell_ious (owner);" )
start the project with only a few layers turned on by default
do not turn on by default base-layers XYZ such as (Google base maps)
do not use rule-based/categorized rendering on layers with too many categories (example: elec_penwell_public_power), they are unreadable anyway
enable redering simplification for not-point layers, set it to Distance 1.2 and check Enable provider simplification if available
enable cache on linestring and polygon layers (tile cache can be configured and cleared per-layer through the webgis admin panel and lasts forever until it is disabled or cleared)
set a cron job on host machine that checks edited features that have been locked for more than 4 hours and frees them:

0 */1 * * * docker exec g3w-suite-docker_g3w-suite_1 python3 /code/g3w-admin/manage.py check_features_locked

🐋 Portainer usage

Portainer (https://www.portainer.io) is a docker-based web application used to edit and manage Docker applications in a simple and intuitive way.

Plese refer to the Add new stack section to learn how to deploy the docker-compose-consumer.yml stack with Portainer (>= v2.1.1).

♻️ Database backup / restore

# NB:
# • (ENV = dev)      → docker-compose-dev.yml
# • (ENV = prod)     → docker-compose.yml
# • (ENV = consumer) → docker-compose-consumer.yml

docker compose up -f docker-compose.yml up -d

make backup-db ID=foo-backup ENV=prod
make restore-db ID=foo-backup ENV=prod

Contributors

GIS3W: wlorenzetti, raruto
ItOpen: elpaso
Kartoza: NyakudyaA
QTIBIA: tudorbarascu

	# When building in dev env you might want a clean build each time.
	if [[ -z "${DEV}" ]]; then
	rm -rf /shared-volume/build_done
	fi


	client_max_body_size 200M;
	client_body_timeout 600;


	upstream web {
	ip_hash;
	server g3w-suite:8000;
	}


	# portal
	server {

	# Block *.php
	location ~\.php$ {
	return 404;
	}

	# Secure project's folder
	location /static/projects/ {
	return 403;
	}

	location /static/ {
	root /shared-volume/;
	}

	location /media/ {
	root /shared-volume/;
	}

	location /media_user/ {
	root /shared-volume/project_data/;
	}

	# Certbot configuration
	location /.well-known/acme-challenge/ {
	root /var/www;
	}

	# Comment this if you enable HTTPS
	location / {
	keepalive_timeout 500;
	proxy_connect_timeout 600;
	proxy_send_timeout 600;
	send_timeout 600;
	fastcgi_read_timeout 300;
	proxy_read_timeout 600;
	proxy_set_header Host $host;
	proxy_set_header X-Forwarded-For $remote_addr;
	proxy_set_header X-Forwarded-Proto $scheme;
	proxy_pass http://web/;
	}

	# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
	# Uncomment the following lines if you want activate https
	# and comment the previous location / declaration

	#location / {
	# return 301 https://$host$request_uri;
	#}

	# Listen
	listen 8080;

	# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
	# NOTE: change server_name according to your real hostname
	server_name dev.g3wsuite.it;

	}

	# HTTPS portal

	server {

	location ~\.php$ {
	return 404;
	}

	# Secure project's folder
	location /static/projects/ {
	return 403;
	}

	location /static/ {
	root /shared-volume/;
	}

	location /media/ {
	root /shared-volume/;
	}

	location / {
	proxy_read_timeout 120;
	proxy_set_header Host $host;
	proxy_set_header X-Forwarded-For $remote_addr;
	proxy_set_header X-Forwarded-Proto $scheme;
	proxy_pass http://web/;
	}

	listen 443 ssl;

	# !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
	# NOTE: change server_name and cert paths according to
	# your real hostname

	server_name dev.g3wsuite.it;

	ssl_certificate /etc/letsencrypt/live/dev.g3wsuite.it/fullchain.pem;
	ssl_certificate_key /etc/letsencrypt/live/dev.g3wsuite.it/privkey.pem;

	include /etc/letsencrypt/options-ssl-nginx.conf;
	ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;

	resolver 8.8.8.8;

	}

	#!/bin/bash
	# Run certbot docker container to renew the HTTPS certificate.
	# Requires .env file with container configuration variables

	CURRENT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"

	source ${CURRENT_DIR}/.env

	if [ "${WEBGIS_PUBLIC_HOSTNAME}" = "" ]; then
	echo "WEBGIS_PUBLIC_HOSTNAME not defined: exiting"
	exit 1
	fi

	if [ "${WEBGIS_DOCKER_SHARED_VOLUME}" = "" ]; then
	echo "WEBGIS_DOCKER_SHARED_VOLUME not defined: exiting"
	exit 1
	fi

	mkdir -p "${WEBGIS_DOCKER_SHARED_VOLUME}/certs/letsencrypt/"

	curl -s https://raw.githubusercontent.com/certbot/certbot/master/certbot-nginx/certbot_nginx/_internal/tls_configs/options-ssl-nginx.conf > "${WEBGIS_DOCKER_SHARED_VOLUME}/certs/letsencrypt/options-ssl-nginx.conf"
	curl -s https://raw.githubusercontent.com/certbot/certbot/master/certbot/certbot/ssl-dhparams.pem > "${WEBGIS_DOCKER_SHARED_VOLUME}/certs/letsencrypt/ssl-dhparams.pem"

	docker run -it --rm --name certbot \
	-v ${WEBGIS_DOCKER_SHARED_VOLUME}/certs/letsencrypt:/etc/letsencrypt \
	-v ${WEBGIS_DOCKER_SHARED_VOLUME}/var/www/.well-known:/var/www/.well-known \
	certbot/certbot -t certonly \
	--agree-tos --renew-by-default \
	--no-eff-email \
	--webroot -w /var/www \
	-d ${WEBGIS_PUBLIC_HOSTNAME}

	[water_service]
	host=192.168.1.137
	port=5432
	dbname=gis_data
	user=postgres
	password=postgres

	# Shared volume mount (docker internal: shared-volume)
	# I suggest not to use the /tmp/ folder, /tmp/ folder is cleaned at each reboot
	WEBGIS_DOCKER_SHARED_VOLUME=/tmp/shared-volume-g3wsuite-dev

	### PG_SERVICE

	To use of PostgreSql Service, put your service setups into `./secrets/pg_service.conf file`,
	the conf file will be mounted into docker container at runtime to PGSERVICEFILE path position.

	# QGIS Server env variables
	# ----------------------------------------------------
	PGSERVICEFILE=/pg_service/pg_service.conf
	# Put your pg service into ./scripts/pg_service.conf file, the conf file will be mounted into
	# docker container at runtime a the PGSERVICEFILE

	gunicorn base.wsgi:application \
	--limit-request-fields 0 \
	--error-logfile - \
	--log-level=debug \
	--timeout ${G3WSUITE_GUNICORN_TIMEOUT:-120} \
	--workers=${G3WSUITE_GUNICORN_NUM_WORKERS:-8} \
	--max-requests=${G3WSUITE_GUNICORN_MAX_REQUESTS:-200} \
	-b 0.0.0.0:8000

	#TODO make this as generic so that we can install as many plugins as possible
	git submodule add -f https://github.com/g3w-suite/g3w-admin-frontend.git g3w-admin/frontend

	# docker-compose file for Portainer(https://www.portainer.io)
	# A the moment Portainer work only with version "2"

	version: "2"

	# Public hostmane
	WEBGIS_PUBLIC_HOSTNAME=dev.g3wsuite.it

g3w-suite / g3w-suite-docker Goto Github PK

g3w-suite-docker's Introduction

G3W-SUITE-DOCKER

⬆️ How to upgrade from v3.7 to v3.8

🌍 Deploying your webgis app

💻 How to access into a container

🔒 HTTPS

📦 Docker image

🎨 Style customization

🚀 Performance optimizations

🐋 Portainer usage

♻️ Database backup / restore

Contributors

g3w-suite-docker's People

Stargazers

Watchers

Forkers

g3w-suite-docker's Issues

Problem

HTTPS additional setup

The Connection Service File

Problem

Recommend Projects

Recommend Topics

Recommend Org