docs: Adds information about changes when running in a development environment

chore: Applies docker naming convention to files

.gitignore

@@ -4,3 +4,6 @@ lastStatisticsUpdate.txt
 log.*
 state.txt
 migrations
+
+# created when running development environment
+mariadb/**

README.md

@@ -34,12 +34,21 @@ To run Surveillance using docker, decide between development/testing or producti
 
 1. Clone this repository
 
-2. Run `docker compose up` and wait for services to start up
+2. Run `docker compose -f docker-compose.yml -f docker-compose.dev.yml up` and wait for services to start up
 
 3. Visit `http://localhost:8080/` in a browser; you should see an interactive OpenStreetMap
 
-_tbd.: Populate camera data_
+4. You can see most cameras on the map immediately; the `data_handler` background process continuously applies updates from OpenStreetMap which become visible after refrshing the page
 
+5. Appending `-f docker-compose.dev.yml` applies these changes:
+
+   - PHP won't supress any errors; to disable this, remove `return;` in `./web/www/sunders/config.php`
+
+   - Making changes in the `web` will immediately apply them to the running containers; try modifying `web/www/sunders/index.php`
+
+   - Making changes in the `data_handler` will immediately apply them to the running containers (try modifying `data_handler/utils/update_camera.sh`)
+
+   - The host has access to database files at `./mariadb`
 ### Production
 
 1. Close this repository
@@ -48,9 +57,9 @@ _tbd.: Populate camera data_
 
 3. Run `docker compose up` and wait for services to start up
 
-3. Visit `http://localhost:8080/` in a browser to open the web interface
+3. Visit `http://localhost:8080/` in a browser; you should see an interactive OpenStreetMap
 
-_tbd.: Populate camera data_
+4. You can see most cameras on the map immediately; the `data_handler` background process continuously applies updates from OpenStreetMap which become visible after refrshing the page
 
 ## Surveillance nodes
 

docker-compose-dev.yml

@@ -1,72 +0,0 @@
-services:
-  db:
-    image: mariadb:12.0.2
-    restart: unless-stopped
-    command: --max_allowed_packet=3250585600
-    environment:
-      MYSQL_ROOT_PASSWORD: rootpassword # ${{secrets.MYSQL_ROOT_PASSWORD}}
-      MYSQL_DATABASE: camera # ${{secrets.MYSQL_DATABASE}}
-      MYSQL_USER: camera # ${{secrets.MYSQL_USER}}
-      MYSQL_PASSWORD: camerapassword # ${{secrets.MYSQL_PASSWORD}}
-    volumes:
-        - ./mariadb:/var/lib/mysql:Z
-    healthcheck:
-      test: ["CMD", "mariadb-admin", "ping", "-h", "localhost", "-uroot", "-prootpassword"]
-      interval: 10s
-      timeout: 5s
-      start_period: 30s
-      retries: 5
-
-  web:
-    image: git.hamburg.ccc.de/ccchh/sunders/web:latest
-    restart: unless-stopped
-    environment:
-      MYSQL_HOST: db
-      MYSQL_DB: camera # ${{secrets.MYSQL_DATABASE}}
-      CAMERA_SELECT_USER: camera_select # ${{secrets.CAMERA_SELECT_USER}}
-      CAMERA_SELECT_USER_PASSWORD: camera_selectpassword # ${{secrets.CAMERA_SELECT_USER_PASSWORD}}
-      DEFAULT_ZOOM: 12
-      DEFAULT_LAT: 0
-      DEFAULT_LON: 0
-      DEFAULT_LANGUAGE: en
-      IMPRESSUM_URL: https://hamburg.ccc.de/imprint/
-    ports:
-      - "8081:80"
-    volumes:
-      - ./web/www/sunders:/var/www/html:Z
-    depends_on:
-      db:
-        condition: service_started
-    # all the way zoomed out, with hamburg at the center, at least one camera should be returned
-    healthcheck:
-      test: ["CMD", "curl", "-f", "http://localhost/sync-state.php"]
-      interval: 10s
-      timeout: 5s
-      retries: 5
-      start_period: 10s
-  
-  data_handler:
-    image: git.hamburg.ccc.de/ccchh/sunders/data_handler:latest
-    restart: unless-stopped
-    environment:
-      MYSQL_HOST: db
-      MYSQL_DB: camera # ${{secrets.MYSQL_DATABASE}}
-      MYSQL_USER: root # ${{secrets.MYSQL_USER}}
-      MYSQL_PASSWORD: rootpassword # ${{secrets.MYSQL_ROOT_PASSWORD}}
-      CAMERA_USER: camera # ${{secrets.CAMERA_USER}}
-      CAMERA_USER_PASSWORD: camerapassword # ${{secrets.CAMERA_USER_PASSWORD}}
-      CAMERA_SELECT_USER: camera_select # ${{secrets.CAMERA_SELECT_USER}}
-      CAMERA_SELECT_USER_PASSWORD: camera_selectpassword # ${{secrets.CAMERA_SELECT_USER_PASSWORD}}
-    depends_on:
-      db:
-        condition: service_healthy
-        restart: true
-    # if the latest `update_camera_*.log` contains "error", fail the healthcheck
-    healthcheck:
-      test: ["CMD", "sh", "-c", "ls /var/log | grep '^update_camera_' | xargs -I {} sh -c 'grep -q error /var/log/{} || exit 0; exit 1'"]
-      interval: 10s
-      timeout: 5s
-      retries: 5
-
-volumes:
-  mariadb:

docker-compose.dev.yml

@@ -0,0 +1,15 @@
+services:
+  db:
+    volumes:
+        - ./mariadb:/var/lib/mysql:Z
+
+  web:
+    volumes:
+      - ./web/www/sunders:/var/www/html:Z
+    environment:
+      APP_ENV: development
+
+  data_handler:
+    volumes:
+      - ./data_handler/utils:/opt:Z
+      - ./data_handler/data_init:/opt/init/init.sql:Z

docker-compose.yml

@@ -33,12 +33,10 @@ services:
     ports:
       - "8081:80"
     depends_on:
-      data_handler:
+      db:
         condition: service_started
-    # all the way zoomed out, with hamburg at the center, at least one camera should be returned
     healthcheck:
-      test: >
-        ["CMD", "curl -s 'http://localhost/camera.php?bbox=-92.52991540527346,30.683278176916133,131.7689595947266,72.87186315234298&zoom=4&width=2552&height=867' | grep '^\[.+\]$'"]
+      test: ["CMD", "curl", "-f", "http://localhost/sync-state.php"]
       interval: 10s
       timeout: 5s
       start_period: 30s

web/www/sunders/add-lists.php

@@ -1,5 +1,4 @@
 <?php
-  error_reporting(0);
   // Convert the content of the symbology JSON file to HTML.
   function addListSymbology($jsonPath, $i18n, $i18nDefault) {
     global $pathToWebFolder;

web/www/sunders/camera.php

@@ -1,5 +1,4 @@
 <?php
-  error_reporting(0);
   include $pathToWebFolder.'config.php';
   
   define('MAX_POINTS_FOR_QUICKHULL', 3000);

web/www/sunders/config.php

@@ -13,4 +13,15 @@
     define('MYSQL_PASSWORD', getenv('CAMERA_SELECT_USER_PASSWORD') ?: '');
 
     define('USE_STATISTICS', false);
+
+
+    $environment = getenv('APP_ENV') ?: 'production';
+    if ($environment === 'development') {
+        ini_set('display_errors', 1);
+        error_reporting(E_ALL);
+        return;
+    }
+     
+    ini_set('display_errors', 0);
+    error_reporting(0);
 ?>

web/www/sunders/sync-state.php

@@ -2,14 +2,10 @@
   error_reporting(0);
   include $pathToWebFolder.'config.php';
 
-
-  /* Connect to database */
+  try {
     $mysqli = new mysqli(MYSQL_HOST, MYSQL_USER, MYSQL_PASSWORD, MYSQL_DB);
     if($mysqli->connect_errno) {
-    header('Content-type: application/json');
-    $result = '{"error":"error while connecting to db : ' . $mysqli->error . '"}';
-    echo $result;
-    exit;
+      throw new Exception("Could not connect to database");
     }
 
     $syncstate_querry = $mysqli->query("SELECT * FROM sync_state WHERE k = 'sequenceNumber'");
@@ -24,4 +20,11 @@
 
     header('Content-type: application/json; Charset : utf-8');
     echo $result;
+    mysqli_report(MYSQLI_REPORT_OFF);
+  } catch (Exception $e) {
+      http_response_code(503);
+      header('Content-type: application/json');
+      $result = '{"error":"Database unavailable"}';
+      echo $result;
+  }
 ?>