mudhorn/TC2-BBS-mesh
1
0
Fork 1
mirror of https://github.com/TheCommsChannel/TC2-BBS-mesh.git synced 2025-02-21 03:15:24 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse source 
README.md fixes
This commit is contained in:
TC² 2024-06-28 08:35:19 -04:00
parent df340d25d6
commit f10495a974
1 changed files with 99 additions and 85 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -23,7 +23,9 @@ If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub!
1. Clone the repository: 1. Clone the repository:
```sh ```sh
cd ~git clone https://github.com/TheCommsChannel/TC2-BBS-mesh.gitcd TC2-BBS-mesh cd ~
git clone https://github.com/TheCommsChannel/TC2-BBS-mesh.git
cd TC2-BBS-mesh
``` ```
2. Set up a Python virtual environment: 2. Set up a Python virtual environment:
@ -39,6 +41,7 @@ python -m venv venv
```sh ```sh
venv\Scripts\activate venv\Scripts\activate
``` ```
- On macOS and Linux: - On macOS and Linux:
```sh ```sh
@ -62,7 +65,7 @@ pip install -r requirements.txt
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.
@ -71,6 +74,7 @@ If using type = tcp you will need to uncomment the hostname = 192.168.x.x line a
[Meshtastic-Python-Examples/print-nodedb.py at main · pdxlocations/Meshtastic-Python-Examples (github.com)](https://github.com/pdxlocations/Meshtastic-Python-Examples/blob/main/print-nodedb.py) [Meshtastic-Python-Examples/print-nodedb.py at main · pdxlocations/Meshtastic-Python-Examples (github.com)](https://github.com/pdxlocations/Meshtastic-Python-Examples/blob/main/print-nodedb.py)
Example Config: Example Config:
```ini ```ini
[interface] [interface]
type = serial type = serial
@ -79,7 +83,7 @@ type = serial
[sync] [sync]
bbs_nodes = !f53f4abc,!f3abc123 bbs_nodes = !f53f4abc,!f3abc123
```` ```
### Running the Server ### Running the Server
@ -91,7 +95,6 @@ python server.py```
Be sure you've followed the Python virtual environment steps above and activated it before running. Be sure you've followed the Python virtual environment steps above and activated it before running.
## Automatically run at boot ## Automatically run at boot
If you would like to have the script automatically run at boot, follow the steps below: If you would like to have the script automatically run at boot, follow the steps below:
@ -113,24 +116,35 @@ If you would like to have the script automatically run at boot, follow the steps
2. **Configuring systemd** 2. **Configuring systemd**
From the TC2-BBS-mesh directory, run the following commands: From the TC2-BBS-mesh directory, run the following commands:
`sh sudo cp mesh-bbs.service /etc/systemd/system/` ```sh
sudo cp mesh-bbs.service /etc/systemd/system/
```
`sh sudo systemctl enable mesh-bbs.service` ```sh
sudo systemctl enable mesh-bbs.service
```
`sh sudo systemctl start mesh-bbs.service` ```sh
sudo systemctl start mesh-bbs.service
```
The service should be started now and should start anytime your device is powered on or rebooted. You can check the status ofk the service by running the following command: The service should be started now and should start anytime your device is powered on or rebooted. You can check the status ofk the service by running the following command:
`sh sudo systemctl status mesh-bbs.service` ```sh
sudo systemctl status mesh-bbs.service
```
If you need to stop the service, you can run the following: If you need to stop the service, you can run the following:
`sh sudo systemctl stop mesh-bbs.service` ```sh
sudo systemctl stop mesh-bbs.service
```
If you make changes to the watchlist.txt file, you will need to restart the service with the following command: If you make changes to the watchlist.txt file, you will need to restart the service with the following command:
`sh sudo systemctl restart mesh-bbs.service` ```sh
sudo systemctl restart mesh-bbs.service
```
## Features ## Features