Skip to content

Commit

Permalink
Update configuration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vidplace7 committed Oct 19, 2024
1 parent 6b492bb commit ed6fc7a
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 6 deletions.
17 changes: 12 additions & 5 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ status: new

# Recommended Configuration Settings

In order to maintain a healthy mesh network, we recommend the following configuration settings for your Meshtastic devices.

These settings are intended to facilitate a stable and reliable mesh network. They are based on the collective experience of the Mountain Mesh community and are subject to change as the mesh grows and evolves.

## Radio configuration

Expand All @@ -14,7 +17,7 @@ status: new
| Role | `CLIENT` or `CLIENT_MUTE` | See :fontawesome-brands-youtube: [Meshtastic Deployment Scenarios](https://www.youtube.com/watch?v=htjwtnjQkkE) |
| NodeInfo broadcast interval | `10800` (3 hours) | |

=== "Position"
=== ":material-map-marker-alert: Position"

| Option | Recommended Config | Notes |
| --------------------------: | :------------------- | :---------------------------------------------- |
Expand Down Expand Up @@ -46,7 +49,11 @@ status: new

=== "Neighbor Info"

| Option | Recommended Config |
| --------------------: | :----------------- |
| Neighbor Info enabled | `True` |
| Update interval | `21600` (6 hours) |
| Option | Recommended Config | Notes |
| --------------------: | :----------------- | :---------------------------------------------------------- |
| Neighbor Info enabled | `True` | Only enable this on "infrastructure" nodes. |
| Update interval | `21600` (6 hours) | This is a large packet! Do not set this lower than 6 hours. |

Neighbor Info is a large packet and should only be enabled on "infrastructure" nodes (Routers / Home base-stations). This is a great way to see who is around you on our mapping tools, but it is not recommended for mobile nodes or secondary indoor nodes.

Setting the interval too low will cause congestion on the mesh, leading to packet loss and dropped messages.
4 changes: 4 additions & 0 deletions docs/neighbors.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,7 @@

- Austin, Texas: [Austin Mesh](https://www.austinmesh.org/)
- Sacramento, California: [Sac Valley Mesh](https://www.sacvalleymesh.com/)

## Related groups

- DefCon Atlanta: [DC404](https://dc404.org/)
Binary file modified docs/static/meshinfo_map.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: MtnMe.sh
site_author: MtnMe.sh
site_description: "Mountain Mesh: Serving Meshtastic to the Appalachian Mountains (North GA)"
site_description: "Mountain Mesh: Serving Meshtastic to the Appalachian Mountains (North GA / East TN)"
copyright: © Creative Commons Attribution-ShareAlike 4.0 International License
site_url: https://mtnme.sh/
repo_url: https://github.com/MtnMesh/mtnmesh.github.io
Expand Down

0 comments on commit ed6fc7a

Please sign in to comment.