Add Docker support and update environment configuration

- Introduced .dockerignore to exclude unnecessary files from Docker builds.
- Removed outdated .env.example file and updated README with Docker setup instructions.
- Modified docker-publish.yml for improved image name handling.
- Updated compose.yml for local image build and clarified environment variable usage.
- Enhanced entrypoint.sh to support new environment variables.
- Adjusted custom.css for better styling of filter labels.

Author: usrflo

.dockerignore

@@ -0,0 +1,8 @@
+venv/
+.venv/
+__pycache__/
+*.pyc
+*.sqlite
+*.sqlite3
+.env
+*.log

.env.example

@@ -8,8 +8,8 @@ on:
 
 env:
   REGISTRY: ghcr.io
-  # IMAGE_NAME musi być małymi literami. github.repository może zawierać wielkie litery.
-  # Dlatego w kroku budowania użyjemy metadanych, które to wyczyszczą.
+  # IMAGE_NAME must be lowercase, otherwise the build will fail with "invalid reference format" error.
+  # Therefore, in the build step, we will use metadata to clean it up.
   IMAGE_NAME: ${{ github.repository }}
 
 jobs:
@@ -35,7 +35,7 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
-          # Akcja automatycznie zamienia nazwy obrazów na małe litery.
+          # The action automatically converts image names to lowercase.
           tags: |
             type=raw,value=latest,enable=${{ github.ref == format('refs/heads/{0}', github.event.repository.default_branch) }}
             type=semver,pattern={{version}}
@@ -48,4 +48,3 @@ jobs:
           push: true
           tags: ${{ steps.meta.outputs.tags }}
           labels: ${{ steps.meta.outputs.labels }}
-

.github/workflows/docker-publish.yml

@@ -90,18 +90,6 @@ This will:
 
 Stop the tool with `Ctrl+C`.
 
-## Docker
-
-You can use Meshcore Reachability as a Docker container.
-
-Compose file is available in this repository. You can use it in Portainer Stack or directly using 
-
-```bash
-docker compose up -d
-```
-
-Remember to set your env vars!
-
 ### Command line options
 
 From `--help` in `meshcore_reachability.py`:
@@ -148,6 +136,49 @@ options:
 
 > Note: `--headless` and `--guionly` are mutually exclusive. Do not enable both at the same time.
 
+## Docker
+
+MeshCore Reachability can be run as a Docker container using the included `compose.yml`.
+
+### Setup
+
+Open `compose.yml` and adjust the values in the `environment` section:
+
+1. **Set your home location** — `MC_LATITUDE` and `MC_LONGITUDE` are required.
+
+2. **Set the connection to your LoRa device** — uncomment exactly one of:
+   - `MC_SERIAL_PORT` for a USB serial connection — also uncomment the `devices` block directly above the `ports` entry so Docker can access the device:
+     ```yaml
+     devices:
+       - "/dev/ttyUSB0:/dev/ttyUSB0"
+     ```
+   - `MC_HOST` for a TCP/IP connection (node must listen on port 5000)
+   - `MC_BLE` for a BLE connection
+
+3. Build and start:
+
+```bash
+docker compose up -d
+```
+
+The web UI is available at `http://localhost:5342`. The SQLite database is persisted in `/opt/meshcore-reachability/` on the host.
+
+### Environment variables
+
+| Variable | CLI equivalent | Description |
+|---|---|---|
+| `MC_SERIAL_PORT` | `-p` / `--port` | Serial port of the LoRa device (e.g. `/dev/ttyUSB0`) |
+| `MC_HOST` | `-ip` / `--host` | IP/hostname of the LoRa node (port 5000) |
+| `MC_BLE` | `--ble` | BLE address of the LoRa node |
+| `MC_LATITUDE` | `-lat` / `--latitude` | Latitude of home location |
+| `MC_LONGITUDE` | `-lon` / `--longitude` | Longitude of home location |
+| `MC_RADIUS_KM` | `-rad` / `--checkradius_km` | Check radius in km (default: 200) |
+| `MC_HEADLESS` | `--headless` | `true` = collect data without web UI |
+| `MC_GUIONLY` | `--guionly` | `true` = web UI only, no packet collection |
+| `MC_MAPTILER_KEY` | `-ak` / `--maptiler_api_key` | Optional MapTiler API key |
+
+> Note: `MC_HEADLESS` and `MC_GUIONLY` are mutually exclusive.
+
 ---
 
 ## Database

README.md

