commit: b30f60178bac8d353360850ed2001f10963eac94
parent: 3a2965ca3d818d107c41742b0e6003d69eb16f02
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date: Mon, 30 Apr 2018 01:28:54 +0200
README: Add more documentation
Diffstat:
1 file changed, 17 insertions(+), 1 deletion(-)
diff --git a/README b/README
@@ -1,5 +1,21 @@
# sshpaste
-A small shell script inspired by wgetpaste but for pushing to your own server.
+A mostly POSIX shell script inspired by wgetpaste but for pushing to your own server.
Please modify target_ssh and target_www to the appropriate servers and paths.
+
+## Dependencies
+* POSIX system
+* scp(1): tested with OpenSSH
+* mktemp(1): tested with coreutils; needed for -x and -c
+* xclip(1): optionnal; needed for -x option
+
+## Packages
+* It is in my gentoo overlay, here is theorically how to install sshpaste from a clean gentoo:
+```
+emerge layman
+layman -a lanodanOverlay
+emerge sshpaste
+```
+
+Note: Your server needs a ssh daemon for the uploads and a web server for hosting the files. You can also replace the web server with one for Gopher, FTP (but let it die) or maybe even something else.
