summaryrefslogtreecommitdiffstats
path: root/net/tesseras-paste/pkg/README
diff options
context:
space:
mode:
Diffstat (limited to 'net/tesseras-paste/pkg/README')
-rw-r--r--net/tesseras-paste/pkg/README58
1 files changed, 58 insertions, 0 deletions
diff --git a/net/tesseras-paste/pkg/README b/net/tesseras-paste/pkg/README
new file mode 100644
index 0000000..ff86ffd
--- /dev/null
+++ b/net/tesseras-paste/pkg/README
@@ -0,0 +1,58 @@
++-----------------------------------------------------------------------
+| Running ${PKGSTEM} on OpenBSD
++-----------------------------------------------------------------------
+
+Daemon Setup
+============
+
+Enable and start the tpd(1) daemon:
+
+ # rcctl enable tpd
+ # rcctl start tpd
+
+To connect to a bootstrap peer:
+
+ # rcctl set tpd flags "-b host:port"
+ # rcctl restart tpd
+
+Multiple bootstrap peers can be specified:
+
+ # rcctl set tpd flags "-b host1:port -b host2:port"
+
+To enable the HTTP interface on port 8080:
+
+ # rcctl set tpd flags "-b host:port -w 8080"
+
+To run as a public server on a fixed UDP port:
+
+ # rcctl set tpd flags "-g -p 6881 -b host:port"
+
+Data Directory
+==============
+
+Paste data and the node identity key are stored in
+${LOCALSTATEDIR}/tesseras-paste/, owned by the _tpd user.
+
+Socket Permissions
+==================
+
+The tp(1) client communicates with tpd(1) via a Unix domain socket at
+${LOCALSTATEDIR}/tesseras-paste/daemon.sock. To allow a regular user to
+use tp(1), add them to the _tpd group:
+
+ # usermod -G _tpd <username>
+
+The user must log out and back in for the group change to take effect.
+
+Client Usage
+============
+
+Store a paste (default TTL 24h):
+
+ $ echo "hello world" | tp put
+
+Retrieve a paste:
+
+ $ tp get <key>
+
+See tp(1) and tpd(1) for full documentation.