Diagnosti logs url explanation (#662)

* Explanation of diagnosti logs url

* add alt text for images
- add explanation for diagnostic logs url to deployment

* exclude api url from check

* Fix url addres descripiton

Author: tomasMizera

scripts/broken-link-exceptions.txt

@@ -1 +1 @@
---exclude=https://de.merginmaps.com/* --exclude=https://es.merginmaps.com/* --exclude=https://fr.merginmaps.com/* --exclude=https://it.merginmaps.com/* --exclude=https://pt.merginmaps.com/* --exclude=.*twitter.com/* --exclude=.*x.com/* --exclude=https://www.fauna-flora.org* --exclude=https://download.geofabrik.de* --exclude=https://www.linkedin.com/* --exclude=https://docs.github.com* --exclude=.*openstreetmap.org.* --exclude=.*sqlite.org.* --exclude=.*gnu.org.* --exclude=.*github.com/merginmaps/docs/edit/.* --exclude=.*libtiff.org.* --exclude=https://gis.stackexchange.com/* --exclude=https://www.stackexchange.com/* --exclude=https://www.stackoverflow.com/* --exclude=https://ocw.un-ihe.org/* --exclude=https://merginmaps.com/case-studies/* --exclude=https://merginmaps.com/support/* --exclude=https://merginmaps.com/glossary/* --exclude=https://merginmaps.com/community/join --exclude=https://merginmaps.com/blog/* --exclude=https://apps.apple.com/us/app/input/* --exclude=https://www.maplango.com* --exclude=https://apps.apple.com/* --exclude=https://www.mobilegis.at/* --exclude=https://fonts.googleapis.com* --exclude=https://fonts.gstatic.com* --exclude=https://gispro.com.au/* --exclude=http://www.mobilegis.at* --exclude=http://linkedin.com/* --exclude=https://www.verticalgeo.com/* --exclude=https://mappinggis.com/* --exclude=https://app.termly.io/* --exclude=https://www.apple.com/* --exclude=https://play.google.com/* --exclude=https://www.nginx.com/* --exclude=https://proj.org/* --exclude=https://www.burdgis.com* --exclude=https://www.docker.com* --exclude=https://www.googletagmanager.com* --exclude=https://assets-global.website-files.com --exclude=https://uploads-ssl.webflow.com --exclude=https://www.institut-agro-montpellier.fr/* --exclude=http://bad-elf.com* --exclude=https://bad-elf.com/* --exclude=https://merginmaps.com/hardware-partners --exclude=https://merginmaps.com/partners --exclude=https://merginmaps.com/use-case/* --exclude=https://www.otter.org/ --exclude=https://docs.sqlalchemy.org* --exclude=https://www.facebook.com/* --exclude=.*gdal.org/* --exclude=.*spatialised.net/* --exclude=https://cdn.prod.website-files.com/* --exclude=https://aws.amazon.com/* --exclude=https://support.apple.com/* --exclude=https://www.ordnancesurvey.co.uk/* --exclude=https://www.ardusimple.com/* --exclude=https://exiftool.org/* --exclude=https://pro.arcgis.com/* --exclude=https://www.esri.com/*
+--exclude=https://de.merginmaps.com/* --exclude=https://es.merginmaps.com/* --exclude=https://fr.merginmaps.com/* --exclude=https://it.merginmaps.com/* --exclude=https://pt.merginmaps.com/* --exclude=.*twitter.com/* --exclude=.*x.com/* --exclude=https://www.fauna-flora.org* --exclude=https://download.geofabrik.de* --exclude=https://www.linkedin.com/* --exclude=https://docs.github.com* --exclude=.*openstreetmap.org.* --exclude=.*sqlite.org.* --exclude=.*gnu.org.* --exclude=.*github.com/merginmaps/docs/edit/.* --exclude=.*libtiff.org.* --exclude=https://gis.stackexchange.com/* --exclude=https://www.stackexchange.com/* --exclude=https://www.stackoverflow.com/* --exclude=https://ocw.un-ihe.org/* --exclude=https://merginmaps.com/case-studies/* --exclude=https://merginmaps.com/support/* --exclude=https://merginmaps.com/glossary/* --exclude=https://merginmaps.com/community/join --exclude=https://merginmaps.com/blog/* --exclude=https://apps.apple.com/us/app/input/* --exclude=https://www.maplango.com* --exclude=https://apps.apple.com/* --exclude=https://www.mobilegis.at/* --exclude=https://fonts.googleapis.com* --exclude=https://fonts.gstatic.com* --exclude=https://gispro.com.au/* --exclude=http://www.mobilegis.at* --exclude=http://linkedin.com/* --exclude=https://www.verticalgeo.com/* --exclude=https://mappinggis.com/* --exclude=https://app.termly.io/* --exclude=https://www.apple.com/* --exclude=https://play.google.com/* --exclude=https://www.nginx.com/* --exclude=https://proj.org/* --exclude=https://www.burdgis.com* --exclude=https://www.docker.com* --exclude=https://www.googletagmanager.com* --exclude=https://assets-global.website-files.com --exclude=https://uploads-ssl.webflow.com --exclude=https://www.institut-agro-montpellier.fr/* --exclude=http://bad-elf.com* --exclude=https://bad-elf.com/* --exclude=https://merginmaps.com/hardware-partners --exclude=https://merginmaps.com/partners --exclude=https://merginmaps.com/use-case/* --exclude=https://www.otter.org/ --exclude=https://docs.sqlalchemy.org* --exclude=https://www.facebook.com/* --exclude=.*gdal.org/* --exclude=.*spatialised.net/* --exclude=https://cdn.prod.website-files.com/* --exclude=https://aws.amazon.com/* --exclude=https://support.apple.com/* --exclude=https://www.ordnancesurvey.co.uk/* --exclude=https://www.ardusimple.com/* --exclude=https://exiftool.org/* --exclude=https://pro.arcgis.com/* --exclude=https://www.esri.com/* --exclude=https://api.merginmaps.com/logs

src/.vitepress/theme/components/MMBanner.vue

@@ -1,8 +1,8 @@
 <template>
   <aside class="banner">
     <div class="banner-container">
-      <img class="banner-image banner-image-full" :src="fullImageUrl" />
-      <img class="banner-image banner-image-small" :src="smallImageUrl" />
+      <img class="banner-image banner-image-full" :src="fullImageUrl" alt="Mergin Maps banner" />
+      <img class="banner-image banner-image-small" :src="smallImageUrl" alt="Mergin Maps banner" />
       <header class="banner-header">
         <h2 class="banner-title">{{ title }}</h2>
         <p class="banner-text">{{ text }}</p>

src/.vitepress/theme/components/PageFooter.vue

@@ -11,6 +11,7 @@
                   : '/MM_logo_HORIZ_COLOR_VECTOR_no_padding.svg'
               )
             "
