From f10495a97465214155f3bc353b882ddfd691a211 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?TC=C2=B2?= <130875305+TheCommsChannel@users.noreply.github.com> Date: Fri, 28 Jun 2024 08:35:19 -0400 Subject: [PATCH] Update README.md README.md fixes --- README.md | 184 +++++++++++++++++++++++++++++------------------------- 1 file changed, 99 insertions(+), 85 deletions(-) diff --git a/README.md b/README.md index 28d93c4..425bf83 100644 --- a/README.md +++ b/README.md @@ -21,65 +21,69 @@ If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub! ### Installation 1. Clone the repository: - -```sh -cd ~git clone https://github.com/TheCommsChannel/TC2-BBS-mesh.gitcd TC2-BBS-mesh -``` + + ```sh + cd ~ + git clone https://github.com/TheCommsChannel/TC2-BBS-mesh.git + cd TC2-BBS-mesh + ``` 2. Set up a Python virtual environment: - -```sh -python -m venv venv -``` + + ```sh + python -m venv venv + ``` 3. Activate the virtual environment: - -- On Windows: - -```sh -venv\Scripts\activate -``` -- On macOS and Linux: - -```sh -source venv/bin/activate -``` + + - On Windows: + + ```sh + venv\Scripts\activate + ``` + + - On macOS and Linux: + + ```sh + source venv/bin/activate + ``` 4. Install the required packages: - -```sh -pip install -r requirements.txt -``` + + ```sh + pip install -r requirements.txt + ``` 5. Set up the configuration in `config.ini`: - - **[interface]** - If using `type = serial` and you have multiple devices connected, you will need to uncomment the `port =` line and enter the port of your device. - - Linux Example: - `port = /dev/ttyUSB0` - -Windows Example: - `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 - - **[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. - You can find the nodeID in the menu under `Radio Configuration > User` for each node, or use this script for getting nodedb data from a device: - - [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: -```ini -[interface] -type = serial -# port = /dev/ttyUSB0 -# hostname = 192.168.x.x - -[sync] -bbs_nodes = !f53f4abc,!f3abc123 -```` + + **[interface]** + If using `type = serial` and you have multiple devices connected, you will need to uncomment the `port =` line and enter the port of your device. + + Linux Example: + `port = /dev/ttyUSB0` + + Windows Example: + `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. + + **[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. + You can find the nodeID in the menu under `Radio Configuration > User` for each node, or use this script for getting nodedb data from a device: + + [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: + + ```ini + [interface] + type = serial + # port = /dev/ttyUSB0 + # hostname = 192.168.x.x + + [sync] + bbs_nodes = !f53f4abc,!f3abc123 + ``` ### Running the Server @@ -91,46 +95,56 @@ python server.py``` Be sure you've followed the Python virtual environment steps above and activated it before running. - ## Automatically run at boot If you would like to have the script automatically run at boot, follow the steps below: 1. **Edit the service file** - - First, edit the mesh-bbs.service file using your preferred text editor. The 3 following lines in that file are what we need to edit: - - ```sh - User=pi - WorkingDirectory=/home/pi/TC2-BBS-mesh - ExecStart=/home/pi/TC2-BBS-mesh/venv/bin/python3 /home/pi/TC2-BBS-mesh/server.py - ``` - - The file is currently setup for a user named 'pi' and assumes that the TC2-BBS-mesh directory is located in the home directory (which it should be if the earlier directions were followed) - - We just need to replace the 4 parts that have "pi" in those 3 lines with your username. - + + First, edit the mesh-bbs.service file using your preferred text editor. The 3 following lines in that file are what we need to edit: + + ```sh + User=pi + WorkingDirectory=/home/pi/TC2-BBS-mesh + ExecStart=/home/pi/TC2-BBS-mesh/venv/bin/python3 /home/pi/TC2-BBS-mesh/server.py + ``` + + The file is currently setup for a user named 'pi' and assumes that the TC2-BBS-mesh directory is located in the home directory (which it should be if the earlier directions were followed) + + We just need to replace the 4 parts that have "pi" in those 3 lines with your username. + 2. **Configuring systemd** - From the TC2-BBS-mesh directory, run the following commands: - - `sh sudo cp mesh-bbs.service /etc/systemd/system/` - - `sh sudo systemctl enable 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: - - `sh sudo systemctl status mesh-bbs.service` - - If you need to stop the service, you can run the following: - - `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: - - `sh sudo systemctl restart mesh-bbs.service` - + From the TC2-BBS-mesh directory, run the following commands: + + ```sh + sudo cp mesh-bbs.service /etc/systemd/system/ + ``` + + ```sh + sudo systemctl enable 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: + + ```sh + sudo systemctl status mesh-bbs.service + ``` + + If you need to stop the service, you can run the following: + + ```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: + + ```sh + sudo systemctl restart mesh-bbs.service + ``` ## Features