aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.md b/README.md
index 925fc63..7a75823 100644
--- a/README.md
+++ b/README.md
@@ -38,3 +38,25 @@ s.send_message("+1098765432", "Hello there!")
for message in s.receive_messages():
print(message)
```
+
+
+Various
+-------
+
+pysignald also supports different socket paths:
+
+```python
+s = Signal("+1234567890", socket_path="/var/some/other/socket.sock")
+```
+
+It supports TCP sockets too, if you run a proxy. For example, you can proxy signald's UNIX socket over TCP with socat:
+
+```bash
+$ socat -d -d TCP4-LISTEN:15432,fork UNIX-CONNECT:/var/run/signald/signald.sock
+```
+
+Then in pysignald:
+
+```python
+s = Signal("+1234567890", socket_path=("your.serveri.ip", 15432))
+```