DRCIT/N2DRC-BBS-mesh
1
0
Fork 0
forked from mudhorn/TC2-BBS-mesh
Code Pull requests Activity

Update README.md

Browse source
This commit is contained in:
mudhorn 2024-10-31 15:49:07 -07:00
parent a1cb88a8b9
commit 8d2bf23e30
1 changed files with 250 additions and 250 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -1,8 +1,8 @@
# TC²-BBS Meshtastic Version ~~# TC²-BBS~~ N2DRC-BBS Meshtastic Version
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B1OZ22Z) [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B1OZ22Z)
This is the TC²-BBS system integrated with Meshtastic devices. The system allows for message handling, bulletin boards, mail systems, and a channel directory. This is a fork of the TC²-BBS system integrated with Meshtastic devices. The system allows for message handling, bulletin boards, mail systems, and a channel directory.
### Docker ### Docker
@ -32,8 +32,8 @@ If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub!
```sh ```sh
cd ~ cd ~
git clone https://github.com/TheCommsChannel/TC2-BBS-mesh.git git clone https://github.com/TheCommsChannel/N2DRC-BBS-mesh.git
cd TC2-BBS-mesh cd N2DRC-BBS-mesh
``` ```
2. Set up a Python virtual environment: 2. Set up a Python virtual environment:
@ -81,7 +81,7 @@ If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub!
Windows Example: Windows Example:
`port = COM3` `port = COM3`
If using type = tcp you will need to uncomment the hostname = 192.168.x.x line and put in the IP address of your Meshtastic device. If using `type = tcp` you will need to uncomment the `hostname = 192.168.x.x` line and put in the IP address of your Meshtastic device.
**[sync]** **[sync]**
Enter a list of other BBS nodes you would like to sync messages and bulletins with. Separate each by comma and no spaces as shown in the example below. Enter a list of other BBS nodes you would like to sync messages and bulletins with. Separate each by comma and no spaces as shown in the example below.
@ -115,12 +115,12 @@ Be sure you've followed the Python virtual environment steps above and activated
``` ```
$ python server.py --help $ python server.py --help
████████╗ ██████╗██████╗ ██████╗ ██████╗ ███████╗ ███╗ ██╗██████╗ ██████╗ ██████╗ ██████╗ ██████╗ ██████╗ ███████╗
╚══██╔══╝██╔════╝╚════██╗ ██╔══██╗██╔══██╗██╔════╝ ████╗ ██║╚════██╗██╔══██╗██╔══██╗██╔════╝ ██╔══██╗██╔══██╗██╔════╝
██║ ██║ █████╔╝█████╗██████╔╝██████╔╝███████╗ ██╔██╗ ██║ █████╔╝██║ ██║██████╔╝██║ █████╗██████╔╝██████╔╝███████╗
██║ ██║ ██╔═══╝ ╚════╝██╔══██╗██╔══██╗╚════██║ ██║╚██╗██║██╔═══╝ ██║ ██║██╔══██╗██║ ╚════╝██╔══██╗██╔══██╗╚════██║
██║ ╚██████╗███████╗ ██████╔╝██████╔╝███████║ ██║ ╚████║███████╗██████╔╝██║ ██║╚██████╗ ██████╔╝██████╔╝███████║
╚═╝ ╚═════╝╚══════╝ ╚═════╝ ╚═════╝ ╚══════╝ ╚═╝ ╚═══╝╚══════╝╚═════╝ ╚═╝ ╚═╝ ╚═════╝ ╚═════╝ ╚═════╝ ╚══════╝
Meshtastic Version Meshtastic Version
usage: server.py [-h] [--config CONFIG] [--interface-type {serial,tcp}] [--port PORT] [--host HOST] [--mqtt-topic MQTT_TOPIC] usage: server.py [-h] [--config CONFIG] [--interface-type {serial,tcp}] [--port PORT] [--host HOST] [--mqtt-topic MQTT_TOPIC]