From b95a1db38658e379fa8b7ab408d3fd86e8ba9fd5 Mon Sep 17 00:00:00 2001 From: mazano Date: Fri, 27 Dec 2019 17:38:23 +0200 Subject: [PATCH] Cleanup descriptions (#183) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Fix typo in helper script * Port work in develop to 10 branch (#90) * Port 9.6 to develop (#89) * Part one of porting work from 9.6 to 10 * Backported more scripts from 9.6 branch * Added missing apt update in dockerfile * Updates to entrypoint to reference image and update docker-compose to reference 10 pg * Added sample and docs from 9.6 branch * Removed my diagram as Rizky had already added one * Fix env paths for pg 10 * Fixes for backporting work from 9.6 to 10 - dbb now spins up and accepts connections properly * Update README.md * Backport from branch: 9.6-2.4 Fix default datadir - Change into default datadir - Add small unittest * Optimise PostgreSQL performance and align with the changes done in 9.6 version * Fix version numbers * Minor change to correct env file * Merged 10 branch into develop * Remove reduntant conf file from dockerfile * Remove reduntant conf file directive from setup script * Remove reduntant conf file directive from script * Migrate settings to be compatible with PostgreSQL version 11 * fix ssl setup * Align changes to postgresql version 11 * Set destroy database to false * Commented out code for destroy database * Fix version number for build * Merge develop to master to align with PostgreSQL 11 (#117) * Added note about version number * README update * Revert to using pg 9.3 in latest build - prevent breaking downstream apps for now * Revert to pg 9.3 * Fix references to 9.4 to make them 9.3 rather * Fix incorrect version in 9.4 branch * Fix TOPOLOGY conditional typo * Update run-postgis-docker.sh * Update run-postgis-docker.sh added IPADDRESS * Updates from Marco * Allow connections from 192.168 private network too * start temporary server in local-only mode, poll instead of blind wait, preserve pid 1 * Enable PostGIS Out DB raster support http://postgis.net/2015/05/02/tip_enable_raster_drivers/ http://postgis.net/docs/postgis_installation.html#install_short_version * Remove hardcoded reference to container name "docker" * upgrade postgres to 9.5 and postgis to 2.2 * Added flexible IP range as arg on docker run * Added better description to docker env vars * Updated references to pg and postgis versions in readme * Followup 0745c488, fix references to 9.4 * problem version postgresql version is 9.4, instead of 9.5 * Added note about allowing external ports. * Update README.md * Cleanups to 9.5 branch - remove old supervisor files * Fix for README * 9.5 2.2 (#49) * Allow connections from 192.168 private network too * Updated references to pg and postgis versions in readme * Cleanups to 9.5 branch - remove old supervisor files * Fix for README * Dont add supervisor stuff which is deprecated * Fix 9.4 reference * Allow changing the default database name (#50) * Allow changing the default database name (#50) * Allow changing the default database name (#50) (#52) * Commented out legacy scripts since it seems they are removed in 2.2 * 9.5 2.2 (#58) * Allow changing the default database name (#50) * Commented out legacy scripts since it seems they are removed in 2.2 * 9.5 2.2 (#59) * Allow changing the default database name (#50) * Commented out legacy scripts since it seems they are removed in 2.2 * Improve start (#57) * Make initial dir optional * Improve termination of background initial process #56 * Merge improvements from 9.5 branch (#60) * Allow changing the default database name (#50) * Commented out legacy scripts since it seems they are removed in 2.2 * 9.5 2.2 (#59) * Allow changing the default database name (#50) * Commented out legacy scripts since it seems they are removed in 2.2 * Improve start (#57) * Make initial dir optional * Improve termination of background initial process #56 * Added more options to convenience run script * Added missing l from getopts * Added missing l from getopts * 9.5 2.2 (#61) * Allow changing the default database name (#50) * Allow changing the default database name (#50) * Allow changing the default database name (#50) (#52) * Commented out legacy scripts since it seems they are removed in 2.2 * Added more options to convenience run script * Added missing l from getopts * Added missing l from getopts * Tweak convenience scripts (#62) * Added missing l from getopts * allow connection when using docker compose (#65) see https://github.com/docker/compose/issues/4336 and https://github.com/kartoza/docker-postgis/issues/40 * Install gnupg for fetching keys first * Fix key fetching * Updated to 9.6 and postgis 2.4 * Ditch apt-cacher stuff * Upgraded to PG 10 * change version from postgresql-10.0 to 10 and fix typo in run-postgis… (#76) * change version from postgresql-10.0 to 10 and fix typo in run-postgis file * edit setup.sh to version 10 * Change from version 10.0 to 10 in Dockerfile (#75) I checked that postgresql-10.0 is an invalid name. It should be just postgresql-10 * Fixes for pg 10 to start nicely * Port 9.6 to develop (#89) * Part one of porting work from 9.6 to 10 * Backported more scripts from 9.6 branch * Added missing apt update in dockerfile * Updates to entrypoint to reference image and update docker-compose to reference 10 pg * Added sample and docs from 9.6 branch * Removed my diagram as Rizky had already added one * Fix env paths for pg 10 * Fixes for backporting work from 9.6 to 10 - dbb now spins up and accepts connections properly * Update README.md * Fix #90 and replace references to slave with replicant (Slave is a pejorative term) * Backport from branch: 9.6-2.4 Fix default datadir - Change into default datadir - Add small unittest * Merge branch 10 into develop (#113) * Fix typo in helper script * Port work in develop to 10 branch (#90) * Port 9.6 to develop (#89) * Part one of porting work from 9.6 to 10 * Backported more scripts from 9.6 branch * Added missing apt update in dockerfile * Updates to entrypoint to reference image and update docker-compose to reference 10 pg * Added sample and docs from 9.6 branch * Removed my diagram as Rizky had already added one * Fix env paths for pg 10 * Fixes for backporting work from 9.6 to 10 - dbb now spins up and accepts connections properly * Update README.md * Backport from branch: 9.6-2.4 Fix default datadir - Change into default datadir - Add small unittest * Optimise PostgreSQL performance and align with the changes done in 9.6 version * Fix version numbers * Minor change to correct env file * Merged 10 branch into develop * Remove reduntant conf file from dockerfile * Remove reduntant conf file directive from setup script * Remove reduntant conf file directive from script * Port changes for Postgres version 11 (#114) * Fix typo in helper script * Port work in develop to 10 branch (#90) * Port 9.6 to develop (#89) * Part one of porting work from 9.6 to 10 * Backported more scripts from 9.6 branch * Added missing apt update in dockerfile * Updates to entrypoint to reference image and update docker-compose to reference 10 pg * Added sample and docs from 9.6 branch * Removed my diagram as Rizky had already added one * Fix env paths for pg 10 * Fixes for backporting work from 9.6 to 10 - dbb now spins up and accepts connections properly * Update README.md * Backport from branch: 9.6-2.4 Fix default datadir - Change into default datadir - Add small unittest * Optimise PostgreSQL performance and align with the changes done in 9.6 version * Fix version numbers * Minor change to correct env file * Merged 10 branch into develop * Remove reduntant conf file from dockerfile * Remove reduntant conf file directive from setup script * Remove reduntant conf file directive from script * Migrate settings to be compatible with PostgreSQL version 11 * fix ssl setup * Port changes to 11 branch (#115) * Fix typo in helper script * Port work in develop to 10 branch (#90) * Port 9.6 to develop (#89) * Part one of porting work from 9.6 to 10 * Backported more scripts from 9.6 branch * Added missing apt update in dockerfile * Updates to entrypoint to reference image and update docker-compose to reference 10 pg * Added sample and docs from 9.6 branch * Removed my diagram as Rizky had already added one * Fix env paths for pg 10 * Fixes for backporting work from 9.6 to 10 - dbb now spins up and accepts connections properly * Update README.md * Backport from branch: 9.6-2.4 Fix default datadir - Change into default datadir - Add small unittest * Optimise PostgreSQL performance and align with the changes done in 9.6 version * Fix version numbers * Minor change to correct env file * Merged 10 branch into develop * Remove reduntant conf file from dockerfile * Remove reduntant conf file directive from setup script * Remove reduntant conf file directive from script * Migrate settings to be compatible with PostgreSQL version 11 * fix ssl setup * Align changes to postgresql version 11 * Set destroy database to false * Commented out code for destroy database * Fix version number for build * Implement conf lock file check (#116) It will make sure that the conf file will only be generated once for a given container. * Added new configuration in recovery.conf and postgres optimisations for master-slave replication * Added new configuration in recovery.conf and postgres optimisations for master-slave replication (#118) * Remove template logic and use plain create extension (#119) * Remove template logic and added option to create multiple databases and extensions * Fix travis error * More optimisations for replication * Fix logic for checking if database exists since we now can create multiple databases. * Added Licence file * add option to mount certificates * fix comments in PR about mounting SSL * Align to develop upstream * Add OGR FDW to the installation and activate it in the docker-compose * Fix spacing in readme * Add replication user and enable postgis rasters drivers * Replicate from restricted IP address * use replication user for streaming changes * update README to higlight new changes * change permisions of default schema to enable replication * add missing env variables * Add logic to cater for destroy database on restart. It can be True or False on start and the logic will handle it * fix for version 12 upgrade * add postgis raster extension * Small fixes for postgresql 12 * Modified docker-compose to run against pg 12 * remove duplicated env * Build point cloud and other custome extension, add plpython and pgcron * Disable building community extensions * fix reference to port in docker compose * Cleanup readme Co-authored-by: Tim Sutton Co-authored-by: Rizky Maulana Nugraha --- README.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 029d21f..08222b0 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ just getting started with docker, PostGIS and QGIS, we really recommend that you The following convention is used for tagging the images we build: -kartoza/postgis:[postgres_version]-[postgis-version] +kartoza/postgis:[postgres_major_version]-[postgis-point-releases] So for example: @@ -87,8 +87,8 @@ and then run docker build --build-args PG_EXTENSION=true -t kartoza/postgis:12.0 . ``` -The image is currently built to accommodate the following extensions `ogr_fdw`,`pointcloud`,`pointcloud_postgis` which you can use by with the environment variable -`POSTGRES_MULTIPLE_EXTENSIONS`. +If you build the custom extensions you will be able to activate the following `pointcloud`,`pointcloud_postgis` +extensions with the environment variable `POSTGRES_MULTIPLE_EXTENSIONS`. ## Run @@ -96,7 +96,7 @@ The image is currently built to accommodate the following extensions `ogr_fdw`,` To create a running container do: ``` -sudo docker run --name "postgis" -p 25432:5432 -d -t kartoza/postgis +docker run --name "postgis" -p 25432:5432 -d -t kartoza/postgis ``` ## Environment variables @@ -107,7 +107,9 @@ user name, password and/or default database name(or multiple databases comma sep * -e POSTGRES_USER= * -e POSTGRES_PASS= * -e POSTGRES_DBNAME= -* -e POSTGRES_MULTIPLE_EXTENSIONS=postgis,hstore,postgis_topology,pointcloud,pointcloud_postgis # You can pass as many extensions as you need. +* -e POSTGRES_MULTIPLE_EXTENSIONS=postgis,hstore,postgis_topology + +You can pass as many extensions as you need. * -e SSL_CERT_FILE=/your/own/ssl_cert_file.pem * -e SSL_KEY_FILE=/your/own/ssl_key_file.key * -e SSL_CA_FILE=/your/own/ssl_ca_file.pem @@ -122,18 +124,9 @@ Maximum size to let the WAL grow to between automatic WAL checkpoints. * -e WAL_SIZE=4GB * -e MIN_WAL_SIZE=2048MB - -Specifes the size of WAL segment files when creating a new data base cluster. Maximum -permitted value is 1024 (equivalent to 1GB) * -e WAL_SEGSIZE=1024 - -Specifies the maximum amount of memory to be used by maintenance operations, such as VACUUM, CREATE INDEX, and ALTER TABLE ADD FOREIGN KEY * -e MAINTAINANCE_WORK_MEM=128MB -These will be used to create a new superuser with -your preferred credentials. If these are not specified then the postgresql -user is set to 'docker' with password 'docker'. - You can open up the PG port by using the following environment variable. By default the container will allow connections only from the docker private subnet. @@ -149,6 +142,7 @@ You can also define any other configuration to add to `postgres.conf`, separated * -e EXTRA_CONF="log_destination = 'stderr'\nlogging_collector = on" + ## Convenience docker-compose.yml For convenience we have provided a ``docker-compose.yml`` that will run a @@ -197,7 +191,7 @@ When running scripts they will only be executed against the first database ie POSTGRES_DB=gis,data,sample The SQL script will be executed against the gis database. -Currently you can pass `.sql` and `.sql.gz` files as mounted volumes. +Currently you can pass `.sql` , `.sql.gz` and `.sh` files as mounted volumes. ```