geovisio 2.8.1__tar.gz → 2.10.0__tar.gz

geovisio-2.10.0/.gitignore

@@ -0,0 +1,39 @@
+pictures
+*.env
+*.log
+picfs
+env
+.pytest_cache
+instance
+__pycache__
+config.py
+docker/models/
+.vscode/
+site/
+*.mo
+
+## https://github.com/github/gitignore/blob/f752d0799fb7e690bfb888d5cd4d453d2858a865/Global/macOS.gitignore
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon[]
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk

{geovisio-2.8.1 → geovisio-2.10.0}/CHANGELOG.md

@@ -9,6 +9,60 @@ Before _1.6.0_, [Viewer](https://gitlab.com/panoramax/clients/web-viewer) was em
 
 ## [Unreleased]
 
+## [2.10.0] - 2025-08-27
+
+### Added
+
+- Added 2 new parameters on creating/updating an upload set: `no_split` to create only 1 sequence from the upload set pictures and `no_deduplication` not to remove pictures too close from each other.
+- Add an `updated` field in all the items's responses.
+- Add an `sortby` parameter in search to sort the results (and it can use the new `updated` field).
+- Add a way to generate a new token for the current user (via `POST /api/users/me/tokens`).
+- Added route aliases to get annotations. 
+  * The route `/api/annotations/<uuid:annotationId>` is now an alias of `/api/collections/<uuid:collectionId>/items/<uuid:itemId>/annotations/<uuid:annotationId>`
+  * The route `/api/picture/<uuid:pictureId>` is now an alias of `/api/collections/<uuid:collectionId>/items/<uuid:itemId>`
+  * The route to create an annotation `/api/picture/<uuid:pictureId>/annotations` is now an alias of `/api/collections/<uuid:collectionId>/items/<uuid:itemId>/annotations`
+- Add a way to attach semantic tags to upload sets. Those tags will be transferred to all the collections associated to the upload set. This makes it possible to add semantic tags directly at the upload, without waiting for all the associated collections to be created.
+- Add a `relative_heading` parameter to the `/api/upload_sets/:id` route (for `POST` and `PATCH`), to update the relative heading of the upload set. If a `relative_heading` is set on the upload set, it will be applied when computeing the heading of all the associated collections.
+
+### Changed
+
+- Changed the default to split an upload set in several collection, by default we split when a picture is separated from the previous one by 5 minutes or 100 m. This default can be configured by each instance, and overridden for each upload set.
+- Changed the default to remove capture duplicates in an upload set, by default we remove pictures less than 1m appart like before and with less than 60° (was 30°). This default can be configured by each instance (by updating the `configurations` table), and overridden for each upload set.
+- Posting an empty JSON while patching a picture (`/api/collections/:cid/items/:id`) will now return a 304 instead of a 200.
+- update lots of dependencies
+
+### Fixed
+
+- Deleting an unkown upload set now returns a 404 instead of a 500.
+- Fix a bug when reorienting a sequence with a single picture would crash the website.
+- It's now possible to remove the last semantic from an annotation and add one again when calling `POST /api/collections/:cid/items/:id/annotations` for a shape that already exists.
+- Now, if the blurring api rotate a side oriented picture, its size and exif orientation are updated accordingly.
+
+## [2.9.0] - 2025-05-12
+
+### Added
+
+- Add a new configuration `PICTURE_PROCESS_NB_RETRIES` to tell the number of times a job will be retried if there is a `RecoverableProcessException` during process (like if the blurring api is not reachable). Defaults to 5 like before.
+- Add a way to search on semantic tags in `/api/search` endpoint with a CQL2 filter like `filter="semantics.some_key"='some_value'`.
+- Add a `API_REGISTRATION_IS_OPEN` setting in the API to tell the federation that account can (or not) be created directly on the instance. Defaults to `false`.
+- Added field `geovisio:rank_in_collection` to pictures metadata to get the rank of the picture in the collection in `/api/collections/:cid/items/:id` / `/api/collections/:cid/items` and `/api/search` responses. This makes it easier to use the `startAfterRank` parameter to paginate through pictures in collections..
+- Handle semantics returned by the blurring API, and automatically add annotations on the pictures with semantic tags on the detected objects..
+- Add a new async job `read_metadata` to read the metadata of pictures. This job can read or not the file (depending on the `read_file` boolean in the job's `args` field). This is usefull to update metadata when the geopic-tag-reader library is updated.
+
+### Fixed
+
+- Fix the pagination links when many sequences had the exact same creation date on `/api/collections`.
+- Migration `20240409_01_jnhra-pictures-grid.sql` was not working from empty database.
+- When asking for collections list as CSV format, API was sending `Content-Type: text/html` instead of `text/csv` in response.
+- Fix a sql error on `/api/users/me/collection` when using PostgreSQL <= 13.
+- Fix a bug causing a 500 when filtering collections with no updates
+- Fix a bug where the collection geometry was not recomputed after a sort.
+
+### Changed
+
+- Change the way the coefficients are computed for the grid, compute the mean only over squares with flat (or 360°) pictures.
+- Update lot of dependencies (Flask, psycopg, pillow, sentry, ...)
+
 ## [2.8.1] - 2025-03-13
 
 ### Added
@@ -16,10 +70,12 @@ Before _1.6.0_, [Viewer](https://gitlab.com/panoramax/clients/web-viewer) was em
 - Add a way to know the role and permission of the logged user in `/api/users/me`.
 - Add the ability to update an upload set parameters through a `PATCH` on `/api/upload_sets/:id`.
 - Add a debug endpoint `/api/debug_headers` that can be handy when setting a new instance to check if the proxies are correctly setting the headers.
+- Add the ability to add annotations to a part of a picture, with semantic tags associated (through `/api/collections/:id/items/:id/annotations`).
 
 ### Fixed
 
 - Fix a bug where dispatching several time the same upload set would not cleanup unused sequences.
+- Fix a bug where the relative heading parameter was not correctly validated on null values.
 
 ### Changed
 
@@ -31,7 +87,7 @@ Before _1.6.0_, [Viewer](https://gitlab.com/panoramax/clients/web-viewer) was em
 
 - Add the ability to export a user's collections in a CSV file by either providing a `format` query parameter or with the `Accept: text/csv` header. The CSV export is not limited to the first 1000 collections as the JSON API.
 - More metadata can be defined for the API in `API_SUMMARY` environment variable: contact email and geographical coverage
-- Add the ability to blur again a picture/sequence, by calling the `/api/collections/:id/prepare`/`/api/collections/:id/items/:id/prepare` endpoints. 
+- Add the ability to blur again a picture/sequence, by calling the `/api/collections/:id/prepare`/`/api/collections/:id/items/:id/prepare` endpoints.
 - Add the ability to change a picture's capture time, latitude and longitude using the PATCH `/api/collections/:id/items/:id` route.
 - Add the number of collection to the endpoint `/api/users/:id/collection`
 - Add _pages_ management to handle legal mentions and terms of service storage in database. New routes `/api/pages` allow to create, list, delete these pages in several languages.
@@ -68,7 +124,7 @@ Before _1.6.0_, [Viewer](https://gitlab.com/panoramax/clients/web-viewer) was em
 - Add `missing_fields` list to the `/api/upload_sets/:id/files` response detailling the missing fields from a rejected uploaded picture.
 - Details about picture quality are now offered for display and filtering:
   - In sequences and pictures routes: `quality:horizontal_accuracy` for GPS position precision (in meters), `panoramax:horizontal_pixel_density` for pixel density on horizon (px/FOV degree).
-  - In vector tiles: `gps_accuracy` and `h_pixel_density` (for __sequences and pictures__ layers, not available on grid layer)
+  - In vector tiles: `gps_accuracy` and `h_pixel_density` (for **sequences and pictures** layers, not available on grid layer)
 - In vector tiles style, a new metadata property `panoramax:fields` lists all available properties in each layer (pictures, sequences, grid). This will allow easier compatibility checks in web viewer.
 - Translations in Spanish 🇪🇸 and Hungarian 🇭🇺.
 
@@ -622,7 +678,9 @@ FLASK_APP="src" flask process-sequences
 - Viewer based on Photo Sphere Viewer automatically calling API to search and retrieve pictures
 - Dockerfile for easy server setup
 
-[Unreleased]: https://gitlab.com/panoramax/server/api/-/compare/2.8.1...develop
+[Unreleased]: https://gitlab.com/panoramax/server/api/-/compare/2.10.0...develop
+[2.10.0]: https://gitlab.com/panoramax/server/api/-/compare/2.9.0...2.10.0
+[2.9.0]: https://gitlab.com/panoramax/server/api/-/compare/2.8.1...2.9.0
 [2.8.1]: https://gitlab.com/panoramax/server/api/-/compare/2.8.0...2.8.1
 [2.8.0]: https://gitlab.com/panoramax/server/api/-/compare/2.7.1...2.8.0
 [2.7.1]: https://gitlab.com/panoramax/server/api/-/compare/2.7.0...2.7.1

{geovisio-2.8.1 → geovisio-2.10.0}/PKG-INFO

@@ -1,55 +1,56 @@
 Metadata-Version: 2.4
 Name: geovisio
-Version: 2.8.1
+Version: 2.10.0
 Summary: GeoVisio API - Main
 Author-email: Adrien PAVIE <panieravide@riseup.net>, Antoine Desbordes <antoine.desbordes@gmail.com>
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 Classifier: License :: OSI Approved :: MIT License
 License-File: LICENSE
-Requires-Dist: Flask ~= 2.3
-Requires-Dist: psycopg[pool] ~= 3.1
+Requires-Dist: Flask ~= 3.1
+Requires-Dist: psycopg[pool] ~= 3.2
 Requires-Dist: flasgger ~= 0.9.7
-Requires-Dist: Pillow ~= 9.4
-Requires-Dist: Flask-Cors ~= 4.0
+Requires-Dist: Pillow ~= 11.1
+Requires-Dist: Flask-Cors ~= 6.0
 Requires-Dist: fs ~= 2.4
 Requires-Dist: fs-s3fs-forked ~= 1.1.4
 Requires-Dist: flask-compress ~= 1.14
 Requires-Dist: requests ~= 2.31
-Requires-Dist: yoyo-migrations ~= 8.2
-Requires-Dist: psycopg-binary ~= 3.1
-Requires-Dist: python-dotenv ~= 0.21
-Requires-Dist: authlib ~= 1.2
+Requires-Dist: yoyo-migrations ~= 9.0
+Requires-Dist: psycopg-binary ~= 3.2
+Requires-Dist: python-dotenv ~= 1.1
+Requires-Dist: authlib ~= 1.6
 Requires-Dist: Flask-Executor ~= 1.0
-Requires-Dist: geopic-tag-reader[write-exif] == 1.4.2
+Requires-Dist: geopic-tag-reader[write-exif] ~= 1.8.0
 Requires-Dist: rfeed ~= 1.1.1
-Requires-Dist: sentry-sdk[flask] ~= 1.31
-Requires-Dist: pygeofilter[backend-native] ~= 0.2.4
+Requires-Dist: sentry-sdk[flask] ~= 2.24
+Requires-Dist: pygeofilter[backend-native] ~= 0.3.1
 Requires-Dist: python-dateutil ~= 2.9.0
-Requires-Dist: tzdata ~= 2024.1
-Requires-Dist: croniter ~= 2.0.5
-Requires-Dist: pydantic ~= 2.7
+Requires-Dist: tzdata ~= 2025.2
+Requires-Dist: croniter ~= 6.0.0
+Requires-Dist: pydantic ~= 2.11
 Requires-Dist: pydantic-extra-types ~= 2.7
 Requires-Dist: flask-babel ~= 4.0.0
-Requires-Dist: geojson-pydantic ~= 1.1.0
+Requires-Dist: geojson-pydantic ~= 2.0.0
 Requires-Dist: email-validator ~= 2.2.0
+Requires-Dist: multipart>=1.2.1
 Requires-Dist: flit ~= 3.9.0 ; extra == "build"
-Requires-Dist: coverage ~= 6.5 ; extra == "dev"
-Requires-Dist: protobuf ~= 4.21 ; extra == "dev"
-Requires-Dist: mapbox-vector-tile ~= 2.0 ; extra == "dev"
+Requires-Dist: coverage ~= 7.9 ; extra == "dev"
+Requires-Dist: protobuf ~= 5.26 ; extra == "dev"
+Requires-Dist: mapbox-vector-tile ~= 2.1 ; extra == "dev"
 Requires-Dist: pystac ~= 1.9 ; extra == "dev"
-Requires-Dist: pytest ~= 8.3 ; extra == "dev"
-Requires-Dist: pytest-datafiles ~= 2.0 ; extra == "dev"
+Requires-Dist: pytest ~= 8.4 ; extra == "dev"
+Requires-Dist: pytest-datafiles ~= 3.0 ; extra == "dev"
 Requires-Dist: pyexiv2 ~= 2.15 ; extra == "dev"
-Requires-Dist: testcontainers ~= 4.1 ; extra == "dev"
+Requires-Dist: testcontainers ~= 4.10 ; extra == "dev"
 Requires-Dist: requests-mock ~= 1.11 ; extra == "dev"
-Requires-Dist: black ~= 24.1 ; extra == "dev"
-Requires-Dist: pre-commit ~= 3.3 ; extra == "dev"
+Requires-Dist: black ~= 25.1 ; extra == "dev"
+Requires-Dist: pre-commit ~= 4.2 ; extra == "dev"
 Requires-Dist: pyyaml ~= 6.0 ; extra == "dev"
 Requires-Dist: openapi-spec-validator ~= 0.7 ; extra == "dev"
 Requires-Dist: stac-api-validator ~= 0.6.4 ; extra == "dev"
-Requires-Dist: mkdocs-material ~= 9.5.21 ; extra == "docs"
-Requires-Dist: mkdocs-swagger-ui-tag ~= 0.6.10 ; extra == "docs"
+Requires-Dist: mkdocs-material ~= 9.6.14 ; extra == "docs"
+Requires-Dist: mkdocs-swagger-ui-tag ~= 0.7.1 ; extra == "docs"
 Project-URL: Home, https://gitlab.com/panoramax/server/api
 Project-URL: Source Code, https://gitlab.com/panoramax/server/api
 Provides-Extra: build

geovisio-2.10.0/docker/docker-compose-blurring.yml

@@ -0,0 +1,70 @@
+# This docker compose is the one to use if you want to run the blurring API.
+# It should be quite close to the one defined by https://github.com/cquest/sgblur.
+# ----
+# This docker-compose needs to be used alongside a docker containing geovisio API
+# For instance with docker-compose-full.yml
+# docker compose -f docker/docker-compose-full.yml -f docker/docker-compose-blurring.yml up
+services:
+  blur:
+    # The blurring API, that calls the detection API and blurs the picture using the detected objects.
+    # This does not require a GPU, but is CPU-bound.
+    build: .
+    image: panoramax/sgblur:${BLUR_IMAGE_TAG:-latest}
+    environment:
+      WEB_CONCURRENCY: "8"  # Number of workers for the API, you can adjust this depending on your available CPU ressources.
+      DETECT_URL: "http://detect:8001"
+    restart: unless-stopped
+    depends_on:
+      detect:
+        condition: service_healthy
+    ports:
+      - 8000
+    networks:
+      blur: {}
+
+  detect:
+    # This service is the one responsible for running the detection model.
+    # It is GPU-bound
+    build: .
+    image: panoramax/sgblur:${BLUR_IMAGE_TAG:-latest}
+    entrypoint: ["uvicorn", "src.detect.detect_api:app", "--host", "0.0.0.0", "--port", "8001"]
+    #environment:
+      #MODEL_NAME: # specify a model if needed, else the one fitting the most the available GPU will be used
+    deploy:
+      resources:
+        reservations:
+          devices:
+            - driver: nvidia # We only support Nvidia card right now
+              count: all
+              capabilities: [gpu]
+
+    restart: unless-stopped
+    healthcheck:
+      test: python -c "import requests; requests.get('http://localhost:8001/').raise_for_status()"
+      interval: 4s
+      timeout: 5s
+      retries: 10
+      start_period: 1s
+    ports:
+      - 8001
+    networks:
+      blur: {}
+
+
+  # Add a configuration to the API/workers to tell them the location of the blurring API
+  api:
+    environment:
+      API_BLUR_URL: http://blur:8000
+
+  background-worker:
+    environment:
+      API_BLUR_URL: http://blur:8000
+    depends_on:
+      blur:
+        condition: service_healthy
+    networks:
+      blur: {}
+
+
+networks:
+  blur: {}

geovisio-2.10.0/docker/docker-compose-full-linux.yml

@@ -0,0 +1,6 @@
+
+services:
+  api:
+    network_mode: "host"
+    environment:
+      DB_URL: postgres://gvs:gvspwd@localhost:5445/geovisio

{geovisio-2.8.1 → geovisio-2.10.0}/docker/docker-compose-full.yml

@@ -90,12 +90,17 @@ services:
       - 5000:5000
     volumes:
       - pic_data:/data/geovisio
+    # The API need to be able to query the auth server like it is on localhost
+    # On mac/windows, use the extra_host bindings
+    # On linux, use the other docker-compose-full-linux.yml file to use host networking and adapt configuration
+    # docker compose -f docker-compose-full.yml -f docker-compose-full-linux.yml up -d
     extra_hosts:
       - "localhost:host-gateway"
+
     restart: always
 
   website:
-    image: panoramax/website:latest
+    image: panoramax/website:${GEOVISIO_IMAGE_TAG:-latest}
     environment:
       VITE_INSTANCE_NAME: GeoVisio Docker
       VITE_API_URL: http://localhost:5000/

geovisio-2.10.0/docker/docker-compose-minio.yml

@@ -0,0 +1,45 @@
+services:
+  minio:
+    image: quay.io/minio/minio:RELEASE.2025-05-24T17-08-30Z
+    command: server --console-address ":9001" /mnt/data
+    ports:
+      - 9000
+      - 9001
+    volumes:
+      - minio-data:/mnt/data
+    environment:
+      MINIO_ROOT_USER: geovisio
+      MINIO_ROOT_PASSWORD: SOME_VERY_SECRET_KEY
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://minio:9000/minio/health/live"]
+      interval: 2s
+      timeout: 5s
+      retries: 3
+    restart: always
+
+  create-minio-buckets:
+    image: minio/mc
+    depends_on:
+      minio:
+        condition: service_healthy
+    entrypoint: >
+      /bin/sh -c "
+      mc alias set myminio http://minio:9000 geovisio SOME_VERY_SECRET_KEY;
+      
+      mc mb myminio/panoramax-public;
+      mc mb myminio/panoramax-private;
+      mc anonymous set download myminio/panoramax-public;
+      "
+
+  minio-ready:
+    # hack to bypass testcontainers limitation, since it cannot wait for a job to be completed, 
+    # start a dumb service after all buckets are created
+    # and wait for it to be ready in the tests
+    image: alpine
+    depends_on:
+      create-minio-buckets:
+        condition: service_completed_successfully
+    entrypoint: "sleep infinity"
+
+volumes:
+  minio-data: {}

{geovisio-2.8.1 → geovisio-2.10.0}/docker/full-keycloak-auth/docker-compose.yml

@@ -44,7 +44,7 @@ services:
       KC_PROXY_HEADERS: xforwarded
       # It's fine to use http, the reverse proxy handle the tls termination
       KC_HTTP_ENABLED: true 
-      # trust nginx to set the correct xforwared headers with the hostname
+      # trust nginx to set the correct xforwarded headers with the hostname
       KC_HOSTNAME_STRICT: false
       
       # tell keycloak that it will be /oauth prefix by nginx
@@ -73,7 +73,7 @@ services:
     <<: *geovisio-default
     command: db-upgrade
     environment:
-      DB_URL: postgres://gvs:gvspwd@db/geovisio
+      DB_URL: postgres://gvs:${PG_PASSWORD}@db/geovisio
     depends_on:
       db:
         condition: service_healthy
@@ -94,13 +94,13 @@ services:
       OAUTH_CLIENT_ID: geovisio
       OAUTH_CLIENT_SECRET: ${OAUTH_CLIENT_SECRET}
       OAUTH_OIDC_URL: https://${DOMAIN}/oauth/realms/geovisio
-      DB_URL: postgres://gvs:gvspwd@db/geovisio
+      DB_URL: postgres://gvs:${PG_PASSWORD}@db/geovisio
       FLASK_SECRET_KEY: ${FLASK_SECRET_KEY}
       FLASK_SESSION_COOKIE_DOMAIN: ${DOMAIN:-localhost}
       API_FORCE_AUTH_ON_UPLOAD: True
       API_PICTURES_LICENSE_SPDX_ID: CC-BY-SA-4.0 # default pictures's license, change it if needed
       API_PICTURES_LICENSE_URL: https://spdx.org/licenses/CC-BY-SA-4.0.html
-      API_BLUR_URL: https://blur.panoramax.openstreetmap.fr
+      API_BLUR_URL: ${BLUR_API:-https://blur.panoramax.openstreetmap.fr}
       API_DERIVATES_PICTURES_PUBLIC_URL: /derivates
       API_PERMANENT_PICTURES_PUBLIC_URL: /permanent
       PICTURE_PROCESS_THREADS_LIMIT: 0
@@ -108,6 +108,18 @@ services:
       FS_URL: /data/geovisio
       NB_API_THREADS: 10
       INFRA_NB_PROXIES: ${INFRA_NB_PROXIES:-1}
+      # API SUMMARY regroup many metadata about the instance
+      # check the documentation on how translations are handled: https://docs.panoramax.fr/api/install/settings/#metadata
+      API_SUMMARY: >-
+        {
+          "color": "#abcdef",
+          "description": {"en": "a long description", "fr": "une description longue"},
+          "logo": "https://gitlab.com/panoramax/gitlab-profile/-/raw/main/images/logo.svg", 
+          "email": "the_administrator@mypanoramax.org",
+          "name": {"en": "${INSTANCE_NAME:-A Panoramax instance}", "fr": "Mon petit serveur des familles"},
+          "geo_coverage": {"en": "Anywhere you like", "fr": "Partout où le vent vous portera"}
+        }
+      API_REGISTRATION_IS_OPEN: True # True if the instance is open to registration, False if not, it is only used in the federation for the moment
     ports:
       - 5000
     volumes:
@@ -121,17 +133,27 @@ services:
     networks:
       db: {}
       geovisio: {}
+    restart: always
 
   website:
-    image: panoramax/website:latest
+    image: panoramax/website:${GEOVISIO_IMAGE_TAG:-latest}
     environment:
+      # documentation for configuration: https://docs.panoramax.fr/website/03_Settings/
       VITE_INSTANCE_NAME: ${INSTANCE_NAME:-A geovisio instance}
       VITE_API_URL: /
       VITE_TILES: https://panoramax.openstreetmap.fr/pmtiles/basic.json
+      # optional metadata
+      # The title for the <title> tag of the HTML
+      VITE_TITLE: "My Panoramax: The free alternative to photo-mapping territories" 
+      # The title for the meta tags.
+      VITE_META_TITLE: "My Panoramax: The free alternative to photo-mapping territories"
+      # The description for meta tags, which is useful for SEO.
+      VITE_META_DESCRIPTION: "Panoramax is a digital resource for sharing and using field photos. Anyone can take photographs of places visible from public roads and contribute them to the Panoramax database."
     ports:
       - 3000
     networks:
       geovisio: {}
+    restart: always
 
   # Background workers used to process pictures in the background
   # calling the blur API and generating derivates (SD picture and tiles for faster rendering in photosphereviewer)
@@ -148,7 +170,7 @@ services:
     restart: always
     environment:
       PICTURE_PROCESS_DERIVATES_STRATEGY: PREPROCESS
-      DB_URL: postgres://gvs:gvspwd@db/geovisio
+      DB_URL: postgres://gvs:${PG_PASSWORD}@db/geovisio
       FS_URL: /data/geovisio
       API_BLUR_URL: https://blur.panoramax.openstreetmap.fr
 
@@ -180,7 +202,7 @@ services:
   db:
     environment:
       POSTGRES_DB: geovisio
-      POSTGRES_PASSWORD: gvspwd
+      POSTGRES_PASSWORD: ${PG_PASSWORD}
       POSTGRES_USER: gvs
     healthcheck:
       test: pg_isready -h db -q -d $$POSTGRES_DB -U $$POSTGRES_USER
@@ -190,12 +212,13 @@ services:
       start_period: 5s
     image: postgis/postgis:16-3.4
     ports:
-      - 5444:5432
+      - 5432
     volumes:
       - postgres_data:/var/lib/postgresql/data/
       - ./1-init-keycloak-db.sh:/docker-entrypoint-initdb.d/1-init-keycloak-db.sh
     networks:
       db: {}
+    restart: always
 
 volumes:
   postgres_data:

{geovisio-2.8.1 → geovisio-2.10.0}/docker/full-keycloak-auth/env.example

@@ -1,3 +1,6 @@
+# The name of your instance which will appear in the top left of the website
+INSTANCE_NAME=
+
 # URL of your own domain (without a scheme or a path, just the domain)
 DOMAIN=
 
@@ -15,6 +18,9 @@ KEYCLOAK_ADMIN_PASSWORD=
 # For production should be provided with a long random string as stated in flask's documentation.
 FLASK_SECRET_KEY=
 
+# Password of the postgres db account
+PG_PASSWORD=
+
 # Directory where to store the pictures
 # Note that this directory must have been created beforehand
 # PICTURES_DIR=./pictures_storage
@@ -30,5 +36,5 @@ FLASK_SECRET_KEY=
 # This parameter is used so that geovisio can trust the `X-Forwarded-` headers for URL generation (more details in the [Flask documentation](https://flask.palletsprojects.com/en/2.2.x/deploying/proxy_fix/)).
 # INFRA_NB_PROXIES=2
 
-# The name of your instance which will appear in the top left of the website
-INSTANCE_NAME=
+# Change this if you have your own blur API instance
+BLUR_API=https://blur.panoramax.openstreetmap.fr

{geovisio-2.8.1 → geovisio-2.10.0}/docker/full-keycloak-auth/nginx.conf

@@ -22,7 +22,7 @@ http {
 	server {
 		listen 8080;
 
-		# We need to set Forxarded header, so the API can use them to make nice internal links
+		# We need to set X-Forwarded headers, so the API can use them to make nice internal links
 		proxy_set_header X-Real-IP $remote_addr;
 		proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
 
@@ -37,7 +37,7 @@ http {
 		proxy_read_timeout	120s;
 		proxy_send_timeout	120s;
 
-		# Note: you might want to some cache on some heavily used routes, likes high level zoom on /api/map
+		# Note: you might want to add some cache on some heavily used routes, likes high level zoom on /api/map
 		location /api {
 			proxy_pass http://api;
 			proxy_redirect default;

{geovisio-2.8.1 → geovisio-2.10.0}/docker/full-osm-auth/docker-compose.yml

@@ -19,7 +19,7 @@ services:
     <<: *geovisio-default
     command: db-upgrade
     environment:
-      DB_URL: postgres://gvs:gvspwd@db/geovisio
+      DB_URL: postgres://gvs:${PG_PASSWORD}@db/geovisio
     depends_on:
       db:
         condition: service_healthy
@@ -38,20 +38,32 @@ services:
       OAUTH_PROVIDER: osm
       OAUTH_CLIENT_ID: ${OAUTH_CLIENT_ID}
       OAUTH_CLIENT_SECRET: ${OAUTH_CLIENT_SECRET}
-      DB_URL: postgres://gvs:gvspwd@db/geovisio
+      DB_URL: postgres://gvs:${PG_PASSWORD}@db/geovisio
       FLASK_SECRET_KEY: ${FLASK_SECRET_KEY}
       FLASK_SESSION_COOKIE_DOMAIN: ${FLASK_SESSION_COOKIE_DOMAIN:-localhost}
       API_FORCE_AUTH_ON_UPLOAD: True
       API_PICTURES_LICENSE_SPDX_ID: CC-BY-SA-4.0 # default pictures's license, change it if needed
       API_PICTURES_LICENSE_URL: https://spdx.org/licenses/CC-BY-SA-4.0.html
-      API_BLUR_URL: https://blur.panoramax.openstreetmap.fr
-      API_DERIVATES_PICTURES_PUBLIC_URL: /derivates
+      API_BLUR_URL: ${BLUR_API:-https://blur.panoramax.openstreetmap.fr}
+      API_DERIVATES_PICTURES_PUBLIC_URL: /derivatives
       API_PERMANENT_PICTURES_PUBLIC_URL: /permanent
       PICTURE_PROCESS_THREADS_LIMIT: 0
       PICTURE_PROCESS_DERIVATES_STRATEGY: PREPROCESS
       FS_URL: /data/geovisio
       NB_API_THREADS: 10
       INFRA_NB_PROXIES: ${INFRA_NB_PROXIES:-1}
+      # API SUMMARY regroup many metadata about the instance
+      # check the documentation on how translations are handled: https://docs.panoramax.fr/api/install/settings/#metadata
+      API_SUMMARY: >-
+        {
+          "color": "#abcdef",
+          "description": {"en": "a long description", "fr": "une description longue"},
+          "logo": "https://gitlab.com/panoramax/gitlab-profile/-/raw/main/images/logo.svg", 
+          "email": "the_administrator@mypanoramax.org",
+          "name": {"en": "${INSTANCE_NAME:-A Panoramax instance}", "fr": "Mon petit serveur des familles"},
+          "geo_coverage": {"en": "Anywhere you like", "fr": "Partout où le vent vous portera"}
+        }
+      API_REGISTRATION_IS_OPEN: True # True if the instance is open to registration, False if not, it is only used in the federation for the moment
     ports:
       - 5000
     volumes:
@@ -68,17 +80,28 @@ services:
     restart: always
 
   website:
-    image: panoramax/website:latest
+    image: panoramax/website:${GEOVISIO_IMAGE_TAG:-latest}
     environment:
       VITE_INSTANCE_NAME: ${INSTANCE_NAME:-A geovisio instance}
       VITE_API_URL: /
       VITE_TILES: https://panoramax.openstreetmap.fr/pmtiles/basic.json
+       # optional metadata
+      # The title for the <title> tag of the HTML
+      VITE_TITLE: "My Panoramax: The free alternative to photo-mapping territories" 
+      # The title for the meta tags.
+      VITE_META_TITLE: "My Panoramax: The free alternative to photo-mapping territories"
+      # The description for meta tags, which is useful for SEO.
+      VITE_META_DESCRIPTION: "Panoramax is a digital resource for sharing and using field photos. Anyone can take photographs of places visible from public roads and contribute them to the Panoramax database."
     ports:
       - 3000
     networks:
       geovisio: {}
     restart: always
-
+  
+  # Background workers used to process pictures in the background
+  # calling the blur API and generating derivates (SD picture and tiles for faster rendering in photosphereviewer)
+  # Several background workers can run together
+  # Note: the blurring is configured to be done using the OSM-FR service, you can change the variable `API_BLUR_URL` if needed (in the API too).
   background-worker:
     <<: *geovisio-default
     command: picture-worker
@@ -90,9 +113,9 @@ services:
     restart: always
     environment:
       PICTURE_PROCESS_DERIVATES_STRATEGY: PREPROCESS
-      DB_URL: postgres://gvs:gvspwd@db/geovisio
+      DB_URL: postgres://gvs:${PG_PASSWORD}@db/geovisio
       FS_URL: /data/geovisio
-      API_BLUR_URL: https://blur.panoramax.openstreetmap.fr
+      API_BLUR_URL: ${BLUR_API:-https://blur.panoramax.openstreetmap.fr}
 
     deploy:
       mode: replicated
@@ -120,7 +143,7 @@ services:
   db:
     environment:
       POSTGRES_DB: geovisio
-      POSTGRES_PASSWORD: gvspwd
+      POSTGRES_PASSWORD: ${PG_PASSWORD}
       POSTGRES_USER: gvs
     healthcheck:
       test: pg_isready -h db -q -d $$POSTGRES_DB -U $$POSTGRES_USER
@@ -130,7 +153,7 @@ services:
       start_period: 5s
     image: postgis/postgis:16-3.4
     ports:
-      - 5445:5432
+      - 5432
     volumes:
       - postgres_data:/var/lib/postgresql/data/
     networks: