thealhu/tc2-bbs-mesh repository overview

⁠TC²-BBS Mesh Docker Image

This Docker image provides the TC²-BBS system integrated with Meshtastic devices. The system allows for message handling, bulletin boards, mail systems, and a channel directory.

⁠Source Code

You can view the source code for this project on GitHub: TheCommsChannel/TC2-BBS-mesh⁠

⁠Documentation

⁠Example Docker Compose

Below is an example of how to set up the TC²-BBS Mesh system using Docker Compose:

services:
  tc2-bbs-mesh:
    image: thealhu/tc2-bbs-mesh:latest
    restart: always
    volumes:
      - ./config:/config
    container_name: tc2-bbs-mesh
 # -- These parameters are optional and can be uncommented if needed. --
 #   devices:
 #     - /dev/ttyUSB0:/dev/ttyUSB0
 #     - /dev/ttyACM0:/dev/ttyACM0
         

⁠Example Docker Run

Below is an example of how to set up the TC²-BBS Mesh system using a docker run command:

docker run -d \
  --name tc2-bbs-mesh \
  --restart always \
  -v $(pwd)/config:/config \
  thealhu/tc2-bbs-mesh:latest

⁠Optional Parameters

If you need to include device parameters, you can add them to the docker run command as follows:

docker run -d \
  --name tc2-bbs-mesh \
  --restart always \
  -v $(pwd)/config:/config \
  --device /dev/ttyUSB0:/dev/ttyUSB0 \
  --device /dev/ttyACM0:/dev/ttyACM0 \
  thealhu/tc2-bbs-mesh:latest

⁠Overview

The TC²-BBS system integrates with Meshtastic devices to provide various features such as a mail system, bulletin boards, and a channel directory.

⁠Features

• Mail System: Send and receive mail messages.
• Bulletin Boards: Post and view bulletins on various boards.
• Channel Directory: Add and view channels in the directory.
• Statistics: View statistics about nodes, hardware, and roles.
• Wall of Shame: View devices with low battery levels.
• Fortune Teller: Get a random fortune. Pulls from the fortunes.txt file. Feel free to edit this file to remove or add more if you like.

⁠Configuration file example: ./config/config.ini⁠