openCom-Companion/README.md

137 lines
8.0 KiB
Markdown
Raw Normal View History

2022-10-25 14:52:41 +02:00
Sideband <img align="right" src="https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg"/>
=========
2022-04-07 21:03:53 +02:00
2022-12-19 23:32:42 +01:00
Sideband is an LXMF client for Android, Linux and macOS. It allows you to communicate with other people or LXMF-compatible systems over Reticulum networks using LoRa, Packet Radio, WiFi, I2P, Encrypted QR Paper Messages, or anything else Reticulum supports.
2022-04-07 21:03:53 +02:00
2022-10-04 02:33:36 +02:00
![Screenshot](https://github.com/markqvist/Sideband/raw/main/docs/screenshots/devices_small.webp)
2022-04-07 21:03:53 +02:00
2022-10-04 00:34:21 +02:00
Sideband is completely free, end-to-end encrypted, permission-less, anonymous and infrastructure-less. Sideband uses the peer-to-peer and distributed messaging system [LXMF](https://github.com/markqvist/lxmf "LXMF"). There is no sign-up, no service providers, no "end-user license agreements", no data theft and no surveillance. You own the system.
2022-04-07 21:03:53 +02:00
2022-07-08 00:06:35 +02:00
This also means that Sideband operates differently than what you might be used to. It does not need a connection to a server on the Internet to function, and you do not have an account anywhere. Please read the Guide section included in the program, to get an understanding of how Sideband differs from other messaging systems.
The program currently includes basic functionality for secure and independent communication, and many useful features are planned for implementation. Sideband is currently released as a beta version. Please help make all the functionality a reality by supporting the development with donations.
2022-04-07 21:03:53 +02:00
2022-10-04 02:39:55 +02:00
Sideband works well with the terminal-based LXMF client [Nomad Network](https://github.com/markqvist/nomadnet), which allows you to easily host Propagation Nodes for your LXMF network, and more.
2022-07-09 16:37:25 +02:00
2022-04-07 21:03:53 +02:00
If you want to help develop this program, get in touch.
2023-09-21 02:11:04 +02:00
## Installation On Linux, Android and MacOS
2022-07-08 00:06:35 +02:00
2024-03-25 17:06:44 +01:00
For your Android devices, you can install Sideband through F-Droid, by adding the [Between the Borders Archive Repo](https://reticulum.betweentheborders.com/fdroid/repo/), or you can download an [APK on the latest release](https://github.com/markqvist/Sideband/releases/latest) page. Both sources are signed with the same release keys, and can be used interchangably.
2022-07-08 00:06:35 +02:00
2022-10-04 23:29:13 +02:00
A DMG file containing a macOS app bundle is also available on the [latest release](https://github.com/markqvist/Sideband/releases/latest) page.
2022-10-04 02:39:55 +02:00
Aditionally, you can install Sideband with ``pip`` on Linux and macOS:
2022-07-08 00:06:35 +02:00
```bash
2022-10-04 10:37:31 +02:00
# Install Sideband and dependencies on Linux
2022-07-08 00:06:35 +02:00
pip install sbapp
2022-10-04 10:37:31 +02:00
# Install Sideband and dependencies on macOS
2022-10-14 12:56:33 +02:00
pip install "sbapp[macos]"
2022-10-04 10:37:31 +02:00
2022-07-08 00:06:35 +02:00
# Run it
2022-07-08 00:09:23 +02:00
sideband
2022-07-08 00:06:35 +02:00
```
2022-07-08 17:04:41 +02:00
2023-08-15 12:47:54 +02:00
If you are using an operating system that blocks normal user package installation via `pip`, you can return `pip` to normal behaviour by editing the `~/.config/pip/pip.conf` file, and adding the following directive in the `[global]` section:
```text
[global]
break-system-packages = true
```
Alternatively, you can use the `pipx` tool to install Sideband in an isolated environment instead:
2023-08-15 11:24:54 +02:00
```bash
# Install Sideband on Linux
pipx install sbapp
# Install Sideband on macOS
pip install "sbapp[macos]"
# Optionally install Reticulum utilities
pipx install rns
# Optionally install standalone LXMF utilities
pipx install lxmf
```
2023-09-21 02:11:04 +02:00
## Installation On Windows
2023-09-21 02:25:01 +02:00
It is possible to install and run Sideband on Windows, although some features are not fully functional. If you don't already have Python installed, [download and install](https://www.python.org/downloads/) the latest version of Python.
2023-09-21 02:11:04 +02:00
**Important!** When asked by the installer, make sure to add the Python program to your PATH environment variables. If you don't do this, you will not be able to use the `pip` installer, or run the `sideband` command.
When Python has been installed, you can open a command prompt and install sideband via `pip`:
```bash
pip install sbapp
```
The Sideband application can now be launched by running the command `sideband` in the command prompt.
**Most importantly**, the `AutoInterface` in Reticulum is not yet supported on Windows. This means that on the first run, Sideband will not be able to automatically find any peers or potential Reticulum Transport Nodes you have on your local network.
2023-09-21 02:38:35 +02:00
When running Sideband for the first time, a default Reticulum configuration file will be created, if you don't already have one. You will have to edit this file, located at `C:\Users\USERNAME\.reticulum\config` and manually add an interface that provides connectivity to a wider network. If you just want to connect over the Internet, you can add one of the public hubs on the [Reticulum Testnet](https://reticulum.network/connect.html).
2023-09-21 02:11:04 +02:00
2022-11-28 12:12:11 +01:00
## Example Paper Message
You can try out the paper messaging functionality by using the following QR-code. It is a paper message sent to the LXMF address `6b3362bd2c1dbf87b66a85f79a8d8c75`. To be able to decrypt and read the message, you will need to import the following base32-encoded Reticulum Identity into the app:
`3BPTDTQCRZPKJT3TXAJCMQFMOYWIM3OCLKPWMG4HCF2T4CH3YZHVNHNRDU6QAZWV2KBHMWBNT2C62TQEVC5GLFM4MN25VLZFSK3ADRQ=`
2022-11-27 18:09:23 +01:00
You can import the identity into Sideband in the **Encryption Keys** part of the program. After the you have imported the identity, you can scan the following QR-code and open it in the app, where it will be decrypted and added to your messages.
2022-11-28 12:12:11 +01:00
<p align="center"><img width="50%" src="https://raw.githubusercontent.com/markqvist/LXMF/master/docs/paper_msg_test.png"/></p>
You can also find the entire message in <a href="lxm://azNivSwdv4e2aoX3mo2MdTAozuI7BlzrLlHULmnVgpz3dNT9CMPVwgywzCJP8FVogj5j_kU7j7ywuvBNcr45kRTrd19c3iHenmnSDe4VEd6FuGsAiT0Khzl7T81YZHPTDhRNp0FdhDE9AJ7uphw7zKMyqhHHxOxqrYeBeKF66gpPxDceqjsOApvsSwggjcuHBx9OxOBy05XmnJxA1unCKgvNfOFYc1T47luxoY3c0dLOJnJPwZuFRytx2TXlQNZzOJ28yTEygIfkDqEO9mZi5lgev7XZJ0DvgioQxMIyoCm7lBUzfq66zW3SQj6vHHph7bhr36dLOCFgk4fZA6yia2MlTT9KV66Tn2l8mPNDlvuSAJhwDA_xx2PN9zKadCjo9sItkAp8r-Ss1CzoUWZUAyT1oDw7ly6RrzGBG-e3eM3CL6u1juIeFiHby7_3cON-6VTUuk4xR5nwKlFTu5vsYMVXe5H3VahiDSS4Q1aqX7I">this link</a>:
`lxm://azNivSwdv4e2aoX3mo2MdTAozuI7BlzrLlHULmnVgpz3dNT9CMPVwgywzCJP8FVogj5j_kU7j7ywuvBNcr45kRTrd19c3iHenmnSDe4VEd6FuGsAiT0Khzl7T81YZHPTDhRNp0FdhDE9AJ7uphw7zKMyqhHHxOxqrYeBeKF66gpPxDceqjsOApvsSwggjcuHBx9OxOBy05XmnJxA1unCKgvNfOFYc1T47luxoY3c0dLOJnJPwZuFRytx2TXlQNZzOJ28yTEygIfkDqEO9mZi5lgev7XZJ0DvgioQxMIyoCm7lBUzfq66zW3SQj6vHHph7bhr36dLOCFgk4fZA6yia2MlTT9KV66Tn2l8mPNDlvuSAJhwDA_xx2PN9zKadCjo9sItkAp8r-Ss1CzoUWZUAyT1oDw7ly6RrzGBG-e3eM3CL6u1juIeFiHby7_3cON-6VTUuk4xR5nwKlFTu5vsYMVXe5H3VahiDSS4Q1aqX7I`
On operating systems that allow for registering custom URI-handlers, you can click the link, and it will be decoded directly in your LXMF client. This works with Sideband on Android.
2022-07-08 17:04:41 +02:00
## Support Sideband Development
You can help support the continued development of open, free and private communications systems by donating via one of the following channels:
- Monero:
2024-02-16 17:54:22 +01:00
```
2022-07-08 17:04:41 +02:00
84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
```
- Ethereum
```
2024-02-16 17:49:21 +01:00
0xFDabC71AC4c0C78C95aDDDe3B4FA19d6273c5E73
2022-07-08 17:04:41 +02:00
```
- Bitcoin
```
2024-02-16 17:49:21 +01:00
35G9uWVzrpJJibzUwpNUQGQNFzLirhrYAH
2022-07-08 17:04:41 +02:00
```
2022-10-04 02:33:36 +02:00
- Ko-Fi: https://ko-fi.com/markqvist
2022-10-04 02:44:16 +02:00
<br/>
2022-11-17 13:46:34 +01:00
## Development Roadmap
- Adding a Nomad Net page browser
- Implementing the Local Broadcasts feature
- Adding a debug log option and viewer
- Adding a Linux .desktop file
- Message sorting mechanism
- Fix I2P status not being displayed correctly when the I2P router disappears unexpectedly
2023-08-15 12:49:16 +02:00
- Adding LXMF sneakernet functionality
2022-11-17 13:46:34 +01:00
2022-10-25 14:52:41 +02:00
## License
2022-11-01 23:33:50 +01:00
Unless otherwise noted, this work is licensed under a [Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License][cc-by-nc-sa].
2022-10-25 14:52:41 +02:00
2022-11-01 23:33:50 +01:00
Permission is hereby granted to use Sideband in binary form, for any and all purposes, and to freely distribute binary copies of the program, so long as no payment or compensation is charged or received for such distribution or use.
<img src="https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png" align="right">
2022-10-25 14:52:41 +02:00
[cc-by-nc-sa]: http://creativecommons.org/licenses/by-nc-sa/4.0/
[cc-by-nc-sa-image]: https://licensebuttons.net/l/by-nc-sa/4.0/88x31.png
[cc-by-nc-sa-shield]: https://img.shields.io/badge/License-CC%20BY--NC--SA%204.0-lightgrey.svg
2022-10-04 10:37:31 +02:00
*Device screenshots generated with [deviceframes](https://deviceframes.com). Thanks!*