Update README.md

This commit is contained in:
2025-09-26 16:25:22 -05:00
parent 0811760851
commit 13bb581116

View File

@@ -2,6 +2,8 @@
This Reticulum Interface allows using HTTP POST requests as a bidirectional transport layer. It consists of two parts: a client and a server. The server must have a public IP address and be accessible via HTTP. The client only needs internet access. One server can serve any number of clients. This Reticulum Interface allows using HTTP POST requests as a bidirectional transport layer. It consists of two parts: a client and a server. The server must have a public IP address and be accessible via HTTP. The client only needs internet access. One server can serve any number of clients.
This could be used to bypass firewalls, DPI, and other restrictions. Make sure to adapt the user-agent accordingly or disable it.
## Features ## Features
- Bidirectional communication - Bidirectional communication
@@ -13,17 +15,16 @@ This Reticulum Interface allows using HTTP POST requests as a bidirectional tran
## Setup ## Setup
Install dependencies: Dependencies:
```bash Python 3.9+
pip install requests Requests
```
## Configuration ## Configuration
1. Download http_interface.py to ~/.reticulum/interfaces/ 1. Download http_interface.py to `~/.reticulum/interfaces/` or wherever you want to store it.
2. Add a PipeInterface to your `~/.reticulum/config` file on both the server and the client. 2. Add a PipeInterface to your `~/.reticulum/config` file on both the server and the client and update the path to the http_interface.py file, as well as the server and client URLs.
### Client Configuration ### Client Configuration