readme.adoc

   1 About rrqnet
   2 ============
   3
   4 This repository holds the sources for *rrqnet*, which concern VPN
   5 building over UDP transport. *rrqnet* operates at Ethernet level and
   6 transports both ipv4 and ipv6. It can thus be used for all
   7 combinations of ipv4 and ipv6 tunneling over ipv4 or ipv6.
   8
   9 MAN PAGES
  10 ---------
  11   * link:rrqnet.8.adoc[The rrqnet man page]
  12   * link:rrqnet-cron.sh.8.adoc[The rrqnet-cron.sh man page]
  13   * link:rrqnet-ifupdown.sh.8.adoc[The rrqnet-ifupdown.sh man page]
  14
  15 Devuan Packages
  16 ---------------
  17
  18   * The *rrqnet* package contains the binaries and their man pages,
  19 as well as the utility scripting.
  20
  21 Doing it by hand
  22 ----------------
  23
  24
  25 Building
  26 ~~~~~~~~
  27
  28 .make
  29 [caption='Command {counter:Command}: ']
  30 ====
  31 This command builds the static executable *rrqnet* and documentation
  32 as "man" pages and HTML formats (using asciidoc).
  33 ====
  34
  35 .make rrqnet
  36 [caption='Command {counter:Command}: ']
  37 ====
  38 This command builds only the static executable *rrqnet*.
  39 ====
  40
  41 Installing
  42 ~~~~~~~~~~
  43
  44 The executable (*rrqnet*) should be installed as a system executable
  45 that in particular needs to be able to use network interfaces and
  46 (usually) create a tap.
  47
  48 There are two helper scripts for adminstrating *rrqnet* virtual
  49 cabling:
  50
  51   * *rrqnet-cron.sh* for cron based persistence with bespoke configuration
  52   * *rrqnet-ifupdown.sh* for adminstraion via *ifupdown*
  53