From 8b08b29271e9f8d26ce8d337ffb4261ea8a25914 Mon Sep 17 00:00:00 2001 From: Goetz Goerisch Date: Fri, 19 Apr 2024 18:34:19 +0200 Subject: [PATCH] jool: update documentation * corrected the documentation links for upstream * fixed style to be correctly rendered * add reference to OpenWrt tutorial Signed-off-by: Goetz Goerisch --- net/jool/files/readme.md | 43 +++++++++++++++++++++++----------------- 1 file changed, 25 insertions(+), 18 deletions(-) diff --git a/net/jool/files/readme.md b/net/jool/files/readme.md index 88f978d9dc..0638d786e7 100644 --- a/net/jool/files/readme.md +++ b/net/jool/files/readme.md @@ -1,28 +1,35 @@ -# [Jool](https://www.jool.mx) +# [Jool](https://nicmx.github.io/Jool/en/index.html) ## Documentation -[See here](https://www.jool.mx/en/documentation.html). +[See here](https://nicmx.github.io/Jool/en/documentation.html). -You might also want to see [contact info](https://www.jool.mx/en/contact.html). +You might also want to see [contact info](https://nicmx.github.io/Jool/en/contact.html). ## Usage ### Start script This package includes a start script that will: - 1. Read the configuration file `/etc/config/jool` - 2. Determine what services are active - 3. Run jool with procd - -For now this means that: - * The services will be disabled by default in the uci config `(/etc/config/jool)` - * The only uci configuration support available for the package is to enable or disable each instance or the entire deamon - * There is no uci support and configuration will be saved at `/etc/jool/* - * Only one instance of jool(nat64) can run with the boot script - * Only one instance of jool(siit) can run with the boot script - * For now there is no way of overriding of the configuration file's paths - -The configuration files the startup script useses for each jool instance are: - * jool(nat64): `/etc/jool/jool-nat64.conf.json` - * jool(siit): `/etc/jool/jool-siit.conf.json` + + 1. Read the configuration file `/etc/config/jool` + 2. Determine what services are active + 3. Run `jool` with procd + +### For now this means that + +- The services will be disabled by default in the uci config `(/etc/config/jool)` +- The only uci configuration support available for the package is to enable or disable each instance or the entire deamon +- There is no uci support and configuration will be saved at `/etc/jool/` +- Only one instance of jool(nat64) can run with the boot script +- Only one instance of jool(siit) can run with the boot script +- For now there is no way of overriding of the configuration file's paths + +The configuration files the startup script uses for each jool instance are: + +- jool(nat64): `/etc/jool/jool-nat64.conf.json` +- jool(siit): `/etc/jool/jool-siit.conf.json` + +### OpenWrt tutorial + +For a more detailed tutorial refer to this [wiki page](https://openwrt.org/docs/guide-user/network/ipv6/nat64). -- 2.30.2