https://github.com/aveygo/meshwiki
Offline wikipedia search engine for Meshtastic
https://github.com/aveygo/meshwiki
Last synced: 2 months ago
JSON representation
Offline wikipedia search engine for Meshtastic
- Host: GitHub
- URL: https://github.com/aveygo/meshwiki
- Owner: Aveygo
- License: agpl-3.0
- Created: 2025-01-01T02:39:38.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-03T04:19:11.000Z (5 months ago)
- Last Synced: 2025-01-03T05:25:25.271Z (5 months ago)
- Language: Python
- Homepage:
- Size: 197 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MeshWiki
Offline wikipedia
## Commands
**/help** Shows available commands
**/info** Short text on what the project is about
**/search ** Actually searches wikipedia and returns article *summary*
**/dump** Used after /search to return the *entire* found article
## Building & Running
I recommend setting up a raspberry pi and connecting your meshtastic device via usb, then running the python command below. The script should automatically download the Simple English Wikipedia, build the index, and connect to the mesh. Should take ~10 minutes and about 1gb of storage.
### Environment Variables / Configuration
**MESHWIKI_ZIMURL** - Set to the url of the zim file you wish to index (must be wikipedia format!), see [dumps](https://dumps.wikimedia.org/kiwix/zim/wikipedia/)
**MESHWIKI_REMOTE** - If the meshtastic device is on the same network, set as the host address OR
**MESHWIKI_SERIAL** - If there are multiple meshtastic devices connected via usb, then set this variable to the target device, eg: /dev/ttyUSB0
### Python
Make sure to install [python](https://www.python.org/downloads/), then run:
```
MESHWIKI_ZIMURL='https://dumps.wikimedia.org/kiwix/zim/wikipedia/wikipedia_en_simple_all_mini_2024-06.zim' python main.py
```
### Docker (not recommended for beginners)
Building:
```
sudo docker build -t meshwiki . --no-cache
```
Running:
```
sudo docker run --privileged -it --rm -e MESHWIKI_ZIMURL='https://dumps.wikimedia.org/kiwix/zim/wikipedia/wikipedia_en_simple_all_mini_2024-06.zim' meshwiki
```