+            alt="Mergin Maps logo"
           />
           <p>Copyright &copy; 2021 - {{ year }}</p>
           <p>Lutra Consulting Limited</p>

src/server/environment/index.md

@@ -128,7 +128,6 @@ Other settings related to data management.
 | `PROJECT_ACCESS_REQUEST`     | integer  | `604800`                              | Lifetime of active project access request in seconds.                                                                                                                                                     |
 | `TEMP_EXPIRATION`            | integer  | `7`                                   | Time in days after files in a temporary folder are permanently deleted.                                                                                                                                   |
 
-
 ## Celery asynchronous tasks
 Mergin Maps is using Celery and Redis to perform asynchronous tasks or doing regular jobs.
 
@@ -137,6 +136,13 @@ Mergin Maps is using Celery and Redis to perform asynchronous tasks or doing reg
 |`BROKER_URL`           |string|`redis://merginmaps-redis:6379/0`| Connection details to celery message broker. If non-default, it should match definition in `docker-compose` file.  |
 |`CELERY_RESULT_BACKEND`|string|`redis://merginmaps-redis:6379/0`| Connection details to celery result back-end broker. If non-default, it should match definition in `docker-compose` file.  |
 
+## Diagnostic logs
+Users of Mergin Maps plugin and Mergin Maps mobile application are able to send diagnostic logs from their devices. In custom deployments, logs are stored in `diagnostic_logs` folder. If you want to send these logs to Mergin Maps instead of storing them locally, set the `DIAGNOSTIC_LOGS_URL` variable to `https://api.merginmaps.com/logs`.
+
+| Variable name            | Type     | Default                       | Description                    |
+|--------------------------|----------|-------------------------------|--------------------------------|
+| `DIAGNOSTIC_LOGS_URL`           | string  | ``                       | Enables sending diagnostic logs from clients to the specified URL instead of storing them in the deployment folder. Set to https://api.merginmaps.com/logs to send diagnostic logs to Mergin Maps.           |
+
 ## WebMaps 
 <ServerType type="EE" />
 

src/server/install/index.md

@@ -83,6 +83,12 @@ $ sh ../common/set_permissions.sh diagnostic_logs # directory to persist diagnos
 $ docker-compose -f docker-compose.yml up -d
 $ docker-compose -f docker-compose.maps.yml up -d # Run maps stack separately
 ```
+
+::: tip Diagnostic logs
+Users of the Mergin Maps Mobile App and Mergin Maps QGIS plugin can send diagnostic logs from their devices. In custom deployments, logs are stored in the `diagnostic_logs` folder. If you do not want to persist these logs in a volume, remove the mount point for this folder in the <GitHubRepo id="/MerginMaps/server/blob/master/deployment/enterprise/docker-compose.yml" /> file.
+
+If you want to send diagnostic logs from devices to Mergin Maps instead of storing them in a folder, set `DIAGNOSTIC_LOGS_URL` to `https://api.merginmaps.com/logs`.
+:::
 ​​
 ### Initialise database
 If server is started for the first time, database needs to be initialised and super-user created. Use the `init` command which will perform it automatically (the command generates password for the admin account):

src/server/sso-deployment/index.md

@@ -53,7 +53,7 @@ docker compose -f docker-compose.sso.yml up -d
 The admin panel for Ory Polis will be available at `http://localhost:8081` (the value in `SSO_SERVER_URL`). You can sign in to the admin portal with the credentials you set in the variable `NEXTAUTH_ADMIN_CREDENTIALS`.
 
 :::tip Domain for SSO Service 
-We recommend running the Ory Polis server on a separate domain or subdomain to make it accessible to your users. For your production deployment, use HTTPS to serve the SSO service. See the <GitHubRepo id="/MerginMaps/server/blob/master/deployment/enterprise/ssl-sso-proxy.conf" /> file in the <GitHubRepo id="MerginMaps/server/blob/master/deployment/" desc="deployment folder" />. You also need to set the variable `SSO_SERVER_URL` to the publicly available URL of the Ory Polis service.
+We recommend running the Ory Polis server on a separate domain or subdomain to make it accessible to your users. For your production deployment, use HTTPS to serve the SSO service. See the <GitHubRepo id="/MerginMaps/server/blob/master/deployment/enterprise/ssl-sso-proxy.conf" desc="ssl-sso-proxy.conf" /> file in the <GitHubRepo id="MerginMaps/server/blob/master/deployment/" desc="deployment folder" />. You also need to set the variable `SSO_SERVER_URL` to the publicly available URL of the Ory Polis service.
 :::
 
 If you want to configure the Ory Polis service to run on its own domain in production (e.g., `sso.example.com`), you need to add this domain to the following variables: