From 5a39c166a74cf553e1564c3ed1eb41ee100f4d81 Mon Sep 17 00:00:00 2001 From: Pablo Revilla Date: Sun, 6 Apr 2025 10:49:30 -0700 Subject: [PATCH] Updated Documentation --- README.md | 31 ++++++++++++++++++++++++++----- sample.config.ini | 6 +++++- 2 files changed, 31 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d1dcacf..e19b9c9 100644 --- a/README.md +++ b/README.md @@ -63,28 +63,49 @@ nano config.ini Example: ```ini +# Server Details [server] bind = * port = 8081 -tls_cert = -acme_challenge = +tls_cert = +acme_challenge = +# Site Details [site] -domain = http://meshview.bayme.sh +domain = https://www.bayme.sh title = Bay Area Mesh -message = +message = Real time data from around the bay area and beyond. + +# Quick links enablement on site +nodes=True +conversations=True +everything=True +graph_lf=True +graph_ms=True +graph_mf=False +stats=True +net=True +map=True +top=True + +# Map structure map_top_left_lat=39 map_top_left_lon=-123 map_bottom_right_lat=36 map_bottom_right_lon=-121 +# Note about how your weekly mesh runs. time and tag used for the system to track. +weekly_net_message= Weekly Mesh check-in. We will keep it open on every Wednesday from 5:00pm for checkins. The message format should be (LONG NAME) - (CITY YOU ARE IN) #MeshNet. + +# MQTT Server configuration [mqtt] server = mqtt.bayme.sh -topics = ["msh/US/bayarea/#", "msh/US/CA/mrymesh/#"] +topics = ["msh/US/bayarea/#", "msh/US/CA/mrymesh/#", "msh/US/CA/sacvalley" ] port = 1883 username = meshdev password = large4cats +# Database configuration [database] connection_string = sqlite+aiosqlite:///packets.db ``` diff --git a/sample.config.ini b/sample.config.ini index c4599c9..00a66e1 100644 --- a/sample.config.ini +++ b/sample.config.ini @@ -1,15 +1,17 @@ +# Server Details [server] bind = * port = 8081 tls_cert = acme_challenge = +# Site Details [site] domain = https://www.bayme.sh title = Bay Area Mesh message = Real time data from around the bay area and beyond. -# Quick links enablement +# Quick links enablement on site nodes=True conversations=True everything=True @@ -30,6 +32,7 @@ map_bottom_right_lon=-121 # Note about how your weekly mesh runs. time and tag used for the system to track. weekly_net_message= Weekly Mesh check-in. We will keep it open on every Wednesday from 5:00pm for checkins. The message format should be (LONG NAME) - (CITY YOU ARE IN) #BayMeshNet. +# MQTT Server configuration [mqtt] server = mqtt.bayme.sh topics = ["msh/US/bayarea/#", "msh/US/CA/mrymesh/#", "msh/US/CA/sacvalley" ] @@ -37,5 +40,6 @@ port = 1883 username = meshdev password = large4cats +# Database configuration [database] connection_string = sqlite+aiosqlite:///packets.db