Mirror/liamcottle___reticulum-meshchat
1
0
Fork 0
mirror of https://github.com/liamcottle/reticulum-meshchat.git synced 2026-04-27 16:10:32 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update documentation and supply example compose file

Browse source
This commit is contained in:
Neil G7UFO 2024-12-24 15:00:47 +00:00
commit 3b0bac2bfd
No known key found for this signature in database
2 changed files with 20 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

60
README.md
View file

@ -259,65 +259,9 @@ python meshchat.py --identity-base64 "GCN6mMhVemdNIK/fw97C1zvU17qjQPFTXRBotVckeG
## Running via Docker
A very simple example of a `docker-compose.yml` file, generating and passing the .reticulum directory to the container:
A very simple example of a `docker-compose.yml` file can be found [here](./docker-compose-example.yml).
```yaml
services:
reticulum-meshchat:
container_name: reticulum-meshchat
image: ghcr.io/liamcottle/reticulum-meshchat:latest
pull_policy: always
restart: unless-stopped
ports:
- 8000:8000
volumes:
.reticulum:/config/.reticulum
devices:
- /dev/ttyUSB0:/dev/ttyUSB0
```
To make the web interface accessible from the host, you will need to include the IP (or `0.0.0.0` for all) in the `ports` command, for example:
```yaml
services:
reticulum-meshchat:
container_name: reticulum-meshchat
image: ghcr.io/liamcottle/reticulum-meshchat:latest
pull_policy: always
restart: unless-stopped
ports:
- 0.0.0.0:8000:8000
volumes:
.reticulum:/config/.reticulum
devices:
- /dev/ttyUSB0:/dev/ttyUSB0
```
By default the container will run `python meshchat.py --host=0.0.0.0 --reticulum-config-dir=/config/.reticulum --storage-dir=/config/.reticulum/storage --headless`. This can be overridden like:
```yaml
services:
reticulum-meshchat:
container_name: reticulum-meshchat
image: ghcr.io/liamcottle/reticulum-meshchat:latest
pull_policy: always
command:
- python
- meshchat.py
- --host=0.0.0.0
- --reticulum-config-dir=/config/.reticulum
- --storage-dir=/config/storage
- --headless
- --some-other-argument
- --and-another-argument
restart: unless-stopped
ports:
- 8000:8000
volumes:
.my-different-storage-dir:/config/storage
devices:
- /dev/ttyUSB0:/dev/ttyUSB0
```
The reticulum config is auto-generated at startup in the `meshchat-config` volume along with the storage db used by meshchat.
## Build Electron Application

18
docker-compose-example.yml Normal file
View file

@ -0,0 +1,18 @@
services:
reticulum-meshchat:
container_name: reticulum-meshchat
image: ghcr.io/liamcottle/reticulum-meshchat:latest
pull_policy: always
restart: unless-stopped
# Make the web interace accessible from the host at 8000.
ports:
- 0.0.0.0:8000:8000
volumes:
meshchat-config:/config
# Uncomment if you have a USB device connected
# devices:
# - /dev/ttyUSB0:/dev/ttyUSB0
volumes:
meshchat-config: