Ship new configuration and startup kit.

[tripe] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..9188e9f
--- /dev/null
+++ b/README
@@ -0,0 +1,51 @@
+TRIPE
+
+Installation notes
+
+       Standard GNU Autoconf fare.
+
+               ./configure
+               make
+               make install
+
+       I've now added a startup script, `tripe-init'.  The Makefile
+       doesn't install it anywhere, but if you want to use it in your
+       boot sequence:
+
+         * If you use a SysV-like init, drop `tripe-init' in as
+           `/etc/init.d/tripe' (or wherever -- Tru64 users and similar
+           will want `/sbin/init.d/tripe'; RedHat users want
+           `/etc/rc.d/init.d/tripe' for some bizarre reason), and put
+           in symlinks to make it run, just after your networking
+           starts up.
+
+           On my Debian box, I used
+
+             update-rc.d tripe defaults 55 85
+
+           to set up the links.
+
+         * If you use a BSD-like init, put `tripe-init' in /usr/sbin,
+           and run
+
+             /usr/sbin/tripe-init start
+
+           from the init script at some appropriate time.
+
+       Automake is a bit crap and won't have set the execute bit on
+       `tripe-init', so you'll need to do that.  Sorry.
+
+       Also, it's a good idea to copy `tripe.conf' into
+       `/etc/tripe.conf'.  Then fill in the options that you want.
+
+       Finally, populate the directory `/var/lib/tripe/peers' with
+       scripts to set up peers.  This kind of thing is all that's
+       needed:
+
+               #! /bin/sh
+
+               set -e
+               tripectl add PEER PEER-ADDR 22003
+               ifname=`tripectl ifname PEER`
+               ifconfig $ifname LOCAL pointopoint REMOTE
+               route add -net RNET netmask RMASK gw REMOTE