@@ -19,7 +19,6 @@ html, body {
 
 .reachable-filter {
     margin: 8px 0 16px 0;
-    color: #f5f5f5;
 }
 
 .reachable-filter input {
@@ -30,6 +29,7 @@ html, body {
 .reachable-filter label {
     margin-right: 12px;
     cursor: pointer;
+    color: #f5f5f5;
 }
 
 .map-container {

assets/custom.css

@@ -1,20 +1,30 @@
 services:
   reachability:
-    image: ghcr.io/usrflo/meshcore-reachability:latest
+    # image: ghcr.io/usrflo/meshcore-reachability:latest
+    build: .
+    image: meshcore-reachability:local
     container_name: meshcore-reachability
     restart: unless-stopped
-    # If using serial:
+    # Serial port: uncomment both 'devices' and MC_SERIAL_PORT below, adjust the path:
     # devices:
     #   - "/dev/ttyUSB0:/dev/ttyUSB0"
     ports:
       - "5342:5342"
     environment:
-      #- SERIAL_PORT=/dev/ttyUSB0     
-      - NODE_IP=192.168.253.162
-      - LAT=51.1234            # Twoja szeroko..
-      - LON=20.2233            # Twoja d.ugo..
-      - RAD=25                 # Promie. w km
-      - MC_HEADLESS=false         # Ustaw na true, je.li nie chcesz UI
-      #- MC_MAPTILER_KEY=your_api_key
+      # Connection — set exactly one of the three options:
+      #- MC_SERIAL_PORT=/dev/ttyUSB0     # USB serial (also uncomment 'devices' above)
+      #- MC_HOST=192.168.1.100           # TCP/IP (node must listen on port 5000)
+      #- MC_BLE=                         # BLE address
+
+      # Required: home location
+      - MC_LATITUDE=47.73322
+      - MC_LONGITUDE=12.11043
+
+      # Optional
+      - MC_RADIUS_KM=200                 # Reachability check radius in km (default: 200)
+      - MC_DB=/app/data/mcreach.sqlite   # Database path inside the container
+      #- MC_HEADLESS=false               # true = collect data without web UI
+      #- MC_GUIONLY=false                # true = web UI only, no packet collection
+      #- MC_MAPTILER_KEY=               # MapTiler API key for background map tiles
     volumes:
-      - /opt/meshcore-reachability:/app/data          # Persist data
+      - /opt/meshcore-reachability:/app/data  # Persistent data (database)

compose.yml

@@ -3,15 +3,15 @@
 
 ARGS=""
 
-if [ -n "$SERIAL_PORT" ]; then ARGS="$ARGS -p $SERIAL_PORT"; fi
-if [ -n "$NODE_IP" ]; then ARGS="$ARGS -ip $NODE_IP"; fi
-if [ -n "$NODE_BLE" ]; then ARGS="$ARGS --ble $NODE_BLE"; fi
-if [ -n "$LAT" ]; then ARGS="$ARGS -lat $LAT"; fi
-if [ -n "$LON" ]; then ARGS="$ARGS -lon $LON"; fi
-if [ -n "$RAD" ]; then ARGS="$ARGS -rad $RAD"; fi
+if [ -n "$MC_SERIAL_PORT" ]; then ARGS="$ARGS -p $MC_SERIAL_PORT"; fi
+if [ -n "$MC_HOST" ]; then ARGS="$ARGS -ip $MC_HOST"; fi
+if [ -n "$MC_BLE" ]; then ARGS="$ARGS --ble $MC_BLE"; fi
+if [ -n "$MC_DB" ]; then ARGS="$ARGS --db $MC_DB"; fi
+if [ -n "$MC_LATITUDE" ]; then ARGS="$ARGS -lat $MC_LATITUDE"; fi
+if [ -n "$MC_LONGITUDE" ]; then ARGS="$ARGS -lon $MC_LONGITUDE"; fi
+if [ -n "$MC_RADIUS_KM" ]; then ARGS="$ARGS -rad $MC_RADIUS_KM"; fi
 if [ "$MC_HEADLESS" = "true" ]; then ARGS="$ARGS --headless"; fi
 if [ "$MC_GUIONLY" = "true" ]; then ARGS="$ARGS --guionly"; fi
 if [ -n "$MC_MAPTILER_KEY" ]; then ARGS="$ARGS -ak $MC_MAPTILER_KEY"; fi
 
-# Uruchomienie aplikacji z przekazanymi argumentami
 exec python meshcore_reachability.py $ARGS