Skip to content

Commit

Permalink
Protocolary updates for release 4.0.2
Browse files Browse the repository at this point in the history
  • Loading branch information
ydahhrk committed Jul 12, 2019
1 parent da4f320 commit aa25865
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 70 deletions.
73 changes: 7 additions & 66 deletions INSTALL
Original file line number Diff line number Diff line change
@@ -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
2 changes: 2 additions & 0 deletions Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -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
3 changes: 2 additions & 1 deletion docs/en/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

<!-- 2. [Installation on Debian and derivatives](debian.html) -->

## Basic Tutorials

1. [SIIT](run-vanilla.html)
Expand Down
6 changes: 6 additions & 0 deletions docs/en/download.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) | <a href="{{ site.repository-url }}/tree/v4.0.2" target="_blank">Link</a> |

## 3.5.x

Jool 3.5 is also a [compliant SIIT and Stateful NAT64](intro-jool.html#compliance).
Expand Down
2 changes: 1 addition & 1 deletion docs/en/intro-jool.md
Original file line number Diff line number Diff line change
Expand Up @@ -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<br />4.0 - 4.20<br />5.0 | RHEL 7.0 - RHEL 7.5 |
| [master]({{ site.repository-url }}) | 3.13 - 3.19<br />4.0 - 4.20<br />5.0-5.2 | RHEL 7.0 - RHEL 7.5 |
| [4.0.1](download.html#40x) | 3.13 - 3.19<br />4.0 - 4.20<br />5.0 | RHEL 7.0 - RHEL 7.5 |
| [3.5.8](download.html#35x) | 3.2 - 3.19<br />4.0 - 4.18 | RHEL 7.0 - RHEL 7.4 |

Expand Down
2 changes: 1 addition & 1 deletion src/usr/nat64/jool.8
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" Manpage for jool's userspace app.
.\" Report bugs to [email protected].

.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).
Expand Down
2 changes: 1 addition & 1 deletion src/usr/siit/jool_siit.8
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" Manpage for jool's userspace app.
.\" Report bugs to [email protected].

.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).
Expand Down

0 comments on commit aa25865

Please sign in to comment.