mirror of
				https://github.com/TheCommsChannel/TC2-BBS-mesh.git
				synced 2025-03-05 20:51:53 -08:00 
			
		
		
		
	Update README.md
README.md fixes
This commit is contained in:
		
							parent
							
								
									df340d25d6
								
							
						
					
					
						commit
						f10495a974
					
				
							
								
								
									
										84
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										84
									
								
								README.md
									
									
									
									
									
								
							| 
						 | 
				
			
			@ -22,34 +22,37 @@ If you're a Docker user, TC²-BBS Meshtastic is available on Docker Hub!
 | 
			
		|||
 | 
			
		||||
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:  
 | 
			
		||||
   - On Windows:  
 | 
			
		||||
   
 | 
			
		||||
```sh  
 | 
			
		||||
venv\Scripts\activate  
 | 
			
		||||
```
 | 
			
		||||
- On macOS and Linux:
 | 
			
		||||
   ```sh
 | 
			
		||||
   venv\Scripts\activate  
 | 
			
		||||
   ```
 | 
			
		||||
   
 | 
			
		||||
```sh
 | 
			
		||||
source venv/bin/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`:  
 | 
			
		||||
   
 | 
			
		||||
| 
						 | 
				
			
			@ -59,10 +62,10 @@ pip install -r requirements.txt
 | 
			
		|||
   Linux Example:  
 | 
			
		||||
   `port = /dev/ttyUSB0`   
 | 
			
		||||
   
 | 
			
		||||
Windows Example:  
 | 
			
		||||
   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.   
 | 
			
		||||
| 
						 | 
				
			
			@ -71,15 +74,16 @@ 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)  
 | 
			
		||||
   
 | 
			
		||||
   Example Config:  
 | 
			
		||||
```ini  
 | 
			
		||||
[interface]  
 | 
			
		||||
type = serial  
 | 
			
		||||
# port = /dev/ttyUSB0  
 | 
			
		||||
# hostname = 192.168.x.x  
 | 
			
		||||
   
 | 
			
		||||
[sync]  
 | 
			
		||||
bbs_nodes = !f53f4abc,!f3abc123  
 | 
			
		||||
````
 | 
			
		||||
   ```ini
 | 
			
		||||
   [interface]  
 | 
			
		||||
   type = serial  
 | 
			
		||||
   # port = /dev/ttyUSB0  
 | 
			
		||||
   # hostname = 192.168.x.x  
 | 
			
		||||
   
 | 
			
		||||
   [sync]  
 | 
			
		||||
   bbs_nodes = !f53f4abc,!f3abc123  
 | 
			
		||||
   ```
 | 
			
		||||
 | 
			
		||||
### 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.
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
## Automatically run at boot
 | 
			
		||||
 | 
			
		||||
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** 
 | 
			
		||||
   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:
 | 
			
		||||
   
 | 
			
		||||
  `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:
 | 
			
		||||
   
 | 
			
		||||
  `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:
 | 
			
		||||
   
 | 
			
		||||
  `sh sudo systemctl restart mesh-bbs.service`
 | 
			
		||||
  
 | 
			
		||||
   ```sh
 | 
			
		||||
   sudo systemctl restart mesh-bbs.service
 | 
			
		||||
   ```
 | 
			
		||||
 | 
			
		||||
## Features
 | 
			
		||||
 | 
			
		||||
| 
						 | 
				
			
			
 | 
			
		|||
		Loading…
	
		Reference in a new issue