Git-Mirrors/TC2-BBS-mesh
1
0
Fork 0
mirror of https://github.com/TheCommsChannel/TC2-BBS-mesh.git synced 2024-10-01 01:15:36 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updates for systemd

Browse Source 
This adds a service file and instructions for getting this to start at boot
This commit is contained in:
TC² 2024-06-28 08:18:12 -04:00
parent 8c9780a0c4
commit ca04096c8e
2 changed files with 103 additions and 53 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

142
README.md
View File

@ -1,15 +1,16 @@
# TC²-BBS Meshtastic Version # TC²-BBS Meshtastic Version
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B1OZ22Z) [](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 the TC²-BBS system integrated with Meshtastic devices. The system allows for message handling, bulletin boards, mail systems, and a channel directory.
## Setup ## Setup
### Docker installation ### Docker installation
TC²-BBS Meshtastic is available on Docker Hub
[![Docker HUB](https://icon-icons.com/downloadimage.php?id=151885&root=2530/PNG/128/&file=docker_button_icon_151885.png)](https://hub.docker.com/r/thealhu/tc2-bbs-mesh) If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub!
[](https://hub.docker.com/r/thealhu/tc2-bbs-mesh)
### Requirements ### Requirements
@ -22,79 +23,115 @@ TC²-BBS Meshtastic is available on Docker Hub
1. Clone the repository: 1. Clone the repository:
```sh ```sh
git clone https://github.com/TheCommsChannel/TC2-BBS-mesh.git cd ~git clone https://github.com/TheCommsChannel/TC2-BBS-mesh.gitcd TC2-BBS-mesh
cd TC2-BBS-mesh
``` ```
2. Set up a Python virtual environment: 2. Set up a Python virtual environment:
```sh ```sh
python -m venv venv python -m venv venv
```
3. Activate the virtual environment:
- On Windows:
```sh
venv\Scripts\activate
``` ```
3. Activate the virtual environment:
- On Windows:
```sh
venv\Scripts\activate
```
- On macOS and Linux: - On macOS and Linux:
```sh ```sh
source venv/bin/activate source venv/bin/activate
``` ```
4. Install the required packages: 4. Install the required packages:
```sh ```sh
pip install -r requirements.txt pip install -r requirements.txt
``` ```
5. Set up the configuration in `config.ini`: 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 in 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 in 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: **[interface]**
```ini 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.
[interface]
type = serial
# port = /dev/ttyUSB0
# hostname = 192.168.x.x
[sync] Linux Example:
bbs_nodes = !f53f4abc,!f3abc123 `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 ### Running the Server
Run the server with: Run the server with:
```sh ```sh
python server.py 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
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.
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`
## Features ## Features
- **Mail System**: Send and receive mail messages. - **Mail System**: Send and receive mail messages.
@ -106,13 +143,12 @@ Be sure you've followed the Python virtual environment steps above and activated
## Usage ## Usage
You interact with the BBS by sending direct messages to the node that's connected to the system running the Python script. Sending any message to it will get a response with the main menu. You interact with the BBS by sending direct messages to the node that's connected to the system running the Python script. Sending any message to it will get a response with the main menu.
Make selections by sending messages based on the letter or number in brackets - Send M for [M]ail Menu for example. Make selections by sending messages based on the letter or number in brackets - Send M for [M]ail Menu for example.
A video of it in use is available on our YouTube channel: A video of it in use is available on our YouTube channel:
[![TC²-BBS-Mesh](https://img.youtube.com/vi/d6LhY4HoimU/0.jpg)](https://www.youtube.com/watch?v=d6LhY4HoimU) [](https://www.youtube.com/watch?v=d6LhY4HoimU)
## Thanks ## Thanks
@ -124,4 +160,4 @@ Big thanks to [Meshtastic](https://github.com/meshtastic) and [pdxlocations](htt
## License ## License
GNU General Public License v3.0 GNU General Public License v3.0

14
mesh-bbs.service Normal file
View File

@ -0,0 +1,14 @@
[Unit]
Description=TC²-BBS Meshtastic Version
After=multi-user.target
[Service]
Type=simple
Restart=always
RestartSec=20
User=pi
WorkingDirectory=/home/pi/TC2-BBS-mesh
ExecStart=/home/pi/TC2-BBS-mesh/venv/bin/python3 /home/pi/TC2-BBS-mesh/server.py
[Install]
WantedBy=multi-user.target