diff --git a/INSTALL b/INSTALL index 9de4400b6..972b00504 100755 --- a/INSTALL +++ b/INSTALL @@ -1,68 +1,9 @@ -*********************************************************************** +See https://jool.mx/en/install.html. - Before you continue, perhaps you want to have a look at - the newcomer-friendlier version of this file: - https://jool.mx/en/documentation.html - https://nicmx.github.io/Jool/en/documentation.html +Quick version: - It also contains a few tutorials to get you started. - -*********************************************************************** - -Install the requirements: - 1. Your kernel headers (version 3.13.0+) - # apt install linux-headers-$(uname -r) - 2. libnl-genl-3-dev - # apt install libnl-genl-3-dev - (Site: http://www.carisma.slowglass.com/~tgr/libnl) - 3. iptables dev - # apt install libxtables-dev - -Build and install everything: - $ # (This is the Kbuild version.) - $ ./configure - $ make - # make install - -Insert the module: - Configure networking: - # ip link set ... - # ip addr add ... - # ip route add ... - # sysctl -w net.ipv4.conf.all.forwarding=1 - # sysctl -w net.ipv6.conf.all.forwarding=1 - - Actually insert the module: - # modprobe jool_siit - or - # modprobe jool - - Create a Jool instance: - # jool_siit instance add potato --netfilter - or - # jool instance add tomato --netfilter -6 64:ff9b::/96 - - See your module shine: - $ # See your module listed - $ lsmod | grep jool - $ # Check the log - $ dmesg - $ # Print your instances - # jool_siit instance display - # jool instance display - -Configure the module: - Configure the instance through userspace app requests: - $ jool_siit --help - or - $ jool --help - -Destroy an instance: - # jool_siit instance remove potato - or - # jool instance remove tomato - -Detatch the module from your kernel: - # modprobe -r jool_siit - or - # modprobe -r jool + ./autogen.sh + ./configure + make + sudo make install # userspace tools + sudo dkms install . # kernel modules diff --git a/Makefile.am b/Makefile.am index 06de073cf..28df0a530 100644 --- a/Makefile.am +++ b/Makefile.am @@ -40,3 +40,5 @@ DIST_SUBDIRS = src/common src/mod src/usr # Needed by libtoolize. (Othewise autoreconf complains.) ACLOCAL_AMFLAGS=-I m4 + +EXTRA_DIST=dkms.conf diff --git a/docs/en/documentation.md b/docs/en/documentation.md index bdb1978a4..93f214d66 100644 --- a/docs/en/documentation.md +++ b/docs/en/documentation.md @@ -22,9 +22,10 @@ See [RFC 6586](https://tools.ietf.org/html/rfc6586) for deployment experiences u 1. [Installation on OpenWRT](openwrt.html) 2. [Installation on openSUSE](opensuse.html) -2. [Installation on Debian and derivatives](debian.html) 2. [Installation on most other distros](install.html) + + ## Basic Tutorials 1. [SIIT](run-vanilla.html) diff --git a/docs/en/download.md b/docs/en/download.md index bffb5fa32..2489080f3 100644 --- a/docs/en/download.md +++ b/docs/en/download.md @@ -35,6 +35,12 @@ Jool 4.0 is a [compliant SIIT and Stateful NAT64](intro-jool.html#compliance). "rc" stands for "Release Candidate." +Transitional packages: + +| Release Date | Version | .tar.gz | Git commit | +|--------------|---------|---------|------------| +| 2019-07-11 | 4.0.2 | [Download]({{ site.downloads-url-2 }}/v4.0.2/jool-4.0.2.tar.gz) | Link | + ## 3.5.x Jool 3.5 is also a [compliant SIIT and Stateful NAT64](intro-jool.html#compliance). diff --git a/docs/en/intro-jool.md b/docs/en/intro-jool.md index 49c62d52b..0e150da9e 100644 --- a/docs/en/intro-jool.md +++ b/docs/en/intro-jool.md @@ -45,7 +45,7 @@ Please [let us know]({{ site.repository-url }}/issues) if you find additional co | Jool version | Supported Linux kernels (mainline) | Supported Linux kernels (RHEL) | |-------------------------------------|--------------------------------------|--------------------------------| -| [master]({{ site.repository-url }}) | 3.13 - 3.19
4.0 - 4.20
5.0 | RHEL 7.0 - RHEL 7.5 | +| [master]({{ site.repository-url }}) | 3.13 - 3.19
4.0 - 4.20
5.0-5.2 | RHEL 7.0 - RHEL 7.5 | | [4.0.1](download.html#40x) | 3.13 - 3.19
4.0 - 4.20
5.0 | RHEL 7.0 - RHEL 7.5 | | [3.5.8](download.html#35x) | 3.2 - 3.19
4.0 - 4.18 | RHEL 7.0 - RHEL 7.4 | diff --git a/src/usr/nat64/jool.8 b/src/usr/nat64/jool.8 index 5f1a93305..328a70a6a 100644 --- a/src/usr/nat64/jool.8 +++ b/src/usr/nat64/jool.8 @@ -1,7 +1,7 @@ .\" Manpage for jool's userspace app. .\" Report bugs to jool@nic.mx. -.TH jool 8 2019-04-26 v4.0.1 "NAT64 Jool's Userspace Client" +.TH jool 8 2019-07-11 v4.0.2 "NAT64 Jool's Userspace Client" .SH NAME jool - Interact with NAT64 Jool (the kernel module). diff --git a/src/usr/siit/jool_siit.8 b/src/usr/siit/jool_siit.8 index 9e81ecfa9..8fe976d15 100644 --- a/src/usr/siit/jool_siit.8 +++ b/src/usr/siit/jool_siit.8 @@ -1,7 +1,7 @@ .\" Manpage for jool's userspace app. .\" Report bugs to jool@nic.mx. -.TH jool_siit 8 2019-04-26 v4.0.1 "SIIT Jool's Userspace Client" +.TH jool_siit 8 2019-07-11 v4.0.2 "SIIT Jool's Userspace Client" .SH NAME jool_siit - Interact with SIIT Jool (the kernel module).