Agie Ashwood 46997b1f95 | ||
---|---|---|
docs | ||
imgs | ||
src | ||
.gitignore | ||
LICENSE | ||
bubble.png | ||
builddocs | ||
catch.png | ||
overview.png | ||
piermeshicon.png | ||
pyvenv.cfg | ||
readme.md | ||
requirements.txt |
readme.md
PierMesh
A new internet, a fresh start
Docs
You can find the full docs here: docs/
How to use
Note: these instructions will probably only work on Linux at the moment
Note: check the scripts to make sure they'll work with your system, and in general I recommend checking scripts before you run them
Follow Meshtastic's guide on setting up your device: https://meshtastic.org/docs/getting-started/
Make sure you have the latest Python installed
Make sure you have pip and venv installed
git clone https://git.utopic.work/PierMesh/piermesh
cd piermesh
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
cd src
cp .piermesh.example .piermesh
Set the TransceiverPort (you should have this from setting up your Meshtastic device)
Set the PSK, this should match the PSK of node's you want to connect with
python run.py
You should now be able to access the web interface at port 5000 of the machine you set up on (likely localhost:5000)
Make sure to click connect at the top of the page to initialize your websocket connection, after this you can use the utilities provided
Hopper: proxy requests to the main internet
Catch: browse for a Catch/website on PierMesh
Catch Editor: create and publish a Catch onto PierMesh
Bubble: send peer to peer messages (and art using the pixel art tool) to other nodes
License text
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.