jshiffer/lora-xmpp-bridge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
James Shiffer
2026-03-06 00:10:19 -08:00
parent a77955394d
commit f07fc7e69e
1 changed files with 5 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@@ -38,7 +38,7 @@ SovereignRelay provides a NixOS module to seamlessly integrate the bridge as a d
Clone this repository to your NixOS machine:
```bash
git clone https://github.com/jshiffer/lora-xmpp-bridge.git /path/to/lora-xmpp-bridge
git clone https://github.com/jamessucla/lora-xmpp-bridge.git /path/to/lora-xmpp-bridge
```
Then in your NixOS configuration (e.g., `/etc/nixos/configuration.nix`), import the `module.nix` file:
@@ -85,9 +85,10 @@ To deploy this on a fresh NixOS system for the hackathon without experimental fe
```
3. Clone this repository to the machine (we recommend placing it near your config):
```bash
sudo git clone https://github.com/jshiffer/lora-xmpp-bridge.git /etc/nixos/lora-xmpp-bridge
sudo git clone https://github.com/jamessucla/lora-xmpp-bridge.git /etc/nixos/lora-xmpp-bridge
```
4. Edit your `/etc/nixos/configuration.nix` to include the module and configuration block as shown above.
5. Create the password file: `echo "yourpassword" | sudo tee /run/secrets/xmpp_password && sudo chmod 600 /run/secrets/xmpp_password`.
6. Apply the configuration: `sudo nixos-rebuild switch`.
7. Verify it's running: `systemctl status sovereign-bridge.service`.
6. **Protip for Raspberry Pi 3B+:** add 1GB of swap to prevent OOM during builds: `sudo fallocate -l 1G /swapfile && sudo chmod 600 /swapfile && sudo mkswap /swapfile && sudo swapon /swapfile`.
7. Apply the configuration: `sudo nixos-rebuild switch`.
8. Verify it's running: `systemctl status sovereign-bridge.service`.