mirror of
https://github.com/TheCommsChannel/TC2-BBS-mesh.git
synced 2024-09-19 22:37:33 -07:00
Merge pull request #15 from TheCommsChannel/pr/14
README.md updates and systemd file
This commit is contained in:
TC²
GitHub
commit
a2cf31a93f
136
README.md
136
README.md
|
|
@ -7,7 +7,8 @@ This is the TC²-BBS system integrated with Meshtastic devices. The system allow
|
|||
## Setup
|
||||
|
||||
### Docker installation
|
||||
TC²-BBS Meshtastic is available on Docker Hub
|
||||
|
||||
If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub!
|
||||
|
||||
[](https://hub.docker.com/r/thealhu/tc2-bbs-mesh)
|
||||
|
||||
|
|
@ -21,80 +22,130 @@ TC²-BBS Meshtastic is available on Docker Hub
|
|||
|
||||
1. Clone the repository:
|
||||
|
||||
```sh
|
||||
git clone https://github.com/TheCommsChannel/TC2-BBS-mesh.git
|
||||
cd 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:
|
||||
|
||||
- On Windows:
|
||||
```sh
|
||||
venv\Scripts\activate
|
||||
```
|
||||
|
||||
```sh
|
||||
venv\Scripts\activate
|
||||
```
|
||||
- On macOS and Linux:
|
||||
|
||||
- On macOS and Linux:
|
||||
|
||||
```sh
|
||||
source venv/bin/activate
|
||||
```
|
||||
```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]**
|
||||
**[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.
|
||||
|
||||
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`
|
||||
|
||||
Linux Example:
|
||||
`port = /dev/ttyUSB0`
|
||||
Windows Example:
|
||||
`port = COM3`
|
||||
|
||||
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.
|
||||
|
||||
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:
|
||||
|
||||
**[sync]**
|
||||
[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)
|
||||
|
||||
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:
|
||||
Example Config:
|
||||
|
||||
[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)
|
||||
```ini
|
||||
[interface]
|
||||
type = serial
|
||||
# port = /dev/ttyUSB0
|
||||
# hostname = 192.168.x.x
|
||||
|
||||
Example Config:
|
||||
```ini
|
||||
[interface]
|
||||
type = serial
|
||||
# port = /dev/ttyUSB0
|
||||
# hostname = 192.168.x.x
|
||||
|
||||
[sync]
|
||||
bbs_nodes = !f53f4abc,!f3abc123
|
||||
```
|
||||
[sync]
|
||||
bbs_nodes = !f53f4abc,!f3abc123
|
||||
```
|
||||
|
||||
### Running the Server
|
||||
|
||||
Run the server with:
|
||||
|
||||
```sh
|
||||
python server.py
|
||||
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.
|
||||
|
||||
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
|
||||
|
||||
- **Mail System**: Send and receive mail messages.
|
||||
|
|
@ -113,7 +164,6 @@ A video of it in use is available on our YouTube channel:
|
|||
|
||||
[](https://www.youtube.com/watch?v=d6LhY4HoimU)
|
||||
|
||||
|
||||
## Thanks
|
||||
|
||||
Big thanks to [Meshtastic](https://github.com/meshtastic) and [pdxlocations](https://github.com/pdxlocations) for the great Python examples:
|
||||
|
|
|
|||
14
mesh-bbs.service
Normal file
14
mesh-bbs.service
Normal 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
|
||||
Loading…
Reference in a new issue