Documentation

Welcome to Jool 4’s documentation index.

Note: If you are looking for Jool 3.5’s documentation, you can download it here.

Introduction

1. What is SIIT/NAT64?
2. What is Jool?

See RFC 6586 for deployment experiences using Stateful NAT64.

Installation

1. Installation in Debian and its derivatives
2. Installation in Ubuntu (20.04+)
3. Installation in Alpine Linux
4. Installation in openSUSE
5. Installation in OpenWRT
6. Installation in most other distros (Installing from source)

Basic Tutorials

1. Basic Linux Networking
2. SIIT
3. SIIT + EAM
4. Stateful NAT64
5. DNS64
6. MAP-T
7. Persistence

If you know what you’re doing, try the Cheat Sheet.

IP/ICMP Translation in Detail

1. The IPv6 Address Pool

SIIT in Detail

1. The EAMT
2. Untranslatable IPv6 addresses

NAT64 in Detail

1. The IPv4 Transport Address Pool
2. BIB

Userspace Clients

1. General usage
2. Common modes
   1. instance
   2. stats
   3. global
      1. mtu-plateaus
   4. file
3. jool_siit-only modes
   1. eamt
   2. denylist4
   3. address
4. jool-only modes
   1. pool4
   2. bib
   3. session
   4. joold

Other Configuration

1. joold

Defined Architectures

1. SIIT-DC
2. 464XLAT
3. SIIT-DC: Dual Translation Mode

Other Sample Runs

1. Single Interface
2. Node-Based Translation
3. Session Synchronization

Miscellaneous

1. FAQ
2. MTU and Fragmentation
3. Offloads
4. Cheat Sheet