diff options
| author | Goetz Goerisch <ggoerisch@gmail.com> | 2024-04-19 18:34:19 +0200 |
|---|---|---|
| committer | Tianling Shen <cnsztl@gmail.com> | 2024-04-26 15:46:37 +0800 |
| commit | 8b08b29271e9f8d26ce8d337ffb4261ea8a25914 (patch) | |
| tree | 11e0e740a6a5682f400a06467ab49545f1f04e86 /net | |
| parent | f471b6b4598c47d8dc6758b2cb4137d4c1efc859 (diff) | |
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 <ggoerisch@gmail.com>
Diffstat (limited to 'net')
| -rw-r--r-- | net/jool/files/readme.md | 43 |
1 files changed, 25 insertions, 18 deletions
diff --git a/net/jool/files/readme.md b/net/jool/files/readme.md index 88f978d9d..0638d786e 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). |