diff --git a/.gitignore b/.gitignore
index 779a69e..85c6c77 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,4 @@
build.env
-build/*
\ No newline at end of file
+./build/*
+./build
+build
diff --git a/LICENSE b/LICENSE
index c5329e0..9285f0f 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
-MIT License, unless otherwise noted
+Reticulum License
-Copyright (c) 2022 Mark Qvist / unsigned.io
+Copyright (c) 2016-2025 Mark Qvist
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
@@ -9,8 +9,16 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+- The Software shall not be used in any kind of system which includes amongst
+ its functions the ability to purposefully do harm to human beings.
+
+- The Software shall not be used, directly or indirectly, in the creation of
+ an artificial intelligence, machine learning or language model training
+ dataset, including but not limited to any use that contributes to the
+ training or development of such a model or algorithm.
+
+- The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
diff --git a/Makefile b/Makefile
index 1590f6e..e792e98 100644
--- a/Makefile
+++ b/Makefile
@@ -12,9 +12,17 @@ website:
cp assets/gfx/* build/gfx/
cp -r ../../Reticulum/docs/manual/* build/manual/
cp -r ../../Reticulum/docs/Reticulum\ Manual.pdf build/manual/
+ cp -r ../../Reticulum/docs/Reticulum\ Manual.epub build/manual/
+
+docsfolder:
+ @mkdir -p ./docs
+ cp -rv ./build/* ./docs/
+ touch ./docs/.nojekyll
+
+github: website docsfolder
upload:
. ./build.env; \
- rsync -rv build/ "$$DEPLOY_TARGET" --delete
+ rsync -rv -e "ssh -p $${DEPLOY_PORT}" build/ $${DEPLOY_TARGET} --delete;
deploy: clean website upload
diff --git a/README.md b/README.md
index 5a7ae2a..7c20e93 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,10 @@
# Reticulum Website
This is the sources for the Reticulum website currently reachable at [https://reticulum.network/](https://reticulum.network/).
+
+### Add new translation
+
+Execute the `add_new_translation.sh` script and follow the instructions
+
+```bash
+bash add_new_translation.sh
+```
diff --git a/add_new_translation.sh b/add_new_translation.sh
new file mode 100755
index 0000000..1df0fa1
--- /dev/null
+++ b/add_new_translation.sh
@@ -0,0 +1,33 @@
+#!/bin/bash
+
+set -e
+
+origin_directory="./source/"
+destiny_directory="./source/"
+
+echo -e "\n"
+
+# Ask the user for the new translation language
+
+read -r -p "Enter the new translation language [es, en, fr, etc]: " new_language
+
+if [[ -z "$new_language" ]]; then
+ echo -e "Invalid language code"
+ exit 1
+fi
+
+echo "Duplicating files for $new_language language"
+for file in "$origin_directory"/*; do
+ # Took the original files and duplicate them with the new language
+ if [[ ! "$file" =~ _ ]]; then
+ # Parse name and extesion
+ name=$(basename "$file")
+ name_without_extension="${name%.*}"
+ extension="${name##*.}"
+ new_name="${name_without_extension}_${new_language}.${extension}"
+ # Duplicate the file
+ cp "$file" "$destiny_directory/$new_name"
+ fi
+done
+
+echo -e "Done, happy translation!\n"
diff --git a/assets/css/water.css b/assets/css/water.css
index 39c5d78..96aba7b 100644
--- a/assets/css/water.css
+++ b/assets/css/water.css
@@ -127,7 +127,7 @@ html {
body {
font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', 'Segoe UI Emoji', 'Apple Color Emoji', 'Noto Color Emoji', sans-serif;
line-height: 1.4;
- max-width: 800px;
+ max-width: 880px;
margin: 20px auto;
padding: 0 10px;
word-wrap: break-word;
diff --git a/build.py b/build.py
index 37b2059..1077a22 100644
--- a/build.py
+++ b/build.py
@@ -1,16 +1,18 @@
import markdown
import os
-SOURCES_PATH="./source"
-BUILD_PATH="./build"
-INPUT_ENCODING="utf-8"
-OUTPUT_ENCODING="utf-8"
+from constants import PUBLIC_ENTRYPOINTS
+
+SOURCES_PATH = "./source"
+BUILD_PATH = "./build"
+INPUT_ENCODING = "utf-8"
+OUTPUT_ENCODING = "utf-8"
document_start = """
-Reticulum Network
"+get_languages_md(mdf)+""+get_menu_md(page_lang).replace("{LANG_EXT}", page_lang_ext) + " \n\n" + md
- html = markdown.markdown(page_md, extensions=["markdown.extensions.fenced_code"])
+ md = f.read().decode(INPUT_ENCODING).replace("{PUBLIC_ENTRYPOINTS}", PUBLIC_ENTRYPOINTS)
+ page_md = "" + get_languages_md(mdf) + "" + get_menu_md(page_lang).replace("{LANG_EXT}", page_lang_ext) + " \n\n" + md
+ html = markdown.markdown(
+ page_md, extensions=["markdown.extensions.fenced_code"]
+ )
html = document_start + html + document_end
- of = BUILD_PATH+mdf.replace(SOURCES_PATH, "").replace(".md", ".html")
+ of = BUILD_PATH + mdf.replace(SOURCES_PATH, "").replace(".md", ".html")
with open(of, "wb") as wf:
wf.write(html.encode(OUTPUT_ENCODING))
diff --git a/constants.py b/constants.py
new file mode 100644
index 0000000..c8acd71
--- /dev/null
+++ b/constants.py
@@ -0,0 +1,148 @@
+PUBLIC_ENTRYPOINTS = """```
+# These are community-provided public Reticulum entrypoints
+# served over TCP, and available over the public Internet.
+
+ [[Sydney RNS]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = sydney.reticulum.au
+ target_port = 4242
+
+ [[dismails TCP Interface]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.dismail.de
+ target_port = 7822
+
+ [[interloper node]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = intr.cx
+ target_port = 4242
+
+ [[noDNS1]] │
+ type = TCPClientInterface │
+ interface_enabled = true │
+ target_host = 202.61.243.41 │
+ target_port = 4965
+
+ [[The Outpost]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = theoutpost.life
+ target_port = 4242
+
+ [[Beleth RNS Hub]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.beleth.net
+ target_port = 4242
+
+ [[Rocket Tech Hub]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.rocket-tech.net
+ target_port = 443
+
+ [[SparkN0de]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = aspark.uber.space
+ target_port = 44860
+
+ [[Tidudanka.com]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.tidudanka.com
+ target_port = 37500
+
+ [[quad4net tcp]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.quad4.io
+ target_port = 4242
+
+ [[nisa-node]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = nisa.cat
+ target_port = 4242
+
+ [[acehoss]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.acehoss.net
+ target_port = 4242
+
+ [[RNS Testnet StoppedCold]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.stoppedcold.com
+ target_port = 4242
+
+ [[RNS COMSEC-RD]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 80.78.23.249
+ target_port = 4242
+
+ [[R-Net TCP]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = istanbul.reserve.network
+ target_port = 9034
+
+ [[RNS TCP Node Germany 001]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 202.61.243.41
+ target_port = 4965
+
+ [[RNS TCP Node Germany 002]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 193.26.158.230
+ target_port = 4965
+
+ [[Quortal TCP Node]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = reticulum.qortal.link
+ target_port = 4242
+
+ [[mobilefabrik TCP]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = phantom.mobilefabrik.com
+ target_port = 4242
+
+ [[g00n.cloud Hub]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = dfw.us.g00n.cloud
+ target_port = 6969
+
+ [[RNS_Transport_US-East]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = 45.77.109.86
+ target_port = 4965
+
+ [[rothbard_RNS_transport_ZA]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = rothbard.lab.networks.deavmi.assigned.network
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_ygg]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 200:73eb:2e4:14be:aac7:90b3:784b:71a3
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_i2p]]
+ type = I2PInterface
+ enabled = true
+ peers = guuahj7pyb6ksmjv2bqrjg4cs2wou6cor3ivsi6crntqbzsxnbna.b32.i2p
+```
+"""
diff --git a/docs/.nojekyll b/docs/.nojekyll
new file mode 100644
index 0000000..e69de29
diff --git a/docs/CNAME b/docs/CNAME
new file mode 100644
index 0000000..acb85b9
--- /dev/null
+++ b/docs/CNAME
@@ -0,0 +1 @@
+reticulum.network
\ No newline at end of file
diff --git a/docs/connect.html b/docs/connect.html
new file mode 100644
index 0000000..a24b5d3
--- /dev/null
+++ b/docs/connect.html
@@ -0,0 +1,190 @@
+
+
+
+
+Reticulum Network
+
Public Testnet
+If you just want to get started experimenting without building any physical networks, you are welcome to join the Public Reticulum Testnet. The testnet is just that, an informal network for testing and experimenting. It will be up most of the time, and anyone can join, but it also means that there's no guarantees for service availability.
+Please note! For everyday use of Reticulum, such as for messaging and other communications, it is much better to use one or more of the community-provided public entrypoints. Please see the next section for details.
+The testnet runs the very latest version of Reticulum (often even a short while before it is publicly released). Sometimes experimental versions of Reticulum might be deployed to nodes on the testnet, which means strange behaviour can occur. If none of that scares you, you can join the testnet via either TCP or I2P.
+Just add one of the following interfaces to your Reticulum configuration file:
+# TCP/IP interface to the Dublin Hub
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# TCP/IP interface to the BetweenTheBorders Hub (community-provided)
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# Interface to I2P Hub A
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+The testnet also contains a number of Nomad Network nodes, and LXMF propagation nodes.
+Community Entrypoints
+A number of publicly available entrypoints to Reticulum networks have been provided by the community. For everyday use, it is recommended to use these instead of the testnet.
+You can connect your devices or instances to one or more of these to gain access to any Reticulum networks they are physically connected to.
+Ideally, set up a Reticulum Transport Node that your own devices can reach locally, and then connect that transport node to a couple of public entrypoints. This will provide efficient connections and redundancy in case any of them go down.
+# These are community-provided public Reticulum entrypoints
+# served over TCP, and available over the public Internet.
+
+ [[Sydney RNS]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = sydney.reticulum.au
+ target_port = 4242
+
+ [[dismails TCP Interface]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.dismail.de
+ target_port = 7822
+
+ [[interloper node]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = intr.cx
+ target_port = 4242
+
+ [[noDNS1]] │
+ type = TCPClientInterface │
+ interface_enabled = true │
+ target_host = 202.61.243.41 │
+ target_port = 4965
+
+ [[The Outpost]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = theoutpost.life
+ target_port = 4242
+
+ [[Beleth RNS Hub]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.beleth.net
+ target_port = 4242
+
+ [[Rocket Tech Hub]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.rocket-tech.net
+ target_port = 443
+
+ [[SparkN0de]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = aspark.uber.space
+ target_port = 44860
+
+ [[Tidudanka.com]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.tidudanka.com
+ target_port = 37500
+
+ [[quad4net tcp]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.quad4.io
+ target_port = 4242
+
+ [[nisa-node]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = nisa.cat
+ target_port = 4242
+
+ [[acehoss]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.acehoss.net
+ target_port = 4242
+
+ [[RNS Testnet StoppedCold]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.stoppedcold.com
+ target_port = 4242
+
+ [[RNS COMSEC-RD]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 80.78.23.249
+ target_port = 4242
+
+ [[R-Net TCP]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = istanbul.reserve.network
+ target_port = 9034
+
+ [[RNS TCP Node Germany 001]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 202.61.243.41
+ target_port = 4965
+
+ [[RNS TCP Node Germany 002]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 193.26.158.230
+ target_port = 4965
+
+ [[Quortal TCP Node]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = reticulum.qortal.link
+ target_port = 4242
+
+ [[mobilefabrik TCP]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = phantom.mobilefabrik.com
+ target_port = 4242
+
+ [[g00n.cloud Hub]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = dfw.us.g00n.cloud
+ target_port = 6969
+
+ [[RNS_Transport_US-East]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = 45.77.109.86
+ target_port = 4965
+
+ [[rothbard_RNS_transport_ZA]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = rothbard.lab.networks.deavmi.assigned.network
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_ygg]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 200:73eb:2e4:14be:aac7:90b3:784b:71a3
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_i2p]]
+ type = I2PInterface
+ enabled = true
+ peers = guuahj7pyb6ksmjv2bqrjg4cs2wou6cor3ivsi6crntqbzsxnbna.b32.i2p
+Next Topic: Read The Manual
+
+
diff --git a/docs/connect_de.html b/docs/connect_de.html
new file mode 100644
index 0000000..075c007
--- /dev/null
+++ b/docs/connect_de.html
@@ -0,0 +1,190 @@
+
+
+
+
+Reticulum Network
+
Öffentliches Testnetz
+Wenn Sie einfach nur experimentieren wollen, ohne ein physisches Netzwerk aufzubauen, können Sie sich gerne dem öffentlichen Reticulum Testnet anschließen. Das Testnetz ist genau das: ein informelles Netzwerk zum Testen und Experimentieren. Es wird die meiste Zeit verfügbar sein, und jeder kann mitmachen, aber das bedeutet auch, dass es keine Garantien für die Verfügbarkeit der Dienste gibt.
+Auf dem Testnetz läuft die allerneueste Version von Reticulum (oft sogar kurz vor der öffentlichen Freigabe). Manchmal werden experimentelle Versionen von Reticulum auf Knoten im Testnetz eingesetzt, was bedeutet, dass seltsames Verhalten auftreten kann.
+Wenn Sie das alles nicht abschreckt, können Sie dem Testnetz über TCP oder I2P beitreten.
+Fügen Sie einfach eine der folgenden Schnittstellen in Ihre Reticulum-Konfigurationsdatei ein:
+# TCP/IP interface to the Dublin Hub
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# TCP/IP interface to the BetweenTheBorders Hub (community-provided)
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# Interface to I2P Hub A
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+Das Testnetz enthält auch eine Reihe von Nomad Network -Knoten und LXMF -Propagationsknoten, Sowie Sideband Peers, welche untereinander erreichbar sind.
+Community-Einstiegspunkte
+Die Community hat eine Reihe öffentlich verfügbarer Einstiegspunkte zu Reticulum-Netzwerken bereitgestellt. Für den alltäglichen Gebrauch wird empfohlen, diese anstelle des Testnetzes zu verwenden.
+Sie können Ihre Geräte oder Instanzen mit einem oder mehreren dieser Punkte verbinden, um Zugriff auf alle Reticulum-Netzwerke zu erhalten, mit denen sie physisch verbunden sind.
+Richten Sie im Idealfall einen Reticulum-Transportknoten ein, den Ihre eigenen Geräte lokal erreichen können, und verbinden Sie diesen Transportknoten dann mit einigen öffentlichen Einstiegspunkten. Dies sorgt für effiziente Verbindungen und Redundanz, falls einer von ihnen ausfällt.
+# These are community-provided public Reticulum entrypoints
+# served over TCP, and available over the public Internet.
+
+ [[Sydney RNS]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = sydney.reticulum.au
+ target_port = 4242
+
+ [[dismails TCP Interface]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.dismail.de
+ target_port = 7822
+
+ [[interloper node]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = intr.cx
+ target_port = 4242
+
+ [[noDNS1]] │
+ type = TCPClientInterface │
+ interface_enabled = true │
+ target_host = 202.61.243.41 │
+ target_port = 4965
+
+ [[The Outpost]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = theoutpost.life
+ target_port = 4242
+
+ [[Beleth RNS Hub]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.beleth.net
+ target_port = 4242
+
+ [[Rocket Tech Hub]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.rocket-tech.net
+ target_port = 443
+
+ [[SparkN0de]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = aspark.uber.space
+ target_port = 44860
+
+ [[Tidudanka.com]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.tidudanka.com
+ target_port = 37500
+
+ [[quad4net tcp]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.quad4.io
+ target_port = 4242
+
+ [[nisa-node]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = nisa.cat
+ target_port = 4242
+
+ [[acehoss]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.acehoss.net
+ target_port = 4242
+
+ [[RNS Testnet StoppedCold]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.stoppedcold.com
+ target_port = 4242
+
+ [[RNS COMSEC-RD]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 80.78.23.249
+ target_port = 4242
+
+ [[R-Net TCP]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = istanbul.reserve.network
+ target_port = 9034
+
+ [[RNS TCP Node Germany 001]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 202.61.243.41
+ target_port = 4965
+
+ [[RNS TCP Node Germany 002]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 193.26.158.230
+ target_port = 4965
+
+ [[Quortal TCP Node]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = reticulum.qortal.link
+ target_port = 4242
+
+ [[mobilefabrik TCP]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = phantom.mobilefabrik.com
+ target_port = 4242
+
+ [[g00n.cloud Hub]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = dfw.us.g00n.cloud
+ target_port = 6969
+
+ [[RNS_Transport_US-East]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = 45.77.109.86
+ target_port = 4965
+
+ [[rothbard_RNS_transport_ZA]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = rothbard.lab.networks.deavmi.assigned.network
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_ygg]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 200:73eb:2e4:14be:aac7:90b3:784b:71a3
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_i2p]]
+ type = I2PInterface
+ enabled = true
+ peers = guuahj7pyb6ksmjv2bqrjg4cs2wou6cor3ivsi6crntqbzsxnbna.b32.i2p
+Nächstes Thema: Lesen Sie das Handbuch
+
+
diff --git a/docs/connect_es.html b/docs/connect_es.html
new file mode 100644
index 0000000..2e596ff
--- /dev/null
+++ b/docs/connect_es.html
@@ -0,0 +1,190 @@
+
+
+
+
+Reticulum Network
+
Testnet pública
+Si sólo quiere empezar a experimentar sin construir ninguna red física, le invitamos a unirse a la red pública de pruebas de Reticulum (Testnet).
+La red de pruebas es precisamente eso, una red informal para probar y experimentar. Estará activa la mayor parte del tiempo y cualquiera puede unirse a ella, pero esto también significa que no hay garantías de disponibilidad del servicio.
+La red de pruebas ejecuta la ultimísima versión de Reticulum (a menudo incluso un poco antes de su lanzamiento público). A veces pueden desplegarse versiones experimentales de Reticulum en nodos de la red de pruebas, lo que significa que pueden producirse comportamientos extraños. Si nada de esto le asusta, puede unirse a la red de prueba a través de TCP o I2P.
+Sólo tiene que añadir una de las siguientes interfaces a su archivo de configuración de Reticulum:
+# TCP/IP interfaz al Dublin Hub
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# TCP/IP interfaz al BetweenTheBorders Hub (proporcionado por la comunidad)
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# Interfaz a I2P Hub A
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+La red de pruebas también contiene varios nodos de Nomad Network y nodos de propagación LXMF .
+Puntos de entrada de la comunidad
+La comunidad ha proporcionado una serie de puntos de entrada disponibles públicamente a las redes de Reticulum. Para el uso diario, se recomienda utilizar estos en lugar de la red de prueba.
+Puede conectar sus dispositivos o instancias a uno o más de estos para obtener acceso a cualquier red de Reticulum a la que estén conectados físicamente.
+Lo ideal es configurar un nodo de transporte de Reticulum al que sus propios dispositivos puedan acceder localmente y luego conectar ese nodo de transporte a un par de puntos de entrada públicos. Esto proporcionará conexiones eficientes y redundancia en caso de que alguno de ellos deje de funcionar.
+# These are community-provided public Reticulum entrypoints
+# served over TCP, and available over the public Internet.
+
+ [[Sydney RNS]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = sydney.reticulum.au
+ target_port = 4242
+
+ [[dismails TCP Interface]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.dismail.de
+ target_port = 7822
+
+ [[interloper node]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = intr.cx
+ target_port = 4242
+
+ [[noDNS1]] │
+ type = TCPClientInterface │
+ interface_enabled = true │
+ target_host = 202.61.243.41 │
+ target_port = 4965
+
+ [[The Outpost]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = theoutpost.life
+ target_port = 4242
+
+ [[Beleth RNS Hub]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.beleth.net
+ target_port = 4242
+
+ [[Rocket Tech Hub]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.rocket-tech.net
+ target_port = 443
+
+ [[SparkN0de]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = aspark.uber.space
+ target_port = 44860
+
+ [[Tidudanka.com]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.tidudanka.com
+ target_port = 37500
+
+ [[quad4net tcp]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.quad4.io
+ target_port = 4242
+
+ [[nisa-node]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = nisa.cat
+ target_port = 4242
+
+ [[acehoss]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.acehoss.net
+ target_port = 4242
+
+ [[RNS Testnet StoppedCold]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.stoppedcold.com
+ target_port = 4242
+
+ [[RNS COMSEC-RD]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 80.78.23.249
+ target_port = 4242
+
+ [[R-Net TCP]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = istanbul.reserve.network
+ target_port = 9034
+
+ [[RNS TCP Node Germany 001]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 202.61.243.41
+ target_port = 4965
+
+ [[RNS TCP Node Germany 002]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 193.26.158.230
+ target_port = 4965
+
+ [[Quortal TCP Node]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = reticulum.qortal.link
+ target_port = 4242
+
+ [[mobilefabrik TCP]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = phantom.mobilefabrik.com
+ target_port = 4242
+
+ [[g00n.cloud Hub]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = dfw.us.g00n.cloud
+ target_port = 6969
+
+ [[RNS_Transport_US-East]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = 45.77.109.86
+ target_port = 4965
+
+ [[rothbard_RNS_transport_ZA]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = rothbard.lab.networks.deavmi.assigned.network
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_ygg]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 200:73eb:2e4:14be:aac7:90b3:784b:71a3
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_i2p]]
+ type = I2PInterface
+ enabled = true
+ peers = guuahj7pyb6ksmjv2bqrjg4cs2wou6cor3ivsi6crntqbzsxnbna.b32.i2p
+Siguiente tema: Leer el manual
+
+
diff --git a/docs/connect_jp.html b/docs/connect_jp.html
new file mode 100644
index 0000000..39349fa
--- /dev/null
+++ b/docs/connect_jp.html
@@ -0,0 +1,189 @@
+
+
+
+
+Reticulum Network
+
パブリックテストネット
+物理的なネットワークを構築せずに実験を始めたい場合は、パブリックレティキュラムテストネットに参加してください。テストネットはまさにそれであり、テストと実験のための非公式なネットワークです。ほとんどの時間稼働しており、誰でも参加できますが、それは同時にサービスの可用性に対する保証がないことも意味します。
+テストネットは最新のレティキュラムのバージョンを実行しており（公開される前の短い期間でもあることがよくあります）、時折実験的なレティキュラムのバージョンがテストネット上のノードに展開されることがあり、それにより奇妙な動作が発生する可能性があります。それでも怖くない場合は、TCPまたはI2Pを使用してテストネットに参加できます。
+次のいずれかのインターフェースをReticulumの設定ファイルに追加してください：
+# Dublin HubへのTCP/IPインターフェース
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# BetweenTheBorders HubへのTCP/IPインターフェース（コミュニティ提供）
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# I2P Hub Aへのインターフェース
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+テストネットにはNomad Network ノードおよびLXMF 伝播ノードも含まれています。
+コミュニティ エントリポイント
+コミュニティによって、Reticulum ネットワークへの公開エントリポイントが多数提供されています。日常的な使用には、テストネットではなくこれらを使用することをお勧めします。
+デバイスまたはインスタンスをこれらの 1 つ以上のエントリポイントに接続して、物理的に接続されている Reticulum ネットワークにアクセスできます。
+理想的には、自分のデバイスがローカルでアクセスできる Reticulum トランスポート ノードを設定し、そのトランスポート ノードをいくつかのパブリック エントリポイントに接続します。これにより、いずれかのエントリポイントがダウンした場合でも、効率的な接続と冗長性が提供されます。
+# These are community-provided public Reticulum entrypoints
+# served over TCP, and available over the public Internet.
+
+ [[Sydney RNS]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = sydney.reticulum.au
+ target_port = 4242
+
+ [[dismails TCP Interface]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.dismail.de
+ target_port = 7822
+
+ [[interloper node]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = intr.cx
+ target_port = 4242
+
+ [[noDNS1]] │
+ type = TCPClientInterface │
+ interface_enabled = true │
+ target_host = 202.61.243.41 │
+ target_port = 4965
+
+ [[The Outpost]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = theoutpost.life
+ target_port = 4242
+
+ [[Beleth RNS Hub]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.beleth.net
+ target_port = 4242
+
+ [[Rocket Tech Hub]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.rocket-tech.net
+ target_port = 443
+
+ [[SparkN0de]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = aspark.uber.space
+ target_port = 44860
+
+ [[Tidudanka.com]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.tidudanka.com
+ target_port = 37500
+
+ [[quad4net tcp]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.quad4.io
+ target_port = 4242
+
+ [[nisa-node]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = nisa.cat
+ target_port = 4242
+
+ [[acehoss]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.acehoss.net
+ target_port = 4242
+
+ [[RNS Testnet StoppedCold]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.stoppedcold.com
+ target_port = 4242
+
+ [[RNS COMSEC-RD]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 80.78.23.249
+ target_port = 4242
+
+ [[R-Net TCP]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = istanbul.reserve.network
+ target_port = 9034
+
+ [[RNS TCP Node Germany 001]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 202.61.243.41
+ target_port = 4965
+
+ [[RNS TCP Node Germany 002]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 193.26.158.230
+ target_port = 4965
+
+ [[Quortal TCP Node]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = reticulum.qortal.link
+ target_port = 4242
+
+ [[mobilefabrik TCP]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = phantom.mobilefabrik.com
+ target_port = 4242
+
+ [[g00n.cloud Hub]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = dfw.us.g00n.cloud
+ target_port = 6969
+
+ [[RNS_Transport_US-East]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = 45.77.109.86
+ target_port = 4965
+
+ [[rothbard_RNS_transport_ZA]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = rothbard.lab.networks.deavmi.assigned.network
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_ygg]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 200:73eb:2e4:14be:aac7:90b3:784b:71a3
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_i2p]]
+ type = I2PInterface
+ enabled = true
+ peers = guuahj7pyb6ksmjv2bqrjg4cs2wou6cor3ivsi6crntqbzsxnbna.b32.i2p
+次のトピック：マニュアルを読む
+
+
diff --git a/docs/connect_nl.html b/docs/connect_nl.html
new file mode 100644
index 0000000..239a9a2
--- /dev/null
+++ b/docs/connect_nl.html
@@ -0,0 +1,189 @@
+
+
+
+
+Reticulum Network
+
Openbaar Testnet
+Als je gewoon wilt beginnen met experimenteren zonder fysieke netwerken te bouwen, ben je van harte welkom om lid te worden van het Public Reticulum Testnet. Het testnet is precies dat: een informeel netwerk voor testen en experimenteren. Het zal het grootste deel van de tijd actief zijn en iedereen kan meedoen, maar het betekent ook dat er geen garanties zijn voor de beschikbaarheid van de service.
+Het testnet draait de allernieuwste versie van Reticulum (vaak zelfs kort voordat deze publiekelijk wordt vrijgegeven). Soms kunnen experimentele versies van Reticulum worden ingezet op knooppunten op het testnet, wat betekent dat er vreemd gedrag kan optreden. Als dit u allemaal niet afschrikt, kunt u zich via TCP of I2P bij het testnet aansluiten.
+Voeg gewoon een van de volgende interfaces toe aan uw Reticulum-configuratiebestand:
+# TCP/IP interface to the Dublin Hub
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# TCP/IP interface to the BetweenTheBorders Hub (door de gemeenschap geleverd)
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# Interface to I2P Hub A
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+Het testnet bevat ook een aantal Nomad Network knooppunten en LXMF propagatieknooppunten.
+Community Entrypoints
+De community heeft een aantal openbaar beschikbare entrypoints voor Reticulum-netwerken geleverd. Voor dagelijks gebruik is het raadzaam om deze te gebruiken in plaats van het testnet.
+U kunt uw apparaten of instanties verbinden met een of meer van deze om toegang te krijgen tot alle Reticulum-netwerken waarmee ze fysiek verbonden zijn.
+Idealiter stelt u een Reticulum Transport Node in die uw eigen apparaten lokaal kunnen bereiken en verbindt u die transport node vervolgens met een aantal openbare entrypoints. Dit zorgt voor efficiënte verbindingen en redundantie in het geval dat een van hen uitvalt.
+# These are community-provided public Reticulum entrypoints
+# served over TCP, and available over the public Internet.
+
+ [[Sydney RNS]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = sydney.reticulum.au
+ target_port = 4242
+
+ [[dismails TCP Interface]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.dismail.de
+ target_port = 7822
+
+ [[interloper node]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = intr.cx
+ target_port = 4242
+
+ [[noDNS1]] │
+ type = TCPClientInterface │
+ interface_enabled = true │
+ target_host = 202.61.243.41 │
+ target_port = 4965
+
+ [[The Outpost]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = theoutpost.life
+ target_port = 4242
+
+ [[Beleth RNS Hub]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.beleth.net
+ target_port = 4242
+
+ [[Rocket Tech Hub]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.rocket-tech.net
+ target_port = 443
+
+ [[SparkN0de]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = aspark.uber.space
+ target_port = 44860
+
+ [[Tidudanka.com]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.tidudanka.com
+ target_port = 37500
+
+ [[quad4net tcp]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.quad4.io
+ target_port = 4242
+
+ [[nisa-node]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = nisa.cat
+ target_port = 4242
+
+ [[acehoss]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.acehoss.net
+ target_port = 4242
+
+ [[RNS Testnet StoppedCold]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.stoppedcold.com
+ target_port = 4242
+
+ [[RNS COMSEC-RD]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 80.78.23.249
+ target_port = 4242
+
+ [[R-Net TCP]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = istanbul.reserve.network
+ target_port = 9034
+
+ [[RNS TCP Node Germany 001]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 202.61.243.41
+ target_port = 4965
+
+ [[RNS TCP Node Germany 002]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 193.26.158.230
+ target_port = 4965
+
+ [[Quortal TCP Node]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = reticulum.qortal.link
+ target_port = 4242
+
+ [[mobilefabrik TCP]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = phantom.mobilefabrik.com
+ target_port = 4242
+
+ [[g00n.cloud Hub]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = dfw.us.g00n.cloud
+ target_port = 6969
+
+ [[RNS_Transport_US-East]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = 45.77.109.86
+ target_port = 4965
+
+ [[rothbard_RNS_transport_ZA]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = rothbard.lab.networks.deavmi.assigned.network
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_ygg]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 200:73eb:2e4:14be:aac7:90b3:784b:71a3
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_i2p]]
+ type = I2PInterface
+ enabled = true
+ peers = guuahj7pyb6ksmjv2bqrjg4cs2wou6cor3ivsi6crntqbzsxnbna.b32.i2p
+Volgend onderwerp: lees de handleiding
+
+
diff --git a/docs/connect_pl.html b/docs/connect_pl.html
new file mode 100644
index 0000000..afcd0d2
--- /dev/null
+++ b/docs/connect_pl.html
@@ -0,0 +1,189 @@
+
+
+
+
+Reticulum Network
+
Publiczny Testnet
+Jeśli chcesz po prostu zacząć eksperymentować bez budowania fizycznych sieci, zachęcam do przyłączenia się do Publicznego Testnetu Reticulum. Testnet to po prostu nieformalna sieć do testowania i eksperymentowania. Będzie działać przez większość czasu i każdy może do niej dołączyć, ale oznacza to również, że nie ma gwarancji dostępności usług.
+W sieci testowej działa najnowsza wersja Reticulum (często nawet krótko przed jej publicznym udostępnieniem). Czasami eksperymentalne wersje Reticulum mogą zostać wdrożone do węzłów w sieci testowej, co oznacza, że mogą wystąpić dziwne zachowania. Jeśli Ciebie to nie przeraża, możesz dołączyć do sieci testowej przez TCP lub I2P.
+Dodaj jeden z następujących interfejsów do pliku konfiguracyjnego Reticulum:
+# TCP/IP interface to the Dublin Hub
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# TCP/IP interface to the BetweenTheBorders Hub (community-provided)
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# Interface to I2P Hub A
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+Testnet zawiera również liczne węzły Nomad Network , i węzły propagacyjne LXMF .
+Punkty wejścia społeczności
+Społeczność udostępniła szereg publicznie dostępnych punktów wejścia do sieci Reticulum. Do codziennego użytku zaleca się korzystanie z nich zamiast sieci testowej.
+Możesz podłączyć swoje urządzenia lub instancje do jednego lub większej liczby z nich, aby uzyskać dostęp do dowolnej sieci Reticulum, do której są fizycznie podłączone.
+W idealnym przypadku skonfiguruj węzeł transportowy Reticulum, do którego Twoje własne urządzenia mogą dotrzeć lokalnie, a następnie podłącz ten węzeł transportowy do kilku publicznych punktów wejścia. Zapewni to wydajne połączenia i redundancję w przypadku awarii któregokolwiek z nich.
+# These are community-provided public Reticulum entrypoints
+# served over TCP, and available over the public Internet.
+
+ [[Sydney RNS]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = sydney.reticulum.au
+ target_port = 4242
+
+ [[dismails TCP Interface]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.dismail.de
+ target_port = 7822
+
+ [[interloper node]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = intr.cx
+ target_port = 4242
+
+ [[noDNS1]] │
+ type = TCPClientInterface │
+ interface_enabled = true │
+ target_host = 202.61.243.41 │
+ target_port = 4965
+
+ [[The Outpost]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = theoutpost.life
+ target_port = 4242
+
+ [[Beleth RNS Hub]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.beleth.net
+ target_port = 4242
+
+ [[Rocket Tech Hub]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.rocket-tech.net
+ target_port = 443
+
+ [[SparkN0de]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = aspark.uber.space
+ target_port = 44860
+
+ [[Tidudanka.com]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.tidudanka.com
+ target_port = 37500
+
+ [[quad4net tcp]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.quad4.io
+ target_port = 4242
+
+ [[nisa-node]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = nisa.cat
+ target_port = 4242
+
+ [[acehoss]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.acehoss.net
+ target_port = 4242
+
+ [[RNS Testnet StoppedCold]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.stoppedcold.com
+ target_port = 4242
+
+ [[RNS COMSEC-RD]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 80.78.23.249
+ target_port = 4242
+
+ [[R-Net TCP]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = istanbul.reserve.network
+ target_port = 9034
+
+ [[RNS TCP Node Germany 001]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 202.61.243.41
+ target_port = 4965
+
+ [[RNS TCP Node Germany 002]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 193.26.158.230
+ target_port = 4965
+
+ [[Quortal TCP Node]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = reticulum.qortal.link
+ target_port = 4242
+
+ [[mobilefabrik TCP]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = phantom.mobilefabrik.com
+ target_port = 4242
+
+ [[g00n.cloud Hub]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = dfw.us.g00n.cloud
+ target_port = 6969
+
+ [[RNS_Transport_US-East]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = 45.77.109.86
+ target_port = 4965
+
+ [[rothbard_RNS_transport_ZA]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = rothbard.lab.networks.deavmi.assigned.network
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_ygg]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 200:73eb:2e4:14be:aac7:90b3:784b:71a3
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_i2p]]
+ type = I2PInterface
+ enabled = true
+ peers = guuahj7pyb6ksmjv2bqrjg4cs2wou6cor3ivsi6crntqbzsxnbna.b32.i2p
+Następny Temat: Przeczytaj Podręcznik
+
+
diff --git a/docs/connect_pt-br.html b/docs/connect_pt-br.html
new file mode 100644
index 0000000..ae04640
--- /dev/null
+++ b/docs/connect_pt-br.html
@@ -0,0 +1,190 @@
+
+
+
+
+Reticulum Network
+
Rede de Teste Pública
+Se você quiser experimentar sem criar nenhuma rede física, você é bem-vindo para entrar na Rede de Teste Pública Reticulum. A rede de teste é apenas isso, uma rede informal para teste e experimentação. Estará online na maior parte do tempo e qualquer um pode entrar, mas isso também significa que não há garantia da disponibilidade do serviço.
+A rede de teste executa a última versão do Reticulum (muitas vezes antes da versão ser publicamente lançada).
+Algumas vezes versões experimentais do Reticulum podem ser utilizada em nós da rede de teste, que pode causar instabilidade. Se nada disso importa para você, você pode entrar na rede de teste via TCP ou I2P.
+Adicione uma das seguintes interfaces no arquivo de configuração do seu Reticulum:
+# Interface TCP/IP para o Dublin Hub
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# Interface TCP/IP para o BetweenTheBorders Hub
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# Interface para o I2P Hub A
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+A rede de teste também contém o número de nós da Nomad Network e nós de propagação LXMF .
+Pontos de entrada da comunidade
+Vários pontos de entrada disponíveis publicamente para redes Reticulum foram fornecidos pela comunidade. Para uso diário, é recomendado usar estes em vez da testnet.
+Você pode conectar seus dispositivos ou instâncias a um ou mais destes para obter acesso a quaisquer redes Reticulum às quais eles estejam fisicamente conectados.
+O ideal é configurar um nó de transporte Reticulum que seus próprios dispositivos possam alcançar localmente e, em seguida, conectar esse nó de transporte a alguns pontos de entrada públicos. Isso fornecerá conexões eficientes e redundância caso algum deles fique inativo.
+# These are community-provided public Reticulum entrypoints
+# served over TCP, and available over the public Internet.
+
+ [[Sydney RNS]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = sydney.reticulum.au
+ target_port = 4242
+
+ [[dismails TCP Interface]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.dismail.de
+ target_port = 7822
+
+ [[interloper node]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = intr.cx
+ target_port = 4242
+
+ [[noDNS1]] │
+ type = TCPClientInterface │
+ interface_enabled = true │
+ target_host = 202.61.243.41 │
+ target_port = 4965
+
+ [[The Outpost]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = theoutpost.life
+ target_port = 4242
+
+ [[Beleth RNS Hub]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.beleth.net
+ target_port = 4242
+
+ [[Rocket Tech Hub]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.rocket-tech.net
+ target_port = 443
+
+ [[SparkN0de]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = aspark.uber.space
+ target_port = 44860
+
+ [[Tidudanka.com]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.tidudanka.com
+ target_port = 37500
+
+ [[quad4net tcp]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.quad4.io
+ target_port = 4242
+
+ [[nisa-node]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = nisa.cat
+ target_port = 4242
+
+ [[acehoss]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.acehoss.net
+ target_port = 4242
+
+ [[RNS Testnet StoppedCold]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.stoppedcold.com
+ target_port = 4242
+
+ [[RNS COMSEC-RD]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 80.78.23.249
+ target_port = 4242
+
+ [[R-Net TCP]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = istanbul.reserve.network
+ target_port = 9034
+
+ [[RNS TCP Node Germany 001]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 202.61.243.41
+ target_port = 4965
+
+ [[RNS TCP Node Germany 002]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 193.26.158.230
+ target_port = 4965
+
+ [[Quortal TCP Node]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = reticulum.qortal.link
+ target_port = 4242
+
+ [[mobilefabrik TCP]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = phantom.mobilefabrik.com
+ target_port = 4242
+
+ [[g00n.cloud Hub]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = dfw.us.g00n.cloud
+ target_port = 6969
+
+ [[RNS_Transport_US-East]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = 45.77.109.86
+ target_port = 4965
+
+ [[rothbard_RNS_transport_ZA]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = rothbard.lab.networks.deavmi.assigned.network
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_ygg]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 200:73eb:2e4:14be:aac7:90b3:784b:71a3
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_i2p]]
+ type = I2PInterface
+ enabled = true
+ peers = guuahj7pyb6ksmjv2bqrjg4cs2wou6cor3ivsi6crntqbzsxnbna.b32.i2p
+Próxima Página: Leia o Manual
+
+
diff --git a/docs/connect_tr.html b/docs/connect_tr.html
new file mode 100644
index 0000000..0ef2220
--- /dev/null
+++ b/docs/connect_tr.html
@@ -0,0 +1,189 @@
+
+
+
+
+Reticulum Network
+
Genel Test Ağı
+Eğer fiziksel ağlar oluşturmadan sadece denemelere başlamak istiyorsanız, Genel Reticulum Test Ağı'na katılmaktan hoş geldiniz. Test ağı tam olarak bunun için, test etmek ve denemeler yapmak için gayri resmi bir ağdır. Çoğu zaman aktif olacak ve herkes katılabilir, ancak bu aynı zamanda hizmetin sürekli kullanılabilirliği için garanti olmadığı anlamına gelir.
+Test ağı, Reticulum'un en güncel sürümünü çalıştırır (çoğu zaman genel olarak yayınlanmadan kısa bir süre önce). Ara sıra Reticulum'un deneysel sürümleri, test ağındaki düğümlere dağıtılabilir, bu da tuhaf davranışlara neden olabilir. Eğer hiçbiri sizi korkutmuyorsa, test ağına TCP veya I2P aracılığıyla katılabilirsiniz.
+Reticulum yapılandırma dosyanıza aşağıdaki arayüzlerden birini ekleyin:
+# Dublin Hub için TCP/IP arabirimi
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# BetweenTheBorders Hub için TCP/IP arabirimi (topluluk tarafından sağlanmış)
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# I2P Hub A için arabirim
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+Test ayrıca bir dizi Nomad Network düğümü ve LXMF yayılma düğümü içerir.
+Topluluk Giriş Noktaları
+Topluluk tarafından Reticulum ağlarına bir dizi genel erişime açık giriş noktası sağlanmıştır. Günlük kullanım için, testnet yerine bunları kullanmanız önerilir.
+Cihazlarınızı veya örneklerinizi fiziksel olarak bağlı oldukları herhangi bir Reticulum ağına erişim sağlamak için bunlardan birine veya daha fazlasına bağlayabilirsiniz.
+İdeal olarak, kendi cihazlarınızın yerel olarak ulaşabileceği bir Reticulum Taşıma Düğümü kurun ve ardından bu taşıma düğümünü birkaç genel giriş noktasına bağlayın. Bu, bunlardan herhangi biri çökerse verimli bağlantılar ve yedeklilik sağlayacaktır.
+# These are community-provided public Reticulum entrypoints
+# served over TCP, and available over the public Internet.
+
+ [[Sydney RNS]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = sydney.reticulum.au
+ target_port = 4242
+
+ [[dismails TCP Interface]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.dismail.de
+ target_port = 7822
+
+ [[interloper node]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = intr.cx
+ target_port = 4242
+
+ [[noDNS1]] │
+ type = TCPClientInterface │
+ interface_enabled = true │
+ target_host = 202.61.243.41 │
+ target_port = 4965
+
+ [[The Outpost]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = theoutpost.life
+ target_port = 4242
+
+ [[Beleth RNS Hub]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.beleth.net
+ target_port = 4242
+
+ [[Rocket Tech Hub]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.rocket-tech.net
+ target_port = 443
+
+ [[SparkN0de]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = aspark.uber.space
+ target_port = 44860
+
+ [[Tidudanka.com]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.tidudanka.com
+ target_port = 37500
+
+ [[quad4net tcp]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.quad4.io
+ target_port = 4242
+
+ [[nisa-node]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = nisa.cat
+ target_port = 4242
+
+ [[acehoss]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.acehoss.net
+ target_port = 4242
+
+ [[RNS Testnet StoppedCold]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.stoppedcold.com
+ target_port = 4242
+
+ [[RNS COMSEC-RD]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 80.78.23.249
+ target_port = 4242
+
+ [[R-Net TCP]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = istanbul.reserve.network
+ target_port = 9034
+
+ [[RNS TCP Node Germany 001]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 202.61.243.41
+ target_port = 4965
+
+ [[RNS TCP Node Germany 002]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 193.26.158.230
+ target_port = 4965
+
+ [[Quortal TCP Node]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = reticulum.qortal.link
+ target_port = 4242
+
+ [[mobilefabrik TCP]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = phantom.mobilefabrik.com
+ target_port = 4242
+
+ [[g00n.cloud Hub]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = dfw.us.g00n.cloud
+ target_port = 6969
+
+ [[RNS_Transport_US-East]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = 45.77.109.86
+ target_port = 4965
+
+ [[rothbard_RNS_transport_ZA]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = rothbard.lab.networks.deavmi.assigned.network
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_ygg]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 200:73eb:2e4:14be:aac7:90b3:784b:71a3
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_i2p]]
+ type = I2PInterface
+ enabled = true
+ peers = guuahj7pyb6ksmjv2bqrjg4cs2wou6cor3ivsi6crntqbzsxnbna.b32.i2p
+Sonraki Konu: Kılavuzu Okuyun
+
+
diff --git a/docs/connect_uk.html b/docs/connect_uk.html
new file mode 100644
index 0000000..939db04
--- /dev/null
+++ b/docs/connect_uk.html
@@ -0,0 +1,190 @@
+
+
+
+
+Reticulum Network
+
Публічний Testnet
+Якщо ви просто хочете почати експериментувати без створення фізичних мереж, ви можете приєднатися до публічного тестнету Reticulum. Тестнет саме такий, неформальна мережа для тестування та експериментів. Він буде доступний більшість часу, і кожен може приєднатися, але це також означає, що немає гарантій щодо доступності сервісу.
+Зверніть увагу! Для повсякденного використання Reticulum, наприклад, для обміну повідомленнями та інших комунікацій, набагато краще використовувати один або кілька з публічних точок входу, наданих спільнотою. Деталі дивіться в наступному розділі.
+Тестнет працює на найновішій версії Reticulum (зазвичай навіть до її офіційного випуску). Іноді на тестнеті можуть бути розгорнуті експериментальні версії Reticulum, що може призвести до дивної поведінки. Якщо вас це не лякає, ви можете приєднатися до тестнету через TCP або I2P.
+Просто додайте один із наступних інтерфейсів до вашого конфігураційного файлу Reticulum:
+# TCP/IP interface to the Dublin Hub
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# TCP/IP interface to the BetweenTheBorders Hub (community-provided)
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# Interface to I2P Hub A
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+Тестнет також містить кілька вузлів Nomad Network та вузлів поширення LXMF.
+Точки входу спільноти
+Спільнота надала кілька публічно доступних точок входу до мереж Reticulum. Для повсякденного використання рекомендується використовувати ці точки замість тестнету.
+Ви можете приєднати свої пристрої або інстанси до однієї або кількох таких точок входу, щоб отримати доступ до будь-яких мереж Reticulum, до яких вони фізично підключені.
+Ідеально, якщо ви налаштуєте вузол транспорту Reticulum, до якого ваші пристрої зможуть підключатися локально, а потім з’єднаєте цей транспортний вузол з кількома публічними точками входу. Це забезпечить ефективні з’єднання та надійність у випадку, якщо одна з точок входу вийде з ладу.
+# These are community-provided public Reticulum entrypoints
+# served over TCP, and available over the public Internet.
+
+ [[Sydney RNS]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = sydney.reticulum.au
+ target_port = 4242
+
+ [[dismails TCP Interface]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.dismail.de
+ target_port = 7822
+
+ [[interloper node]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = intr.cx
+ target_port = 4242
+
+ [[noDNS1]] │
+ type = TCPClientInterface │
+ interface_enabled = true │
+ target_host = 202.61.243.41 │
+ target_port = 4965
+
+ [[The Outpost]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = theoutpost.life
+ target_port = 4242
+
+ [[Beleth RNS Hub]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.beleth.net
+ target_port = 4242
+
+ [[Rocket Tech Hub]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.rocket-tech.net
+ target_port = 443
+
+ [[SparkN0de]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = aspark.uber.space
+ target_port = 44860
+
+ [[Tidudanka.com]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.tidudanka.com
+ target_port = 37500
+
+ [[quad4net tcp]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.quad4.io
+ target_port = 4242
+
+ [[nisa-node]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = nisa.cat
+ target_port = 4242
+
+ [[acehoss]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.acehoss.net
+ target_port = 4242
+
+ [[RNS Testnet StoppedCold]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.stoppedcold.com
+ target_port = 4242
+
+ [[RNS COMSEC-RD]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 80.78.23.249
+ target_port = 4242
+
+ [[R-Net TCP]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = istanbul.reserve.network
+ target_port = 9034
+
+ [[RNS TCP Node Germany 001]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 202.61.243.41
+ target_port = 4965
+
+ [[RNS TCP Node Germany 002]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 193.26.158.230
+ target_port = 4965
+
+ [[Quortal TCP Node]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = reticulum.qortal.link
+ target_port = 4242
+
+ [[mobilefabrik TCP]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = phantom.mobilefabrik.com
+ target_port = 4242
+
+ [[g00n.cloud Hub]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = dfw.us.g00n.cloud
+ target_port = 6969
+
+ [[RNS_Transport_US-East]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = 45.77.109.86
+ target_port = 4965
+
+ [[rothbard_RNS_transport_ZA]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = rothbard.lab.networks.deavmi.assigned.network
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_ygg]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 200:73eb:2e4:14be:aac7:90b3:784b:71a3
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_i2p]]
+ type = I2PInterface
+ enabled = true
+ peers = guuahj7pyb6ksmjv2bqrjg4cs2wou6cor3ivsi6crntqbzsxnbna.b32.i2p
+Наступна тема: Читати мануал
+
+
diff --git a/docs/connect_zh-cn.html b/docs/connect_zh-cn.html
new file mode 100644
index 0000000..3ad63e3
--- /dev/null
+++ b/docs/connect_zh-cn.html
@@ -0,0 +1,190 @@
+
+
+
+
+Reticulum Network
+
公共测试网络
+如果你只是想立刻上手使用，而不想搭建物理意义上的网络的话，你可以加入公开的 Reticulum 测试网络。这是一个非正式的用于测试与实验的网络。大部分时间它都会在线，所有人都可以加入。同时，“测试”也意味着没有可用性保障。
+请注意！ 对于 Reticulum 的日常使用，例如消息传递和其他通信，最好使用社区提供的一个或多个公共入口点。请参阅下一节了解详细信息。
+测试网络运行的是最新版的 Reticulum（甚至会在正式发布之前更新）。有时实验版的 Reticulum 会被部署到测试网络的节点之上，这可能会产生奇怪的行为。如果这些都没让你感到害怕，欢迎通过 TCP 或是 I2P 加入测试网络。
+你仅需在 Reticulum 的配置文件中加入以下任意一个界面：
+# Dublin Hub 的 TCP/IP 界面
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# BetweenTheBorders Hub (社区提供) 的 TCP/IP 界面
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# I2P Hub A 界面
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+测试网络中还有几个 Nomad Network 节点和 LXMF 传播节点（propagation nodes）。
+社区入口点
+社区提供了许多可公开访问的 Reticulum 网络入口点。对于日常使用，建议使用这些入口点而不是测试网。
+您可以将设备或实例连接到其中一个或多个入口点，以访问它们物理连接的任何 Reticulum 网络。
+理想情况下，设置一个您自己的设备可以在本地访问的 Reticulum 传输节点，然后将该传输节点连接到几个公共入口点。这将提供有效的连接和冗余，以防其中任何一个出现故障。
+# These are community-provided public Reticulum entrypoints
+# served over TCP, and available over the public Internet.
+
+ [[Sydney RNS]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = sydney.reticulum.au
+ target_port = 4242
+
+ [[dismails TCP Interface]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.dismail.de
+ target_port = 7822
+
+ [[interloper node]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = intr.cx
+ target_port = 4242
+
+ [[noDNS1]] │
+ type = TCPClientInterface │
+ interface_enabled = true │
+ target_host = 202.61.243.41 │
+ target_port = 4965
+
+ [[The Outpost]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = theoutpost.life
+ target_port = 4242
+
+ [[Beleth RNS Hub]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = rns.beleth.net
+ target_port = 4242
+
+ [[Rocket Tech Hub]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.rocket-tech.net
+ target_port = 443
+
+ [[SparkN0de]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = aspark.uber.space
+ target_port = 44860
+
+ [[Tidudanka.com]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.tidudanka.com
+ target_port = 37500
+
+ [[quad4net tcp]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.quad4.io
+ target_port = 4242
+
+ [[nisa-node]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = nisa.cat
+ target_port = 4242
+
+ [[acehoss]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.acehoss.net
+ target_port = 4242
+
+ [[RNS Testnet StoppedCold]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = rns.stoppedcold.com
+ target_port = 4242
+
+ [[RNS COMSEC-RD]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 80.78.23.249
+ target_port = 4242
+
+ [[R-Net TCP]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = istanbul.reserve.network
+ target_port = 9034
+
+ [[RNS TCP Node Germany 001]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 202.61.243.41
+ target_port = 4965
+
+ [[RNS TCP Node Germany 002]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 193.26.158.230
+ target_port = 4965
+
+ [[Quortal TCP Node]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = reticulum.qortal.link
+ target_port = 4242
+
+ [[mobilefabrik TCP]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = phantom.mobilefabrik.com
+ target_port = 4242
+
+ [[g00n.cloud Hub]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = dfw.us.g00n.cloud
+ target_port = 6969
+
+ [[RNS_Transport_US-East]]
+ type = TCPClientInterface
+ interface_enabled = true
+ target_host = 45.77.109.86
+ target_port = 4965
+
+ [[rothbard_RNS_transport_ZA]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = rothbard.lab.networks.deavmi.assigned.network
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_ygg]]
+ type = TCPClientInterface
+ enabled = true
+ target_host = 200:73eb:2e4:14be:aac7:90b3:784b:71a3
+ target_port = 4242
+
+ [[rothbard_RNS_transport_ZA_i2p]]
+ type = I2PInterface
+ enabled = true
+ peers = guuahj7pyb6ksmjv2bqrjg4cs2wou6cor3ivsi6crntqbzsxnbna.b32.i2p
+下一个主题：阅读手册
+
+
diff --git a/docs/credits.html b/docs/credits.html
new file mode 100644
index 0000000..81aba99
--- /dev/null
+++ b/docs/credits.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Acknowledgements & Credits
+Reticulum can only exist because of the mountain of Open Source work it was built on top of, the contributions of everyone involved, and everyone that has supported the project through the years. To everyone who has helped, thank you so much.
+A number of other modules and projects are either part of, or used by Reticulum. Sincere thanks to the authors and contributors of the following projects:
+
+PyCA/cryptography , BSD License Pure-25519 by Brian Warner , MIT License Pysha2 by Thom Dixon , MIT License Python-AES by Or Gur Arie , MIT License Curve25519.py by Nicko van Someren , Public Domain I2Plib by Viktor Villainov PySerial by Chris Liechti, BSD License Netifaces by Alastair Houghton , MIT License Configobj by Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, BSD License Six by Benjamin Peterson , MIT License Umsgpack.py by Ivan A. Sergeev Python
+The protocol design and reference implementation for Reticulum was carried out between 2014 and 2022 by Mark Qvist.
+The Python reference implementation of Reticulum and this website is licensed under the Reticulum License . Please donate to support the continued development.
+
The Reticulum Protocol is the shared property of all people,
+Reticulum Network
+
Danksagungen & Credits
+Reticulum kann nur existieren, weil es auf einem Berg von Open-Source-Arbeiten aufbaut, weil alle Beteiligten dazu beigetragen haben und weil alle, die das Projekt über die Jahre hinweg unterstützt haben. Vielen Dank an alle, die geholfen haben.
+Eine Reihe anderer Module und Projekte sind entweder Teil von Reticulum oder werden von Reticulum verwendet. Ein herzliches Dankeschön an die Autoren und Mitwirkenden der folgenden Projekte:
+
+PyCA/cryptography , BSD License Pure-25519 by Brian Warner , MIT License Pysha2 by Thom Dixon , MIT License Python-AES by Or Gur Arie , MIT License Curve25519.py by Nicko van Someren , Public Domain I2Plib by Viktor Villainov PySerial by Chris Liechti, BSD License Netifaces by Alastair Houghton , MIT License Configobj by Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, BSD License Six by Benjamin Peterson , MIT License Umsgpack.py by Ivan A. Sergeev Python
+Das Protokolldesign und die Referenzimplementierung für Reticulum wurden zwischen 2014 und 2022 von Mark Qvist durchgeführt.
+Die Python Referenzimplementierung von Reticulum und diese Website ist lizenziert unter der Reticulum License . Bitte Spenden sie zur Unterstützung der weiteren Entwicklung.
+
Das Reticulum Protokoll ist das gemeinsame Eigentum aller Menschen,
+Reticulum Network
+
Agradecimientos y créditos
+Reticulum sólo puede existir gracias a la montaña de código abierto sobre la que se construyó, a las contribuciones de todos los implicados y a todos los que han apoyado el proyecto a lo largo de los años. A todos los que han ayudado, muchas gracias.
+Otros módulos y proyectos forman parte o son utilizados por Reticulum. Nuestro más sincero agradecimiento a los autores y colaboradores de los siguientes proyectos:
+
+PyCA/cryptography , Licencia BSD Pure-25519 por Brian Warner , Licencia MIT Pysha2 por Thom Dixon , Licencia MIT Python-AES por Or Gur Arie , Licencia MIT Curve25519.py por Nicko van Someren , Public Domain I2Plib por Viktor Villainov PySerial por Chris Liechti, Licencia BSD Netifaces por Alastair Houghton , Licencia MIT Configobj por Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, Licencia BSD Six por Benjamin Peterson , Licencia MIT Umsgpack.py por Ivan A. Sergeev Python
+El diseño del protocolo y la implementación de referencia para Reticulum se llevaron a cabo entre 2014 y 2022 por Mark Qvist.
+La referencia de la implementación de Reticulum en Python y este sitio están licenciados bajo la Licencia Reticulum . Por favor, dona para apoyar el desarrollo.
+
El Protocolo de Reticulum es propiedad compartida de todas las personas,
+Reticulum Network
+
謝辞とクレジット
+Reticulumは、その土台となるオープンソースの膨大な作業、関与するすべての人々の貢献、およびこれまでのプロジェクトへのサポートがあるために存在しています。手伝ってくれたすべての方々に心から感謝します。
+Reticulumには他にも多くのモジュールやプロジェクトが含まれており、またはそれらを使用しています。以下のプロジェクトの作者と寄与者に心から感謝します：
+
+Reticulumのプロトコルデザインおよびリファレンス実装は、2014年から2022年までMark Qvistによって実施されました。
+ReticulumのPythonリファレンス実装 およびこのウェブサイトは、Reticulumライセンス の下でライセンスされています。継続的な開発をサポートするために、寄付 をお願いします。
+
Reticulumプロトコルはすべての人々の共有財産です。
+Reticulum Network
+
Dankbetuigingen en referenties
+Reticulum kan alleen bestaan dankzij de berg Open Source-werk waarop het is gebouwd, de bijdragen van alle betrokkenen en iedereen die het project door de jaren heen heeft gesteund. Iedereen die geholpen heeft, hartelijk dank.
+Een aantal andere modules en projecten maken deel uit van of worden gebruikt door Reticulum. Oprechte dank aan de auteurs en medewerkers van de volgende projecten:
+
+PyCA/cryptography , BSD License Pure-25519 by Brian Warner , MIT License Pysha2 by Thom Dixon , MIT License Python-AES by Or Gur Arie , MIT License Curve25519.py by Nicko van Someren , Public Domain I2Plib by Viktor Villainov PySerial by Chris Liechti, BSD License Netifaces by Alastair Houghton , MIT License Configobj by Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, BSD License Six by Benjamin Peterson , MIT License Umsgpack.py by Ivan A. Sergeev Python
+Het protocolontwerp en de referentie-implementatie voor Reticulum werden tussen 2014 en 2022 uitgevoerd door Mark Qvist.
+De Python-referentie-implementatie van Reticulum en deze website zijn gelicentieerd onder de Reticulum License . Doneer om de voortdurende ontwikkeling te ondersteunen.
+
Het Reticulum Protocol is het gedeelde eigendom van alle mensen,
+Reticulum Network
+
Podziękowania & Zasługi
+Reticulum może istnieć tylko dzięki górze pracy Open Source, na której zostało zbudowane, dzięki wkładowi wszystkich zaangażowanych osób i wszystkich, którzy wspierali projekt przez lata. Wszystkim, którzy pomogli, bardzo dziękuję.
+Wiele innych modułów i projektów jest częścią lub jest wykorzystywanych przez Reticulum. Szczere podziękowania dla autorów i współtwórców następujących projektów:
+
+PyCA/cryptography , Licencja BSD Pure-25519 przez Brian Warner , Licencja MIT Pysha2 przez Thom Dixon , Licencja MIT Python-AES przez Or Gur Arie , Licencja MIT Curve25519.py przez Nicko van Someren , Domena Publiczna I2Plib przez Viktor Villainov PySerial przez Chris Liechti, Licencja BSD Netifaces przez Alastair Houghton , Licencja MIT Configobj przez Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, Licencja BSD Six przez Benjamin Peterson , Licencja MIT Umsgpack.py przez Ivan A. Sergeev Python
+Projekt protokołu i wdrożenie referencyjne dla Reticulum zostało zrealizowane w latach 2014-2022 przez Mark Qvist.
+Implementacja referencji dla języka Python oraz ta strona są opubliowanie na Licencji Reticulum . Proszę przekaż darowiznę , żeby wesprzeć dalszy rozwój projektu.
+
Protokół Reticulum jest wspólną własnością wszystkich ludzi,
+Reticulum Network
+
Reconhecimentos e Créditos
+Reticulum só foi possível graças a montanha de trabalho Código Aberto para o projeto, as contribuições de todos envolvidos e todos que apoiaram o projeto por esses anos. Para todos que ajudaram, muito obrigado.
+Uma lista de outros modelos e projetos são parte disso ou utilizado no Reticulum, Agradecimentos sinceros para os autores e contribuidores dos seguinte projetos:
+
+PyCA/cryptography , BSD License Pure-25519 por Brian Warner , MIT License Pysha2 por Thom Dixon , MIT License Python-AES por Or Gur Arie , MIT License Curve25519.py por Nicko van Someren , Public Domain I2Plib por Viktor Villainov PySerial por Chris Liechti, BSD License Netifaces por Alastair Houghton , MIT License Configobj por Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, BSD License Six por Benjamin Peterson , MIT License Umsgpack.py por Ivan A. Sergeev Python
+O design do protocolo e implementação de referência foram desenvolvidos entre 2014 e 2022 por Mark Qvist.
+A implementação Python referencial do Reticulum e seu site utilizam a licença Reticulum . Por favor considere uma doação para ajudar a continuar o projeto.
+
O Protocolo Reticulum é de propriedade de todas as pessoas,
+Reticulum Network
+
Teşekkürler & Saygılar
+Reticulum, üzerine inşa edildiği Açık Kaynak çalışmalarının dağının ve yıllar boyunca projeye destek olan herkesin katkıları sayesinde var olabilir. Yardım eden herkese çok teşekkür ederiz.
+Reticulum'a ait birçok diğer modül ve proje ya Reticulum'un bir parçasıdır ya da onun tarafından kullanılmaktadır. Aşağıdaki projelerin yazarlarına ve katkıda bulunanlarına içten teşekkürler:
+
+PyCA/cryptography , BSD Lisansı Pure-25519 by Brian Warner , MIT Lisansı Pysha2 by Thom Dixon , MIT Lisansı Python-AES by Or Gur Arie , MIT Lisansı Curve25519.py by Nicko van Someren , Genel Kamu Malı I2Plib by Viktor Villainov PySerial by Chris Liechti, BSD Lisansı Netifaces by Alastair Houghton , MIT Lisansı Configobj by Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, BSD Lisansı Six by Benjamin Peterson , MIT Lisansı Umsgpack.py by Ivan A. Sergeev Python
+Reticulum'un protokol tasarımı ve referans uygulaması, 2014 ile 2022 yılları arasında Mark Qvist tarafından gerçekleştirildi.
+Reticulum'un Python referans uygulaması ve bu web sitesi Reticulum Lisansı altında lisanslanmıştır. Lütfen devam eden geliştirmeyi desteklemek için bağış yapın.
+
Reticulum Protokolü, tüm insanların ortak mülkiyetidir,
+Reticulum Network
+
Подяки та кредити
+Reticulum може існувати тільки завдяки великій кількості відкритого програмного забезпечення, на якому він був побудований, внескам всіх, хто брав участь, і всім, хто підтримував проєкт протягом багатьох років. Усім, хто допомагав, велике спасибі.
+Чимало інших модулів та проєктів є частинами або використовуються Reticulum. Щира подяка авторам і контриб'юторам наступних проєктів:
+
+PyCA/cryptography , BSD License Pure-25519 від Brian Warner , MIT License Pysha2 від Thom Dixon , MIT License Python-AES від Or Gur Arie , MIT License Curve25519.py від Nicko van Someren , Public Domain I2Plib від Viktor Villainov PySerial від Chris Liechti, BSD License Netifaces від Alastair Houghton , MIT License Configobj від Michael Foord, Nicola Larosa, Rob Dennis та Eli Courtwright, BSD License Six від Benjamin Peterson , MIT License Umsgpack.py від Ivan A. Sergeev Python
+Проєктування протоколу та його референс-імплементація для Reticulum здійснювались з 2014 по 2022 рік Mark Qvist.
+Python референс-імплементація Reticulum та цей вебсайт ліцензовані за умовами Reticulum License . Будь ласка, пожертвуйте , щоб підтримати подальший розвиток.
+
Протокол Reticulum є спільною власністю всіх людей,
+Reticulum Network
+
致谢与署名
+Reticulum 站在巨人的肩膀上。没有前人移山般的开源工作、多位贡献者的参与以及各位对本项目的支持，Reticulum 就不可能存在。非常感谢每一位帮助过这个项目的人。
+Reticulum 用到了一系列模块与项目。在这里，对以下项目的作者与贡献者致以诚挚的感谢。
+
+PyCA/cryptography , BSD License Pure-25519 by Brian Warner , MIT License Pysha2 by Thom Dixon , MIT License Python-AES by Or Gur Arie , MIT License Curve25519.py by Nicko van Someren , Public Domain I2Plib by Viktor Villainov PySerial by Chris Liechti, BSD License Netifaces by Alastair Houghton , MIT License Configobj by Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, BSD License Six by Benjamin Peterson , MIT License Umsgpack.py by Ivan A. Sergeev Python
+Reticulum 的协议设计与参考实现是由 Mark Qvist 于 2014-2022 进行的。
+Reticulum 的 Python 参考实现 以及这个网站均为 Reticulum 授权 。若想支持 Reticulum 的开发，欢迎捐赠 。
+
Reticulum 协议是人类的共有财产
+
+
+
diff --git a/docs/crypto.html b/docs/crypto.html
new file mode 100644
index 0000000..75931d0
--- /dev/null
+++ b/docs/crypto.html
@@ -0,0 +1,37 @@
+
+
+
+
+Reticulum Network
+
Cryptographic Primitives
+Reticulum uses a simple suite of efficient, strong and well-tested cryptographic primitives, with widely available implementations that can be used both on general-purpose CPUs and on microcontrollers.
+One of the primary considerations for choosing this particular set of primitives is that they can be implemented safely with relatively few pitfalls, on practically all current computing platforms.
+The primitives listed here are authoritative . Anything claiming to be Reticulum, but not using these exact primitives is not Reticulum, and possibly an intentionally compromised or weakened clone. The utilised primitives are:
+
+Ed25519 for signatures
+X22519 for ECDH key exchanges
+HKDF for key derivation
+AES-256 in CBC mode
+HMAC-SHA256 for message authentication
+SHA-256
+SHA-512
+
+In the default installation configuration, the X25519, Ed25519 and AES-256-CBC primitives are provided by OpenSSL (via the PyCA/cryptography package). The hashing functions SHA-256 and SHA-512 are provided by the standard Python hashlib . The HKDF, HMAC, Token primitives, and the PKCS7 padding function are always provided by the following internal implementations:
+
+Reticulum also includes a complete implementation of all necessary primitives in pure Python. If OpenSSL & PyCA are not available on the system when Reticulum is started, Reticulum will instead use the internal pure-python primitives. A trivial consequence of this is performance, with the OpenSSL backend being much faster. The most important consequence however, is the potential loss of security by using primitives that has not seen the same amount of scrutiny, testing and review as those from OpenSSL.
+If you want to use the internal pure-python primitives, it is highly advisable that you have a good understanding of the risks that this pose, and make an informed decision on whether those risks are acceptable to you.
+Reticulum is relatively young software, and should be considered as such. While it has been built with cryptography best-practices very foremost in mind, it has not been externally security audited, and there could very well be privacy or security breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch.
+Next Topic: Acknowledgements & Credits
+
+
diff --git a/docs/crypto_de.html b/docs/crypto_de.html
new file mode 100644
index 0000000..b358438
--- /dev/null
+++ b/docs/crypto_de.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Kryptographische Primitive
+Reticulum verwendet eine einfache Reihe von effizienten, starken und modernen kryptographischen Primitiven mit weithin verfügbaren Implementierungen, die sowohl auf Allzweck-CPUs als auch auf Mikrocontrollern verwendet werden können. Die notwendigen Primitive sind:
+
+Ed25519 für Signaturen
+X22519 für ECDH Schlüsselaustausch
+HKDF für die Schlüsselableitung
+AES-256 im CBC modus
+HMAC-SHA256 für die Nachrichtenauthentifizierung
+SHA-256
+SHA-512
+
+In der Standard-Installationskonfiguration werden die Primitive X25519, Ed25519 und AES-256-CBC von OpenSSL (mit dem PyCA/cryptography Packet mitgebracht). Die Hashing-Funktionen SHA-256 und SHA-512 werden vom Standard-Python bereitgestellt hashlib . Die HKDF, HMAC, Token Primitive, und die PKCS7 Auffüllfunktion werden immer von den folgenden internen Implementierungen bereitgestellt:
+
+Reticulum enthält außerdem eine vollständige Implementierung aller erforderlichen Primitive in reinem Python. Wenn OpenSSL und PyCA beim Start von Reticulum nicht auf dem System verfügbar sind, verwendet Reticulum stattdessen die internen reinen Python-Primitive. Eine triviale Folge hiervon ist die Leistung, da das OpenSSL-Backend viel schneller ist. Die wichtigste Konsequenz ist jedoch der potenzielle Verlust an Sicherheit durch die Verwendung von Primitiven, die nicht in gleichem Maße wie die von OpenSSL untersucht, getestet und geprüft wurden.
+Wenn Sie die internen reinen Python-Primitive verwenden wollen, ist es sehr ratsam , dass Sie die damit verbundenen Risiken gut verstehen und eine fundierte Entscheidung darüber treffen, ob diese Risiken für Sie akzeptabel sind.
+Reticulum ist eine relativ junge Software, die als solche betrachtet werden sollte. Obwohl es unter Berücksichtigung der besten Kryptographie-Praktiken entwickelt wurde, ist es nicht extern sicherheitsgeprüft worden, und es könnte sehr wohl Fehler enthalten, die den Datenschutz oder die Sicherheit verletzen. Wenn Sie mithelfen oder ein Audit sponsern wollen, nehmen Sie bitte Kontakt auf.
+Nächstes Thema: Danksagungen & Credits
+
+
diff --git a/docs/crypto_es.html b/docs/crypto_es.html
new file mode 100644
index 0000000..3d26737
--- /dev/null
+++ b/docs/crypto_es.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Primitivas Criptográficas
+Reticulum utiliza un conjunto sencillo de primitivas criptográficas eficientes, potentes y modernas, con implementaciones ampliamente disponibles que pueden utilizarse tanto en CPU's de propósito general como en microcontroladores. Las primitivas necesarias son:
+
+Ed25519 para firmas
+X22519 para cambios de llaves ECDH
+HKDF para derivación de llaves
+AES-256 en modo CBC
+HMAC-SHA256 para autenticación de mensajes
+SHA-256
+SHA-512
+
+En la configuración de la instalación por defecto, las primitivas X25519, Ed25519 y AES-256-CBC son proporcionadas por OpenSSL (a través del paquete PyCA/cryptography ). Las funciones hash SHA-256 y SHA-512 las proporciona el paquete estándar de Python hashlib . Las primitivas HKDF, HMAC, Token y la función de padding PKCS7 son siempre proporcionadas por las siguientes implementaciones internas:
+
+Reticulum también incluye una implementación completa de todas las primitivas necesarias en Python puro. Si OpenSSL y PyCA no están disponibles en el sistema cuando se inicia Reticulum, éste utilizará en su lugar las primitivas internas de Python puro. Una consecuencia trivial de esto es el rendimiento, ya que el backend de OpenSSL es mucho más rápido. Sin embargo, la consecuencia más importante es la pérdida potencial de seguridad al utilizar primitivas que no han sido sometidas a la misma cantidad de escrutinio, pruebas y revisiones que las de OpenSSL.
+Si desea utilizar las primitivas internas de Python puro, es altamente recomendable que usted tenga una buena comprensión de los riesgos que esto plantea, y tome una decisión informada sobre si esos riesgos son aceptables para usted.
+Reticulum es un software relativamente joven y debe ser considerado como tal. Aunque se ha construido teniendo muy presentes las mejores prácticas criptográficas, no ha sido auditado externamente en materia de seguridad y es muy posible que haya errores que rompan la privacidad o la seguridad. Si queres ayudar o patrocinar una auditoría, ponete en contacto con nosotros.
+Siguiente tema: Agradecimientos y créditos
+
+
diff --git a/docs/crypto_jp.html b/docs/crypto_jp.html
new file mode 100644
index 0000000..5f40a84
--- /dev/null
+++ b/docs/crypto_jp.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
暗号プリミティブ
+Reticulumは、効率的で強力かつ現代的な暗号プリミティブのシンプルなスイートを使用しています。これらは、一般的な用途のCPUおよびマイクロコントローラーの両方で使用できる広く利用可能な実装を備えています。必要なプリミティブには以下が含まれます：
+
+署名用のEd25519
+ECDH鍵交換用のX22519
+鍵導出用のHKDF
+CBCモードでのAES-256
+メッセージ認証用のHMAC-SHA256
+SHA-256
+SHA-512
+
+デフォルトのインストール構成では、X25519、Ed25519、およびAES-256-CBCのプリミティブはOpenSSL （PyCA/cryptography パッケージを介して）によって提供されます。ハッシュ関数SHA-256およびSHA-512は、標準のPython hashlib によって提供されています。HKDF、HMAC、Tokenプリミティブ、およびPKCS7パディング関数は、常に次の内部実装によって提供されます：
+
+Reticulumには、すべての必要なプリミティブの純粋なPythonによる完全な実装も含まれています。Reticulumが開始されるときにシステムにOpenSSL＆PyCAが利用できない場合、Reticulumは代わりに内部の純粋なPythonプリミティブを使用します。これの取り決めの一因はパフォーマンスであり、OpenSSLバックエンドが非常に速いことです。しかし、最も重要な結果は、OpenSSLと同じくらいの精査、テスト、およびレビューを受けていないプリミティブを使用することによるセキュリティの潜在的な損失です。
+内部の純粋なPythonプリミティブを使用したい場合は、このリスクが許容できるかどうかを検討し、よく理解した上で情報を得ることが強くお勧め されます。
+Reticulumは比較的新しいソフトウェアであり、それに準じて考えるべきです。暗号化のベストプラクティスを非常に重視して構築されていますが、外部からのセキュリティ監査はまだ行われておらず、プライバシーやセキュリティを崩壊させる可能性があります。協力したり、監査をスポンサーしたりしたい場合は、どうぞお知らせください。
+次のトピック: 謝辞とクレジット
+
+
diff --git a/docs/crypto_nl.html b/docs/crypto_nl.html
new file mode 100644
index 0000000..a3954a6
--- /dev/null
+++ b/docs/crypto_nl.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Cryptografische primitieven
+Reticulum maakt gebruik van een eenvoudige reeks efficiënte, sterke en moderne cryptografische primitieven, met algemeen beschikbare implementaties die zowel op CPU's voor algemene doeleinden als op microcontrollers kunnen worden gebruikt. De noodzakelijke primitieven zijn:
+
+Ed25519 voor handtekeningen
+X22519 voor ECDH-sleuteluitwisselingen
+HKDF voor sleutelafleiding
+AES-256 in CBC-modus
+HMAC-SHA256 voor berichtauthenticatie
+SHA-256
+SHA-512
+
+In de standaard installatieconfiguratie worden de primitieven X25519, Ed25519 en AES-256-CBC geleverd door OpenSSL (via het PyCA/cryptography pakket). De hashfuncties SHA-256 and SHA-512 worden geleverd door de standaard Python hashlib . De HKDF, HMAC, Token primitieven en de PKCS7 opvullingsfunctie worden altijd geleverd door de volgende interne implementaties:
+
+Reticulum bevat ook een volledige implementatie van alle benodigde primitieven in pure Python. Als OpenSSL en PyCA niet beschikbaar zijn op het systeem wanneer Reticulum wordt gestart, zal Reticulum in plaats daarvan de interne pure-python-primitieven gebruiken. Een triviaal gevolg hiervan zijn de prestaties, waarbij de OpenSSL-backend veel sneller is. Het belangrijkste gevolg is echter het potentiële verlies aan veiligheid door het gebruik van primitieven die niet dezelfde hoeveelheid onderzoek, testen en beoordeling hebben ondergaan als die van OpenSSL.
+Als u de interne pure Python-primitieven wilt gebruiken, is het zeer aan te raden dat u een goed inzicht heeft in de risico's die dit met zich meebrengt, en een weloverwogen beslissing neemt of deze risico's voor u acceptabel zijn.
+Reticulum is relatief jonge software en moet als zodanig worden beschouwd. Hoewel het is gebouwd met de best practices op het gebied van cryptografie in het achterhoofd, is er geen externe beveiligingsaudit uitgevoerd en kunnen er bugs in zitten die de privacy of de beveiliging schenden. Als u wilt helpen of een audit wilt sponsoren, neem dan contact met ons op.
+Volgend onderwerp: dankbetuigingen en referenties
+
+
diff --git a/docs/crypto_pl.html b/docs/crypto_pl.html
new file mode 100644
index 0000000..55120f6
--- /dev/null
+++ b/docs/crypto_pl.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Prymitywy kryptograficzne
+Reticulum wykorzystuje prosty zestaw wydajnych, silnych i nowoczesnych prymitywów kryptograficznych, z szeroko dostępnymi implementacjami, które mogą być używane zarówno na procesorach ogólnego przeznaczenia, jak i na mikrokontrolerach. Niezbędne prymitywy to:
+
+Ed25519 dla sygnatur
+X22519 dla wymiany kluczy ECDH
+HKDF dla wyodrębnienia klucza
+AES-256 w trybie CBC
+HMAC-SHA256 dla uwierzytelnienia wiadomości
+SHA-256
+SHA-512
+
+W domyślnej konfiguracji instalacji, prymitywy X25519, Ed25519 i AES-256-CBC są dostarczone przez OpenSSL (przez pakiet PyCA/cryptography ). Funkcja hashu SHA-256 i SHA-512 są dostarczone przez standard Pythona hashlib . Prymitywy HKDF, HMAC, Token i funkcja padding PKCS7 są zawsze dostarczane przez następujące wewnętrzne implementacje:
+
+Reticulum zawiera również kompletną implementację wszystkich niezbędnych prymitywów w czystym Pythonie. Jeśli OpenSSL i PyCA nie są dostępne w systemie podczas uruchamiania Reticulum, Reticulum użyje wewnętrznych prymitywów w czystym Pythonie. Trywialną konsekwencją tego jest wydajność, backend OpenSSL jest znacznie szybszy. Najważniejszą konsekwencją jest jednak potencjalna utrata bezpieczeństwa poprzez użycie prymitywów, które nie zostały poddane takiej samej analizie, testom i przeglądom jak te z OpenSSL.
+Jeśli chcesz używać wewnętrznych czystych prymitywów pythona, jest bardzo wskazane , abyś dobrze rozumiał ryzyko, jakie to stwarza, i podjął świadomą decyzję, czy to ryzyko jest dla ciebie do przyjęcia.
+Reticulum jest stosunkowo młodym oprogramowaniem i powinno być traktowane jako takie. Chociaż zostało zbudowane z myślą o najlepszych praktykach kryptograficznych, nie zostało poddane zewnętrznemu audytowi bezpieczeństwa i bardzo możliwe, że zawiera błędy naruszające prywatność lub bezpieczeństwo. Jeśli chcesz pomóc lub zasponsorować audyt, skontaktuj się ze mną.
+Next Topic: Podziękowania & Zasługi
+
+
diff --git a/docs/crypto_pt-br.html b/docs/crypto_pt-br.html
new file mode 100644
index 0000000..7e5b1be
--- /dev/null
+++ b/docs/crypto_pt-br.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Primitivos Criptográficos
+Reticulum utiliza uma suíte simples de primitivos criptográficos modernos, fortes e eficientes, com diversas implementações disponíveis que pode ser utilizados tanto em CPUs convencionais como microcontroladores. Os primitivos necessários são:
+
+Ed25519 para assinaturas
+X22519 para trocas de chave ECDH
+HKDF para derivação de chaves
+AES-256 em modo CBC
+HMAC-SHA256 para autenticação de mensagem
+SHA-256
+SHA-512
+
+Na configuração de instalação padrão, os primitivos X25519, Ed25519 e AES-256-CBC são fornecidos pela OpenSSL (pelo pacote PyCA/cryptography ). As funções de hash SHA-256 e SHA-512 são fornecidas pela biblioteca Python hashlib . Os primitivos HKDF, HMAC, Token, e a função de preenchimento PKCS7 são sempre fornecidas pelas seguintes implementações internas:
+
+Reticulum também incluí a implementação completa de todos os primitivos necessários em Python puro. Se o OpenSSL & PyCA não estão disponíveis no sistema que o Reticulum é iniciado, Reticulum vai utilizar os primitivos internos. A consequência trivial disso é o desempenho, com a biblioteca OpenSSL sendo mais rápida. A consequência mais importante no entanto, é a potencial perda de segurança por utilizar primitivos que não possuem o mesmo nível de suporte, teste e revisão que o OpenSSL.
+Se você quer utilizar primitivos internos em Python, é aconselhável que você entenda os riscos envolvidos, e tome uma decisão informada conforme os ricos são aceitáveis para você.
+Reticulum é um software relativamente jovem, e deve ser considerado como tal. Enquanto ele é desenvolvido com as melhores práticas de criptografia em mente, ainda não foi auditado externamente, e pode haver bugs para segurança e privacidade. Se você quer ajudar, ou patrocinar uma auditoria, nos informe.
+Próxima Página: Agradecimentos & Créditos
+
+
diff --git a/docs/crypto_tr.html b/docs/crypto_tr.html
new file mode 100644
index 0000000..036b375
--- /dev/null
+++ b/docs/crypto_tr.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Şifreleme Temelleri
+Reticulum, genel amaçlı CPU'lerde ve mikrodenetleyicilerde kullanılabilen yaygın olarak bulunan uygulamalara sahip, etkili, güçlü ve modern bir şifreleme temel paketi kullanır. Gerekli temel öğeler şunlardır:
+
+Dijital İmzalar için Ed25519
+ECDH anahtar değişimleri için X22519
+Anahtar oluşturmak için HKDF
+CBC modunda AES-256
+Mesaj doğrulama için HMAC-SHA256
+SHA-256
+SHA-512
+
+Varsayılan kurulum yapılandırmasında, X25519, Ed25519 ve AES-256-CBC temel öğeleri, OpenSSL (aracılığıyla PyCA/cryptography paketi üzerinden) tarafından sağlanır. Karma fonksiyonları SHA-256 ve SHA-512, standart Python hashlib tarafından sağlanır. HKDF, HMAC, Token temel öğeleri ve PKCS7 dolgu fonksiyonu her zaman şu içsel uygulamalar tarafından sağlanır:
+
+Reticulum ayrıca tüm gerekli temel öğelerin saf Python'da tam bir uygulamasını içerir. Reticulum başlatıldığında sistemde OpenSSL ve PyCA kullanılamıyorsa, Reticulum bunun yerine içsel saf Python temel öğelerini kullanacaktır. Bu durumun basit bir sonucu performanstır, çünkü OpenSSL çok daha hızlıdır. Ancak, en önemli sonuç, OpenSSL'den daha az inceleme, test ve gözden geçirme görmemiş temellerin kullanılmasıyla güvenlik kaybının potansiyelidir.
+Eğer içsel saf Python temel öğelerini kullanmak istiyorsanız, bunun getirdiği riskleri iyi anlamanız ve bu risklerin sizin için kabul edilebilir olup olmadığına dair bilinçli bir karar vermeniz son derece tavsiye edilir .
+Reticulum nispeten genç bir yazılımdır ve buna göre değerlendirilmelidir. Kriptografi en iyi uygulamaları gözetilerek inşa edilmiş olmasına rağmen, dış güvenlik denetimi yapılmamıştır ve gizlilik veya güvenlik ihlali yapabilecek hatalar olabilir. Yardımcı olmak veya maddi açıdan bir güvenlik denetimi yapılmasını desteklemek istiyorsanız, lütfen iletişime geçin.
+Sonraki Konu: Teşekkürler ve Saygılar
+
+
diff --git a/docs/crypto_uk.html b/docs/crypto_uk.html
new file mode 100644
index 0000000..61f61b5
--- /dev/null
+++ b/docs/crypto_uk.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Криптографічні примітиви
+Reticulum використовує простий набір ефективних, надійних і сучасних криптографічних примітивів, з широко доступними імплементаціями, які можна використовувати як на загальновживаних процесорах, так і на мікроконтролерах. Необхідні примітиви:
+
+Ed25519 для підписів
+X22519 для ECDH обміну ключами
+HKDF для виведення ключів
+AES-256 у режимі CBC
+HMAC-SHA256 для аутентифікації повідомлень
+SHA-256
+SHA-512
+
+У стандартній конфігурації установки примітиви X25519, Ed25519 і AES-256-CBC надаються OpenSSL (через пакет PyCA/cryptography ). Функції хешування SHA-256 і SHA-512 надаються стандартною бібліотекою Python hashlib . Примітиви HKDF, HMAC, Token, а також функція паддінгу PKCS7 завжди надаються наступними внутрішніми імплементаціями:
+
+Reticulum також включає повну імплементацію всіх необхідних примітивів на чистому Python. Якщо OpenSSL і PyCA недоступні на системі під час запуску Reticulum, то замість них будуть використані внутрішні чисто-python примітиви. Легким наслідком цього є продуктивність, причому бекенд OpenSSL працює набагато швидше. Однак найважливіший наслідок полягає в потенційній втраті безпеки через використання примітивів, які не були піддані такій самій перевірці, тестуванню та огляду, як ті, що надаються OpenSSL.
+Якщо ви хочете використовувати внутрішні чисто-python примітиви, вкрай рекомендується добре розуміти ризики, які вони несуть, і приймати обґрунтоване рішення щодо того, чи є ці ризики для вас прийнятними.
+Reticulum — це відносно молода програма, і її слід розглядати саме як таку. Хоча вона була створена з урахуванням найкращих практик криптографії, вона не проходила зовнішнього аудиту безпеки, і цілком ймовірно, що існують помилки, які можуть зламати конфіденційність або безпеку. Якщо ви хочете допомогти або спонсорувати аудит, будь ласка, зв'яжіться з нами.
+Наступна тема: Подяки та кредити
+
+
diff --git a/docs/crypto_zh-cn.html b/docs/crypto_zh-cn.html
new file mode 100644
index 0000000..aa71308
--- /dev/null
+++ b/docs/crypto_zh-cn.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
密码学原语
+Reticulum 使用了一系列高效、健壮、现代的密码学原语(cryptographic primitives)。它们都有着被广泛使用的现成的实现，且在一般的 CPU 或是微控制器上都可以运行。这些必要的原语是：
+
+Ed25519 用于签名
+X22519 用于 ECDH 密钥交换
+HKDF 用于密钥派生
+AES-256 CBC 模式
+HMAC-SHA256 用于消息认证
+SHA-256
+SHA-512
+
+在默认安装下，X25519、Ed25519 和 AES-256-CBC 都由 OpenSSL 提供(通过 PyCA/cryptography )。散列函数 SHA-256 和 SHA-512 由 Python 标准库 hashlib 提供。HKDF、HMAC、Token 原语与 PKCS7 填充函数总是由以下内部实现提供：
+
+Reticulum 还包含了所有所需密码学原语的纯 Python 实现。如果 OpenSSL 和 PyCA 在系统上不可用的话，Reticulum 会使用自带的纯 Python 实现。这时，最明显的影响是速度——OpenSSL作为后端会快的多 。然而最严重的后果可能是使用这些实现带来的安全性问题，毕竟它们没有经受过与 OpenSSL 同级别的安全审查、测试与评估。
+如果你想使用自带的纯 Python 实现，我十分建议你先充分了解可能的风险，并仔细思考这些风险是否适用于你。
+Reticulum 目前还十分年轻，这一点必须牢记于心。虽说 Reticulum 的开发尽量遵守了密码学的最佳实践，但它还没有 受过外部的安全审计，而且很可能会有破坏隐私或是安全性的 Bug。如果你愿意帮忙，或是愿意赞助进行安全审计，欢迎联系开发者。
+下一个主题: 致谢与署名
+
+
diff --git a/docs/css/water.css b/docs/css/water.css
new file mode 100644
index 0000000..96aba7b
--- /dev/null
+++ b/docs/css/water.css
@@ -0,0 +1,1710 @@
+/**
+ * Automatic version:
+ * Uses light theme by default but switches to dark theme
+ * if a system-wide theme preference is set on the user's device.
+ */
+
+:root {
+ --background-body: #fff;
+ --background: #efefef;
+ --background-alt: #f7f7f7;
+ --selection: #9e9e9e;
+ --text-main: #363636;
+ --text-bright: #000;
+ --text-muted: #70777f;
+ --links: #0076d1;
+ --focus: #0096bfab;
+ --border: #dbdbdb;
+ --code: #000;
+ --animation-duration: 0.1s;
+ --button-base: #d0cfcf;
+ --button-hover: #9b9b9b;
+ --scrollbar-thumb: rgb(170, 170, 170);
+ --scrollbar-thumb-hover: var(--button-hover);
+ --form-placeholder: #949494;
+ --form-text: #1d1d1d;
+ --variable: #39a33c;
+ --highlight: #ff0;
+ --select-arrow: url("data:image/svg+xml;charset=utf-8,%3C?xml version='1.0' encoding='utf-8'?%3E %3Csvg version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' height='62.5' width='116.9' fill='%23161f27'%3E %3Cpath d='M115.3,1.6 C113.7,0 111.1,0 109.5,1.6 L58.5,52.7 L7.4,1.6 C5.8,0 3.2,0 1.6,1.6 C0,3.2 0,5.8 1.6,7.4 L55.5,61.3 C56.3,62.1 57.3,62.5 58.4,62.5 C59.4,62.5 60.5,62.1 61.3,61.3 L115.2,7.4 C116.9,5.8 116.9,3.2 115.3,1.6Z'/%3E %3C/svg%3E");
+}
+
+body {
+ font-size: 1.1em;
+}
+
+div.top_menu {
+ font-size: 1em;
+}
+
+div.lang_menu {
+ margin-bottom: 0.35em;
+}
+
+@media (prefers-color-scheme: dark) {
+:root {
+ --background-body: #202b38;
+ --background: #161f27;
+ --background-alt: #1a242f;
+ --selection: #1c76c5;
+ --text-main: #dbdbdb;
+ --text-bright: #fff;
+ --text-muted: #a9b1ba;
+ --links: #41adff;
+ --focus: #0096bfab;
+ --border: #526980;
+ --code: #ffbe85;
+ --animation-duration: 0.1s;
+ --button-base: #0c151c;
+ --button-hover: #040a0f;
+ --scrollbar-thumb: var(--button-hover);
+ --scrollbar-thumb-hover: rgb(0, 0, 0);
+ --form-placeholder: #a9a9a9;
+ --form-text: #fff;
+ --variable: #d941e2;
+ --highlight: #efdb43;
+ --select-arrow: url("data:image/svg+xml;charset=utf-8,%3C?xml version='1.0' encoding='utf-8'?%3E %3Csvg version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' height='62.5' width='116.9' fill='%23efefef'%3E %3Cpath d='M115.3,1.6 C113.7,0 111.1,0 109.5,1.6 L58.5,52.7 L7.4,1.6 C5.8,0 3.2,0 1.6,1.6 C0,3.2 0,5.8 1.6,7.4 L55.5,61.3 C56.3,62.1 57.3,62.5 58.4,62.5 C59.4,62.5 60.5,62.1 61.3,61.3 L115.2,7.4 C116.9,5.8 116.9,3.2 115.3,1.6Z'/%3E %3C/svg%3E");
+}
+}
+
+html {
+ scrollbar-color: rgb(170, 170, 170) #fff;
+ scrollbar-color: var(--scrollbar-thumb) var(--background-body);
+ scrollbar-width: thin;
+ text-size-adjust: none;
+ -webkit-text-size-adjust: none;
+ -moz-text-size-adjust: none;
+ -ms-text-size-adjust: none;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ html {
+ scrollbar-color: #040a0f #202b38;
+ scrollbar-color: var(--scrollbar-thumb) var(--background-body);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ html {
+ scrollbar-color: #040a0f #202b38;
+ scrollbar-color: var(--scrollbar-thumb) var(--background-body);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ html {
+ scrollbar-color: #040a0f #202b38;
+ scrollbar-color: var(--scrollbar-thumb) var(--background-body);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ html {
+ scrollbar-color: #040a0f #202b38;
+ scrollbar-color: var(--scrollbar-thumb) var(--background-body);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ html {
+ scrollbar-color: #040a0f #202b38;
+ scrollbar-color: var(--scrollbar-thumb) var(--background-body);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ html {
+ scrollbar-color: #040a0f #202b38;
+ scrollbar-color: var(--scrollbar-thumb) var(--background-body);
+ }
+}
+
+body {
+ font-family: system-ui, -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', 'Oxygen', 'Ubuntu', 'Cantarell', 'Fira Sans', 'Droid Sans', 'Helvetica Neue', 'Segoe UI Emoji', 'Apple Color Emoji', 'Noto Color Emoji', sans-serif;
+ line-height: 1.4;
+ max-width: 880px;
+ margin: 20px auto;
+ padding: 0 10px;
+ word-wrap: break-word;
+ color: #363636;
+ color: var(--text-main);
+ background: #fff;
+ background: var(--background-body);
+ text-rendering: optimizeLegibility;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ body {
+ background: #202b38;
+ background: var(--background-body);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ body {
+ color: #dbdbdb;
+ color: var(--text-main);
+ }
+}
+
+li {
+ margin-top: 0.5em;
+ margin-bottom: 0.5em;
+}
+
+button {
+ transition:
+ background-color 0.1s linear,
+ border-color 0.1s linear,
+ color 0.1s linear,
+ box-shadow 0.1s linear,
+ transform 0.1s ease;
+ transition:
+ background-color var(--animation-duration) linear,
+ border-color var(--animation-duration) linear,
+ color var(--animation-duration) linear,
+ box-shadow var(--animation-duration) linear,
+ transform var(--animation-duration) ease;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ button {
+ transition:
+ background-color 0.1s linear,
+ border-color 0.1s linear,
+ color 0.1s linear,
+ box-shadow 0.1s linear,
+ transform 0.1s ease;
+ transition:
+ background-color var(--animation-duration) linear,
+ border-color var(--animation-duration) linear,
+ color var(--animation-duration) linear,
+ box-shadow var(--animation-duration) linear,
+ transform var(--animation-duration) ease;
+ }
+}
+
+input {
+ transition:
+ background-color 0.1s linear,
+ border-color 0.1s linear,
+ color 0.1s linear,
+ box-shadow 0.1s linear,
+ transform 0.1s ease;
+ transition:
+ background-color var(--animation-duration) linear,
+ border-color var(--animation-duration) linear,
+ color var(--animation-duration) linear,
+ box-shadow var(--animation-duration) linear,
+ transform var(--animation-duration) ease;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input {
+ transition:
+ background-color 0.1s linear,
+ border-color 0.1s linear,
+ color 0.1s linear,
+ box-shadow 0.1s linear,
+ transform 0.1s ease;
+ transition:
+ background-color var(--animation-duration) linear,
+ border-color var(--animation-duration) linear,
+ color var(--animation-duration) linear,
+ box-shadow var(--animation-duration) linear,
+ transform var(--animation-duration) ease;
+ }
+}
+
+textarea {
+ transition:
+ background-color 0.1s linear,
+ border-color 0.1s linear,
+ color 0.1s linear,
+ box-shadow 0.1s linear,
+ transform 0.1s ease;
+ transition:
+ background-color var(--animation-duration) linear,
+ border-color var(--animation-duration) linear,
+ color var(--animation-duration) linear,
+ box-shadow var(--animation-duration) linear,
+ transform var(--animation-duration) ease;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ textarea {
+ transition:
+ background-color 0.1s linear,
+ border-color 0.1s linear,
+ color 0.1s linear,
+ box-shadow 0.1s linear,
+ transform 0.1s ease;
+ transition:
+ background-color var(--animation-duration) linear,
+ border-color var(--animation-duration) linear,
+ color var(--animation-duration) linear,
+ box-shadow var(--animation-duration) linear,
+ transform var(--animation-duration) ease;
+ }
+}
+
+h1 {
+ font-size: 1.85em;
+ margin-top: 0;
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6 {
+ margin-bottom: 12px;
+ margin-top: 24px;
+}
+
+h1 {
+ color: #000;
+ color: var(--text-bright);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ h1 {
+ color: #fff;
+ color: var(--text-bright);
+ }
+}
+
+h2 {
+ color: #000;
+ color: var(--text-bright);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ h2 {
+ color: #fff;
+ color: var(--text-bright);
+ }
+}
+
+h3 {
+ color: #000;
+ color: var(--text-bright);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ h3 {
+ color: #fff;
+ color: var(--text-bright);
+ }
+}
+
+h4 {
+ color: #000;
+ color: var(--text-bright);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ h4 {
+ color: #fff;
+ color: var(--text-bright);
+ }
+}
+
+h5 {
+ color: #000;
+ color: var(--text-bright);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ h5 {
+ color: #fff;
+ color: var(--text-bright);
+ }
+}
+
+h6 {
+ color: #000;
+ color: var(--text-bright);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ h6 {
+ color: #fff;
+ color: var(--text-bright);
+ }
+}
+
+strong {
+ color: #000;
+ color: var(--text-bright);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ strong {
+ color: #fff;
+ color: var(--text-bright);
+ }
+}
+
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+b,
+strong,
+th {
+ font-weight: 600;
+}
+
+q::before {
+ content: none;
+}
+
+q::after {
+ content: none;
+}
+
+blockquote {
+ border-left: 4px solid #0096bfab;
+ border-left: 4px solid var(--focus);
+ margin: 1.5em 0;
+ padding: 0.5em 1em;
+ font-style: italic;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ blockquote {
+ border-left: 4px solid #0096bfab;
+ border-left: 4px solid var(--focus);
+ }
+}
+
+q {
+ border-left: 4px solid #0096bfab;
+ border-left: 4px solid var(--focus);
+ margin: 1.5em 0;
+ padding: 0.5em 1em;
+ font-style: italic;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ q {
+ border-left: 4px solid #0096bfab;
+ border-left: 4px solid var(--focus);
+ }
+}
+
+blockquote > footer {
+ font-style: normal;
+ border: 0;
+}
+
+blockquote cite {
+ font-style: normal;
+}
+
+address {
+ font-style: normal;
+}
+
+a[href^='mailto\:']::before {
+ content: '📧 ';
+}
+
+a[href^='tel\:']::before {
+ content: '📞 ';
+}
+
+a[href^='sms\:']::before {
+ content: '💬 ';
+}
+
+mark {
+ background-color: #ff0;
+ background-color: var(--highlight);
+ border-radius: 2px;
+ padding: 0 2px 0 2px;
+ color: #000;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ mark {
+ background-color: #efdb43;
+ background-color: var(--highlight);
+ }
+}
+
+a > code,
+a > strong {
+ color: inherit;
+}
+
+button,
+select,
+input[type='submit'],
+input[type='reset'],
+input[type='button'],
+input[type='checkbox'],
+input[type='range'],
+input[type='radio'] {
+ cursor: pointer;
+}
+
+input,
+select {
+ display: block;
+}
+
+[type='checkbox'],
+[type='radio'] {
+ display: initial;
+}
+
+input {
+ color: #1d1d1d;
+ color: var(--form-text);
+ background-color: #efefef;
+ background-color: var(--background);
+ font-family: inherit;
+ font-size: inherit;
+ margin-right: 6px;
+ margin-bottom: 6px;
+ padding: 10px;
+ border: none;
+ border-radius: 6px;
+ outline: none;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input {
+ background-color: #161f27;
+ background-color: var(--background);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input {
+ color: #fff;
+ color: var(--form-text);
+ }
+}
+
+button {
+ color: #1d1d1d;
+ color: var(--form-text);
+ background-color: #efefef;
+ background-color: var(--background);
+ font-family: inherit;
+ font-size: inherit;
+ margin-right: 6px;
+ margin-bottom: 6px;
+ padding: 10px;
+ border: none;
+ border-radius: 6px;
+ outline: none;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ button {
+ background-color: #161f27;
+ background-color: var(--background);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ button {
+ color: #fff;
+ color: var(--form-text);
+ }
+}
+
+textarea {
+ color: #1d1d1d;
+ color: var(--form-text);
+ background-color: #efefef;
+ background-color: var(--background);
+ font-family: inherit;
+ font-size: inherit;
+ margin-right: 6px;
+ margin-bottom: 6px;
+ padding: 10px;
+ border: none;
+ border-radius: 6px;
+ outline: none;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ textarea {
+ background-color: #161f27;
+ background-color: var(--background);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ textarea {
+ color: #fff;
+ color: var(--form-text);
+ }
+}
+
+select {
+ color: #1d1d1d;
+ color: var(--form-text);
+ background-color: #efefef;
+ background-color: var(--background);
+ font-family: inherit;
+ font-size: inherit;
+ margin-right: 6px;
+ margin-bottom: 6px;
+ padding: 10px;
+ border: none;
+ border-radius: 6px;
+ outline: none;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ select {
+ background-color: #161f27;
+ background-color: var(--background);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ select {
+ color: #fff;
+ color: var(--form-text);
+ }
+}
+
+button {
+ background-color: #d0cfcf;
+ background-color: var(--button-base);
+ padding-right: 30px;
+ padding-left: 30px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ button {
+ background-color: #0c151c;
+ background-color: var(--button-base);
+ }
+}
+
+input[type='submit'] {
+ background-color: #d0cfcf;
+ background-color: var(--button-base);
+ padding-right: 30px;
+ padding-left: 30px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='submit'] {
+ background-color: #0c151c;
+ background-color: var(--button-base);
+ }
+}
+
+input[type='reset'] {
+ background-color: #d0cfcf;
+ background-color: var(--button-base);
+ padding-right: 30px;
+ padding-left: 30px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='reset'] {
+ background-color: #0c151c;
+ background-color: var(--button-base);
+ }
+}
+
+input[type='button'] {
+ background-color: #d0cfcf;
+ background-color: var(--button-base);
+ padding-right: 30px;
+ padding-left: 30px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='button'] {
+ background-color: #0c151c;
+ background-color: var(--button-base);
+ }
+}
+
+button:hover {
+ background: #9b9b9b;
+ background: var(--button-hover);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ button:hover {
+ background: #040a0f;
+ background: var(--button-hover);
+ }
+}
+
+input[type='submit']:hover {
+ background: #9b9b9b;
+ background: var(--button-hover);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='submit']:hover {
+ background: #040a0f;
+ background: var(--button-hover);
+ }
+}
+
+input[type='reset']:hover {
+ background: #9b9b9b;
+ background: var(--button-hover);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='reset']:hover {
+ background: #040a0f;
+ background: var(--button-hover);
+ }
+}
+
+input[type='button']:hover {
+ background: #9b9b9b;
+ background: var(--button-hover);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='button']:hover {
+ background: #040a0f;
+ background: var(--button-hover);
+ }
+}
+
+input[type='color'] {
+ min-height: 2rem;
+ padding: 8px;
+ cursor: pointer;
+}
+
+input[type='checkbox'],
+input[type='radio'] {
+ height: 1em;
+ width: 1em;
+}
+
+input[type='radio'] {
+ border-radius: 100%;
+}
+
+input {
+ vertical-align: top;
+}
+
+label {
+ vertical-align: middle;
+ margin-bottom: 4px;
+ display: inline-block;
+}
+
+input:not([type='checkbox']):not([type='radio']),
+input[type='range'],
+select,
+button,
+textarea {
+ -webkit-appearance: none;
+}
+
+textarea {
+ display: block;
+ margin-right: 0;
+ box-sizing: border-box;
+ resize: vertical;
+}
+
+textarea:not([cols]) {
+ width: 100%;
+}
+
+textarea:not([rows]) {
+ min-height: 40px;
+ height: 140px;
+}
+
+select {
+ background: #efefef url("data:image/svg+xml;charset=utf-8,%3C?xml version='1.0' encoding='utf-8'?%3E %3Csvg version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' height='62.5' width='116.9' fill='%23161f27'%3E %3Cpath d='M115.3,1.6 C113.7,0 111.1,0 109.5,1.6 L58.5,52.7 L7.4,1.6 C5.8,0 3.2,0 1.6,1.6 C0,3.2 0,5.8 1.6,7.4 L55.5,61.3 C56.3,62.1 57.3,62.5 58.4,62.5 C59.4,62.5 60.5,62.1 61.3,61.3 L115.2,7.4 C116.9,5.8 116.9,3.2 115.3,1.6Z'/%3E %3C/svg%3E") calc(100% - 12px) 50% / 12px no-repeat;
+ background: var(--background) var(--select-arrow) calc(100% - 12px) 50% / 12px no-repeat;
+ padding-right: 35px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ select {
+ background: #161f27 url("data:image/svg+xml;charset=utf-8,%3C?xml version='1.0' encoding='utf-8'?%3E %3Csvg version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' height='62.5' width='116.9' fill='%23efefef'%3E %3Cpath d='M115.3,1.6 C113.7,0 111.1,0 109.5,1.6 L58.5,52.7 L7.4,1.6 C5.8,0 3.2,0 1.6,1.6 C0,3.2 0,5.8 1.6,7.4 L55.5,61.3 C56.3,62.1 57.3,62.5 58.4,62.5 C59.4,62.5 60.5,62.1 61.3,61.3 L115.2,7.4 C116.9,5.8 116.9,3.2 115.3,1.6Z'/%3E %3C/svg%3E") calc(100% - 12px) 50% / 12px no-repeat;
+ background: var(--background) var(--select-arrow) calc(100% - 12px) 50% / 12px no-repeat;
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ select {
+ background: #161f27 url("data:image/svg+xml;charset=utf-8,%3C?xml version='1.0' encoding='utf-8'?%3E %3Csvg version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' height='62.5' width='116.9' fill='%23efefef'%3E %3Cpath d='M115.3,1.6 C113.7,0 111.1,0 109.5,1.6 L58.5,52.7 L7.4,1.6 C5.8,0 3.2,0 1.6,1.6 C0,3.2 0,5.8 1.6,7.4 L55.5,61.3 C56.3,62.1 57.3,62.5 58.4,62.5 C59.4,62.5 60.5,62.1 61.3,61.3 L115.2,7.4 C116.9,5.8 116.9,3.2 115.3,1.6Z'/%3E %3C/svg%3E") calc(100% - 12px) 50% / 12px no-repeat;
+ background: var(--background) var(--select-arrow) calc(100% - 12px) 50% / 12px no-repeat;
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ select {
+ background: #161f27 url("data:image/svg+xml;charset=utf-8,%3C?xml version='1.0' encoding='utf-8'?%3E %3Csvg version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' height='62.5' width='116.9' fill='%23efefef'%3E %3Cpath d='M115.3,1.6 C113.7,0 111.1,0 109.5,1.6 L58.5,52.7 L7.4,1.6 C5.8,0 3.2,0 1.6,1.6 C0,3.2 0,5.8 1.6,7.4 L55.5,61.3 C56.3,62.1 57.3,62.5 58.4,62.5 C59.4,62.5 60.5,62.1 61.3,61.3 L115.2,7.4 C116.9,5.8 116.9,3.2 115.3,1.6Z'/%3E %3C/svg%3E") calc(100% - 12px) 50% / 12px no-repeat;
+ background: var(--background) var(--select-arrow) calc(100% - 12px) 50% / 12px no-repeat;
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ select {
+ background: #161f27 url("data:image/svg+xml;charset=utf-8,%3C?xml version='1.0' encoding='utf-8'?%3E %3Csvg version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' height='62.5' width='116.9' fill='%23efefef'%3E %3Cpath d='M115.3,1.6 C113.7,0 111.1,0 109.5,1.6 L58.5,52.7 L7.4,1.6 C5.8,0 3.2,0 1.6,1.6 C0,3.2 0,5.8 1.6,7.4 L55.5,61.3 C56.3,62.1 57.3,62.5 58.4,62.5 C59.4,62.5 60.5,62.1 61.3,61.3 L115.2,7.4 C116.9,5.8 116.9,3.2 115.3,1.6Z'/%3E %3C/svg%3E") calc(100% - 12px) 50% / 12px no-repeat;
+ background: var(--background) var(--select-arrow) calc(100% - 12px) 50% / 12px no-repeat;
+ }
+}
+
+select::-ms-expand {
+ display: none;
+}
+
+select[multiple] {
+ padding-right: 10px;
+ background-image: none;
+ overflow-y: auto;
+}
+
+input:focus {
+ box-shadow: 0 0 0 2px #0096bfab;
+ box-shadow: 0 0 0 2px var(--focus);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input:focus {
+ box-shadow: 0 0 0 2px #0096bfab;
+ box-shadow: 0 0 0 2px var(--focus);
+ }
+}
+
+select:focus {
+ box-shadow: 0 0 0 2px #0096bfab;
+ box-shadow: 0 0 0 2px var(--focus);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ select:focus {
+ box-shadow: 0 0 0 2px #0096bfab;
+ box-shadow: 0 0 0 2px var(--focus);
+ }
+}
+
+button:focus {
+ box-shadow: 0 0 0 2px #0096bfab;
+ box-shadow: 0 0 0 2px var(--focus);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ button:focus {
+ box-shadow: 0 0 0 2px #0096bfab;
+ box-shadow: 0 0 0 2px var(--focus);
+ }
+}
+
+textarea:focus {
+ box-shadow: 0 0 0 2px #0096bfab;
+ box-shadow: 0 0 0 2px var(--focus);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ textarea:focus {
+ box-shadow: 0 0 0 2px #0096bfab;
+ box-shadow: 0 0 0 2px var(--focus);
+ }
+}
+
+input[type='checkbox']:active,
+input[type='radio']:active,
+input[type='submit']:active,
+input[type='reset']:active,
+input[type='button']:active,
+input[type='range']:active,
+button:active {
+ transform: translateY(2px);
+}
+
+input:disabled,
+select:disabled,
+button:disabled,
+textarea:disabled {
+ cursor: not-allowed;
+ opacity: 0.5;
+}
+
+::-moz-placeholder {
+ color: #949494;
+ color: var(--form-placeholder);
+}
+
+:-ms-input-placeholder {
+ color: #949494;
+ color: var(--form-placeholder);
+}
+
+::-ms-input-placeholder {
+ color: #949494;
+ color: var(--form-placeholder);
+}
+
+::placeholder {
+ color: #949494;
+ color: var(--form-placeholder);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ ::-moz-placeholder {
+ color: #a9a9a9;
+ color: var(--form-placeholder);
+ }
+
+ :-ms-input-placeholder {
+ color: #a9a9a9;
+ color: var(--form-placeholder);
+ }
+
+ ::-ms-input-placeholder {
+ color: #a9a9a9;
+ color: var(--form-placeholder);
+ }
+
+ ::placeholder {
+ color: #a9a9a9;
+ color: var(--form-placeholder);
+ }
+}
+
+fieldset {
+ border: 1px #0096bfab solid;
+ border: 1px var(--focus) solid;
+ border-radius: 6px;
+ margin: 0;
+ margin-bottom: 12px;
+ padding: 10px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ fieldset {
+ border: 1px #0096bfab solid;
+ border: 1px var(--focus) solid;
+ }
+}
+
+legend {
+ font-size: 0.9em;
+ font-weight: 600;
+}
+
+input[type='range'] {
+ margin: 10px 0;
+ padding: 10px 0;
+ background: transparent;
+}
+
+input[type='range']:focus {
+ outline: none;
+}
+
+input[type='range']::-webkit-slider-runnable-track {
+ width: 100%;
+ height: 9.5px;
+ -webkit-transition: 0.2s;
+ transition: 0.2s;
+ background: #efefef;
+ background: var(--background);
+ border-radius: 3px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='range']::-webkit-slider-runnable-track {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+input[type='range']::-webkit-slider-thumb {
+ box-shadow: 0 1px 1px #000, 0 0 1px #0d0d0d;
+ height: 20px;
+ width: 20px;
+ border-radius: 50%;
+ background: #dbdbdb;
+ background: var(--border);
+ -webkit-appearance: none;
+ margin-top: -7px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='range']::-webkit-slider-thumb {
+ background: #526980;
+ background: var(--border);
+ }
+}
+
+input[type='range']:focus::-webkit-slider-runnable-track {
+ background: #efefef;
+ background: var(--background);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='range']:focus::-webkit-slider-runnable-track {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+input[type='range']::-moz-range-track {
+ width: 100%;
+ height: 9.5px;
+ -moz-transition: 0.2s;
+ transition: 0.2s;
+ background: #efefef;
+ background: var(--background);
+ border-radius: 3px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='range']::-moz-range-track {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+input[type='range']::-moz-range-thumb {
+ box-shadow: 1px 1px 1px #000, 0 0 1px #0d0d0d;
+ height: 20px;
+ width: 20px;
+ border-radius: 50%;
+ background: #dbdbdb;
+ background: var(--border);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='range']::-moz-range-thumb {
+ background: #526980;
+ background: var(--border);
+ }
+}
+
+input[type='range']::-ms-track {
+ width: 100%;
+ height: 9.5px;
+ background: transparent;
+ border-color: transparent;
+ border-width: 16px 0;
+ color: transparent;
+}
+
+input[type='range']::-ms-fill-lower {
+ background: #efefef;
+ background: var(--background);
+ border: 0.2px solid #010101;
+ border-radius: 3px;
+ box-shadow: 1px 1px 1px #000, 0 0 1px #0d0d0d;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='range']::-ms-fill-lower {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+input[type='range']::-ms-fill-upper {
+ background: #efefef;
+ background: var(--background);
+ border: 0.2px solid #010101;
+ border-radius: 3px;
+ box-shadow: 1px 1px 1px #000, 0 0 1px #0d0d0d;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='range']::-ms-fill-upper {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+input[type='range']::-ms-thumb {
+ box-shadow: 1px 1px 1px #000, 0 0 1px #0d0d0d;
+ border: 1px solid #000;
+ height: 20px;
+ width: 20px;
+ border-radius: 50%;
+ background: #dbdbdb;
+ background: var(--border);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='range']::-ms-thumb {
+ background: #526980;
+ background: var(--border);
+ }
+}
+
+input[type='range']:focus::-ms-fill-lower {
+ background: #efefef;
+ background: var(--background);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='range']:focus::-ms-fill-lower {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+input[type='range']:focus::-ms-fill-upper {
+ background: #efefef;
+ background: var(--background);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ input[type='range']:focus::-ms-fill-upper {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+a {
+ text-decoration: none;
+ color: #0076d1;
+ color: var(--links);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ a {
+ color: #41adff;
+ color: var(--links);
+ }
+}
+
+a:hover {
+ text-decoration: underline;
+}
+
+code {
+ background: #efefef;
+ background: var(--background);
+ color: #000;
+ color: var(--code);
+ padding: 2.5px 5px;
+ border-radius: 6px;
+ font-size: 1em;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ code {
+ color: #ffbe85;
+ color: var(--code);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ code {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+samp {
+ background: #efefef;
+ background: var(--background);
+ color: #000;
+ color: var(--code);
+ padding: 2.5px 5px;
+ border-radius: 6px;
+ font-size: 1em;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ samp {
+ color: #ffbe85;
+ color: var(--code);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ samp {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+time {
+ background: #efefef;
+ background: var(--background);
+ color: #000;
+ color: var(--code);
+ padding: 2.5px 5px;
+ border-radius: 6px;
+ font-size: 1em;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ time {
+ color: #ffbe85;
+ color: var(--code);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ time {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+pre > code {
+ padding: 10px;
+ display: block;
+ overflow-x: auto;
+}
+
+var {
+ color: #39a33c;
+ color: var(--variable);
+ font-style: normal;
+ font-family: monospace;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ var {
+ color: #d941e2;
+ color: var(--variable);
+ }
+}
+
+kbd {
+ background: #efefef;
+ background: var(--background);
+ border: 1px solid #dbdbdb;
+ border: 1px solid var(--border);
+ border-radius: 2px;
+ color: #363636;
+ color: var(--text-main);
+ padding: 2px 4px 2px 4px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ kbd {
+ color: #dbdbdb;
+ color: var(--text-main);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ kbd {
+ border: 1px solid #526980;
+ border: 1px solid var(--border);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ kbd {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+img,
+video {
+ max-width: 100%;
+ height: auto;
+}
+
+hr {
+ border: none;
+ border-top: 1px solid #dbdbdb;
+ border-top: 1px solid var(--border);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ hr {
+ border-top: 1px solid #526980;
+ border-top: 1px solid var(--border);
+ }
+}
+
+table {
+ border-collapse: collapse;
+ margin-bottom: 10px;
+ width: 100%;
+ table-layout: fixed;
+}
+
+table caption {
+ text-align: left;
+}
+
+td,
+th {
+ padding: 6px;
+ text-align: left;
+ vertical-align: top;
+ word-wrap: break-word;
+}
+
+thead {
+ border-bottom: 1px solid #dbdbdb;
+ border-bottom: 1px solid var(--border);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ thead {
+ border-bottom: 1px solid #526980;
+ border-bottom: 1px solid var(--border);
+ }
+}
+
+tfoot {
+ border-top: 1px solid #dbdbdb;
+ border-top: 1px solid var(--border);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ tfoot {
+ border-top: 1px solid #526980;
+ border-top: 1px solid var(--border);
+ }
+}
+
+tbody tr:nth-child(even) {
+ background-color: #efefef;
+ background-color: var(--background);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ tbody tr:nth-child(even) {
+ background-color: #161f27;
+ background-color: var(--background);
+ }
+}
+
+tbody tr:nth-child(even) button {
+ background-color: #f7f7f7;
+ background-color: var(--background-alt);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ tbody tr:nth-child(even) button {
+ background-color: #1a242f;
+ background-color: var(--background-alt);
+ }
+}
+
+tbody tr:nth-child(even) button:hover {
+ background-color: #fff;
+ background-color: var(--background-body);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ tbody tr:nth-child(even) button:hover {
+ background-color: #202b38;
+ background-color: var(--background-body);
+ }
+}
+
+::-webkit-scrollbar {
+ height: 10px;
+ width: 10px;
+}
+
+::-webkit-scrollbar-track {
+ background: #efefef;
+ background: var(--background);
+ border-radius: 6px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ ::-webkit-scrollbar-track {
+ background: #161f27;
+ background: var(--background);
+ }
+}
+
+::-webkit-scrollbar-thumb {
+ background: rgb(170, 170, 170);
+ background: var(--scrollbar-thumb);
+ border-radius: 6px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ ::-webkit-scrollbar-thumb {
+ background: #040a0f;
+ background: var(--scrollbar-thumb);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ ::-webkit-scrollbar-thumb {
+ background: #040a0f;
+ background: var(--scrollbar-thumb);
+ }
+}
+
+::-webkit-scrollbar-thumb:hover {
+ background: #9b9b9b;
+ background: var(--scrollbar-thumb-hover);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ ::-webkit-scrollbar-thumb:hover {
+ background: rgb(0, 0, 0);
+ background: var(--scrollbar-thumb-hover);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ ::-webkit-scrollbar-thumb:hover {
+ background: rgb(0, 0, 0);
+ background: var(--scrollbar-thumb-hover);
+ }
+}
+
+::-moz-selection {
+ background-color: #9e9e9e;
+ background-color: var(--selection);
+ color: #000;
+ color: var(--text-bright);
+}
+
+::selection {
+ background-color: #9e9e9e;
+ background-color: var(--selection);
+ color: #000;
+ color: var(--text-bright);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ ::-moz-selection {
+ color: #fff;
+ color: var(--text-bright);
+ }
+
+ ::selection {
+ color: #fff;
+ color: var(--text-bright);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ ::-moz-selection {
+ background-color: #1c76c5;
+ background-color: var(--selection);
+ }
+
+ ::selection {
+ background-color: #1c76c5;
+ background-color: var(--selection);
+ }
+}
+
+details {
+ display: flex;
+ flex-direction: column;
+ align-items: flex-start;
+ background-color: #f7f7f7;
+ background-color: var(--background-alt);
+ padding: 10px 10px 0;
+ margin: 1em 0;
+ border-radius: 6px;
+ overflow: hidden;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ details {
+ background-color: #1a242f;
+ background-color: var(--background-alt);
+ }
+}
+
+details[open] {
+ padding: 10px;
+}
+
+details > :last-child {
+ margin-bottom: 0;
+}
+
+details[open] summary {
+ margin-bottom: 10px;
+}
+
+summary {
+ display: list-item;
+ background-color: #efefef;
+ background-color: var(--background);
+ padding: 10px;
+ margin: -10px -10px 0;
+ cursor: pointer;
+ outline: none;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ summary {
+ background-color: #161f27;
+ background-color: var(--background);
+ }
+}
+
+summary:hover,
+summary:focus {
+ text-decoration: underline;
+}
+
+details > :not(summary) {
+ margin-top: 0;
+}
+
+summary::-webkit-details-marker {
+ color: #363636;
+ color: var(--text-main);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ summary::-webkit-details-marker {
+ color: #dbdbdb;
+ color: var(--text-main);
+ }
+}
+
+dialog {
+ background-color: #f7f7f7;
+ background-color: var(--background-alt);
+ color: #363636;
+ color: var(--text-main);
+ border: none;
+ border-radius: 6px;
+ border-color: #dbdbdb;
+ border-color: var(--border);
+ padding: 10px 30px;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ dialog {
+ border-color: #526980;
+ border-color: var(--border);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ dialog {
+ color: #dbdbdb;
+ color: var(--text-main);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ dialog {
+ background-color: #1a242f;
+ background-color: var(--background-alt);
+ }
+}
+
+dialog > header:first-child {
+ background-color: #efefef;
+ background-color: var(--background);
+ border-radius: 6px 6px 0 0;
+ margin: -10px -30px 10px;
+ padding: 10px;
+ text-align: center;
+}
+
+@media (prefers-color-scheme: dark) {
+
+ dialog > header:first-child {
+ background-color: #161f27;
+ background-color: var(--background);
+ }
+}
+
+dialog::-webkit-backdrop {
+ background: #0000009c;
+ -webkit-backdrop-filter: blur(4px);
+ backdrop-filter: blur(4px);
+}
+
+dialog::backdrop {
+ background: #0000009c;
+ -webkit-backdrop-filter: blur(4px);
+ backdrop-filter: blur(4px);
+}
+
+footer {
+ border-top: 1px solid #dbdbdb;
+ border-top: 1px solid var(--border);
+ padding-top: 10px;
+ color: #70777f;
+ color: var(--text-muted);
+}
+
+@media (prefers-color-scheme: dark) {
+
+ footer {
+ color: #a9b1ba;
+ color: var(--text-muted);
+ }
+}
+
+@media (prefers-color-scheme: dark) {
+
+ footer {
+ border-top: 1px solid #526980;
+ border-top: 1px solid var(--border);
+ }
+}
+
+body > footer {
+ margin-top: 40px;
+}
+
+@media print {
+ body,
+ pre,
+ code,
+ summary,
+ details,
+ button,
+ input,
+ textarea {
+ background-color: #fff;
+ }
+
+ button,
+ input,
+ textarea {
+ border: 1px solid #000;
+ }
+
+ body,
+ h1,
+ h2,
+ h3,
+ h4,
+ h5,
+ h6,
+ pre,
+ code,
+ button,
+ input,
+ textarea,
+ footer,
+ summary,
+ strong {
+ color: #000;
+ }
+
+ summary::marker {
+ color: #000;
+ }
+
+ summary::-webkit-details-marker {
+ color: #000;
+ }
+
+ tbody tr:nth-child(even) {
+ background-color: #f2f2f2;
+ }
+
+ a {
+ color: #00f;
+ text-decoration: underline;
+ }
+}
diff --git a/docs/docs.html b/docs/docs.html
new file mode 100644
index 0000000..0e2fbc7
--- /dev/null
+++ b/docs/docs.html
@@ -0,0 +1,17 @@
+
+
+
+
+Reticulum Network
+
Read The Manual
+You can browse full documentation for Reticulum on this site or on GitHub Pages .
+You can also download the Reticulum manual as a PDF or in EPUB format .
+Next Topic: Cryptographic Primitives
+
+
diff --git a/docs/docs_de.html b/docs/docs_de.html
new file mode 100644
index 0000000..1a5c5ad
--- /dev/null
+++ b/docs/docs_de.html
@@ -0,0 +1,17 @@
+
+
+
+
+Reticulum Network
+
Lesen Sie das Handbuch
+Die vollständige Dokumentation zu Reticulum finden Sie hier Auf dieser Seite oder auf den GitHub Seiten .
+Sie können auch das Reticulum-Handbuch als PDF oder EPUB herunterladen.
+Nächstes Thema: Kryptographische Primitive
+
+
diff --git a/docs/docs_es.html b/docs/docs_es.html
new file mode 100644
index 0000000..dac73dc
--- /dev/null
+++ b/docs/docs_es.html
@@ -0,0 +1,18 @@
+
+
+
+
+Reticulum Network
+
Leer el manual
+Puede consultar la documentación completa de Reticulum en este sitio o en GitHub Pages .
+También puede descargar el manual de Reticulum en formato PDF o en formato EPUB .
+Por el momento sólo está disponible en Inglés.
+Ooootro tema: Primitivas criptográficas
+
+
diff --git a/docs/docs_jp.html b/docs/docs_jp.html
new file mode 100644
index 0000000..baa36b1
--- /dev/null
+++ b/docs/docs_jp.html
@@ -0,0 +1,17 @@
+
+
+
+
+Reticulum Network
+
マニュアルを読む
+Reticulumの完全なドキュメンテーションは、このサイト またはGitHub Pages で閲覧できます。
+ReticulumマニュアルをPDFでダウンロード するか、EPUB形式 で入手することもできます。
+次のトピック: 暗号プリミティブ
+
+
diff --git a/docs/docs_nl.html b/docs/docs_nl.html
new file mode 100644
index 0000000..6d9e761
--- /dev/null
+++ b/docs/docs_nl.html
@@ -0,0 +1,17 @@
+
+
+
+
+Reticulum Network
+
Lees de handleiding
+U kunt door de volledige documentatie voor Reticulum bladeren op deze site of op GitHub Pages .
+U kunt ook de Reticulum-handleiding downloaden als PDF of in EPUB format .
+Volgend onderwerp: cryptografische primitieven
+
+
diff --git a/docs/docs_pl.html b/docs/docs_pl.html
new file mode 100644
index 0000000..1aa9001
--- /dev/null
+++ b/docs/docs_pl.html
@@ -0,0 +1,17 @@
+
+
+
+
+Reticulum Network
+
Przeczytaj Podręcznik
+Możesz sprawdzić pełną dokumentację Reticulum na tej stronie lub na stronach GitHub .
+Możesz również pobrać podręcznik Reticulum jako PDF lub EPUB .
+Następny Temat: Prymitywy Kryptograficzne
+
+
diff --git a/docs/docs_pt-br.html b/docs/docs_pt-br.html
new file mode 100644
index 0000000..7c22812
--- /dev/null
+++ b/docs/docs_pt-br.html
@@ -0,0 +1,17 @@
+
+
+
+
+Reticulum Network
+
Leia o Manual
+Você navegar por toda documentação do Reticulum neste site ou no GitHub Pages .
+Você também pode baixar o manual do Reticulum como PDF ou EPUB .
+Próxima Página: Criptografia
+
+
diff --git a/docs/docs_tr.html b/docs/docs_tr.html
new file mode 100644
index 0000000..0580471
--- /dev/null
+++ b/docs/docs_tr.html
@@ -0,0 +1,17 @@
+
+
+
+
+Reticulum Network
+
Kılavuzu Okuyun
+Reticulum için tam belgelendirmeyi bu site üzerinden inceleyebilirsiniz veya GitHub Pages'te bulabilirsiniz.
+Ayrıca Reticulum kılavuzunu PDF olarak indirebilirsiniz veya EPUB formatında .
+Sonraki Konu: Şifreleme Temelleri
+
+
diff --git a/docs/docs_uk.html b/docs/docs_uk.html
new file mode 100644
index 0000000..34bdd23
--- /dev/null
+++ b/docs/docs_uk.html
@@ -0,0 +1,17 @@
+
+
+
+
+Reticulum Network
+
Читайте інструкцію
+Ви можете переглядати повну документацію для Reticulum на цьому сайті або на GitHub Pages .
+Ви також можете завантажити інструкцію Reticulum у форматі PDF або в форматі EPUB .
+Наступна тема: Криптографічні примітиви
+
+
diff --git a/docs/docs_zh-cn.html b/docs/docs_zh-cn.html
new file mode 100644
index 0000000..4145a11
--- /dev/null
+++ b/docs/docs_zh-cn.html
@@ -0,0 +1,17 @@
+
+
+
+
+Reticulum Network
+
阅读手册
+你可以在本站 或是GitHub Pages 阅读完整的文档。
+此外，你还可以下载PDF 或是EPUB 格式的文档以供离线查看。
+下一个主题: 密码学原语
+
+
diff --git a/docs/donate.html b/docs/donate.html
new file mode 100644
index 0000000..08cf236
--- /dev/null
+++ b/docs/donate.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Support Reticulum
+You can help support the continued development of open, free and private communications systems by donating via one of the following channels:
+
+Monero84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
+
+Bitcoinbc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5
+
+Ethereum0xae89F3B94fC4AD6563F0864a55F9a697a90261ff
+
+Liberapayhttps://liberapay.com/Reticulum/
+Ko-Fihttps://ko-fi.com/markqvist
+
+
+
diff --git a/docs/donate_de.html b/docs/donate_de.html
new file mode 100644
index 0000000..37a46c2
--- /dev/null
+++ b/docs/donate_de.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Reticulum Entwicklung unterstützen
+Sie können die weitere Entwicklung offener, freier und privater Kommunikationssysteme unterstützen, indem Sie über einen der folgenden Kanäle spenden:
+
+Monero84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
+
+Bitcoinbc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5
+
+Ethereum0xae89F3B94fC4AD6563F0864a55F9a697a90261ff
+
+Liberapayhttps://liberapay.com/Reticulum/
+Ko-Fihttps://ko-fi.com/markqvist
+
+
+
diff --git a/docs/donate_es.html b/docs/donate_es.html
new file mode 100644
index 0000000..b9ecec3
--- /dev/null
+++ b/docs/donate_es.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Apoya Reticulum
+Podes contribuir al desarrollo de sistemas de comunicaciones abiertas, libres y privadas haciendo una donación a través de uno de los siguientes canales:
+
+Monero84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
+
+Bitcoinbc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5
+
+Ethereum0xae89F3B94fC4AD6563F0864a55F9a697a90261ff
+
+Liberapayhttps://liberapay.com/Reticulum/
+Ko-Fihttps://ko-fi.com/markqvist
+
+
+
diff --git a/docs/donate_jp.html b/docs/donate_jp.html
new file mode 100644
index 0000000..dbaa457
--- /dev/null
+++ b/docs/donate_jp.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
レティクラムのサポート
+あなたは、以下のチャンネルを通じて寄付を行うことで、オープンで無料、かつプライベートな通信システムの継続的な開発をサポートできます：
+
+Monero84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
+
+Bitcoinbc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5
+
+Ethereum0xae89F3B94fC4AD6563F0864a55F9a697a90261ff
+
+Liberapayhttps://liberapay.com/Reticulum/
+Ko-Fihttps://ko-fi.com/markqvist
+
+
+
diff --git a/docs/donate_nl.html b/docs/donate_nl.html
new file mode 100644
index 0000000..d710582
--- /dev/null
+++ b/docs/donate_nl.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Ondersteun Reticulum
+U kunt de voortdurende ontwikkeling van open, vrije en particuliere communicatiesystemen helpen ondersteunen door te doneren via een van de volgende kanalen:
+
+Monero84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
+
+Bitcoinbc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5
+
+Ethereum0xae89F3B94fC4AD6563F0864a55F9a697a90261ff
+
+Liberapayhttps://liberapay.com/Reticulum/
+Ko-Fihttps://ko-fi.com/markqvist
+
+
+
diff --git a/docs/donate_pl.html b/docs/donate_pl.html
new file mode 100644
index 0000000..37587fc
--- /dev/null
+++ b/docs/donate_pl.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Wesprzyj Reticulum
+Możesz wspomóc dalszy rozwój otwartych, wolnych, prywatnych systemów komunikacji przez przekazanie darowizny za pośrednictwem jednego z następujących kanałów:
+
+Monero84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
+
+Bitcoinbc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5
+
+Ethereum0xae89F3B94fC4AD6563F0864a55F9a697a90261ff
+
+Liberapayhttps://liberapay.com/Reticulum/
+Ko-Fihttps://ko-fi.com/markqvist
+
+
+
diff --git a/docs/donate_pt-br.html b/docs/donate_pt-br.html
new file mode 100644
index 0000000..721299b
--- /dev/null
+++ b/docs/donate_pt-br.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Ajude o Reticulum
+Você pode ajudar na continuação do desenvolvimento de sistemas de comunicação abertos, livres e privados, doando através de um dos seguintes canais:
+
+Monero84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
+
+Bitcoinbc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5
+
+Ethereum0xae89F3B94fC4AD6563F0864a55F9a697a90261ff
+
+Liberapayhttps://liberapay.com/Reticulum/
+Ko-Fihttps://ko-fi.com/markqvist
+
+
+
diff --git a/docs/donate_tr.html b/docs/donate_tr.html
new file mode 100644
index 0000000..c779cf7
--- /dev/null
+++ b/docs/donate_tr.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Reticulum'u Destekle
+Açık, özgür ve özel iletişim sistemlerinin sürekli gelişimine destek olabilirsiniz, aşağıdaki kanallardan biri aracılığıyla bağış yaparak:
+
+Monero84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
+
+Bitcoinbc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5
+
+Ethereum0xae89F3B94fC4AD6563F0864a55F9a697a90261ff
+
+Liberapayhttps://liberapay.com/Reticulum/
+Ko-Fihttps://ko-fi.com/markqvist
+
+
+
diff --git a/docs/donate_uk.html b/docs/donate_uk.html
new file mode 100644
index 0000000..a581ca5
--- /dev/null
+++ b/docs/donate_uk.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Підтримати Reticulum
+Ви можете допомогти підтримати подальший розвиток відкритих, безкоштовних та приватних комунікаційних систем, зробивши донат через один із наступних каналів:
+
+Monero84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
+
+Bitcoinbc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5
+
+Ethereum0xae89F3B94fC4AD6563F0864a55F9a697a90261ff
+
+Liberapayhttps://liberapay.com/Reticulum/
+Ko-Fihttps://ko-fi.com/markqvist
+
+
+
diff --git a/docs/donate_zh-cn.html b/docs/donate_zh-cn.html
new file mode 100644
index 0000000..1064b2b
--- /dev/null
+++ b/docs/donate_zh-cn.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
支持 Reticulum
+你可以通过以下途径来支持这一开放、自由、私密的通信系统的开发。
+
+Monero84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
+
+Bitcoinbc1p4a6axuvl7n9hpapfj8sv5reqj8kz6uxa67d5en70vzrttj0fmcusgxsfk5
+
+Ethereum0xae89F3B94fC4AD6563F0864a55F9a697a90261ff
+
+Liberapayhttps://liberapay.com/Reticulum/
+Ko-Fihttps://ko-fi.com/markqvist
+
+
+
diff --git a/docs/gfx/reticulum_logo_512.png b/docs/gfx/reticulum_logo_512.png
new file mode 100644
index 0000000..ba3940a
Binary files /dev/null and b/docs/gfx/reticulum_logo_512.png differ
diff --git a/docs/hardware.html b/docs/hardware.html
new file mode 100644
index 0000000..0f01a4f
--- /dev/null
+++ b/docs/hardware.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Supported Hardware
+Reticulum can be used over practically any medium that can support at least a half-duplex channel with 500 bits per second throughput, and an MTU of 500 bytes. Data radios, modems, LoRa radios, serial lines, AX.25 TNCs, amateur radio digital modes, WiFi and Ethernet devices, free-space optical links, and similar systems are all examples of the types of physical devices Reticulum can use. The supported interface types include:
+
+Any ethernet device
+Almost all WiFi-based hardware
+LoRa using RNode
+Packet Radio TNCs (with or without AX.25)
+KISS-compatible hardware and software modems
+Any device with a serial port
+TCP over IP networks
+UDP over IP networks
+External programs via stdio or pipes
+Custom hardware via stdio or pipes
+
+For a more detailed info, and a full list of supported interface types, please read the Communications Hardware and Supported Interfaces chapters of the manual.
+Reticulum can also be encapsulated over existing IP networks, so there's nothing stopping you from using it over wired ethernet, your local WiFi network or the Internet, where it'll work just as well. In fact, one of the strengths of Reticulum is how easily it allows you to connect different mediums into a self-configuring, resilient and encrypted mesh, using any available mixture of available infrastructure.
+As an example, it's possible to set up a Raspberry Pi connected to both a LoRa radio, a packet radio TNC and a WiFi network. Once the interfaces are configured, Reticulum will take care of the rest, and any device on the WiFi network can communicate with nodes on the LoRa and packet radio sides of the network, and vice versa.
+Next Topic: Public Testnet
+
+
diff --git a/docs/hardware_de.html b/docs/hardware_de.html
new file mode 100644
index 0000000..e2c1ae0
--- /dev/null
+++ b/docs/hardware_de.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Unterstützte Hardware
+Reticulum kann über praktisch jedes Medium verwendet werden, das mindestens einen Halbduplex-Kanal mit einem Durchsatz von 500 Bit pro Sekunde und einer MTU von 500 Byte unterstützt. Datenfunkgeräte, Modems, LoRa-Funkgeräte, serielle Leitungen, AX.25-TNCs, digitale Amateurfunkmodi, WiFi- und Ethernet-Geräte, optische Verbindungen im freien Raum und ähnliche Systeme sind Beispiele für physische Geräte, die Reticulum verwenden kann. Zu den unterstützten Schnittstellentypen gehören:
+
+Jedes Ethernet-Gerät
+Fast alle WiFi-basierte Hardware
+LoRa mit RNode
+Packet Radio TNCs (mit oder ohne AX.25)
+KISS-kompatible Hardware- und Software-Modems
+Jedes Gerät mit einer seriellen Schnittstelle
+TCP über IP Netzwerke
+UDP über IP Netzwerke
+Externe Programme über stdio oder Pipes
+Kundenspezifische Hardware über stdio oder Pipes
+
+Ausführlichere Informationen und eine vollständige Liste der unterstützten Schnittstellentypen finden Sie in den Kapiteln Kommunikationshardware und Unterstützte Schnittstellen des Handbuchs.
+Reticulum kann auch über bestehende IP-Netzwerke gekapselt werden, so dass dem Einsatz über ein kabelgebundenes Ethernet, Ihr lokales WiFi-Netzwerk oder das Internet nichts im Wege steht, wo es genauso gut funktioniert. Eine der Stärken von Reticulum besteht darin, dass Sie verschiedene Medien ganz einfach zu einem selbstkonfigurierenden, robusten und verschlüsselten Mesh verbinden können, wobei jede verfügbare Infrastruktur genutzt werden kann.
+So ist es beispielsweise möglich, einen Raspberry Pi sowohl mit einem LoRa-Funkgerät als auch mit einem Paketfunk-TNC und einem WiFi-Netzwerk zu verbinden. Sobald die Schnittstellen konfiguriert sind, kümmert sich Reticulum um den Rest, und jedes Gerät im WiFi-Netzwerk kann mit Knoten auf der LoRa- und Paketfunkseite des Netzwerks kommunizieren und umgekehrt.
+Nächstes Thema: Öffentliches Testnetz
+
+
diff --git a/docs/hardware_es.html b/docs/hardware_es.html
new file mode 100644
index 0000000..16872ed
--- /dev/null
+++ b/docs/hardware_es.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Hardware soportado
+Reticulum puede utilizarse en prácticamente cualquier medio que admita al menos un canal semidúplex con un rendimiento de 500 bits por segundo y una MTU de 500 bytes. Radios de datos, módems, radios LoRa, líneas seriales, TNC AX.25, modos digitales de radio-aficionados, dispositivos WiFi y Ethernet, enlaces ópticos de espacio libre y sistemas similares son ejemplos de los tipos de dispositivos físicos que puede utilizar Reticulum. Los tipos de interfaz admitidos incluyen:
+
+Cualquier dispositivo Ethernet
+Casi todo el hardware basado en WiFi
+LoRa utilizando RNode
+TNCs de Radio en paquetes (con o sin AX.25)
+Módems de hardware y software compatibles con KISS
+Cualquier dispositivo con puerto serial
+TCP sobre redes IP
+UDP sobre redes IP
+Programas externos a través de stdio o pipes
+Hardware personalizado a través de stdio o pipes
+
+Para obtener información más detallada y una lista completa de los tipos de interfaz compatibles, lea los capítulos Hardware de comunicaciones e Interfaces compatibles del manual.
+Reticulum también puede encapsularse sobre redes IP existentes, por lo que nada le impide utilizarlo a través de Ethernet por cable, su red WiFi local o Internet, donde funcionará igual de bien. De hecho, uno de los puntos fuertes de Reticulum es la facilidad con la que permite conectar diferentes medios en una malla autoconfigurable, resistente y encriptada, utilizando cualquier mezcla de infraestructura disponible.
+Como ejemplo, se puede setear una Raspberry Pi conectada a un dispositivo LoRa, una radio en paquetes TNC y una red WiFi. Cuando las interfaces estén configuradas, Reticulum se hace cargo del resto, y cualquier dispositivo en la red se va a poder comunicar con nodos que estén en LoRa y/o radio en paquetes de la red y viceversa.
+Siguiente tema: Testnet publica
+
+
diff --git a/docs/hardware_jp.html b/docs/hardware_jp.html
new file mode 100644
index 0000000..64ee8b0
--- /dev/null
+++ b/docs/hardware_jp.html
@@ -0,0 +1,30 @@
+
+
+
+
+Reticulum Network
+
サポートされているハードウェア
+Reticulumは、少なくともハーフデュプレックスチャネルとして500ビット/秒のスループット、および500バイトのMTUをサポートできるほぼすべてのメディアで使用できます。データラジオ、モデム、LoRaラジオ、シリアルライン、AX.25 TNC、アマチュアラジオデジタルモード、WiFiおよびEthernetデバイス、フリースペース光通信リンクなど、これらはReticulumが使用できる物理デバイスの例です。サポートされるインターフェースのタイプは以下の通りです。
+
+任意のEthernetデバイス
+ほぼすべてのWiFiベースのハードウェア
+RNode を使用したLoRaパケットラジオTNC（AX.25ありまたはなし）
+KISS互換のハードウェアおよびソフトウェアモデム
+シリアルポートを持つ任意のデバイス
+IPネットワーク上のTCP
+IPネットワーク上のUDP
+stdioまたはパイプを介した外部プログラム
+stdioまたはパイプを介したカスタムハードウェア
+
+詳細な情報やサポートされているインターフェースタイプの完全なリストについては、Communications Hardware および Supported Interfaces マニュアルの章を参照してください。
+Reticulumは既存のIPネットワーク上にカプセル化されるため、有線Ethernet、ローカルWiFiネットワーク、またはインターネットを介しても利用できます。実際、Reticulumの強みの一つは、さまざまな媒体を容易に自己設定、強固で暗号化されたメッシュに接続できるようにすることです。利用可能な基盤の組み合わせを使用して、ラズベリーパイをLoRaラジオ、パケットラジオTNC、およびWiFiネットワークに接続することができます。インターフェースが構成されると、Reticulumが残りの作業を処理し、WiFiネットワーク上の任意のデバイスがネットワークのLoRaおよびパケットラジオ側のノードと双方向に通信できます。
+次のトピック: パブリックテストネット
+
+
diff --git a/docs/hardware_nl.html b/docs/hardware_nl.html
new file mode 100644
index 0000000..046fd32
--- /dev/null
+++ b/docs/hardware_nl.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Ondersteunde hardware
+Reticulum kan worden gebruikt via vrijwel elk medium dat ten minste een half-duplex kanaal met een doorvoersnelheid van 500 bits per seconde en een MTU van 500 bytes kan ondersteunen. Dataradio's, modems, LoRa-radio's, seriële lijnen, AX.25 TNC's, digitale amateurradiomodi, WiFi- en Ethernet-apparaten, optische verbindingen in de vrije ruimte en soortgelijke systemen zijn allemaal voorbeelden van de soorten fysieke apparaten die Reticulum kan gebruiken. De ondersteunde interfacetypen zijn onder meer:
+
+Elke ethernetinterface
+Bijna alle op WiFi gebaseerde hardware
+LoRa met behulp van RNode
+Packet Radio TNC's (met of zonder AX.25)
+KISS-compatibele hardware- en softwaremodems
+Elk apparaat met een seriële poort
+TCP over IP-netwerken
+UDP via IP-netwerken
+Externe programma's via stdio of pipelines
+Aangepaste hardware via stdio of pijpen
+
+Voor meer gedetailleerde informatie en een volledige lijst met ondersteunde interfacetypen kunt u de hoofdstukken Communicatiehardware en Ondersteunde interfaces van de handleiding lezen.
+Reticulum kan ook worden ingekapseld over bestaande IP-netwerken, dus niets houdt u tegen om het te gebruiken via bedraad ethernet, uw lokale WiFi-netwerk of internet, waar het net zo goed zal werken. Een van de sterke punten van Reticulum is in feite hoe gemakkelijk u verschillende media kunt verbinden tot een zelfconfigurerend, veerkrachtig en gecodeerd netwerk, met behulp van elke beschikbare mix van beschikbare infrastructuur.
+Het is bijvoorbeeld mogelijk om een Raspberry Pi op te zetten die is aangesloten op zowel een LoRa-radio, een packet-radio-TNC als een WiFi-netwerk. Zodra de interfaces zijn geconfigureerd, zorgt Reticulum voor de rest, en elk apparaat op het WiFi-netwerk kan communiceren met knooppunten aan de LoRa- en pakketradiozijde van het netwerk, en vice versa.
+Volgend onderwerp: openbaar testnet
+
+
diff --git a/docs/hardware_pl.html b/docs/hardware_pl.html
new file mode 100644
index 0000000..509e2e7
--- /dev/null
+++ b/docs/hardware_pl.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Wspierany Hardware
+Reticulum może być używane praktycznie przez każde medium, które wspiera przynajmniej kanał półdupleksowy z przepustowością 500 bitów na sekundę, i MTU 500 bitów. Data radio, modemy, radia LoRa, porty szeregowe, AX.25 TNC, tryby cyfrowe radia amatorskiego, WiFi i urządzenia Ethernet, bezprzewodowe łącza optyczne (FSO), i podobne systemy są przykładem rodzajów fizycznych urządzeń, które Reticulum może używać. Wspierane rodzaje interfejsów zawierają:
+
+Każde urządzenie ethernet
+Prawie wszystkie urządzenia z WiFi
+LoRa używające RNode
+Packet Radio TNC (z lub bez AX.25)
+Hardware kompatybilny z KISS i modemy programowe
+Każde urządzenie z portem szeregowym
+TCP przez sieci IP
+UDP przez sieci IP
+Zewnętrzne programy przez stdio lub pipes
+Niestandardowy hardware przez stdio lub pipes
+
+Bardziej szczegółowe informacje i pełną listę wspieranych rodzajów interfejsów można znaleźć w rozdziałach poświęconych sprzętowi komunikacyjnemu i wspieranych interfejsów .
+Reticulum może być również umieszczone w istniejących sieciach IP, więc nic nie stoi na przeszkodzie, by używać go w przewodowej sieci ethernet, lokalnej sieci WiFi lub w Internecie, gdzie będzie działał równie dobrze. W rzeczywistości, jedną z mocnych stron Reticulum jest to, jak łatwo pozwala połączyć różne media w samokonfigurującą się, odporną i szyfrowaną sieć, wykorzystując dowolną mieszankę dostępnej infrastruktury.
+Przykładowo, możliwe jest skonfigurowanie Raspberry Pi podłączonego zarówno do radia LoRa, TNC packet radio, jak i sieci WiFi. Po skonfigurowaniu interfejsów, Reticulum zajmie się resztą, a każde urządzenie w sieci WiFi może komunikować się z węzłami po stronie sieci LoRa i packet radio, i odwrotnie.
+Następny Temat: Publiczny Testnet
+
+
diff --git a/docs/hardware_pt-br.html b/docs/hardware_pt-br.html
new file mode 100644
index 0000000..f399011
--- /dev/null
+++ b/docs/hardware_pt-br.html
@@ -0,0 +1,30 @@
+
+
+
+
+Reticulum Network
+
Hardware Compátivel
+Reticulum pode ser usado sobre praticamente qualquer dispositivo que suporte pelo menos um canal half-duplex com 500 bits por segundo de taxa de transferência, um MTU de 500 bytes. Rádios de dados, roteadores, rádios LoRa, linhas seriais, AX.25 TNCs, modos de rádio digital amador, Wi-Fi, Bluetooth, links ópticos de espaço-livre e sistemas similares são todos exemplos dos tipos de dispositivos físicos que o Reticulum pode utilizar. Os tipos de interface suportados incluem:
+
+Qualquer dispositivo Ethernet
+Praticamente todo hardware com Wi-Fi
+LoRa utilizando RNode
+Hardware/roteadores de software com filosofia KISS
+Qualquer dispositivo com uma porta serial
+TCP sobre redes IP
+UDP sobre redes IP
+Programas externos via stdio ou pipes
+Hardware personalizado via stdio ou pipes
+
+Para informações detalhadas e uma lista completa de todos os tipos de interfaces suportadas, leia o Hardware de Comunicações e o capítulo de Interfaces Suportadas do manual.
+Reticulum pode ser utilizado sobre redes IP, nada lhe impede de utilizar via cabo Ethernet, sua rede local de Wi-Fi ou a Internet, onde ele funciona corretamente. Na verdade, um dos pontos fortes do Reticulum é como ele facilmente permite que você se conecte a diferentes dispositivos com mesh auto-configurável, resiliente e criptografada, utilizando apenas a infraestrutura disponível.
+Como um exemplo, é possível utilizar um Raspberry Pi conectado em ambos, uma rádio LoRa, um rádio amador TNC e uma rede Wi-Fi. Uma vez que as interfaces estejam configuradas, Reticulum cuida do resto, e qualquer dispositivo na rede Wi-Fi pode se comunicar com nós do rádio LoRa e rádio amador, e vice-versa.
+Próxima Página: Rede de Teste Pública
+
+
diff --git a/docs/hardware_tr.html b/docs/hardware_tr.html
new file mode 100644
index 0000000..60c0afb
--- /dev/null
+++ b/docs/hardware_tr.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Desteklenen Donanım
+Reticulum, en az yarı dubleks bir kanalı ve saniyede 500 bit iletim hızını destekleyebilen neredeyse her ortamda kullanılabilir ve MTU değeri 500 byte olan bir ortamda çalışabilir. Veri radyoları, modemler, LoRa radyoları, seri hatlar, AX.25 TNC'ler, amatör telsiz dijital modları, WiFi ve Ethernet cihazları, serbest uzay optik bağlantılar ve benzeri sistemler, Reticulum'un kullanabileceği fiziksel cihaz türlerine örnek olarak verilebilir. Desteklenen arayüz türleri şunları içerir:
+
+Herhangi bir Ethernet cihazı
+Neredeyse tüm WiFi tabanlı donanımlar
+RNode kullanılarak LoRaPaket Radyo TNC'leri (AX.25 ile veya olmadan)
+KISS uyumlu donanım ve yazılım modemleri
+Bir dizi seri porta sahip herhangi bir cihaz
+IP ağları üzerinden TCP
+IP ağları üzerinden UDP
+stdio veya borular aracılığıyla harici programlar
+stdio veya borular aracılığıyla özel donanım
+
+Daha fazla bilgi ve desteklenen arayüz türlerinin tam listesi için lütfen İletişim Donanımı ve Desteklenen Arayüzler bölümlerini okuyun.
+Reticulum ayrıca mevcut IP ağları üzerinde de kapsülleyebilir, bu nedenle onu kablolu Ethernet, yerel WiFi ağınız veya İnternet üzerinden kullanmanıza engel bir şey yok, burada da aynı şekilde çalışacaktır. Aslında, Reticulum'un güçlü yanlarından biri, farklı ortamları kolayca birbirine bağlama yeteneğidir; bu, mevcut altyapının herhangi bir karışımını kullanarak özelleştirilebilir, dayanıklı ve şifreli bir mesh ağı oluşturmanıza izin verir.
+Örneğin, bir Raspberry Pi'nin hem bir LoRa radyosuna, bir paket radyo TNC'sine ve bir WiFi ağına bağlı olduğu bir yapı kurmak mümkündür. Arayüzler yapılandırıldığında, Reticulum gerisini halledecek ve WiFi ağındaki herhangi bir cihaz, ağın LoRa ve paket radyo taraflarındaki düğümlerle iletişim kurabilir, ve tam tersi.
+Sonraki Konu: Genel Test Ağı
+
+
diff --git a/docs/hardware_uk.html b/docs/hardware_uk.html
new file mode 100644
index 0000000..d028e5f
--- /dev/null
+++ b/docs/hardware_uk.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
Підтримуване обладнання
+Reticulum можна використовувати практично через будь-який медіум, який підтримує хоча б напівдуплексний канал з пропускною здатністю 500 біт на секунду і MTU 500 байт. Прикладом фізичних пристроїв, через які можна використовувати Reticulum, є радіостанції даних, модеми, LoRa радіостанції, серійні лінії, TNC AX.25, цифрові режими аматорського радіо, WiFi та Ethernet пристрої, оптичні лінії вільного простору та подібні системи. Підтримувані типи інтерфейсів включають:
+
+Будь-який Ethernet пристрій
+Майже все обладнання на базі WiFi
+LoRa з використанням RNode
+TNC для пакетного радіо (з або без AX.25)
+Апаратура та програмні модеми сумісні з KISS
+Будь-який пристрій з серійним портом
+TCP через IP мережі
+UDP через IP мережі
+Зовнішні програми через stdio або канали
+Користувацьке обладнання через stdio або канали
+
+Для більш детальної інформації та повного списку підтримуваних типів інтерфейсів, будь ласка, ознайомтесь з розділами Комунікаційне обладнання та Підтримувані інтерфейси у посібнику.
+Reticulum також може бути інкапсульований через існуючі IP мережі, тому немає жодних обмежень у використанні його через дротовий Ethernet, вашу локальну WiFi мережу або Інтернет, де він працюватиме так само добре. Насправді, однією з переваг Reticulum є те, як легко він дозволяє підключати різні медіуми до самоконфігурованої, стійкої та зашифрованої мережі, використовуючи будь-яку доступну суміш доступної інфраструктури.
+Наприклад, можна налаштувати Raspberry Pi, підключений до радіо LoRa, TNC для пакетного радіо та WiFi мережі. Після налаштування інтерфейсів, Reticulum подбає про решту, і будь-який пристрій у WiFi мережі зможе спілкуватися з вузлами в мережі LoRa і пакетного радіо, і навпаки.
+Наступна тема: Публічний тестнет
+
+
diff --git a/docs/hardware_zh-cn.html b/docs/hardware_zh-cn.html
new file mode 100644
index 0000000..e233c91
--- /dev/null
+++ b/docs/hardware_zh-cn.html
@@ -0,0 +1,31 @@
+
+
+
+
+Reticulum Network
+
硬件支持
+Reticulum 可以被用于任意一个最低支持 500 bps 吞吐量、具有 500 字节 MTU(最大传输单元)的半双工或全双工信道上。Reticulum 支持各种物理设备：数字无线电、调制解调器、LoRa 无线电、串口线、AX.25 终端节点控制器(TNCs)、业余无线电台的数字模式、WiFi与以太网、自由空间光通信……以下是一个简单列表：
+
+任意以太网设备
+几乎所有基于 WiFi 的硬件
+LoRa (使用 RNode )
+封包无线电 TNC(带或不带 AX.25 均可)
+兼容KISS的硬件或软件调制解调器
+任何带串口的设备
+TCP over IP
+UDP over IP
+外部程序(通过 stdio 或是管道)
+自制硬件(通过 stdio 或是管道)
+
+若想了解更多细节或是查看完整的支持列表，请参阅手册的通信硬件(Communications Hardware) 与受支持的界面(Supported Interfaces) 部分。
+Reticulum 也可以在现有的 IP 网络之上建立连接，所以你也能在有线以太网，本地无线网或是互联网上使用它。事实上，Reticulum 的一大优势就是允许你混合使用各种基础设施，把不同的传输介质连接成一个自配置、自恢复、强加密的网状网络。
+譬如，你可以搭建一个连着 LoRa 无线电、封包无线电 TNC 和 WiFi 的树莓派。在这些硬件都设置好之后，Reticulum 会处理剩下的一切——所有在 WiFi 一侧的设备便可以和无线电一侧的设备自由通信了，反之亦然。
+下一个主题: 公共测试网络
+
+
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 0000000..8ee671f
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Reticulum
+Reticulum is the cryptography-based networking stack for building local and wide-area networks with readily available hardware. Reticulum can continue to operate even in adverse conditions with very high latency and extremely low bandwidth.
+The vision of Reticulum is to allow anyone to operate their own sovereign communication networks, and to make it cheap and easy to cover vast areas with a myriad of independent, interconnectable and autonomous networks. Reticulum is Unstoppable Networks for The People.
+
+
+Reticulum is not one network. It is a tool for building thousands of networks . Networks without kill-switches, surveillance, censorship and control. Networks that can freely interoperate, associate and disassociate with each other. Reticulum is Networks for Human Beings.
+From a users perspective, Reticulum allows the creation of applications that respect and empower the autonomy and sovereignty of communities and individuals. Reticulum provides secure digital communication that cannot be subjected to outside control, manipulation or censorship.
+Reticulum enables the construction of both small and potentially planetary-scale networks, without any need for hierarchical or beaureucratic structures to control or manage them, while ensuring individuals and communities full sovereignty over their own network segments.
+Notable Characteristics
+While Reticulum solves the same problem that any network stack does, namely to get data reliably from one point to another over a number of intermediaries, it does so in a way that is very different from other networking technologies.
+
+Reticulum does not use source addresses. No packets transmitted include information about the address, place, machine or person they originated from.
+There is no central control over the address space in Reticulum. Anyone can allocate as many addresses as they need, when they need them.
+Reticulum ensures end-to-end connectivity. Newly generated addresses become globally reachable in a matter of seconds to a few minutes.
+Addresses are self-sovereign and portable . Once an address has been created, it can be moved physically to another place in the network, and continue to be reachable.
+All communication is secured with strong, modern encryption by default.
+All encryption keys are ephemeral, and communication offers forward secrecy by default.
+It is not possible to establish unencrypted links in Reticulum networks.
+It is not possible to send unencrypted packets to any destinations in the network.
+Destinations receiving unencrypted packets will drop them as invalid.
+
+Next Topic: Get Started
+
+
diff --git a/docs/index_de.html b/docs/index_de.html
new file mode 100644
index 0000000..1b783c1
--- /dev/null
+++ b/docs/index_de.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Reticulum
+Reticulum ist der kryptografiebasierte Netzwerkstack für den Aufbau von lokalen und Weitverkehrsnetzen mit leicht verfügbarer Hardware. Reticulum kann auch unter ungünstigen Bedingungen mit sehr hoher Latenz und extrem geringer Bandbreite weiterarbeiten.
+Die Vision von Reticulum ist es, jedem die Möglichkeit zu geben, seine eigenen souveränen Kommunikationsnetze zu betreiben, und es billig und einfach zu machen, große Gebiete mit einer Vielzahl von unabhängigen, zusammenschaltbaren und autonomen Netzen abzudecken. Reticulum ist unaufhaltsame Netzwerke für die Menschen.
+
+
+Reticulum ist nicht ein Netzwerk. Es ist ein Werkzeug zum Aufbau tausender Netzwerke. Netze ohne Kill-Switches, Überwachung, Zensur und Kontrolle. Netzwerke, die frei miteinander interagieren, sich verbinden und trennen können. Reticulum ist ein Netzwerk für Menschen.
+Aus Sicht der Nutzer ermöglicht Reticulum die Entwicklung von Anwendungen, die die Autonomie und Souveränität von Gemeinschaften und Einzelpersonen respektieren und stärken. Reticulum bietet eine sichere digitale Kommunikation, die keiner Kontrolle, Manipulation oder Zensur von außen unterliegt.
+Reticulum ermöglicht den Aufbau sowohl kleiner als auch potenziell planetarer Netzwerke, ohne dass hierarchische oder behördliche Strukturen zu deren Kontrolle oder Verwaltung erforderlich sind, und sichert Individuen und Gemeinschaften die volle Souveränität über ihre eigenen Netzwerksegmente.
+Erwähnenswerte Merkmale
+Reticulum löst zwar das gleiche Problem wie jeder andere Netzwerkstack, nämlich Daten zuverlässig von einem Punkt zu einem anderen über eine Reihe von Zwischenstationen zu transportieren, aber auf eine Weise, die sich von anderen Netzwerktechnologien stark unterscheidet.
+
+Reticulum verwendet keine Quelladressen. Keines der übertragenen Pakete enthält Informationen über die Adresse, den Ort, die Maschine oder die Person, von der es stammt.
+Es gibt keine zentrale Kontrolle über den Adressraum in Reticulum. Jeder kann so viele Adressen zuweisen, wie er braucht und wann er sie braucht.
+Reticulum gewährleistet eine durchgängige Konnektivität. Neu generierte Adressen werden innerhalb von Sekunden bis wenigen Minuten global erreichbar.
+Adressen sind selbstständig und portabel . Sobald eine Adresse erstellt wurde, kann sie physisch an einen anderen Ort im Netz verschoben werden und ist weiterhin erreichbar.
+Die gesamte Kommunikation ist standardmäßig mit starker, moderner Verschlüsselung gesichert.
+Alle Verschlüsselungsschlüssel sind kurzlebig, und die Kommunikation bietet standardmäßig ein Vorwärtsgeheimnis.
+Es ist nicht möglich, unverschlüsselte Verbindungen in Reticulum-Netzen herzustellen.
+Es ist nicht möglich, unverschlüsselte Pakete an beliebige Ziele im Netz zu senden.
+Ziele, die unverschlüsselte Pakete empfangen, verwerfen diese als ungültig.
+
+Nächstes Thema: Los geht's
+
+
diff --git a/docs/index_es.html b/docs/index_es.html
new file mode 100644
index 0000000..808b563
--- /dev/null
+++ b/docs/index_es.html
@@ -0,0 +1,36 @@
+
+
+
+
+Reticulum Network
+
Reticulum
+Reticulum es la infraestructura basada en criptografía para construir redes locales y de área amplia (WAN) utilizando hardware fácilmente disponible. Reticulum puede continuar operando incluso en condiciones adversas con latencia muy alta y ancho de banda extremadamente bajo.
+La visión de Reticulum es permitir que cualquiera opere sus propias redes de comunicación soberanas, hacerlo barato y que cubrir vastas áreas con una multitud de redes independientes, interconectables y autónomas sea fácil. Reticulum es Redes Imparables para La Gente.
+
+
+Reticulum no es una red. Es una herramienta para construir miles de redes. Redes sin interruptores de apagado, vigilancia, censura y control. Redes que pueden operar libremente entre sí, asociarse y desasociarse entre ellas. Reticulum es Redes para Personas.
+Desde la perspectiva de un usuario, Reticulum permite crear aplicaciones que respetan y fortalecen la autonomía y soberanía de comunidades e individuos.
+Reticulum ofrece comunicación digital segura que no puede someterse a control externo, manipulación o censura.
+Reticulum permite la construcción de redes tanto pequeñas como potencialmente a escala planetaria, sin necesidad de estructuras jerárquicas o burocráticas para controlarlas o administrarlas, mientras garantiza que las personas y comunidades tengan plena soberanía sobre sus propios segmentos de red.
+Características Destacadas
+Reticulum resuelve el mismo problema que cualquier infraestructura de redes, es decir, transmitir información de forma fiable de un punto a otro a través de un número indeterminado de intermediarios, pero lo hace de una forma muy diferente a otras tecnologías.
+
+Reticulum no utiliza direcciones de origen. Ningún paquete transmitido incluye información sobre la dirección, lugar, máquina o persona desde donde se originó.
+No hay control central sobre el espacio de direcciones en Reticulum. Cada uno puede asignar tantas direcciones como necesite, cuando lo necesite.
+Reticulum garantiza conexión de extremo a extremo. Las direcciones recién generadas se vuelven globalmente alcanzables en un plazo que va de segundos a solo unos minutos.
+Las direcciones son soberanas y portátiles . Una vez creada una dirección, puede ser movida físicamente a otro lugar en la red y seguir siendo alcanzable.
+Toda la comunicación está cifrada de forma predeterminada con encriptación potente y moderna .
+Todas las claves de encriptación son efímeras y la comunicación ofrece secreto hacia adelante por defecto.
+Es imposible establecer enlaces sin cifrar en redes Reticulum.
+Es imposible enviar paquetes sin cifrar a destinos en la red.
+Los destinos que reciban paquetes sin cifrar, los descartaran como paquetes inválidos.
+
+Siguiente tema: Empezar
+
+
diff --git a/docs/index_jp.html b/docs/index_jp.html
new file mode 100644
index 0000000..cd63011
--- /dev/null
+++ b/docs/index_jp.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
レティクル
+レティクルは、利用可能なハードウェアを使用してローカルおよび広域ネットワークを構築するための、暗号ベースのネットワーキングスタックです。レティクルは、非常に高いレイテンシと極めて低い帯域幅の逆境条件でも動作を継続することができます。
+レティクルのビジョンは、誰もが独自の通信ネットワークを運営し、多くの独立した、相互接続可能で自律的なネットワークで広範囲をカバーすることが安価かつ容易になるようにすることです。レティクルは、人々のための停止できないネットワークです。
+
+
+レティクルは 1 つの ネットワークではありません。それは 数千のネットワーク を構築するためのツールです。キルスイッチ、監視、検閲、および制御のないネットワーク。これらは自由に相互運用し、結びつき、解結することができるネットワークです。レティクルは、人間のためのネットワークです。
+ユーザーの視点から見ると、レティクルはコミュニティと個人の自治および主権を尊重し、強化するアプリケーションの作成を可能にします。レティクルは外部の制御、操作、または検閲を受けることのない安全なデジタルコミュニケーションを提供します。
+レティクルは、階層的またはビューロクラティックな構造が必要なく、個人やコミュニティが独自のネットワークセグメントに対して完全な主権を確保しながら、小規模なネットワークから潜在的な地球規模のネットワークまでの構築を可能にします。
+注目すべき特徴
+レティクルは、他のネットワーキング技術とは非常に異なる方法で、任意の中間者を介してデータを信頼性をもって一点から別の点まで取得するという同じ問題を解決します。
+
+レティクルはソースアドレスを使用しません。転送されるパケットには、それが発信元のアドレス、場所、マシン、または人物に関する情報が含まれません。
+レティクルにおいてアドレススペースに対する中央制御はありません。必要なだけ多くのアドレスを割り当てることができ、必要な時にそれを行うことができます。
+レティクルはエンドツーエンドの接続性を確保します。新しく生成されたアドレスは、数秒から数分でグローバルに到達可能になります。
+アドレスは 自己主権 かつ 携帯可能 です。アドレスが一度作成されると、物理的にネットワーク内の別の場所に移動し、引き続き到達可能です。
+すべての通信は、強力で現代的な暗号化 によってデフォルトで保護されています。
+すべての暗号鍵は一時的であり、通信はデフォルトで前方秘匿を提供します。
+レティクルネットワークでは非暗号化のリンクを確立することはできません。
+レティクルネットワークへの宛先に対して非暗号化のパケットを送信することはできません。
+非暗号化のパケットを受信した宛先は、それらを無効として破棄します。
+
+次のトピック: はじめに
+
+
diff --git a/docs/index_nl.html b/docs/index_nl.html
new file mode 100644
index 0000000..109e2f0
--- /dev/null
+++ b/docs/index_nl.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Reticulum
+Reticulum is de op cryptografie gebaseerde netwerkstack voor het bouwen van lokale en wide-area-netwerken met direct beschikbare hardware. Reticulum kan zelfs onder ongunstige omstandigheden blijven werken met een zeer hoge latentie en extreem lage bandbreedte.
+De visie van Reticulum is om iedereen in staat te stellen zijn eigen soevereine communicatienetwerken te exploiteren en het goedkoop en gemakkelijk te maken om grote gebieden te bestrijken met een groot aantal onafhankelijke, onderling verbonden en autonome netwerken. Reticulum is onstuitbare netwerken voor het volk.
+
+
+Reticulum is niet één netwerk. Het is een hulpmiddel voor het bouwen van duizenden netwerken . Netwerken zonder kill-switches, surveillance, censuur en controle. Netwerken die vrij met elkaar kunnen samenwerken, zich kunnen associëren en zich kunnen losmaken. Reticulum is netwerken voor mensen.
+Vanuit het perspectief van de gebruiker maakt Reticulum de creatie mogelijk van applicaties die de autonomie en soevereiniteit van gemeenschappen en individuen respecteren en versterken. Reticulum biedt veilige digitale communicatie die niet kan worden onderworpen aan controle, manipulatie of censuur van buitenaf.
+Reticulum maakt de constructie mogelijk van zowel kleine als potentieel planetaire netwerken, zonder enige noodzaak voor hiërarchische of beaureucratische structuren om deze te controleren of te beheren, terwijl individuen en gemeenschappen volledige soevereiniteit over hun eigen netwerksegmenten worden gegarandeerd.
+Opmerkelijke kenmerken
+Hoewel Reticulum hetzelfde probleem oplost als elke netwerkstack, namelijk gegevens betrouwbaar van het ene punt naar het andere krijgen via een aantal tussenpersonen, doet het dit op een manier die heel anders is dan andere netwerktechnologieën.
+
+Reticulum gebruikt geen bronadressen. Geen van de verzonden pakketten bevat informatie over het adres, de plaats, de machine of de persoon waar ze vandaan komen.
+Er is geen centrale controle over de adresruimte in Reticulum. Iedereen kan zoveel adressen toewijzen als hij nodig heeft, wanneer hij die nodig heeft..
+Reticulum zorgt voor end-to-end connectiviteit. Nieuw gegenereerde adressen worden binnen enkele seconden tot enkele minuten wereldwijd bereikbaar.
+Adressen zijn zelf-soeverein en draagbaar . Zodra een adres is aangemaakt, kan het fysiek naar een andere plek in het netwerk worden verplaatst en bereikbaar blijven.
+Alle communicatie is standaard beveiligd met sterke, moderne encryptie .
+Alle encryptiesleutels zijn kortstondig en communicatie biedt standaard voorwaartse geheimhouding.
+Het is niet mogelijk om ongecodeerde links tot stand te brengen in Reticulum-netwerken.
+Het is niet mogelijk om ongecodeerde pakketten naar bestemmingen in het netwerk te verzenden.
+Bestemmingen die niet-versleutelde pakketten ontvangen, zullen deze als ongeldig verwijderen.
+
+Volgend onderwerp: aan de slag
+
+
diff --git a/docs/index_pl.html b/docs/index_pl.html
new file mode 100644
index 0000000..f73fe44
--- /dev/null
+++ b/docs/index_pl.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Reticulum
+Reticulum to oparty na kryptografii stos sieciowy do budowy sieci lokalnych (LAN) i rozległych (WAN) z wykorzystaniem łatwo dostępnego sprzętu. Reticulum może kontynuować pracę nawet w niekorzystnych warunkach, przy bardzo dużych opóźnieniach i ekstremalnie niskiej przepustowości.
+Wizją Reticulum jest umożliwienie każdemu zarządzanie własnymi, niezależnymi sieciami komunikacyjnymi, a także umożliwienie taniego i łatwego pokrycia ogromnych obszarów niezliczoną ilością niezależnych, wzajemnie połączonych i autonomicznych sieci. Reticulum to Niepowstrzymane Sieci dla Ludzi.
+
+
+Reticulum nie jest jedną siecią. Jest narzędziem do budowy tysięcy sieci . Sieci bez wyłączników, nadzoru, cenzury i kontroli. Sieci, które mogą swobodnie współdziałać, łączyć się i rozłączać ze sobą. Reticulum to Sieci dla Istot Ludzkich.
+Z punktu widzenia użytkownika, Reticulum pozwala na tworzenie aplikacji, które szanują i wzmacniają autonomię i niezależność społeczności i jednostek. Reticulum zapewnia bezpieczną komunikację cyfrową, która nie może być poddana zewnętrznej kontroli, manipulacji czy cenzurze.
+Reticulum umożliwia budowę zarówno małych, jak i potencjalnie planetarnych sieci, bez potrzeby tworzenia hierarchicznych lub biurokratycznych struktur do ich kontroli lub zarządzania, zapewniając jednocześnie jednostkom i społecznościom pełną niezależność nad ich własnymi segmentami sieci.
+Istotne Cechy
+Podczas gdy Reticulum rozwiązuje ten sam problem, co każdy stos sieciowy, a mianowicie niezawodne przesyłanie danych z jednego punktu do drugiego przez licznych pośredników, robi to w sposób, który bardzo różni się od innych technologii sieciowych.
+
+Reticulum nie korzysta z adresów źródłowych. Żadne przesyłane pakiety nie zawierają informacji o adresie, miejscu, maszynie czy osobie, z której pochodzą.
+W Reticulum nie ma centralnej kontroli nad przestrzenią adresową. Każdy może przydzielić tyle adresów ile potrzebuje i kiedy potrzebuje.
+Reticulum zapewnia łączność end-to-end. Nowo wygenerowane adresy stają się globalnie osiągalne w czasie kilku sekund do kilku minut.
+Adresy są samostanowiące i przenośne . Po utworzeniu adresu można go przenieść fizycznie w inne miejsce w sieci i nadal być osiągalnym.
+Cała komunikacja jest domyślnie zabezpieczona silnym, nowoczesnym szyfrowaniem .
+Wszystkie klucze szyfrujące są efemeryczne, a komunikacja domyślnie oferuje utajnianie z wyprzedzeniem (forward secrecy).
+W sieciach Reticulum nie ma możliwości tworzenia nieszyfrowanych połączeń.
+Nie jest możliwe wysyłanie niezaszyfrowanych pakietów do jakichkolwiek miejsc docelowych w sieci.
+Miejsca docelowe otrzymujące niezaszyfrowane pakiety będą je odrzucały jako nieprawidłowe.
+
+Następny Temat: Jak zacząć
+
+
diff --git a/docs/index_pt-br.html b/docs/index_pt-br.html
new file mode 100644
index 0000000..37f372a
--- /dev/null
+++ b/docs/index_pt-br.html
@@ -0,0 +1,36 @@
+
+
+
+
+Reticulum Network
+
Reticulum
+Reticulum é uma framework de redes baseada em criptografia para desenvolver redes locais e distantes, utilizando o hardware disponível. Reticulum pode operar em condições adversas como alta latência e velocidade de rede extremamente baixa.
+A visão do Reticulum é permitir que qualquer um possa operar sua própria rede de comunicação, sendo barato e fácil de cobrir vastas áreas com uma miríade de redes independentes, interconectáveis e autônomas.
+Reticulum é "Redes Imparáveis Para o Povo".
+
+
+O Reticulum não é uma rede. é uma ferramenta para construir milhares de redes. Redes sem interruptores, espionagem, censura ou controle. Redes que podem livremente interoperar, se associar e disassociar com cada uma. Reticulum é "Redes para Seres Humanos".
+Pela perspectiva do usuário, Reticulum permite a criação de aplicações que respeitam e empoderam a autonomia e soberania de comunidades e indivíduos. Reticulum provê comunicação digital segura que não pode ser submetida ao controle, manipulação e censura.
+Reticulum permite a construção de redes pequenas ou de escala planetária, sem a necessidade de estruturas hierárquicas ou burocráticas que controlem elas, enquanto garante que indivíduos e comunidades tenham total soberania sobre suas próprias redes.
+Caracteristicas Notáveis
+Enquanto o Reticulum resolve o mesmo problema que todo framework de rede, isto é, para obter dados de forma confiável de um ponto para outro por um número de intermediários, faz de uma forma muito diferente de outras tecnologias de rede.
+
+Reticulum não utiliza endereços-fonte, nenhum pacote transmitido inclui informação de endereço, local, computador ou pessoa que enviou.
+Não há controle central sobre o espaço de endereços no Reticulum. Qualquer um pode criar quantos endereços quiser, quando quiser.
+Reticulum garante conexão de ponta-a-ponta. Novos endereços criados são acessíveis globalmente em questão de segundos ou minutos.
+Endereços são soberanos e portáteis. Uma vez que um endereço foi criado, ele pode ser movido fisicamente para outro local da rede, e continuará acessível.
+Toda conexão é assegurada com criptografia forte e moderna por padrão.
+Todas as chaves de criptografia são efêmeras, e a comunicação fornece forward-secrecy por padrão.
+Não é possível criar links sem criptografia em redes Reticulum.
+Não é possível enviar pacotes sem criptografia para qualquer endereço da rede.
+Endereços recebendo pacotes sem criptografia iram descartá-los como inválidos.
+
+Próxima Página: Começar
+
+
diff --git a/docs/index_tr.html b/docs/index_tr.html
new file mode 100644
index 0000000..40af5e5
--- /dev/null
+++ b/docs/index_tr.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Reticulum
+Reticulum, hazır bulunan donanım ile yerel ve geniş alan ağları oluşturmak için kriptografi tabanlı bir ağ yığınıdır. Reticulum, çok yüksek gecikme süresi ve son derece düşük bant genişliği koşullarında bile çalışmaya devam edebilir.
+Reticulum'un vizyonu, herkesin kendi bağımsız iletişim ağlarını işletmesine ve bağımsız, birbirine bağlanabilir ve otonom ağları geniş alanlarda uygun maliyetli ve kolay bir şekilde kapsamak için olanak tanımaktır. Reticulum, Özgür Toplum İçin Durdurulamayan Ağlardır.
+
+
+Reticulum, bir ağ değildir. Binlerce ağ oluşturmak için bir araçtır. Anahtarları, gözetleme, sansür ve kontrol olmadan çalışan ağlar. Serbestçe birbirleriyle etkileşime girebilen, ilişkilendirilebilen ve ayrılabilecek ağlar. Reticulum, İnsanlık İçin Vardır.
+Kullanıcı perspektifinden bakıldığında, Reticulum toplulukların ve bireylerin özerkliğini ve egemenliğini saygılayan ve güçlendiren uygulamaların oluşturulmasına olanak tanır. Reticulum, dış kontrol, manipülasyon veya sansüre tabi olmayan güvenli dijital iletişim sağlar.
+Reticulum, hiyerarşik veya bürokratik yapıların kontrol veya yönetimine ihtiyaç duymadan hem küçük hem de potansiyel olarak gezegen ölçeğinde ağların oluşturulmasını sağlar, bu süreçte bireylere ve topluluklara kendi ağ segmentleri üzerinde tam egemenlik sağlar.
+Dikkat Çeken Özellikler
+Reticulum, herhangi bir ağ yığınının çözdüğü aynı problemleri çözerken, veriyi güvenilir bir şekilde bir noktadan diğerine bir dizi aracı üzerinden iletmek bakımından diğer ağ teknolojilerinden çok farklı bir şekilde yapar.
+
+Reticulum kaynak adresleri kullanmaz. Gönderilen paketler, bunların kaynaklandığı adres, yer, makine veya kişi hakkında bilgi içermez.
+Reticulum'da adres alanı üzerinde merkezi kontrol yoktur. İhtiyaç duyulduğunda herkes, ihtiyaçları doğrultusunda istedikleri kadar adresi tahsis edebilir.
+Reticulum, uçtan uca bağlantıyı sağlar. Yeni oluşturulan adresler, birkaç saniye ila birkaç dakika içinde küresel olarak ulaşılabilir hale gelir.
+Adresler bağımsız ve taşınabilirdir . Bir adres oluşturulduktan sonra, fiziksel olarak başka bir yere taşınabilir ve erişilebilirliğini sürdürebilir.
+Tüm iletişim, güçlü, modern şifreleme ile varsayılan olarak güvence altına alınmıştır.
+Tüm şifreleme anahtarları geçici olup, iletişim varsayılan olarak forward secrecy sunar.
+Reticulum ağlarında şifresiz bağlantılar kurmak mümkün değildir.
+Ağın herhangi bir hedefine şifresiz paket göndermek mümkün değildir.
+Şifresiz paketler alan konumlar, bunları geçersiz olarak görecektir.
+
+Sonraki Konu: Başlangıç
+
+
diff --git a/docs/index_uk.html b/docs/index_uk.html
new file mode 100644
index 0000000..bea370f
--- /dev/null
+++ b/docs/index_uk.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Reticulum
+Reticulum — це криптографічна мережна структура для створення локальних і широкомасштабних мереж з використанням доступного апаратного забезпечення. Reticulum може продовжувати працювати навіть за несприятливих умов з дуже високою затримкою і надзвичайно низькою пропускною здатністю.
+Місія Reticulum — дозволити кожному створювати власні суверенні комунікаційні мережі та зробити їх дешевими й простими для покриття великих територій безліччю незалежних, взаємопідключених і автономних мереж. Reticulum — це мережі, котрі не зупинити для людей.
+
+
+Reticulum — це не одна мережа. Це інструмент для створення тисяч мереж. Мереж без вимикачів, спостереження, цензури й контролю. Мереж, які можуть вільно взаємодіяти, асоціюватися і роз’єднуватися між собою. Reticulum — це мережі для людей.
+З погляду користувача, Reticulum дозволяє створювати додатки, які поважають і зміцнюють автономію та суверенітет громад і осіб. Reticulum забезпечує безпечну цифрову комунікацію, яку не можна піддавати зовнішньому контролю, маніпуляціям або цензурі.
+Reticulum дозволяє будувати як малі, так і потенційно планетарні мережі без необхідності в ієрархічних або бюрократичних структурах для їх контролю чи управління, при цьому забезпечуючи повний суверенітет осіб і громад над їхніми власними сегментами мережі.
+Основні характеристики
+Хоча Reticulum вирішує ту ж проблему, що й будь-яка інша мережна структура, а саме забезпечити надійний перехід даних з однієї точки в іншу через кілька посередників, він робить це дуже по-іншому порівняно з іншими мережними технологіями.
+
+Reticulum не використовує адреси джерела. Жоден переданий пакет не містить інформації про адресу, місце, машину чи людину, з якої він надійшов.
+В Reticulum немає центрального контролю над простором адрес. Кожен може виділяти стільки адрес, скільки йому потрібно, коли вони йому потрібні.
+Reticulum забезпечує з’єднання від кінця до кінця. Новостворені адреси стають глобально доступними протягом декількох секунд або хвилин.
+Адреси є самостійними та переносними. Після того, як адреса була створена, її можна фізично перемістити в інше місце в мережі й продовжувати бути доступною.
+Усі комунікації за замовчуванням захищені сильним, сучасним шифруванням.
+Усі ключі шифрування є тимчасовими, а комунікація за замовчуванням забезпечує вперед-секретність.
+У мережах Reticulum неможливо встановити незашифровані з’єднання.
+Неможливо надсилати незашифровані пакети в будь-які пункти призначення в мережі.
+Пункти призначення, які отримують незашифровані пакети, відкидатимуть їх як недійсні.
+
+Наступна тема: Розпочати
+
+
diff --git a/docs/index_zh-cn.html b/docs/index_zh-cn.html
new file mode 100644
index 0000000..35edca4
--- /dev/null
+++ b/docs/index_zh-cn.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
Reticulum
+Reticulum 是一个基于密码学的网络栈。人们可以用现有的硬件设备基于 Reticulum 搭建本地或是广域的网络。Reticulum 就算是在极高延迟与极低带宽的情况下仍旧可以运行。
+Reticulum 的愿景是让任何人都能够搭建自己的通讯网络——用独立、互联、自治的网络覆盖广阔地域从未如此简单而廉价。Reticulum 是为了人民的、势不可挡的网络。
+
+
+Reticulum 不单单是一个 网络。它是用来搭建成千上万 网络的工具——成千上万个没有停止按钮(kill-switches)、没有监控、没有审查与控制，但却能协调运作、有机结合的网络。Reticulum 是为了人类的网络。
+在用户看来，Reticulum 可以用来构建尊重社区与个人的自治性和独立性的应用。它提供了无法被外部操纵、篡改或是审查的安全数字通信。
+Reticulum 可以用于搭建小型乃至覆盖全星球的网络体系，而无需任何层级或是官僚化的控制管理结构。Reticulum 同时还能保证社区与个人对自己那部分网络的主权。
+值得注意的特质
+虽然 Reticulum 处理的是任何一个网络栈都在尝试解决的问题，即让数据通过数个中间节点，可靠地从一方传输到另一方，但其处理这一问题的方式与其他网络技术却有着很大差异。
+
+Reticulum 不使用源地址。数据包中不会包含源地址、发送位置、机器与操作者相关的信息。
+Reticulum 中没有对于地址空间的中央控制。任何人都可以在需要的时候分配任意多的地址。
+Reticulum 保证端到端连接性。新生的地址会在数秒到数分钟之内全局可及。
+地址是自主 便携 的。它们可以在物理上被移动到网络的另一位置并仍旧保持可及。
+所有通信都默认由现代而健壮的加密 保护。
+所有的密钥都是临时密钥，且通信自带前向保密。
+无法在 Reticulum 网络中建立未加密连接。
+无法在 Reticulum 网络中向任何目标发送未加密的数据包。
+收到未加密数据包的目标会将其视为无效数据包并丢弃。
+
+下一个主题: 开始使用
+
+
diff --git a/docs/license-de.html b/docs/license-de.html
new file mode 100644
index 0000000..1a8cd91
--- /dev/null
+++ b/docs/license-de.html
@@ -0,0 +1,35 @@
+
+
+
+
+Reticulum Network
+
MIT Lizenz
+
+Copyright (c) 2016-2024 Mark Qvist / unsigned.io
+
+Hiermit wird jeder Person, die eine Kopie dieser Software und der zugehörigen Dokumentationsdateien (die "Software") erwirbt, die kostenlose Erlaubnis erteilt
+dieser Software und der zugehörigen Dokumentationsdateien (die "Software") erhält, das Recht
+der Software ohne Einschränkung zu handeln, einschließlich und ohne Einschränkung der Rechte
+zu nutzen, zu kopieren, zu modifizieren, zusammenzuführen, zu veröffentlichen, zu vertreiben, zu unterlizenzieren und/oder zu verkaufen
+der Software zu nutzen, zu kopieren, zu modifizieren, zu veröffentlichen, zu vertreiben, zu unterlizenzieren und/oder zu verkaufen, und
+zu erlauben, dies zu tun, vorbehaltlich der folgenden Bedingungen:
+
+Der obige Copyright-Hinweis und dieser Genehmigungshinweis müssen in allen Kopien oder wesentlichen Teilen der Software enthalten sein.
+Kopien oder wesentlichen Teilen der Software enthalten sein.
+
+DIE SOFTWARE WIRD OHNE MÄNGELGEWÄHR UND OHNE JEGLICHE AUSDRÜCKLICHE ODER
+STILLSCHWEIGEND, EINSCHLIESSLICH, ABER NICHT BESCHRÄNKT AUF DIE GARANTIE DER MARKTGÄNGIGKEIT,
+EIGNUNG FÜR EINEN BESTIMMTEN ZWECK UND NICHTVERLETZUNG VON RECHTEN DRITTER. IN KEINEM FALL SIND DIE
+DIE AUTOREN ODER URHEBERRECHTSINHABER FÜR JEGLICHE ANSPRÜCHE, SCHÄDEN ODER ANDERE
+HAFTUNG, SEI ES AUS VERTRAG, UNERLAUBTER HANDLUNG ODER ANDERWEITIG, DIE SICH AUS,
+AUS ODER IN VERBINDUNG MIT DER SOFTWARE ODER DER NUTZUNG ODER DEM SONSTIGEN UMGANG MIT DER
+SOFTWARE.
+Reticulum Network
+
MIT License
+
+Copyright (c) 2016-2024 Mark Qvist / unsigned.io
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+Reticulum Network
+
MIT Lizenz
+
+Copyright (c) 2016-2024 Mark Qvist / unsigned.io
+
+Hiermit wird jeder Person, die eine Kopie dieser Software und der zugehörigen Dokumentationsdateien (die "Software") erwirbt, die kostenlose Erlaubnis erteilt
+dieser Software und der zugehörigen Dokumentationsdateien (die "Software") erhält, das Recht
+der Software ohne Einschränkung zu handeln, einschließlich und ohne Einschränkung der Rechte
+zu nutzen, zu kopieren, zu modifizieren, zusammenzuführen, zu veröffentlichen, zu vertreiben, zu unterlizenzieren und/oder zu verkaufen
+der Software zu nutzen, zu kopieren, zu modifizieren, zu veröffentlichen, zu vertreiben, zu unterlizenzieren und/oder zu verkaufen, und
+zu erlauben, dies zu tun, vorbehaltlich der folgenden Bedingungen:
+
+Der obige Copyright-Hinweis und dieser Genehmigungshinweis müssen in allen Kopien oder wesentlichen Teilen der Software enthalten sein.
+Kopien oder wesentlichen Teilen der Software enthalten sein.
+
+DIE SOFTWARE WIRD OHNE MÄNGELGEWÄHR UND OHNE JEGLICHE AUSDRÜCKLICHE ODER
+STILLSCHWEIGEND, EINSCHLIESSLICH, ABER NICHT BESCHRÄNKT AUF DIE GARANTIE DER MARKTGÄNGIGKEIT,
+EIGNUNG FÜR EINEN BESTIMMTEN ZWECK UND NICHTVERLETZUNG VON RECHTEN DRITTER. IN KEINEM FALL SIND DIE
+DIE AUTOREN ODER URHEBERRECHTSINHABER FÜR JEGLICHE ANSPRÜCHE, SCHÄDEN ODER ANDERE
+HAFTUNG, SEI ES AUS VERTRAG, UNERLAUBTER HANDLUNG ODER ANDERWEITIG, DIE SICH AUS,
+AUS ODER IN VERBINDUNG MIT DER SOFTWARE ODER DER NUTZUNG ODER DEM SONSTIGEN UMGANG MIT DER
+SOFTWARE.
+Reticulum Network
+
MIT License
+
+Copyright (c) 2016-2024 Mark Qvist / unsigned.io
+
+Por la presente se concede permiso, libre de cargos, a cualquier persona que obtenga una copia
+de este software y de los archivos de documentación asociados (el "Software"), a utilizar el
+Software sin restricción, incluyendo sin limitación los derechos a usar, copiar, modificar,
+fusionar, publicar, distribuir, sublicenciar, y/o vender copias del Software, y a permitir a
+las personas a las que se les proporcione el Software a hacer lo mismo, sujeto a las siguientes condiciones:
+
+El aviso de copyright anterior y este aviso de permiso se incluirán en todas las copias o partes sustanciales del Software.
+
+EL SOFTWARE SE PROPORCIONA "COMO ESTÁ", SIN GARANTÍA DE NINGÚN TIPO, EXPRESA O IMPLÍCITA,
+INCLUYENDO PERO NO LIMITADO A GARANTÍAS DE COMERCIALIZACIÓN, IDONEIDAD PARA UN PROPÓSITO
+PARTICULAR E INCUMPLIMIENTO. EN NINGÚN CASO LOS AUTORES O PROPIETARIOS DE LOS DERECHOS
+DE AUTOR SERÁN RESPONSABLES DE NINGUNA RECLAMACIÓN, DAÑOS U OTRAS RESPONSABILIDADES, YA
+SEA EN UNA ACCIÓN DE CONTRATO, AGRAVIO O CUALQUIER OTRO MOTIVO, DERIVADAS DE, FUERA DE O
+EN CONEXIÓN CON EL SOFTWARE O SU USO U OTRO TIPO DE ACCIONES EN EL SOFTWARE.
+Reticulum Network
+
MIT Ліцензія
+
+Авторські права (c) 2016-2024 Mark Qvist / unsigned.io
+
+Цим надається безкоштовна ліцензія будь-якій особі, яка отримає копію
+цього програмного забезпечення та супутніх документаційних файлів ("Програмне забезпечення"), використовувати
+Програмне забезпечення без обмежень, зокрема, але не обмежуючись правами
+на використання, копіювання, модифікацію, об'єднання, публікацію, розповсюдження, надання ліцензії, і/або продаж
+копій Програмного забезпечення, а також дозволяти особам, яким надається це Програмне забезпечення, робити це, за умови дотримання наступних умов:
+
+Усі копії або суттєві частини цього Програмного забезпечення повинні містити
+вище зазначене повідомлення про авторські права та це повідомлення про дозвіл.
+
+ПРОГРАМНЕ ЗАБЕЗПЕЧЕННЯ НАДАЄТЬСЯ "ЯК Є", БЕЗ ЯКОЇ-НЕБУДЬ ГАРАНТІЇ, ВИРАЖЕНОЇ АБО
+НЕВИРАЖЕНОЇ, ВКЛЮЧАЮЧИ, АЛЕ НЕ ОБМЕЖУЮЧИСЬ, ГАРАНТІЯМИ ПРОДОВЖУВАННЯ,
+ПРИДАТНІСТЬ ДЛЯ ПЕВНОЇ МЕТИ ТА НЕПОРУШЕННЯ ПРАВ. В ЖОДНОМУ ВИПАДКУ
+АВТОРИ АБО ВОЛОДІЛІ РОБОТОМ НЕ НЕСУТЬ ВІДПОВІДАЛЬНІСТЬ ЗА ЯКІ-БУДЬ
+СКАРГИ, ШКОДИ АБО ІНШІ ЗОБОВ'ЯЗАННЯ, ЯК У РАМКАХ ДОГОВОРУ, ДЕЛІКТУ АБО ІНШОГО, ЩО ВИНИКАЮТЬ З,
+АБО У ЗВ'ЯЗКУ З ПРОГРАМНИМ ЗАБЕЗПЕЧЕННЯМ, ЙОГО ВИКОРИСТАННЯМ АБО ІНШИМИ ДІЯМИ У
+ПОРОДЖЕННІ ПРОГРАМНОГО ЗАБЕЗПЕЧЕННЯ.
+`_.
+
+.. _example-announce:
+
+Announce
+========
+
+The *Announce* example builds upon the previous example by exploring how to
+announce a destination on the network, and how to let your program receive
+notifications about announces from relevant destinations.
+
+.. literalinclude:: ../../Examples/Announce.py
+
+This example can also be found at ``_.
+
+.. _example-broadcast:
+
+Broadcast
+=========
+The *Broadcast* example explores how to transmit plaintext broadcast messages
+over the network.
+
+.. literalinclude:: ../../Examples/Broadcast.py
+
+This example can also be found at ``_.
+
+.. _example-echo:
+
+Echo
+====
+
+The *Echo* example demonstrates communication between two destinations using
+the Packet interface.
+
+.. literalinclude:: ../../Examples/Echo.py
+
+This example can also be found at ``_.
+
+.. _example-link:
+
+Link
+====
+
+The *Link* example explores establishing an encrypted link to a remote
+destination, and passing traffic back and forth over the link.
+
+.. literalinclude:: ../../Examples/Link.py
+
+This example can also be found at ``_.
+
+.. _example-identify:
+
+Identification
+==============
+
+The *Identify* example explores identifying an intiator of a link, once
+the link has been established.
+
+.. literalinclude:: ../../Examples/Identify.py
+
+This example can also be found at ``_.
+
+.. _example-request:
+
+Requests & Responses
+====================
+
+The *Request* example explores sending requests and receiving responses.
+
+.. literalinclude:: ../../Examples/Request.py
+
+This example can also be found at ``_.
+
+.. _example-channel:
+
+Channel
+=======
+
+The *Channel* example explores using a ``Channel`` to send structured
+data between peers of a ``Link``.
+
+.. literalinclude:: ../../Examples/Channel.py
+
+This example can also be found at ``_.
+
+Buffer
+======
+
+The *Buffer* example explores using buffered readers and writers to send
+binary data between peers of a ``Link``.
+
+.. literalinclude:: ../../Examples/Buffer.py
+
+This example can also be found at ``_.
+
+.. _example-filetransfer:
+
+Filetransfer
+============
+
+The *Filetransfer* example implements a basic file-server program that
+allow clients to connect and download files. The program uses the Resource
+interface to efficiently pass files of any size over a Reticulum :ref:`Link`.
+
+.. literalinclude:: ../../Examples/Filetransfer.py
+
+This example can also be found at ``_.
+
+.. _example-custominterface:
+
+Custom Interfaces
+=================
+
+The *ExampleInterface* demonstrates creating custom interfaces for Reticulum.
+Any number of custom interfaces can be loaded and utilised by Reticulum, and
+will be fully on-par with natively included interfaces, including all supported
+:ref:`interface modes` and :ref:`common configuration options`.
+
+.. literalinclude:: ../../Examples/ExampleInterface.py
+
+This example can also be found at ``_.
\ No newline at end of file
diff --git a/docs/manual/_sources/forhumans.rst.txt b/docs/manual/_sources/forhumans.rst.txt
new file mode 100644
index 0000000..e953d50
--- /dev/null
+++ b/docs/manual/_sources/forhumans.rst.txt
@@ -0,0 +1,4 @@
+********************************************
+An Explanation of Reticulum for Human Beings
+********************************************
+
diff --git a/docs/manual/_sources/gettingstartedfast.rst.txt b/docs/manual/_sources/gettingstartedfast.rst.txt
new file mode 100644
index 0000000..8b4f5ad
--- /dev/null
+++ b/docs/manual/_sources/gettingstartedfast.rst.txt
@@ -0,0 +1,749 @@
+********************
+Getting Started Fast
+********************
+
+The best way to get started with the Reticulum Network Stack depends on what
+you want to do. This guide will outline sensible starting paths for different
+scenarios.
+
+
+Standalone Reticulum Installation
+=============================================
+If you simply want to install Reticulum and related utilities on a system,
+the easiest way is via the ``pip`` package manager:
+
+.. code::
+
+ pip install rns
+
+If you do not already have pip installed, you can install it using the package manager
+of your system with a command like ``sudo apt install python3-pip``,
+``sudo pamac install python-pip`` or similar.
+
+You can also dowload the Reticulum release wheels from GitHub, or other release channels,
+and install them offline using ``pip``:
+
+.. code::
+
+ pip install ./rns-0.5.1-py3-none-any.whl
+
+For more detailed installation instructions, please see the
+:ref:`Platform-Specific Install Notes` section.
+
+After installation is complete, it might be helpful to refer to the
+:ref:`Using Reticulum on Your System` chapter.
+
+Resolving Dependency & Installation Issues
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+On some platforms, there may not be binary packages available for all dependencies, and
+``pip`` installation may fail with an error message. In these cases, the issue can usually
+be resolved by installing the development essentials packages for your platform:
+
+.. code::
+
+ # Debian / Ubuntu / Derivatives
+ sudo apt install build-essential
+
+ # Arch / Manjaro / Derivatives
+ sudo pamac install base-devel
+
+ # Fedora
+ sudo dnf groupinstall "Development Tools" "Development Libraries"
+
+With the base development packages installed, ``pip`` should be able to compile any missing
+dependencies from source, and complete installation even on platforms that don't have pre-
+compiled packages available.
+
+Try Using a Reticulum-based Program
+=============================================
+
+If you simply want to try using a program built with Reticulum, a few different
+programs exist that allow basic communication and a range of other useful functions,
+even over extremely low-bandwidth Reticulum networks.
+
+These programs will let you get a feel for how Reticulum works. They have been designed
+to run well over networks based on LoRa or packet radio, but can also be used over fast
+links, such as local WiFi, wired Ethernet, the Internet, or any combination.
+
+As such, it is easy to get started experimenting, without having to set up any radio
+transceivers or infrastructure just to try it out. Launching the programs on separate
+devices connected to the same WiFi network is enough to get started, and physical
+radio interfaces can then be added later.
+
+Remote Shell
+^^^^^^^^^^^^
+
+The `rnsh `_ program lets you establish fully interactive
+remote shell sessions over Reticulum. It also allows you to pipe any program to or from a
+remote system, and is similar to how ``ssh`` works. The ``rnsh`` is very efficient, and
+can facilitate fully interactive shell sessions, even over extremely low-bandwidth links,
+such as LoRa or packet radio.
+
+Nomad Network
+^^^^^^^^^^^^^
+
+The terminal-based program `Nomad Network `_
+provides a complete encrypted communications suite built with Reticulum. It features
+encrypted messaging (both direct and delayed-delivery for offline users), file sharing,
+and has a built-in text-browser and page server with support for dynamically rendered pages,
+user authentication and more.
+
+.. image:: screenshots/nomadnet_3.png
+ :target: _images/nomadnet_3.png
+
+`Nomad Network `_ is a user-facing client
+for the messaging and information-sharing protocol
+`LXMF `_, another project built with Reticulum.
+
+You can install Nomad Network via pip:
+
+.. code::
+
+ # Install ...
+ pip install nomadnet
+
+ # ... and run
+ nomadnet
+
+.. note::
+ If this is the very first time you use ``pip`` to install a program
+ on your system, you might need to reboot your system for your program to become
+ available. If you get a "command not found" error or similar when running the
+ program, reboot your system and try again. In some cases, you may even need to
+ manually add the ``pip`` install path to your ``PATH`` environment variable.
+
+Sideband
+^^^^^^^^
+
+If you would rather use a program with a graphical user interface, you can take
+a look at `Sideband `_, which is available for Android,
+Linux, macOS and Windows.
+
+.. only:: html
+
+ .. image:: screenshots/sideband_devices.webp
+ :align: center
+ :target: _images/sideband_devices.webp
+
+.. only:: latex
+
+ .. image:: screenshots/sideband_devices.png
+ :align: center
+ :target: _images/sideband_devices.png
+
+Sideband allows you to communicate with other people or LXMF-compatible
+systems over Reticulum networks using LoRa, Packet Radio, WiFi, I2P, Encrypted QR
+Paper Messages, or anything else Reticulum supports. It also interoperates with
+the Nomad Network program.
+
+MeshChat
+^^^^^^^^
+
+The `Reticulum MeshChat `_ application
+is a user-friendly LXMF client for macOS and Windows, that also includes voice call
+functionality, and a range of other interesting functions.
+
+.. only:: html
+
+ .. image:: screenshots/meshchat_1.webp
+ :align: center
+ :target: _images/meshchat_1.webp
+
+.. only:: latex
+
+ .. image:: screenshots/meshchat_1.png
+ :align: center
+ :target: _images/meshchat_1.png
+
+Reticulum MeshChat is of course also compatible with Sideband and Nomad Network, or
+any other LXMF client.
+
+Using the Included Utilities
+=============================================
+Reticulum comes with a range of included utilities that make it easier to
+manage your network, check connectivity and make Reticulum available to other
+programs on your system.
+
+You can use ``rnsd`` to run Reticulum as a background or foreground service,
+and the ``rnstatus``, ``rnpath`` and ``rnprobe`` utilities to view and query
+network status and connectivity.
+
+To learn more about these utility programs, have a look at the
+:ref:`Using Reticulum on Your System` chapter of this manual.
+
+
+Creating a Network With Reticulum
+=============================================
+To create a network, you will need to specify one or more *interfaces* for
+Reticulum to use. This is done in the Reticulum configuration file, which by
+default is located at ``~/.reticulum/config``. You can get an example
+configuration file with all options via ``rnsd --exampleconfig``.
+
+When Reticulum is started for the first time, it will create a default
+configuration file, with one active interface. This default interface uses
+your existing Ethernet and WiFi networks (if any), and only allows you to
+communicate with other Reticulum peers within your local broadcast domains.
+
+To communicate further, you will have to add one or more interfaces. The default
+configuration includes a number of examples, ranging from using TCP over the
+internet, to LoRa and Packet Radio interfaces.
+
+With Reticulum, you only need to configure what interfaces you want to communicate
+over. There is no need to configure address spaces, subnets, routing tables,
+or other things you might be used to from other network types.
+
+Once Reticulum knows which interfaces it should use, it will automatically
+discover topography and configure transport of data to any destinations it
+knows about.
+
+In situations where you already have an established WiFi or Ethernet network, and
+many devices that want to utilise the same external Reticulum network paths (for example over
+LoRa), it will often be sufficient to let one system act as a Reticulum gateway, by
+adding any external interfaces to the configuration of this system, and then enabling transport on it. Any
+other device on your local WiFi will then be able to connect to this wider Reticulum
+network just using the default (:ref:`AutoInterface`) configuration.
+
+Possibly, the examples in the config file are enough to get you started. If
+you want more information, you can read the :ref:`Building Networks`
+and :ref:`Interfaces` chapters of this manual.
+
+Connecting Reticulum Instances Over the Internet
+================================================
+Reticulum currently offers two interfaces suitable for connecting instances over the Internet: :ref:`TCP`
+and :ref:`I2P`. Each interface offers a different set of features, and Reticulum
+users should carefully choose the interface which best suites their needs.
+
+The ``TCPServerInterface`` allows users to host an instance accessible over TCP/IP. This
+method is generally faster, lower latency, and more energy efficient than using ``I2PInterface``,
+however it also leaks more data about the server host.
+
+TCP connections reveal the IP address of both your instance and the server to anyone who can
+inspect the connection. Someone could use this information to determine your location or identity. Adversaries
+inspecting your packets may be able to record packet metadata like time of transmission and packet size.
+Even though Reticulum encrypts traffic, TCP does not, so an adversary may be able to use
+packet inspection to learn that a system is running Reticulum, and what other IP addresses connect to it.
+Hosting a publicly reachable instance over TCP also requires a publicly reachable IP address,
+which most Internet connections don't offer anymore.
+
+The ``I2PInterface`` routes messages through the `Invisible Internet Protocol
+(I2P) ` section of this manual.
+
+If you do not already have transceiver hardware available, you can easily and
+cheaply build an :ref:`RNode`, which is a general-purpose long-range
+digital radio transceiver, that integrates easily with Reticulum.
+
+To build one yourself requires installing a custom firmware on a supported LoRa
+development board with an auto-install script. Please see the :ref:`Communications Hardware`
+chapter for a guide. If you prefer purchasing a ready-made unit, you can refer to the
+:ref:`list of suppliers`. For more information on RNode, you can also
+refer to these additional external resources:
+
+* `How To Make Your Own RNodes `, but you think would be suitable for use with Reticulum,
+you are welcome to head over to the `GitHub discussion pages `_
+and propose adding an interface for the hardware.
+
+
+Creating and Using Custom Interfaces
+===========================================
+
+While Reticulum includes a flexible and broad range of built-in interfaces, these
+will not cover every conceivable type of communications hardware that Reticulum
+can potentially use to communicate.
+
+It is therefore possible to easily write your own interface modules, that can be
+loaded at run-time and used on-par with any of the built-in interface types.
+
+For more information on this subject, and code examples to build on, please see
+the :ref:`Configuring Interfaces` chapter.
+
+
+Develop a Program with Reticulum
+===========================================
+If you want to develop programs that use Reticulum, the easiest way to get
+started is to install the latest release of Reticulum via pip:
+
+.. code::
+
+ pip install rns
+
+The above command will install Reticulum and dependencies, and you will be
+ready to import and use RNS in your own programs. The next step will most
+likely be to look at some :ref:`Example Programs`.
+
+The entire Reticulum API is documented in the :ref:`API Reference`
+chapter of this manual.
+
+
+Participate in Reticulum Development
+==============================================
+If you want to participate in the development of Reticulum and associated
+utilities, you'll want to get the latest source from GitHub. In that case,
+don't use pip, but try this recipe:
+
+.. code::
+
+ # Install dependencies
+ pip install cryptography pyserial
+
+ # Clone repository
+ git clone https://github.com/markqvist/Reticulum.git
+
+ # Move into Reticulum folder and symlink library to examples folder
+ cd Reticulum
+ ln -s ../RNS ./Examples/
+
+ # Run an example
+ python Examples/Echo.py -s
+
+ # Unless you've manually created a config file, Reticulum will do so now,
+ # and immediately exit. Make any necessary changes to the file:
+ nano ~/.reticulum/config
+
+ # ... and launch the example again.
+ python Examples/Echo.py -s
+
+ # You can now repeat the process on another computer,
+ # and run the same example with -h to get command line options.
+ python Examples/Echo.py -h
+
+ # Run the example in client mode to "ping" the server.
+ # Replace the hash below with the actual destination hash of your server.
+ python Examples/Echo.py 174a64852a75682259ad8b921b8bf416
+
+ # Have a look at another example
+ python Examples/Filetransfer.py -h
+
+When you have experimented with the basic examples, it's time to go read the
+:ref:`Understanding Reticulum` chapter. Before submitting
+your first pull request, it is probably a good idea to introduce yourself on
+the `disucssion forum on GitHub `_,
+or ask one of the developers or maintainers for a good place to start.
+
+.. _install-guides:
+
+Platform-Specific Install Notes
+==============================================
+
+Some platforms require a slightly different installation procedure, or have
+various quirks that are worth being aware of. These are listed here.
+
+Android
+^^^^^^^^^^^^^^^^^^^^^^^^
+Reticulum can be used on Android in different ways. The easiest way to get
+started is using an app like `Sideband `_.
+
+For more control and features, you can use Reticulum and related programs via
+the `Termux app `_.
+
+Termux is a terminal emulator and Linux environment for Android based devices,
+which includes the ability to use many different programs and libraries,
+including Reticulum.
+
+To use Reticulum within the Termux environment, you will need to install
+``python`` and the ``python-cryptography`` library using ``pkg``, the package-manager
+build into Termux. After that, you can use ``pip`` to install Reticulum.
+
+From within Termux, execute the following:
+
+.. code::
+
+ # First, make sure indexes and packages are up to date.
+ pkg update
+ pkg upgrade
+
+ # Then install python and the cryptography library.
+ pkg install python python-cryptography
+
+ # Make sure pip is up to date, and install the wheel module.
+ pip install wheel pip --upgrade
+
+ # Install Reticulum
+ pip install rns
+
+If for some reason the ``python-cryptography`` package is not available for
+your platform via the Termux package manager, you can attempt to build it
+locally on your device using the following command:
+
+.. code::
+
+ # First, make sure indexes and packages are up to date.
+ pkg update
+ pkg upgrade
+
+ # Then install dependencies for the cryptography library.
+ pkg install python build-essential openssl libffi rust
+
+ # Make sure pip is up to date, and install the wheel module.
+ pip install wheel pip --upgrade
+
+ # To allow the installer to build the cryptography module,
+ # we need to let it know what platform we are compiling for:
+ export CARGO_BUILD_TARGET="aarch64-linux-android"
+
+ # Start the install process for the cryptography module.
+ # Depending on your device, this can take several minutes,
+ # since the module must be compiled locally on your device.
+ pip install cryptography
+
+ # If the above installation succeeds, you can now install
+ # Reticulum and any related software
+ pip install rns
+
+It is also possible to include Reticulum in apps compiled and distributed as
+Android APKs. A detailed tutorial and example source code will be included
+here at a later point. Until then you can use the `Sideband source code `_ as an example and starting point.
+
+
+ARM64
+^^^^^^^^^^^^^^^^^^^^^^^^
+On some architectures, including ARM64, not all dependencies have precompiled
+binaries. On such systems, you may need to install ``python3-dev`` (or similar) before
+installing Reticulum or programs that depend on Reticulum.
+
+.. code::
+
+ # Install Python and development packages
+ sudo apt update
+ sudo apt install python3 python3-pip python3-dev
+
+ # Install Reticulum
+ python3 -m pip install rns
+
+With these packages installed, ``pip`` will be able to build any missing dependencies
+on your system locally.
+
+
+Debian Bookworm
+^^^^^^^^^^^^^^^^^^^^^^^^
+On versions of Debian released after April 2023, it is no longer possible by default
+to use ``pip`` to install packages onto your system. Unfortunately, you will need to
+use the replacement ``pipx`` command instead, which places installed packages in an
+isolated environment. This should not negatively affect Reticulum, but will not work
+for including and using Reticulum in your own scripts and programs.
+
+.. code::
+
+ # Install pipx
+ sudo apt install pipx
+
+ # Make installed programs available on the command line
+ pipx ensurepath
+
+ # Install Reticulum
+ pipx install rns
+
+Alternatively, you can restore normal behaviour to ``pip`` by creating or editing
+the configuration file located at ``~/.config/pip/pip.conf``, and adding the
+following section:
+
+.. code:: text
+
+ [global]
+ break-system-packages = true
+
+For a one-shot installation of Reticulum, without globally enabling the ``break-system-packages``
+option, you can use the following command:
+
+.. code:: text
+
+ pip install rns --break-system-packages
+
+.. note::
+ The ``--break-system-packages`` directive is a somewhat misleading choice
+ of words. Setting it will of course not break any system packages, but will simply
+ allow installing ``pip`` packages user- and system-wide. While this *could* in rare
+ cases lead to version conflicts, it does not generally pose any problems, especially
+ not in the case of installing Reticulum.
+
+
+MacOS
+^^^^^^^^^^^^^^^^^^^^^^^^^
+To install Reticulum on macOS, you will need to have Python and the ``pip`` package
+manager installed.
+
+Systems running macOS can vary quite widely in whether or not Python is pre-installed,
+and if it is, which version is installed, and whether the ``pip`` package manager is
+also installed and set up. If in doubt, you can `download and install `_
+ and `reticulum-openwrt `_
+ repositories for more information.
+
+To install Reticulum on OpenWRT, first log into a command line session, and
+then use the following instructions:
+
+.. code::
+
+ # Install dependencies
+ opkg install python3 python3-pip python3-cryptography python3-pyserial
+
+ # Install Reticulum
+ pip install rns
+
+ # Start rnsd with debug logging enabled
+ rnsd -vvv
+
+.. note::
+
+ The above instructions have been verified and tested on OpenWRT 21.02 only.
+ It is likely that other versions may require slightly altered installation
+ commands or package names. You will also need enough free space in your
+ overlay FS, and enough free RAM to actually run Reticulum and any related
+ programs and utilities.
+
+Depending on your device configuration, you may need to adjust firewall rules
+for Reticulum connectivity to and from your device to work. Until proper
+packaging is ready, you will also need to manually create a service or startup
+script to automatically laucnh Reticulum at boot time.
+
+Please also note that the `AutoInterface` requires link-local IPv6 addresses
+to be enabled for any Ethernet and WiFi devices you intend to use. If ``ip a``
+shows an address starting with ``fe80::`` for the device in question,
+``AutoInterface`` should work for that device.
+
+Raspberry Pi
+^^^^^^^^^^^^^^^^^^^^^^^^^
+It is currently recommended to use a 64-bit version of the Raspberry Pi OS
+if you want to run Reticulum on Raspberry Pi computers, since 32-bit versions
+don't always have packages available for some dependencies. If Python and the
+`pip` package manager is not already installed, do that first, and then
+install Reticulum using `pip`.
+
+.. code::
+
+ # Install dependencies
+ sudo apt install python3 python3-pip python3-cryptography python3-pyserial
+
+ # Install Reticulum
+ pip install rns --break-system-packages
+
+.. note::
+ The ``--break-system-packages`` directive is a somewhat misleading choice
+ of words. Setting it will of course not break any system packages, but will simply
+ allow installing ``pip`` packages user- and system-wide. While this *could* in rare
+ cases lead to version conflicts, it does not generally pose any problems, especially
+ not in the case of installing Reticulum.
+
+While it is possible to install and run Reticulum on 32-bit Rasperry Pi OSes,
+it will require manually configuring and installing required build dependencies,
+and is not detailed in this manual.
+
+
+RISC-V
+^^^^^^^^^^^^^^^^^^^^^^^^
+On some architectures, including RISC-V, not all dependencies have precompiled
+binaries. On such systems, you may need to install ``python3-dev`` (or similar) before
+installing Reticulum or programs that depend on Reticulum.
+
+.. code::
+
+ # Install Python and development packages
+ sudo apt update
+ sudo apt install python3 python3-pip python3-dev
+
+ # Install Reticulum
+ python3 -m pip install rns
+
+With these packages installed, ``pip`` will be able to build any missing dependencies
+on your system locally.
+
+
+Ubuntu Lunar
+^^^^^^^^^^^^^^^^^^^^^^^^
+On versions of Ubuntu released after April 2023, it is no longer possible by default
+to use ``pip`` to install packages onto your system. Unfortunately, you will need to
+use the replacement ``pipx`` command instead, which places installed packages in an
+isolated environment. This should not negatively affect Reticulum, but will not work
+for including and using Reticulum in your own scripts and programs.
+
+.. code::
+
+ # Install pipx
+ sudo apt install pipx
+
+ # Make installed programs available on the command line
+ pipx ensurepath
+
+ # Install Reticulum
+ pipx install rns
+
+Alternatively, you can restore normal behaviour to ``pip`` by creating or editing
+the configuration file located at ``~/.config/pip/pip.conf``, and adding the
+following section:
+
+.. code:: text
+
+ [global]
+ break-system-packages = true
+
+For a one-shot installation of Reticulum, without globally enabling the ``break-system-packages``
+option, you can use the following command:
+
+.. code:: text
+
+ pip install rns --break-system-packages
+
+.. note::
+ The ``--break-system-packages`` directive is a somewhat misleading choice
+ of words. Setting it will of course not break any system packages, but will simply
+ allow installing ``pip`` packages user- and system-wide. While this *could* in rare
+ cases lead to version conflicts, it does not generally pose any problems, especially
+ not in the case of installing Reticulum.
+
+Windows
+^^^^^^^^^^^^^^^^^^^^^^^^^
+On Windows operating systems, the easiest way to install Reticulum is by using the
+``pip`` package manager from the command line (either the command prompt or Windows
+Powershell).
+
+If you don't already have Python installed, `download and install Python `_.
+
+**Important!** When asked by the installer, make sure to add the Python program to
+your PATH environment variables. If you don't do this, you will not be able to
+use the ``pip`` installer, or run the included Reticulum utility programs (such as
+``rnsd`` and ``rnstatus``) from the command line.
+
+After installing Python, open the command prompt or Windows Powershell, and type:
+
+.. code::
+
+ pip install rns
+
+You can now use Reticulum and all included utility programs directly from your
+preferred command line interface.
+
+Pure-Python Reticulum
+==============================================
+
+.. warning::
+ If you use the ``rnspure`` package to run Reticulum on systems that
+ do not support `PyCA/cryptography `_, it is
+ important that you read and understand the :ref:`Cryptographic Primitives `
+ section of this manual.
+
+In some rare cases, and on more obscure system types, it is not possible to
+install one or more dependencies. In such situations,
+you can use the ``rnspure`` package instead of the ``rns`` package, or use ``pip``
+with the ``--no-dependencies`` command-line option. The ``rnspure``
+package requires no external dependencies for installation. Please note that the
+actual contents of the ``rns`` and ``rnspure`` packages are *completely identical*.
+The only difference is that the ``rnspure`` package lists no dependencies required
+for installation.
+
+No matter how Reticulum is installed and started, it will load external dependencies
+only if they are *needed* and *available*. If for example you want to use Reticulum
+on a system that cannot support ``pyserial``, it is perfectly possible to do so using
+the `rnspure` package, but Reticulum will not be able to use serial-based interfaces.
+All other available modules will still be loaded when needed.
diff --git a/docs/manual/_sources/hardware.rst.txt b/docs/manual/_sources/hardware.rst.txt
new file mode 100644
index 0000000..233cb5f
--- /dev/null
+++ b/docs/manual/_sources/hardware.rst.txt
@@ -0,0 +1,360 @@
+.. _hardware-main:
+
+***********************
+Communications Hardware
+***********************
+
+One of the truly valuable aspects of Reticulum is the ability to use it over
+almost any conceivable kind of communications medium. The :ref:`interface types`
+available for configuration in Reticulum are flexible enough to cover the use
+of most wired and wireless communications hardware available, from decades-old
+packet radio modems to modern millimeter-wave backhaul systems.
+
+If you already have or operate some kind of communications hardware, there is a
+very good chance that it will work with Reticulum out of the box. In case it does
+not, it is possible to provide the necessary glue with very little effort using
+for example the :ref:`PipeInterface` or the :ref:`TCPClientInterface`
+in combination with code like `TCP KISS Server `_
+by `simplyequipped `_.
+
+While this broad support and flexibility is very useful, an abundance of options
+can sometimes make it difficult to know where to begin, especially when you are
+starting from scratch.
+
+This chapter will outline a few different sensible starting paths to get
+real-world functional wireless communications up and running with minimal cost
+and effort. Two fundamental devices categories will be covered, *RNodes* and
+*WiFi-based radios*. Additionally, other common options will be briefly described.
+
+Knowing how to employ just a few different types of hardware will make it possible
+to build a wide range of useful networks with little effort.
+
+Combining Hardware Types
+========================
+
+It is useful to combine different link and hardware types when designing and
+building a network. One useful design pattern is to employ high-capacity point-to-point
+links based on WiFi or millimeter-wave radios (with high-gain directional antennas)
+for the network backbone, and using LoRa-based RNodes for covering large areas with
+connectivity for client devices.
+
+
+.. _rnode-main:
+
+RNode
+=====
+
+Reliable and general-purpose long-range digital radio transceiver systems are
+commonly either very expensive, difficult to set up and operate, hard to source,
+power-hungry, or all of the above at the same time. In an attempt to alleviate
+this situation, the transceiver system *RNode* was designed. It is important to
+note that RNode is not one specific device, from one particular vendor, but
+*an open plaform* that anyone can use to build interoperable digital transceivers
+suited to their needs and particular situations.
+
+An RNode is a general purpose, interoperable, low-power and long-range, reliable,
+open and flexible radio communications device. Depending on its components, it can
+operate on many different frequency bands, and use many different modulation
+schemes, but most commonly, and for the purposes of this chapter, we will limit
+the discussion to RNodes using *LoRa* modulation in common ISM bands.
+
+**Avoid Confusion!** RNodes can use LoRa as a *physical-layer modulation*, but it
+does not use, and has nothing to do with the *LoRaWAN* protocol and standard, commonly
+used for centrally controlled IoT devices. RNodes use *raw LoRa modulation*, without
+any additional protocol overhead. All high-level protocol functionality is handled
+directly by Reticulum.
+
+.. _rnode-creating:
+
+Creating RNodes
+^^^^^^^^^^^^^^^
+RNode has been designed as a system that is easy to replicate across time and
+space. You can put together a functioning transceiver using commonly available
+components, and a few open source software tools. While you can design and build RNodes
+completely from scratch, to your exact desired specifications, this chapter
+will explain the easiest possible approach to creating RNodes: Using common
+LoRa development boards. This approach can be boiled down to two simple steps:
+
+1. Obtain one or more :ref:`supported development boards`
+2. Install the RNode firmware with the :ref:`automated installer`
+
+Once the firmware has been installed and provisioned by the install script, it
+is ready to use with any software that supports RNodes, including Reticulum.
+The device can be used with Reticulum by adding an :ref:`RNodeInterface`
+to the configuration.
+
+.. _rnode-supported:
+
+Supported Boards and Devices
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+To create one or more RNodes, you will need to obtain supported development
+boards or completed devices. The following boards and devices are supported
+by the auto-installer.
+
+------------
+
+.. image:: graphics/board_tbeam_supreme.png
+ :width: 75%
+ :align: center
+
+LilyGO T-Beam Supreme
+"""""""""""""
+- **Transceiver IC** Semtech SX1262 or SX1268
+- **Device Platform** ESP32
+- **Manufacturer** `LilyGO `_
+
+------------
+
+.. image:: graphics/board_tbeam.png
+ :width: 75%
+ :align: center
+
+LilyGO T-Beam
+"""""""""""""
+- **Transceiver IC** Semtech SX1262, SX1268, SX1276 or SX1278
+- **Device Platform** ESP32
+- **Manufacturer** `LilyGO `_
+
+------------
+
+.. image:: graphics/board_t3s3.png
+ :width: 50%
+ :align: center
+
+LilyGO T3S3
+"""""""""""
+- **Transceiver IC** Semtech SX1262, SX1268, SX1276 or SX1278
+- **Device Platform** ESP32
+- **Manufacturer** `LilyGO `_
+
+------------
+
+.. image:: graphics/board_rak4631.png
+ :width: 45%
+ :align: center
+
+RAK4631-based Boards
+""""""""""""""""""""
+- **Transceiver IC** Semtech SX1262 or SX1268
+- **Device Platform** nRF52
+- **Manufacturer** `RAK Wireless `_
+
+------------
+
+.. image:: graphics/board_opencomxl.png
+ :width: 45%
+ :align: center
+
+OpenCom XL
+""""""""""""""""""""
+- **Transceiver ICs** Semtech SX1262 and SX1280 (dual transceiver)
+- **Device Platform** nRF52
+- **Manufacturer** `RAK Wireless `_
+
+------------
+
+.. image:: graphics/board_t3v21.png
+ :width: 46%
+ :align: center
+
+LilyGO LoRa32 v2.1
+""""""""""""""""""
+- **Transceiver IC** Semtech SX1276 or SX1278
+- **Device Platform** ESP32
+- **Manufacturer** `LilyGO `_
+
+------------
+
+.. image:: graphics/board_t3v20.png
+ :width: 46%
+ :align: center
+
+LilyGO LoRa32 v2.0
+""""""""""""""""""
+- **Transceiver IC** Semtech SX1276 or SX1278
+- **Device Platform** ESP32
+- **Manufacturer** `LilyGO `_
+
+------------
+
+.. image:: graphics/board_t3v10.png
+ :width: 46%
+ :align: center
+
+LilyGO LoRa32 v1.0
+""""""""""""""""""
+- **Transceiver IC** Semtech SX1276 or SX1278
+- **Device Platform** ESP32
+- **Manufacturer** `LilyGO `_
+
+------------
+
+.. image:: graphics/board_tdeck.png
+ :width: 45%
+ :align: center
+
+LilyGO T-Deck
+"""""""""""""
+- **Transceiver IC** Semtech SX1262 or SX1268
+- **Device Platform** ESP32
+- **Manufacturer** `LilyGO `_
+
+------------
+
+.. image:: graphics/board_techo.png
+ :width: 45%
+ :align: center
+
+LilyGO T-Echo
+"""""""""""""
+- **Transceiver IC** Semtech SX1262 or SX1268
+- **Device Platform** nRF52
+- **Manufacturer** `LilyGO `_
+
+------------
+
+.. image:: graphics/board_t114.png
+ :width: 58%
+ :align: center
+
+Heltec T114
+"""""""""""
+- **Transceiver IC** Semtech SX1262 or SX1268
+- **Device Platform** ESP32
+- **Manufacturer** `Heltec Automation `_
+
+------------
+
+.. image:: graphics/board_heltec32v30.png
+ :width: 58%
+ :align: center
+
+Heltec LoRa32 v3.0
+""""""""""""""""""
+- **Transceiver IC** Semtech SX1262 or SX1268
+- **Device Platform** ESP32
+- **Manufacturer** `Heltec Automation `_
+
+------------
+
+.. image:: graphics/board_heltec32v20.png
+ :width: 58%
+ :align: center
+
+Heltec LoRa32 v2.0
+""""""""""""""""""
+- **Transceiver IC** Semtech SX1276 or SX1278
+- **Device Platform** ESP32
+- **Manufacturer** `Heltec Automation `_
+
+------------
+
+.. _rnode-installation:
+
+Installation
+^^^^^^^^^^^^
+
+Once you have obtained compatible boards, you can install the `RNode Firmware `_
+using the `RNode Configuration Utility `_.
+If you have installed Reticulum on your system, the ``rnodeconf`` program will already be
+available. If not, make sure that ``Python3`` and ``pip`` is installed on your system, and
+then install Reticulum with with ``pip``:
+
+.. code::
+
+ pip install rns
+
+Once installation has completed, it is time to start installing the firmware on your
+devices. Run ``rnodeconf`` in auto-install mode like so:
+
+.. code::
+
+ rnodeconf --autoinstall
+
+The utility will guide you through the installation process by asking a series of
+questions about your hardware. Simply follow the guide, and the utility will
+auto-install and configure your devices.
+
+.. _rnode-usage:
+
+Usage with Reticulum
+^^^^^^^^^^^^^^^^^^^^
+When the devices have been installed and provisioned, you can use them with Reticulum
+by adding the :ref:`relevant interface section` to the configuration
+file of Reticulum. In the configuraion you can specify all interface parameters,
+such as serial port and on-air parameters.
+
+
+WiFi-based Hardware
+===================
+
+It is possible to use all kinds of both short- and long-range WiFi-based hardware
+with Reticulum. Any kind of hardware that fully supports bridged Ethernet over the
+WiFi interface will work with the :ref:`AutoInterface` in Reticulum.
+Most devices will behave like this by default, or allow it via configuration options.
+
+This means that you can simply configure the physical links of the WiFi based devices,
+and start communicating over them using Reticulum. It is not necessary to enable any IP
+infrastructure such as DHCP servers, DNS or similar, as long as at least Ethernet is
+available, and packets are passed transparently over the physical WiFi-based devices.
+
+.. only:: html
+
+ .. image:: graphics/radio_rblhg5.png
+ :width: 49%
+
+ .. image:: graphics/radio_is5ac.png
+ :width: 49%
+
+Below is a list of example WiFi (and similar) radios that work well for high capacity
+Reticulum links over long distances:
+
+- `Ubiquiti airMAX radios `_
+- `Ubiquiti LTU radios `_
+- `MikroTik radios `_
+
+This list is by no means exhaustive, and only serves as a few examples of radio hardware
+that is relatively cheap while providing long range and high capacity for Reticulum
+networks. As in all other cases, it is also possible for Reticulum to co-exist with IP
+networks running concurrently on such devices.
+
+Ethernet-based Hardware
+=======================
+
+Reticulum can run over any kind of hardware that can provide a switched Ethernet-based
+medium. This means that anything from a plain Ethernet switch, to fiber-optic systems,
+to data radios with Ethernet interfaces can be used by Reticulum.
+
+The Ethernet medium does not need to have any IP infrastructure such as DHCP servers
+or routing set up, but in case such infrastructure does exist, Reticulum will simply
+co-exist with.
+
+To use Reticulum over Ethernet-based mediums, it is generally enough to use the included
+:ref:`AutoInterface`. This interface also works over any kind of
+virtual networking adapter, such as ``tun`` and ``tap`` devices in Linux.
+
+Serial Lines & Devices
+======================
+
+Using Reticulum over any kind of raw serial line is also possible with the
+:ref:`SerialInterface`. This interface type is also useful for
+using Reticulum over communications hardware that provides a serial port interface.
+
+Packet Radio Modems
+===================
+
+Any packet radio modem that provides a standard KISS interface over USB, serial or TCP
+can be used with Reticulum. This includes virtual software modems such as
+`FreeDV TNC `_ and `Dire Wolf `_.
diff --git a/docs/manual/_sources/index.rst.txt b/docs/manual/_sources/index.rst.txt
new file mode 100644
index 0000000..867a1e2
--- /dev/null
+++ b/docs/manual/_sources/index.rst.txt
@@ -0,0 +1,43 @@
+******************************
+Reticulum Network Stack Manual
+******************************
+
+This manual aims to provide you with all the information you need to
+understand Reticulum, build networks or develop programs using it, or
+to participate in the development of Reticulum itself.
+
+.. only:: builder_html
+
+ This manual is also available in `PDF `_ and `EPUB `_ formats.
+
+.. only:: builder_html
+
+ Table Of Contents
+ =================
+
+.. toctree::
+ :maxdepth: 3
+
+ whatis
+ gettingstartedfast
+ using
+ understanding
+ hardware
+ interfaces
+ networks
+ examples
+ support
+
+.. toctree::
+ :maxdepth: 2
+
+ reference
+
+
+.. only:: html
+
+ Indices and Tables
+ ==================
+
+ * :ref:`genindex`
+ * :ref:`search`
diff --git a/docs/manual/_sources/interfaces.rst.txt b/docs/manual/_sources/interfaces.rst.txt
new file mode 100644
index 0000000..c9be036
--- /dev/null
+++ b/docs/manual/_sources/interfaces.rst.txt
@@ -0,0 +1,1170 @@
+
+.. _interfaces-main:
+
+**********************
+Configuring Interfaces
+**********************
+
+Reticulum supports using many kinds of devices as networking interfaces, and
+allows you to mix and match them in any way you choose. The number of distinct
+network topologies you can create with Reticulum is more or less endless, but
+common to them all is that you will need to define one or more *interfaces*
+for Reticulum to use.
+
+The following sections describe the interfaces currently available in Reticulum,
+and gives example configurations for the respective interface types.
+
+For a high-level overview of how networks can be formed over different interface
+types, have a look at the :ref:`Building Networks` chapter of this
+manual.
+
+
+.. _interfaces-custom:
+
+Custom Interfaces
+=================
+
+In addition to the built-in interface types, Reticulum is **fully extensible** with
+custom, user- or community-supplied interfaces, and creating custom interface
+modules is straightforward. Please see the :ref:`custom interface`
+example for basic interface code to build upon.
+
+.. _interfaces-auto:
+
+Auto Interface
+==============
+
+The ``AutoInterface`` enables communication with other discoverable Reticulum
+nodes over any kind of local Ethernet or WiFi-based medium. Even though it uses IPv6 for peer
+discovery, and UDP for packet transport, it **does not** need any functional IP
+infrastructure like routers or DHCP servers, on your physical network.
+
+As long as there is at least some sort of switching medium present between peers (a
+wired switch, a hub, a WiFi access point or similar, or simply two devices connected
+directly by Ethernet cable), it will work without any configuration, setup or intermediary devices.
+
+For ``AutoInterface`` peer discovery to work, it's also required that link-local
+IPv6 support is available on your system, which it should be by default in all
+current operating systems, both desktop and mobile.
+
+.. note::
+ Almost all current Ethernet and WiFi hardware will work without any kind
+ of configuration or setup with ``AutoInterface``, but a small subset of
+ devices turn on options that limit device-to-device communication by default,
+ resulting in ``AutoInterface`` peer discovery being blocked. This issue is
+ most commonly seen on very cheap, ISP-supplied WiFi routers, and can sometimes
+ be turned off in the router configuration.
+
+.. code::
+
+ # This example demonstrates a bare-minimum setup
+ # of an Auto Interface. It will allow communica-
+ # tion with all other reachable devices on all
+ # usable physical ethernet-based devices that
+ # are available on the system.
+ [[Default Interface]]
+ type = AutoInterface
+ enabled = yes
+
+ # This example demonstrates an more specifically
+ # configured Auto Interface, that only uses spe-
+ # cific physical interfaces, and has a number of
+ # other configuration options set.
+ [[Default Interface]]
+ type = AutoInterface
+ enabled = yes
+
+ # You can create multiple isolated Reticulum
+ # networks on the same physical LAN by
+ # specifying different Group IDs.
+ group_id = reticulum
+
+ # You can also choose the multicast address type:
+ # temporary (default, Temporary Multicast Address)
+ # or permanent (Permanent Multicast Address)
+ multicast_address_type = permanent
+
+ # You can also select specifically which
+ # kernel networking devices to use.
+ devices = wlan0,eth1
+
+ # Or let AutoInterface use all suitable
+ # devices except for a list of ignored ones.
+ ignored_devices = tun0,eth0
+
+
+If you are connected to the Internet with IPv6, and your provider will route
+IPv6 multicast, you can potentially configure the Auto Interface to globally
+autodiscover other Reticulum nodes within your selected Group ID. You can specify
+the discovery scope by setting it to one of ``link``, ``admin``, ``site``,
+``organisation`` or ``global``.
+
+.. code::
+
+ [[Default Interface]]
+ type = AutoInterface
+ enabled = yes
+
+ # Configure global discovery
+
+ group_id = custom_network_name
+ discovery_scope = global
+
+ # Other configuration options
+
+ discovery_port = 48555
+ data_port = 49555
+
+
+.. _interfaces-backbone:
+
+Backbone Interface
+====================
+
+The Backbone interface is a very fast and resource efficient interface type, primarily
+intended for interconnecting Reticulum instances over many different types of mediums.
+It uses a kernel-event I/O backend, and can handle thousands of interfaces and/or clients
+with relatively low system resource utilisation. **This interface type is currently only
+supported on Linux and Android**.
+
+.. note::
+ The Backbone Interface is fully compatible with the ``TCPServerInterface`` and ``TCPClientInterface``
+ types, and they can be used interchangably, and cross-connect with each other. On systems that support
+ ``BackboneInterface``, it is generally recommended to use it, unless you need specific options or
+ features that the TCP server and client interfaces provide.
+
+While the goal is to support *all* socket types and I/O devices provided by the underlying
+operating system, the initial release only provides support for TCP connections over IPv4
+and IPv6.
+
+For all types of connections over a ``BackboneInterface``, Reticulum will gracefully
+handle intermittency, link loss, and connections that come and go.
+
+Listeners
+---------
+
+The following examples illustrates various ways to set up ``BackboneInterface`` listeners.
+
+.. code::
+
+ # This example demonstrates a backbone interface
+ # that listens for incoming connections on the
+ # specified IP address and port number.
+ [[Backbone Listener]]
+ type = BackboneInterface
+ enabled = yes
+ listen_on = 0.0.0.0
+ port = 4242
+
+ # Alternatively you can bind to a specific IP
+ [[Backbone Listener]]
+ type = BackboneInterface
+ enabled = yes
+ listen_on = 10.0.0.88
+ port = 4242
+
+ # Or a specific network device
+ [[Backbone Listener]]
+ type = BackboneInterface
+ enabled = yes
+ device = eth0
+ port = 4242
+
+If you are using the interface on a device which has both IPv4 and IPv6 addresses available,
+you can use the ``prefer_ipv6`` option to bind to the IPv6 address:
+
+.. code::
+
+ # This example demonstrates a backbone interface
+ # listening on the IPv6 address of a specified
+ # kernel networking device.
+ [[Backbone Listener]]
+ type = BackboneInterface
+ enabled = yes
+ prefer_ipv6 = yes
+ device = eth0
+ port = 4242
+
+To use the ``BackboneInterface`` over `Yggdrasil ` performs better, and is even
+ easier to use.
+
+.. code::
+
+ # This example enables communication with other
+ # local Reticulum peers over UDP.
+
+ [[UDP Interface]]
+ type = UDPInterface
+ enabled = yes
+
+ listen_ip = 0.0.0.0
+ listen_port = 4242
+ forward_ip = 255.255.255.255
+ forward_port = 4242
+
+ # The above configuration will allow communication
+ # within the local broadcast domains of all local
+ # IP interfaces.
+
+ # Instead of specifying listen_ip, listen_port,
+ # forward_ip and forward_port, you can also bind
+ # to a specific network device like below.
+
+ # device = eth0
+ # port = 4242
+
+ # Assuming the eth0 device has the address
+ # 10.55.0.72/24, the above configuration would
+ # be equivalent to the following manual setup.
+ # Note that we are both listening and forwarding to
+ # the broadcast address of the network segments.
+
+ # listen_ip = 10.55.0.255
+ # listen_port = 4242
+ # forward_ip = 10.55.0.255
+ # forward_port = 4242
+
+ # You can of course also communicate only with
+ # a single IP address
+
+ # listen_ip = 10.55.0.15
+ # listen_port = 4242
+ # forward_ip = 10.55.0.16
+ # forward_port = 4242
+
+
+.. _interfaces-i2p:
+
+I2P Interface
+=============
+
+The I2P interface lets you connect Reticulum instances over the
+`Invisible Internet Protocol `_. This can be
+especially useful in cases where you want to host a globally reachable
+Reticulum instance, but do not have access to any public IP addresses,
+have a frequently changing IP address, or have firewalls blocking
+inbound traffic.
+
+Using the I2P interface, you will get a globally reachable, portable
+and persistent I2P address that your Reticulum instance can be reached
+at.
+
+To use the I2P interface, you must have an I2P router running
+on your system. The easiest way to achieve this is to download and
+install the `latest release `_
+of the ``i2pd`` package. For more details about I2P, see the
+`geti2p.net website `_.
+
+When an I2P router is running on your system, you can simply add
+an I2P interface to Reticulum:
+
+.. code::
+
+ [[I2P]]
+ type = I2PInterface
+ enabled = yes
+ connectable = yes
+
+On the first start, Reticulum will generate a new I2P address for the
+interface and start listening for inbound traffic on it. This can take
+a while the first time, especially if your I2P router was also just
+started, and is not yet well-connected to the I2P network. When ready,
+you should see I2P base32 address printed to your log file. You can
+also inspect the status of the interface using the ``rnstatus`` utility.
+
+To connect to other Reticulum instances over I2P, just add a comma-separated
+list of I2P base32 addresses to the ``peers`` option of the interface:
+
+.. code::
+
+ [[I2P]]
+ type = I2PInterface
+ enabled = yes
+ connectable = yes
+ peers = 5urvjicpzi7q3ybztsef4i5ow2aq4soktfj7zedz53s47r54jnqq.b32.i2p
+
+It can take anywhere from a few seconds to a few minutes to establish
+I2P connections to the desired peers, so Reticulum handles the process
+in the background, and will output relevant events to the log.
+
+.. note::
+ While the I2P interface is the simplest way to use
+ Reticulum over I2P, it is also possible to tunnel the TCP server and
+ client interfaces over I2P manually. This can be useful in situations
+ where more control is needed, but requires manual tunnel setup through
+ the I2P daemon configuration.
+
+It is important to note that the two methods are *interchangably compatible*.
+You can use the I2PInterface to connect to a TCPServerInterface that
+was manually tunneled over I2P, for example. This offers a high degree
+of flexibility in network setup, while retaining ease of use in simpler
+use-cases.
+
+
+.. _interfaces-rnode:
+
+RNode LoRa Interface
+====================
+
+To use Reticulum over LoRa, the `RNode ` section.
+
+.. _interfaces-announcerates:
+
+Announce Rate Control
+=====================
+
+The built-in announce control mechanisms and the default ``announce_cap``
+option described above are sufficient most of the time, but in some cases, especially on fast
+interfaces, it may be useful to control the target announce rate. Using the
+``announce_rate_target``, ``announce_rate_grace`` and ``announce_rate_penalty``
+options, this can be done on a per-interface basis, and moderates the *rate at
+which received announces are re-broadcasted to other interfaces*.
+
+ * | The ``announce_rate_target`` option sets the minimum amount of time,
+ in seconds, that should pass between received announces, for any one
+ destination. As an example, setting this value to ``3600`` means that
+ announces *received* on this interface will only be re-transmitted and
+ propagated to other interfaces once every hour, no matter how often they
+ are received.
+
+ * | The optional ``announce_rate_grace`` defines the number of times a destination
+ can violate the announce rate before the target rate is enforced.
+
+ * | The optional ``announce_rate_penalty`` configures an extra amount of
+ time that is added to the normal rate target. As an example, if a penalty
+ of ``7200`` seconds is defined, once the rate target is enforced, the
+ destination in question will only have its announces propagated every
+ 3 hours, until it lowers its actual announce rate to within the target.
+
+These mechanisms, in conjunction with the ``annouce_cap`` mechanisms mentioned
+above means that it is essential to select a balanced announce strategy for
+your destinations. The more balanced you can make this decision, the easier
+it will be for your destinations to make it into slower networks that many hops
+away. Or you can prioritise only reaching high-capacity networks with more frequent
+announces.
+
+Current statistics and information about announce rates can be viewed using the
+``rnpath -r`` command.
+
+It is important to note that there is no one right or wrong way to set up announce
+rates. Slower networks will naturally tend towards using less frequent announces to
+conserve bandwidth, while very fast networks can support applications that
+need very frequent announces. Reticulum implements these mechanisms to ensure
+that a large span of network types can seamlessly *co-exist* and interconnect.
+
+.. _interfaces-ingress-control:
+
+New Destination Rate Limiting
+=============================
+
+On public interfaces, where anyone may connect and announce new destinations,
+it can be useful to control the rate at which announces for *new* destinations are
+processed.
+
+If a large influx of announces for newly created or previously unknown destinations
+occur within a short amount of time, Reticulum will place these announces on hold,
+so that announce traffic for known and previously established destinations can
+continue to be processed without interruptions.
+
+After the burst subsides, and an additional waiting period has passed, the held
+announces will be released at a slow rate, until the hold queue is cleared. This
+also means, that should a node decide to connect to a public interface, announce
+a large amount of bogus destinations, and then disconnect, these destination will
+never make it into path tables and waste network bandwidth on retransmitted
+announces.
+
+**It's important to note** that the ingress control works at the level of *individual
+sub-interfaces*. As an example, this means that one client on a :ref:`TCP Server Interface`
+cannot disrupt processing of incoming announces for other connected clients on the same
+:ref:`TCP Server Interface`. All other clients on the same interface will still have new announces
+processed without interruption.
+
+By default, Reticulum will handle this automatically, and ingress announce
+control will be enabled on interface where it is sensible to do so. It should
+generally not be neccessary to modify the ingress control configuration,
+but all the parameters are exposed for configuration if needed.
+
+ * | The ``ingress_control`` option tells Reticulum whether or not
+ to enable announce ingress control on the interface. Defaults to
+ ``True``.
+
+ * | The ``ic_new_time`` option configures how long (in seconds) an
+ interface is considered newly spawned. Defaults to ``2*60*60`` seconds. This
+ option is useful on publicly accessible interfaces that spawn new
+ sub-interfaces when a new client connects.
+
+ * | The ``ic_burst_freq_new`` option sets the maximum announce ingress
+ frequency for newly spawned interfaces. Defaults to ``3.5``
+ announces per second.
+
+ * | The ``ic_burst_freq`` option sets the maximum announce ingress
+ frequency for other interfaces. Defaults to ``12`` announces
+ per second.
+
+ *If an interface exceeds its burst frequency, incoming announces
+ for unknown destinations will be temporarily held in a queue, and
+ not processed until later.*
+
+ * | The ``ic_max_held_announces`` option sets the maximum amount of
+ unique announces that will be held in the queue. Any additional
+ unique announces will be dropped. Defaults to ``256`` announces.
+
+ * | The ``ic_burst_hold`` option sets how much time (in seconds) must
+ pass after the burst frequency drops below its threshold, for the
+ announce burst to be considered cleared. Defaults to ``60``
+ seconds.
+
+ * | The ``ic_burst_penalty`` option sets how much time (in seconds) must
+ pass after the burst is considered cleared, before held announces can
+ start being released from the queue. Defaults to ``5*60``
+ seconds.
+
+ * | The ``ic_held_release_interval`` option sets how much time (in seconds)
+ must pass between releasing each held announce from the queue. Defaults
+ to ``30`` seconds.
+
diff --git a/docs/manual/_sources/networks.rst.txt b/docs/manual/_sources/networks.rst.txt
new file mode 100644
index 0000000..3c40fd7
--- /dev/null
+++ b/docs/manual/_sources/networks.rst.txt
@@ -0,0 +1,169 @@
+.. _networks-main:
+
+*****************
+Building Networks
+*****************
+
+This chapter will provide you with the knowledge needed to build networks with
+Reticulum, which can often be easier than using traditional stacks, since you
+don't have to worry about coordinating addresses, subnets and routing for an
+entire network that you might not know how will evolve in the future. With
+Reticulum, you can simply add more segments to your network when it becomes
+necessary, and Reticulum will handle the convergence of the entire network
+automatically.
+
+Concepts & Overview
+--------------------
+
+There are important points that need to be kept in mind when building networks
+with Reticulum:
+
+ * | In a Reticulum network, any node can autonomously generate as many addresses
+ (called *destinations* in Reticulum terminology) as it needs, which become
+ globally reachable to the rest of the network. There is no central point of
+ control over the address space.
+
+ * | Reticulum was designed to handle both very small, and very large networks.
+ While the address space can support billions of endpoints, Reticulum is
+ also very useful when just a few devices needs to communicate.
+
+ * | Low-bandwidth networks, like LoRa and packet radio, can interoperate and
+ interconnect with much larger and higher bandwidth networks without issue.
+ Reticulum automatically manages the flow of information to and from various
+ network segments, and when bandwidth is limited, local traffic is prioritised.
+
+ * | Reticulum provides sender/initiator anonymity by default. There is no way
+ to filter traffic or discriminate it based on the source of the traffic.
+
+ * | All traffic is encrypted using ephemeral keys generated by an Elliptic Curve
+ Diffie-Hellman key exchange on Curve25519. There is no way to inspect traffic
+ contents, and no way to prioritise or throttle certain kinds of traffic.
+ All transport and routing layers are thus completely agnostic to traffic type,
+ and will pass all traffic equally.
+
+ * | Reticulum can function both with and without infrastructure. When *transport
+ nodes* are available, they can route traffic over multiple hops for other
+ nodes, and will function as a distributed cryptographic keystore. When there
+ is no transport nodes available, all nodes that are within communication range
+ can still communicate.
+
+ * | Every node can become a transport node, simply by enabling it in it's
+ configuration, but there is no need for every node on the network to be a
+ transport node. Letting every node be a transport node will in most cases
+ degrade the performance and reliability of the network.
+
+ *In general terms, if a node is stationary, well-connected and kept running
+ most of the time, it is a good candidate to be a transport node. For optimal
+ performance, a network should contain the amount of transport nodes that
+ provides connectivity to the intended area / topography, and not many more
+ than that.*
+
+ * | Reticulum is designed to work reliably in open, trustless environments. This
+ means you can use it to create open-access networks, where participants can
+ join and leave in a free and unorganised manner. This property allows an
+ entirely new, and so far, mostly unexplored class of networked applications,
+ where networks, and the information flow within them can form and dissolve
+ organically.
+
+ * | You can just as easily create closed networks, since Reticulum allows you to
+ add authentication to any interface. This means you can restrict access on
+ any interface type, even when using legacy devices, such as modems. You can
+ also mix authenticated and open interfaces on the same system. See the
+ :ref:`Common Interface Options` section of the :ref:`Interfaces`
+ chapter of this manual for information on how to set up interface authentication.
+
+
+Reticulum allows you to mix very different kinds of networking mediums into a
+unified mesh, or to keep everything within one medium. You could build a "virtual
+network" running entirely over the Internet, where all nodes communicate over TCP
+and UDP "channels". You could also build such a network using other already-established
+communications channels as the underlying carrier for Reticulum.
+
+However, most real-world networks will probably involve either some form of
+wireless or direct hardline communications. To allow Reticulum to communicate
+over any type of medium, you must specify it in the configuration file, by default
+located at ``~/.reticulum/config``. See the :ref:`Supported Interfaces`
+chapter of this manual for interface configuration examples.
+
+Any number of interfaces can be configured, and Reticulum will automatically
+decide which are suitable to use in any given situation, depending on where
+traffic needs to flow.
+
+Example Scenarios
+-----------------
+
+This section illustrates a few example scenarios, and how they would, in general
+terms, be planned, implemented and configured.
+
+Interconnected LoRa Sites
+=========================
+
+An organisation wants to provide communication and information services to it's
+members, which are located mainly in three separate areas. Three suitable hill-top
+locations are found, where the organisation can install equipment: Site A, B and C.
+
+Since the amount of data that needs to be exchanged between users is mainly text-
+based, the bandwidth requirements are low, and LoRa radios are chosen to connect
+users to the network.
+
+Due to the hill-top locations found, there is radio line-of-sight between site A
+and B, and also between site B and C. Because of this, the organisation does not
+need to use the Internet to interconnect the sites, but purchases four Point-to-Point
+WiFi based radios for interconnecting the sites.
+
+At each site, a Raspberry Pi is installed to function as a gateway. A LoRa radio
+is connected to the Pi with a USB cable, and the WiFi radio is connected to the
+Ethernet port of the Pi. At site B, two WiFi radios are needed to be able to reach
+both site A and site C, so an extra Ethernet adapter is connected to the Pi in
+this location.
+
+Once the hardware has been installed, Reticulum is installed on all the Pis, and at
+site A and C, one interface is added for the LoRa radio, as well as one for the WiFi
+radio. At site B, an interface for the LoRa radio, and one interface for each WiFi
+radio is added to the Reticulum configuration file. The transport node option is
+enabled in the configuration of all three gateways.
+
+The network is now operational, and ready to serve users across all three areas.
+The organisation prepares a LoRa radio that is supplied to the end users, along
+with a Reticulum configuration file, that contains the right parameters for
+communicating with the LoRa radios installed at the gateway sites.
+
+Once users connect to the network, anyone will be able to communicate with anyone
+else across all three sites.
+
+Bridging Over the Internet
+==========================
+
+As the organisation grows, several new communities form in places too far away
+from the core network to be reachable over WiFi links. New gateways similar to those
+previously installed are set up for the new communities at the new sites D and E, but
+they are islanded from the core network, and only serve the local users.
+
+After investigating the options, it is found that it is possible to install an
+Internet connection at site A, and an interface on the Internet connection is
+configured for Reticulum on the Raspberry Pi at site A.
+
+A member of the organisation at site D, named Dori, is willing to help by sharing
+the Internet connection she already has in her home, and is able to leave a Raspberry
+Pi running. A new Reticulum interface is configured on her Pi, connecting to the newly
+enabled Internet interface on the gateway at site A. Dori is now connected to both
+the nodes at her own local site (through the hill-top LoRa gateway), and all the
+combined users of sites A, B and C. She then enables transport on her node, and
+traffic from site D can now reach everyone at site A, B and C, and vice versa.
+
+Growth and Convergence
+======================
+
+As the organisation grows, more gateways are added to keep up with the growing user
+base. Some local gateways even add VHF radios and packet modems to reach outlying users
+and communities that are out of reach for the LoRa radios and WiFi backhauls.
+
+As more sites, gateways and users are connected, the amount of coordination required
+is kept to a minimum. If one community wants to add connectivity to the next one
+over, it can simply be done without having to involve everyone or coordinate address
+space or routing tables.
+
+With the added geographical coverage, the operators at site A one day find that
+the original internet bridged interfaces are no longer utilised. The network has
+converged to be completely self-connected, and the sites that were once poorly
+connected outliers are now an integral part of the network.
diff --git a/docs/manual/_sources/reference.rst.txt b/docs/manual/_sources/reference.rst.txt
new file mode 100644
index 0000000..d789201
--- /dev/null
+++ b/docs/manual/_sources/reference.rst.txt
@@ -0,0 +1,214 @@
+:tocdepth: 4
+
+.. _api-main:
+
+*************
+API Reference
+*************
+Communication over Reticulum networks is achieved by using a simple set of classes exposed by the RNS API.
+This chapter lists and explains all classes exposed by the Reticulum Network Stack API, along with their method signatures and usage. It can be used as a reference while writing applications that utilise Reticulum, or it can be read in entirity to gain an understanding of the complete functionality of RNS from a developers perspective.
+
+.. _api-reticulum:
+
+.. only:: html
+
+ |start-h3| Reticulum |end-h3|
+
+.. only:: latex
+
+ Reticulum
+ ---------
+
+.. autoclass:: RNS.Reticulum
+ :members:
+
+
+.. _api-identity:
+
+.. only:: html
+
+ |start-h3| Identity |end-h3|
+
+.. only:: latex
+
+ Identity
+ --------
+
+.. autoclass:: RNS.Identity
+ :members:
+
+.. _api-destination:
+
+.. only:: html
+
+ |start-h3| Destination |end-h3|
+
+.. only:: latex
+
+ Destination
+ -----------
+
+.. autoclass:: RNS.Destination
+ :members:
+
+.. _api-packet:
+
+.. only:: html
+
+ |start-h3| Packet |end-h3|
+
+.. only:: latex
+
+ Packet
+ ------
+
+.. autoclass:: RNS.Packet(destination, data, create_receipt = True)
+ :members:
+
+.. _api-packetreceipt:
+
+.. only:: html
+
+ |start-h3| Packet Receipt |end-h3|
+
+.. only:: latex
+
+ Packet Receipt
+ --------------
+
+.. autoclass:: RNS.PacketReceipt()
+ :members:
+
+.. _api-link:
+
+.. only:: html
+
+ |start-h3| Link |end-h3|
+
+.. only:: latex
+
+ Link
+ ----
+
+.. autoclass:: RNS.Link(destination, established_callback=None, closed_callback = None)
+ :members:
+
+.. _api-requestreceipt:
+
+.. only:: html
+
+ |start-h3| Request Receipt |end-h3|
+
+.. only:: latex
+
+ Request Receipt
+ ---------------
+
+.. autoclass:: RNS.RequestReceipt()
+ :members:
+
+.. _api-resource:
+
+.. only:: html
+
+ |start-h3| Resource |end-h3|
+
+.. only:: latex
+
+ Resource
+ --------
+
+.. autoclass:: RNS.Resource(data, link, advertise=True, auto_compress=True, callback=None, progress_callback=None, timeout=None)
+ :members:
+
+.. _api-channel:
+
+.. only:: html
+
+ |start-h3| Channel |end-h3|
+
+.. only:: latex
+
+ Channel
+ -------
+
+.. autoclass:: RNS.Channel.Channel()
+ :members:
+
+.. _api-messsagebase:
+
+.. only:: html
+
+ |start-h3| MessageBase |end-h3|
+
+.. only:: latex
+
+ MessageBase
+ -----------
+
+.. autoclass:: RNS.MessageBase()
+ :members:
+
+.. _api-buffer:
+
+.. only:: html
+
+ |start-h3| Buffer |end-h3|
+
+.. only:: latex
+
+ Buffer
+ ------
+
+.. autoclass:: RNS.Buffer
+ :members:
+
+.. _api-rawchannelreader:
+
+.. only:: html
+
+ |start-h3| RawChannelReader |end-h3|
+
+.. only:: latex
+
+ RawChannelReader
+ ----------------
+
+.. autoclass:: RNS.RawChannelReader
+ :members: __init__, add_ready_callback, remove_ready_callback
+
+.. _api-rawchannelwriter:
+
+.. only:: html
+
+ |start-h3| RawChannelWriter |end-h3|
+
+.. only:: latex
+
+ RawChannelWriter
+ ----------------
+
+.. autoclass:: RNS.RawChannelWriter
+ :members: __init__
+
+.. _api-transport:
+
+.. only:: html
+
+ |start-h3| Transport |end-h3|
+
+.. only:: latex
+
+ Transport
+ ---------
+
+.. autoclass:: RNS.Transport
+ :members:
+
+.. |start-h3| raw:: html
+
+
+
+.. |end-h3| raw:: html
+
+
\ No newline at end of file
diff --git a/docs/manual/_sources/support.rst.txt b/docs/manual/_sources/support.rst.txt
new file mode 100644
index 0000000..5a563b9
--- /dev/null
+++ b/docs/manual/_sources/support.rst.txt
@@ -0,0 +1,47 @@
+.. _support-main:
+
+*****************
+Support Reticulum
+*****************
+You can help support the continued development of open, free and private communications
+systems by donating, providing feedback and contributing code and learning resources.
+
+Donations
+=========
+Donations are gratefully accepted via the following channels:
+
+
+.. code:: text
+
+ Monero:
+ 84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
+
+ Ethereum:
+ 0x81F7B979fEa6134bA9FD5c701b3501A2e61E897a
+
+ Bitcoin:
+ 3CPmacGm34qYvR6XWLVEJmi2aNe3PZqUuq
+
+ Liberapay:
+ https://liberapay.com/Reticulum/
+
+ Ko-Fi:
+ https://ko-fi.com/markqvist
+
+Are certain features in the development roadmap are important to you or your
+organisation? Make them a reality quickly by sponsoring their implementation.
+
+Provide Feedback
+================
+All feedback on the usage, functioning and potential dysfunctioning of any and
+all components of the system is very valuable to the continued development and
+improvement of Reticulum.
+
+Absolutely no automated analytics, telemetry, error
+reporting or statistics is collected and reported by Reticulum under any
+circumstances, so we rely on old-fashioned human feedback.
+
+Contribute Code
+===============
+Join us on `the GitHub repository `_ to
+report issues, suggest functionality and contribute code to Reticulum.
diff --git a/docs/manual/_sources/understanding.rst.txt b/docs/manual/_sources/understanding.rst.txt
new file mode 100644
index 0000000..168d4a5
--- /dev/null
+++ b/docs/manual/_sources/understanding.rst.txt
@@ -0,0 +1,918 @@
+.. _understanding-main:
+
+***********************
+Understanding Reticulum
+***********************
+This chapter will briefly describe the overall purpose and operating principles of Reticulum.
+It should give you an overview of how the stack works, and an understanding of how to
+develop networked applications using Reticulum.
+
+This chapter is not an exhaustive source of information on Reticulum, at least not yet. Currently,
+the only complete repository, and final authority on how Reticulum actually functions, is the Python
+reference implementation and API reference. That being said, this chapter is an essential resource in
+understanding how Reticulum works from a high-level perspective, along with the general principles of
+Reticulum, and how to apply them when creating your own networks or software.
+
+After reading this document, you should be well-equipped to understand how a Reticulum network
+operates, what it can achieve, and how you can use it yourself. If you want to help out with the
+development, this is also the place to start, since it will provide a pretty clear overview of the
+sentiments and the philosophy behind Reticulum, what problems it seeks to solve, and how it
+approaches those solutions.
+
+.. _understanding-motivation:
+
+Motivation
+==========
+
+The primary motivation for designing and implementing Reticulum has been the current lack of
+reliable, functional and secure minimal-infrastructure modes of digital communication. It is my
+belief that it is highly desirable to create a reliable and efficient way to set up long-range digital
+communication networks that can securely allow exchange of information between people and
+machines, with no central point of authority, control, censorship or barrier to entry.
+
+Almost all of the various networking systems in use today share a common limitation: They
+require large amounts of coordination and centralised trust and power to function. To join such networks, you need approval
+of gatekeepers in control. This need for coordination and trust inevitably leads to an environment of
+central control, where it's very easy for infrastructure operators or governments to control or alter
+traffic, and censor or persecute unwanted actors. It also makes it completely impossible to freely deploy
+and use networks at will, like one would use other common tools that enhance individual agency and freedom.
+
+Reticulum aims to require as little coordination and trust as possible. It aims to make secure,
+anonymous and permissionless networking and information exchange a tool that anyone can just pick up and use.
+
+Since Reticulum is completely medium agnostic, it can be used to build networks on whatever is best
+suited to the situation, or whatever you have available. In some cases, this might be packet radio
+links over VHF frequencies, in other cases it might be a 2.4 GHz
+network using off-the-shelf radios, or it might be using common LoRa development boards.
+
+At the time of release of this document, the fastest and easiest setup for development and testing is using
+LoRa radio modules with an open source firmware (see the section :ref:`Reference Setup`),
+connected to any kind of computer or mobile device that Reticulum can run on.
+
+The ultimate aim of Reticulum is to allow anyone to be their own network operator, and to make it
+cheap and easy to cover vast areas with a myriad of independent, interconnectable and autonomous networks.
+Reticulum **is not** *one network*, it **is a tool** to build *thousands of networks*. Networks without
+kill-switches, surveillance, censorship and control. Networks that can freely interoperate, associate and disassociate
+with each other, and require no central oversight. Networks for human beings. *Networks for the people*.
+
+.. _understanding-goals:
+
+Goals
+=====
+
+To be as widely usable and efficient to deploy as possible, the following goals have been used to
+guide the design of Reticulum:
+
+
+* **Fully useable as open source software stack**
+ Reticulum must be implemented with, and be able to run using only open source software. This is
+ critical to ensuring the availability, security and transparency of the system.
+* **Hardware layer agnosticism**
+ Reticulum must be fully hardware agnostic, and shall be useable over a wide range of
+ physical networking layers, such as data radios, serial lines, modems, handheld transceivers,
+ wired Ethernet, WiFi, or anything else that can carry a digital data stream. Hardware made for
+ dedicated Reticulum use shall be as cheap as possible and use off-the-shelf components, so
+ it can be easily modified and replicated by anyone interested in doing so.
+* **Very low bandwidth requirements**
+ Reticulum should be able to function reliably over links with a transmission capacity as low
+ as *5 bits per second*.
+* **Encryption by default**
+ Reticulum must use strong encryption by default for all communication.
+* **Initiator Anonymity**
+ It must be possible to communicate over a Reticulum network without revealing any identifying
+ information about oneself.
+* **Unlicensed use**
+ Reticulum shall be functional over physical communication mediums that do not require any
+ form of license to use. Reticulum must be designed in a way, so it is usable over ISM radio
+ frequency bands, and can provide functional long distance links in such conditions, for example
+ by connecting a modem to a PMR or CB radio, or by using LoRa or WiFi modules.
+* **Supplied software**
+ In addition to the core networking stack and API, that allows a developer to build
+ applications with Reticulum, a basic set of Reticulum-based communication tools must be
+ implemented and released along with Reticulum itself. These shall serve both as a
+ functional, basic communication suite, and as an example and learning resource to others wishing
+ to build applications with Reticulum.
+* **Ease of use**
+ The reference implementation of Reticulum is written in Python, to make it easy to use
+ and understand. A programmer with only basic experience should be able to use
+ Reticulum to write networked applications.
+* **Low cost**
+ It shall be as cheap as possible to deploy a communication system based on Reticulum. This
+ should be achieved by using cheap off-the-shelf hardware that potential users might already
+ own. The cost of setting up a functioning node should be less than $100 even if all parts
+ needs to be purchased.
+
+.. _understanding-basicfunctionality:
+
+Introduction & Basic Functionality
+==================================
+
+Reticulum is a networking stack suited for high-latency, low-bandwidth links. Reticulum is at its
+core a *message oriented* system. It is suited for both local point-to-point or point-to-multipoint
+scenarios where all nodes are within range of each other, as well as scenarios where packets need
+to be transported over multiple hops in a complex network to reach the recipient.
+
+Reticulum does away with the idea of addresses and ports known from IP, TCP and UDP. Instead
+Reticulum uses the singular concept of *destinations*. Any application using Reticulum as its
+networking stack will need to create one or more destinations to receive data, and know the
+destinations it needs to send data to.
+
+All destinations in Reticulum are _represented_ as a 16 byte hash. This hash is derived from truncating a full
+SHA-256 hash of identifying characteristics of the destination. To users, the destination addresses
+will be displayed as 16 hexadecimal bytes, like this example: ``<13425ec15b621c1d928589718000d814>``.
+
+The truncation size of 16 bytes (128 bits) for destinations has been chosen as a reasonable trade-off
+between address space
+and packet overhead. The address space accommodated by this size can support many billions of
+simultaneously active devices on the same network, while keeping packet overhead low, which is
+essential on low-bandwidth networks. In the very unlikely case that this address space nears
+congestion, a one-line code change can upgrade the Reticulum address space all the way up to 256
+bits, ensuring the Reticulum address space could potentially support galactic-scale networks.
+This is obviously complete and ridiculous over-allocation, and as such, the current 128 bits should
+be sufficient, even far into the future.
+
+By default Reticulum encrypts all data using elliptic curve cryptography and AES. Any packet sent to a
+destination is encrypted with a per-packet derived key. Reticulum can also set up an encrypted
+channel to a destination, called a *Link*. Both data sent over Links and single packets offer
+*Initiator Anonymity*. Links additionally offer *Forward Secrecy* by default, employing an Elliptic Curve
+Diffie Hellman key exchange on Curve25519 to derive per-link ephemeral keys. Asymmetric, link-less
+packet communication can also provide forward secrecy, with automatic key ratcheting, by enabling
+ratchets on a per-destination basis. The multi-hop transport, coordination, verification and reliability
+layers are fully autonomous and also based on elliptic curve cryptography.
+
+Reticulum also offers symmetric key encryption for group-oriented communications, as well as
+unencrypted packets for local broadcast purposes.
+
+Reticulum can connect to a variety of interfaces such as radio modems, data radios and serial ports,
+and offers the possibility to easily tunnel Reticulum traffic over IP links such as the Internet or
+private IP networks.
+
+.. _understanding-destinations:
+
+Destinations
+------------
+
+To receive and send data with the Reticulum stack, an application needs to create one or more
+destinations. Reticulum uses three different basic destination types, and one special:
+
+
+* **Single**
+ The *single* destination type is the most common type in Reticulum, and should be used for
+ most purposes. It is always identified by a unique public key. Any data sent to this
+ destination will be encrypted using ephemeral keys derived from an ECDH key exchange, and will
+ only be readable by the creator of the destination, who holds the corresponding private key.
+* **Plain**
+ A *plain* destination type is unencrypted, and suited for traffic that should be broadcast to a
+ number of users, or should be readable by anyone. Traffic to a *plain* destination is not encrypted.
+ Generally, *plain* destinations can be used for broadcast information intended to be public.
+ Plain destinations are only reachable directly, and packets addressed to plain destinations are
+ never transported over multiple hops in the network. To be transportable over multiple hops in Reticulum, information
+ *must* be encrypted, since Reticulum uses the per-packet encryption to verify routing paths and
+ keep them alive.
+* **Group**
+ The *group* special destination type, that defines a symmetrically encrypted virtual destination.
+ Data sent to this destination will be encrypted with a symmetric key, and will be readable by
+ anyone in possession of the key, but as with the *plain* destination type, packets to this type
+ of destination are not currently transported over multiple hops, although a planned upgrade
+ to Reticulum will allow globally reachable *group* destinations.
+* **Link**
+ A *link* is a special destination type, that serves as an abstract channel to a *single*
+ destination, directly connected or over multiple hops. The *link* also offers reliability and
+ more efficient encryption, forward secrecy, initiator anonymity, and as such can be useful even
+ when a node is directly reachable. It also offers a more capable API and allows easily carrying
+ out requests and responses, large data transfers and more.
+
+.. _understanding-destinationnaming:
+
+Destination Naming
+^^^^^^^^^^^^^^^^^^
+
+Destinations are created and named in an easy to understand dotted notation of *aspects*, and
+represented on the network as a hash of this value. The hash is a SHA-256 truncated to 128 bits. The
+top level aspect should always be a unique identifier for the application using the destination.
+The next levels of aspects can be defined in any way by the creator of the application.
+
+Aspects can be as long and as plentiful as required, and a resulting long destination name will not
+impact efficiency, as names are always represented as truncated SHA-256 hashes on the network.
+
+As an example, a destination for a environmental monitoring application could be made up of the
+application name, a device type and measurement type, like this:
+
+.. code-block:: text
+
+ app name : environmentlogger
+ aspects : remotesensor, temperature
+
+ full name : environmentlogger.remotesensor.temperature
+ hash : 4faf1b2e0a077e6a9d92fa051f256038
+
+For the *single* destination, Reticulum will automatically append the associated public key as a
+destination aspect before hashing. This is done to ensure only the correct destination is reached,
+since anyone can listen to any destination name. Appending the public key ensures that a given
+packet is only directed at the destination that holds the corresponding private key to decrypt the
+packet.
+
+**Take note!** There is a very important concept to understand here:
+
+* Anyone can use the destination name ``environmentlogger.remotesensor.temperature``
+
+* Each destination that does so will still have a unique destination hash, and thus be uniquely
+ addressable, because their public keys will differ.
+
+In actual use of *single* destination naming, it is advisable not to use any uniquely identifying
+features in aspect naming. Aspect names should be general terms describing what kind of destination
+is represented. The uniquely identifying aspect is always achieved by appending the public key,
+which expands the destination into a uniquely identifiable one. Reticulum does this automatically.
+
+Any destination on a Reticulum network can be addressed and reached simply by knowing its
+destination hash (and public key, but if the public key is not known, it can be requested from the
+network simply by knowing the destination hash). The use of app names and aspects makes it easy to
+structure Reticulum programs and makes it possible to filter what information and data your program
+receives.
+
+To recap, the different destination types should be used in the following situations:
+
+* **Single**
+ When private communication between two endpoints is needed. Supports multiple hops.
+* **Group**
+ When private communication between two or more endpoints is needed. Supports multiple hops
+ indirectly, but must first be established through a *single* destination.
+* **Plain**
+ When plain-text communication is desirable, for example when broadcasting information, or for local discovery purposes.
+
+To communicate with a *single* destination, you need to know its public key. Any method for
+obtaining the public key is valid, but Reticulum includes a simple mechanism for making other
+nodes aware of your destinations public key, called the *announce*. It is also possible to request
+an unknown public key from the network, as all transport instances serve as a distributed ledger
+of public keys.
+
+Note that public key information can be shared and verified in other ways than using the
+built-in *announce* functionality, and that it is therefore not required to use the *announce* and *path request*
+functionality to obtain public keys. It is by far the easiest though, and should definitely be used
+if there is not a very good reason for doing it differently.
+
+.. _understanding-keyannouncements:
+
+Public Key Announcements
+------------------------
+
+An *announce* will send a special packet over any relevant interfaces, containing all needed
+information about the destination hash and public key, and can also contain some additional,
+application specific data. The entire packet is signed by the sender to ensure authenticity. It is not
+required to use the announce functionality, but in many cases it will be the simplest way to share
+public keys on the network. The announce mechanism also serves to establish end-to-end connectivity
+to the announced destination, as the announce propagates through the network.
+
+As an example, an announce in a simple messenger application might contain the following information:
+
+
+* The announcers destination hash
+* The announcers public key
+* Application specific data, in this case the users nickname and availability status
+* A random blob, making each new announce unique
+* An Ed25519 signature of the above information, verifying authenticity
+
+With this information, any Reticulum node that receives it will be able to reconstruct an outgoing
+destination to securely communicate with that destination. You might have noticed that there is one
+piece of information lacking to reconstruct full knowledge of the announced destination, and that is
+the aspect names of the destination. These are intentionally left out to save bandwidth, since they
+will be implicit in almost all cases. The receiving application will already know them. If a destination
+name is not entirely implicit, information can be included in the application specific data part that
+will allow the receiver to infer the naming.
+
+It is important to note that announces will be forwarded throughout the network according to a
+certain pattern. This will be detailed in the section
+:ref:`The Announce Mechanism in Detail`.
+
+In Reticulum, destinations are allowed to move around the network at will. This is very different from
+protocols such as IP, where an address is always expected to stay within the network segment it was assigned in.
+This limitation does not exist in Reticulum, and any destination is *completely portable* over the entire topography
+of the network, and *can even be moved to other Reticulum networks* than the one it was created in, and
+still become reachable. To update its reachability, a destination simply needs to send an announce on any
+networks it is part of. After a short while, it will be globally reachable in the network.
+
+Seeing how *single* destinations are always tied to a private/public key pair leads us to the next topic.
+
+.. _understanding-identities:
+
+Identities
+----------
+
+In Reticulum, an *identity* does not necessarily represent a personal identity, but is an abstraction that
+can represent any kind of *verifiable entity*. This could very well be a person, but it could also be the
+control interface of a machine, a program, robot, computer, sensor or something else entirely. In
+general, any kind of agent that can act, or be acted upon, or store or manipulate information, can be
+represented as an identity. An *identity* can be used to create any number of destinations.
+
+A *single* destination will always have an *identity* tied to it, but not *plain* or *group*
+destinations. Destinations and identities share a multilateral connection. You can create a
+destination, and if it is not connected to an identity upon creation, it will just create a new one to use
+automatically. This may be desirable in some situations, but often you will probably want to create
+the identity first, and then use it to create new destinations.
+
+As an example, we could use an identity to represent the user of a messaging application.
+Destinations can then be created by this identity to allow communication to reach the user.
+In all cases it is of great importance to store the private keys associated with any
+Reticulum Identity securely and privately, since obtaining access to the identity keys equals
+obtaining access and controlling reachability to any destinations created by that identity.
+
+.. _understanding-gettingfurther:
+
+Getting Further
+---------------
+
+The above functions and principles form the core of Reticulum, and would suffice to create
+functional networked applications in local clusters, for example over radio links where all interested
+nodes can directly hear each other. But to be truly useful, we need a way to direct traffic over multiple
+hops in the network.
+
+In the following sections, two concepts that allow this will be introduced, *paths* and *links*.
+
+.. _understanding-transport:
+
+Reticulum Transport
+===================
+
+The methods of routing used in traditional networks are fundamentally incompatible with the physical medium
+types and circumstances that Reticulum was designed to handle. These mechanisms mostly assume trust at the physical layer,
+and often needs a lot more bandwidth than Reticulum can assume is available. Since Reticulum is designed to
+survive running over open radio spectrum, no such trust can be assumed, and bandwidth is often very limited.
+
+To overcome such challenges, Reticulum’s *Transport* system uses asymmetric elliptic curve cryptography to
+implement the concept of *paths* that allow discovery of how to get information closer to a certain
+destination. It is important to note that no single node in a Reticulum network knows the complete
+path to a destination. Every Transport node participating in a Reticulum network will only
+know the most direct way to get a packet one hop closer to it's destination.
+
+
+.. _understanding-nodetypes:
+
+Node Types
+----------
+
+Currently, Reticulum distinguishes between two types of network nodes. All nodes on a Reticulum network
+are *Reticulum Instances*, and some are also *Transport Nodes*. If a system running Reticulum is fixed in
+one place, and is intended to be kept available most of the time, it is a good contender to be a *Transport Node*.
+
+Any Reticulum Instance can become a Transport Node by enabling it in the configuration.
+This distinction is made by the user configuring the node, and is used to determine what nodes on the
+network will help forward traffic, and what nodes rely on other nodes for wider connectivity.
+
+If a node is an *Instance* it should be given the configuration directive ``enable_transport = No``, which
+is the default setting.
+
+If it is a *Transport Node*, it should be given the configuration directive ``enable_transport = Yes``.
+
+
+.. _understanding-announce:
+
+The Announce Mechanism in Detail
+--------------------------------
+
+When an *announce* for a destination is transmitted by a Reticulum instance, it will be forwarded by
+any transport node receiving it, but according to some specific rules:
+
+
+* | If this exact announce has already been received before, ignore it.
+
+* | If not, record into a table which Transport Node the announce was received from, and how many times in
+ total it has been retransmitted to get here.
+
+* | If the announce has been retransmitted *m+1* times, it will not be forwarded any more. By default, *m* is
+ set to 128.
+
+* | After a randomised delay, the announce will be retransmitted on all interfaces that have bandwidth
+ available for processing announces. By default, the maximum bandwidth allocation for processing
+ announces is set at 2%, but can be configured on a per-interface basis.
+
+* | If any given interface does not have enough bandwidth available for retransmitting the announce,
+ the announce will be assigned a priority inversely proportional to its hop count, and be inserted
+ into a queue managed by the interface.
+
+* | When the interface has bandwidth available for processing an announce, it will prioritise announces
+ for destinations that are closest in terms of hops, thus prioritising reachability and connectivity
+ of local nodes, even on slow networks that connect to wider and faster networks.
+
+* | After the announce has been re-transmitted, and if no other nodes are heard retransmitting the announce
+ with a greater hop count than when it left this node, transmitting it will be retried *r* times. By default,
+ *r* is set to 1.
+
+* | If a newer announce from the same destination arrives, while an identical one is already waiting
+ to be transmitted, the newest announce is discarded. If the newest announce contains different
+ application specific data, it will replace the old announce.
+
+Once an announce has reached a node in the network, any other node in direct contact with that
+node will be able to reach the destination the announce originated from, simply by sending a packet
+addressed to that destination. Any node with knowledge of the announce will be able to direct the
+packet towards the destination by looking up the next node with the shortest amount of hops to the
+destination.
+
+According to these rules, an announce will propagate throughout the network in a predictable way,
+and make the announced destination reachable in a short amount of time. Fast networks that have the
+capacity to process many announces can reach full convergence very quickly, even when constantly adding
+new destinations. Slower segments of such networks might take a bit longer to gain full knowledge about
+the wide and fast networks they are connected to, but can still do so over time, while prioritising full
+and quickly converging end-to-end connectivity for their local, slower segments.
+
+In general, even extremely complex networks, that utilize the maximum 128 hops will converge to full
+end-to-end connectivity in about one minute, given there is enough bandwidth available to process
+the required amount of announces.
+
+.. _understanding-paths:
+
+Reaching the Destination
+------------------------
+
+In networks with changing topology and trustless connectivity, nodes need a way to establish
+*verified connectivity* with each other. Since the network is assumed to be trustless, Reticulum
+must provide a way to guarantee that the peer you are communicating with is actually who you
+expect. Reticulum offers two ways to do this.
+
+For exchanges of small amounts of information, Reticulum offers the *Packet* API, which works exactly like you would expect - on a per packet level. The following process is employed when sending a packet:
+
+* | A packet is always created with an associated destination and some payload data. When the packet is sent
+ to a *single* destination type, Reticulum will automatically create an ephemeral encryption key, perform
+ an ECDH key exchange with the destination's public key (or ratchet key, if available), and encrypt the information.
+
+* | It is important to note that this key exchange does not require any network traffic. The sender already
+ knows the public key of the destination from an earlier received *announce*, and can thus perform the ECDH
+ key exchange locally, before sending the packet.
+
+* | The public part of the newly generated ephemeral key-pair is included with the encrypted token, and sent
+ along with the encrypted payload data in the packet.
+
+* | When the destination receives the packet, it can itself perform an ECDH key exchange and decrypt the
+ packet.
+
+* | A new ephemeral key is used for every packet sent in this way.
+
+* | Once the packet has been received and decrypted by the addressed destination, that destination can opt
+ to *prove* its receipt of the packet. It does this by calculating the SHA-256 hash of the received packet,
+ and signing this hash with its Ed25519 signing key. Transport nodes in the network can then direct this
+ *proof* back to the packets origin, where the signature can be verified against the destination's known
+ public signing key.
+
+* | In case the packet is addressed to a *group* destination type, the packet will be encrypted with the
+ pre-shared AES-256 key associated with the destination. In case the packet is addressed to a *plain*
+ destination type, the payload data will not be encrypted. Neither of these two destination types can offer
+ forward secrecy. In general, it is recommended to always use the *single* destination type, unless it is
+ strictly necessary to use one of the others.
+
+
+For exchanges of larger amounts of data, or when longer sessions of bidirectional communication is desired, Reticulum offers the *Link* API. To establish a *link*, the following process is employed:
+
+* | First, the node that wishes to establish a link will send out a special packet, that
+ traverses the network and locates the desired destination. Along the way, the Transport Nodes that
+ forward the packet will take note of this *link request*.
+
+* | Second, if the destination accepts the *link request* , it will send back a packet that proves the
+ authenticity of its identity (and the receipt of the link request) to the initiating node. All
+ nodes that initially forwarded the packet will also be able to verify this proof, and thus
+ accept the validity of the *link* throughout the network.
+
+* | When the validity of the *link* has been accepted by forwarding nodes, these nodes will
+ remember the *link* , and it can subsequently be used by referring to a hash representing it.
+
+* | As a part of the *link request*, an Elliptic Curve Diffie-Hellman key exchange takes place, that sets up an
+ efficiently encrypted tunnel between the two nodes. As such, this mode of communication is preferred,
+ even for situations when nodes can directly communicate, when the amount of data to be exchanged numbers
+ in the tens of packets, or whenever the use of the more advanced API functions is desired.
+
+* | When a *link* has been set up, it automatically provides message receipt functionality, through
+ the same *proof* mechanism discussed before, so the sending node can obtain verified confirmation
+ that the information reached the intended recipient.
+
+* | Once the *link* has been set up, the initiator can remain anonymous, or choose to authenticate towards
+ the destination using a Reticulum Identity. This authentication is happening inside the encrypted
+ link, and is only revealed to the verified destination, and no intermediaries.
+
+In a moment, we will discuss the details of how this methodology is
+implemented, but let’s first recap what purposes this methodology serves. We
+first ensure that the node answering our request is actually the one we want to
+communicate with, and not a malicious actor pretending to be so. At the same
+time we establish an efficient encrypted channel. The setup of this is
+relatively cheap in terms of bandwidth, so it can be used just for a short
+exchange, and then recreated as needed, which will also rotate encryption keys.
+The link can also be kept alive for longer periods of time, if this is more
+suitable to the application. The procedure also inserts the *link id* , a hash
+calculated from the link request packet, into the memory of forwarding nodes,
+which means that the communicating nodes can thereafter reach each other simply
+by referring to this *link id*.
+
+The combined bandwidth cost of setting up a link is 3 packets totalling 297 bytes (more info in the
+:ref:`Binary Packet Format` section). The amount of bandwidth used on keeping
+a link open is practically negligible, at 0.45 bits per second. Even on a slow 1200 bits per second packet
+radio channel, 100 concurrent links will still leave 96% channel capacity for actual data.
+
+
+Link Establishment in Detail
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+After exploring the basics of the announce mechanism, finding a path through the network, and an overview
+of the link establishment procedure, this section will go into greater detail about the Reticulum link
+establishment process.
+
+The *link* in Reticulum terminology should not be viewed as a direct node-to-node link on the
+physical layer, but as an abstract channel, that can be open for any amount of time, and can span
+an arbitrary number of hops, where information will be exchanged between two nodes.
+
+
+* | When a node in the network wants to establish verified connectivity with another node, it
+ will randomly generate a new X25519 private/public key pair. It then creates a *link request*
+ packet, and broadcast it.
+ |
+ | *It should be noted that the X25519 public/private keypair mentioned above is two separate keypairs:
+ An encryption key pair, used for derivation of a shared symmetric key, and a signing key pair, used
+ for signing and verifying messages on the link. They are sent together over the wire, and can be
+ considered as single public key for simplicity in this explanation.*
+
+* | The *link request* is addressed to the destination hash of the desired destination, and
+ contains the following data: The newly generated X25519 public key *LKi*.
+
+* | The broadcasted packet will be directed through the network according to the rules laid out
+ previously.
+
+* | Any node that forwards the link request will store a *link id* in it’s *link table* , along with the
+ amount of hops the packet had taken when received. The link id is a hash of the entire link
+ request packet. If the link request packet is not *proven* by the addressed destination within some
+ set amount of time, the entry will be dropped from the *link table* again.
+
+* | When the destination receives the link request packet, it will decide whether to accept the request.
+ If it is accepted, the destination will also generate a new X25519 private/public key pair, and
+ perform a Diffie Hellman Key Exchange, deriving a new symmetric key that will be used to encrypt the
+ channel, once it has been established.
+
+* | A *link proof* packet is now constructed and transmitted over the network. This packet is
+ addressed to the *link id* of the *link*. It contains the following data: The newly generated X25519
+ public key *LKr* and an Ed25519 signature of the *link id* and *LKr* made by the *original signing key* of
+ the addressed destination.
+
+* | By verifying this *link proof* packet, all nodes that originally transported the *link request*
+ packet to the destination from the originator can now verify that the intended destination received
+ the request and accepted it, and that the path they chose for forwarding the request was valid.
+ In successfully carrying out this verification, the transporting nodes marks the link as active.
+ An abstract bi-directional communication channel has now been established along a path in the network.
+ Packets can now be exchanged bi-directionally from either end of the link simply by adressing the
+ packets to the *link id* of the link.
+
+* | When the source receives the *proof* , it will know unequivocally that a verified path has been
+ established to the destination. It can now also use the X25519 public key contained in the
+ *link proof* to perform it's own Diffie Hellman Key Exchange and derive the symmetric key
+ that is used to encrypt the channel. Information can now be exchanged reliably and securely.
+
+
+It’s important to note that this methodology ensures that the source of the request does not need to
+reveal any identifying information about itself. The link initiator remains completely anonymous.
+
+When using *links*, Reticulum will automatically verify all data sent over the link, and can also
+automate retransmissions if *Resources* are used.
+
+.. _understanding-resources:
+
+Resources
+---------
+
+For exchanging small amounts of data over a Reticulum network, the :ref:`Packet` interface
+is sufficient, but for exchanging data that would require many packets, an efficient way to coordinate
+the transfer is needed.
+
+This is the purpose of the Reticulum :ref:`Resource`. A *Resource* can automatically
+handle the reliable transfer of an arbitrary amount of data over an established :ref:`Link`.
+Resources can auto-compress data, will handle breaking the data into individual packets, sequencing
+the transfer, integrity verification and reassembling the data on the other end.
+
+:ref:`Resources` are programmatically very simple to use, and only requires a few lines
+of codes to reliably transfer any amount of data. They can be used to transfer data stored in memory,
+or stream data directly from files.
+
+.. _understanding-referencesystem:
+
+Reference Setup
+======================
+
+This section will detail a recommended *Reference Setup* for Reticulum. It is important to
+note that Reticulum is designed to be usable on more or less any computing device, and over more
+or less any medium that allows you to send and receive data, which satisfies some very low
+minimum requirements.
+
+The communication channel must support at least half-duplex operation, and provide an average
+throughput of 5 bits per second or greater, and supports a physical layer MTU of 500 bytes. The
+Reticulum stack should be able to run on more or less any hardware that can provide a Python 3.x
+runtime environment.
+
+That being said, this reference setup has been outlined to provide a common platform for anyone
+who wants to help in the development of Reticulum, and for everyone who wants to know a
+recommended setup to get started experimenting. A reference system consists of three parts:
+
+* **An Interface Device**
+ Which provides access to the physical medium whereupon the communication
+ takes place, for example a radio with an integrated modem. A setup with a separate modem
+ connected to a radio would also be an interface device.
+* **A Host Device**
+ Some sort of computing device that can run the necessary software, communicate with the
+ interface device, and provide user interaction.
+* **A Software Stack**
+ The software implementing the Reticulum protocol and applications using it.
+
+The reference setup can be considered a relatively stable platform to develop on, and also to start
+building networks or applications on. While details of the implementation might change at the current stage of
+development, it is the goal to maintain hardware compatibility for as long as entirely possible, and
+the current reference setup has been determined to provide a functional platform for many years
+into the future. The current Reference System Setup is as follows:
+
+
+* **Interface Device**
+ A data radio consisting of a LoRa radio module, and a microcontroller with open source
+ firmware, that can connect to host devices via USB. It operates in either the 430, 868 or 900
+ MHz frequency bands. More details can be found on the `RNode Page `_.
+* **Host Device**
+ Any computer device running Linux and Python. A Raspberry Pi with a Debian based OS is
+ recommended.
+* **Software Stack**
+ The most recently released Python Implementation of Reticulum, running on a Debian based
+ operating system.
+
+To avoid confusion, it is very important to note, that the reference interface device **does not**
+use the LoRaWAN standard, but uses a custom MAC layer on top of the plain LoRa modulation! As such, you will
+need a plain LoRa radio module connected to an controller with the correct firmware. Full details on how to
+get or make such a device is available on the `RNode Page `_.
+
+With the current reference setup, it should be possible to get on a Reticulum network for around 100$
+even if you have none of the hardware already, and need to purchase everything.
+
+This reference setup is of course just a recommendation for getting started easily, and you should
+tailor it to your own specific needs, or whatever hardware you have available.
+
+.. _understanding-protocolspecifics:
+
+Protocol Specifics
+==================
+
+This chapter will detail protocol specific information that is essential to the implementation of
+Reticulum, but non critical in understanding how the protocol works on a general level. It should be
+treated more as a reference than as essential reading.
+
+
+Packet Prioritisation
+---------------------
+
+Currently, Reticulum is completely priority-agnostic regarding general traffic. All traffic is handled
+on a first-come, first-serve basis. Announce re-transmission are handled according to the re-transmission
+times and priorities described earlier in this chapter.
+
+
+Interface Access Codes
+----------------------
+
+Reticulum can create named virtual networks, and networks that are only accessible by knowing a preshared
+passphrase. The configuration of this is detailed in the :ref:`Common Interface Options`
+section. To implement these feature, Reticulum uses the concept of Interface Access Codes, that are calculated
+and verified per packet.
+
+An interface with a named virtual network or passphrase authentication enabled will derive a shared Ed25519
+signing identity, and for every outbound packet generate a signature of the entire packet. This signature is
+then inserted into the packet as an Interface Access Code before transmission. Depending on the speed and
+capabilities of the interface, the IFAC can be the full 512-bit Ed25519 signature, or a truncated version.
+Configured IFAC length can be inspected for all interfaces with the ``rnstatus`` utility.
+
+Upon receipt, the interface will check that the signature matches the expected value, and drop the packet if it
+does not. This ensures that only packets sent with the correct naming and/or passphrase parameters are allowed to
+pass onto the network.
+
+
+.. _understanding-packetformat:
+
+Wire Format
+-----------
+
+.. code-block:: text
+
+ == Reticulum Wire Format ======
+
+ A Reticulum packet is composed of the following fields:
+
+ [HEADER 2 bytes] [ADDRESSES 16/32 bytes] [CONTEXT 1 byte] [DATA 0-465 bytes]
+
+ * The HEADER field is 2 bytes long.
+ * Byte 1: [IFAC Flag], [Header Type], [Context Flag], [Propagation Type],
+ [Destination Type] and [Packet Type]
+ * Byte 2: Number of hops
+
+ * Interface Access Code field if the IFAC flag was set.
+ * The length of the Interface Access Code can vary from
+ 1 to 64 bytes according to physical interface
+ capabilities and configuration.
+
+ * The ADDRESSES field contains either 1 or 2 addresses.
+ * Each address is 16 bytes long.
+ * The Header Type flag in the HEADER field determines
+ whether the ADDRESSES field contains 1 or 2 addresses.
+ * Addresses are SHA-256 hashes truncated to 16 bytes.
+
+ * The CONTEXT field is 1 byte.
+ * It is used by Reticulum to determine packet context.
+
+ * The DATA field is between 0 and 465 bytes.
+ * It contains the packets data payload.
+
+ IFAC Flag
+ -----------------
+ open 0 Packet for publically accessible interface
+ authenticated 1 Interface authentication is included in packet
+
+
+ Header Types
+ -----------------
+ type 1 0 Two byte header, one 16 byte address field
+ type 2 1 Two byte header, two 16 byte address fields
+
+
+ Context Flag
+ -----------------
+ unset 0 The context flag is used for various types
+ set 1 of signalling, depending on packet context
+
+
+ Propagation Types
+ -----------------
+ broadcast 0
+ transport 1
+
+
+ Destination Types
+ -----------------
+ single 00
+ group 01
+ plain 10
+ link 11
+
+
+ Packet Types
+ -----------------
+ data 00
+ announce 01
+ link request 10
+ proof 11
+
+
+ +- Packet Example -+
+
+ HEADER FIELD DESTINATION FIELDS CONTEXT FIELD DATA FIELD
+ _______|_______ ________________|________________ ________|______ __|_
+ | | | | | | | |
+ 01010000 00000100 [HASH1, 16 bytes] [HASH2, 16 bytes] [CONTEXT, 1 byte] [DATA]
+ || | | | |
+ || | | | +-- Hops = 4
+ || | | +------- Packet Type = DATA
+ || | +--------- Destination Type = SINGLE
+ || +----------- Propagation Type = TRANSPORT
+ |+------------- Header Type = HEADER_2 (two byte header, two address fields)
+ +-------------- Access Codes = DISABLED
+
+
+ +- Packet Example -+
+
+ HEADER FIELD DESTINATION FIELD CONTEXT FIELD DATA FIELD
+ _______|_______ _______|_______ ________|______ __|_
+ | | | | | | | |
+ 00000000 00000111 [HASH1, 16 bytes] [CONTEXT, 1 byte] [DATA]
+ || | | | |
+ || | | | +-- Hops = 7
+ || | | +------- Packet Type = DATA
+ || | +--------- Destination Type = SINGLE
+ || +----------- Propagation Type = BROADCAST
+ |+------------- Header Type = HEADER_1 (two byte header, one address field)
+ +-------------- Access Codes = DISABLED
+
+
+ +- Packet Example -+
+
+ HEADER FIELD IFAC FIELD DESTINATION FIELD CONTEXT FIELD DATA FIELD
+ _______|_______ ______|______ _______|_______ ________|______ __|_
+ | | | | | | | | | |
+ 10000000 00000111 [IFAC, N bytes] [HASH1, 16 bytes] [CONTEXT, 1 byte] [DATA]
+ || | | | |
+ || | | | +-- Hops = 7
+ || | | +------- Packet Type = DATA
+ || | +--------- Destination Type = SINGLE
+ || +----------- Propagation Type = BROADCAST
+ |+------------- Header Type = HEADER_1 (two byte header, one address field)
+ +-------------- Access Codes = ENABLED
+
+
+ Size examples of different packet types
+ ---------------------------------------
+
+ The following table lists example sizes of various
+ packet types. The size listed are the complete on-
+ wire size counting all fields including headers,
+ but excluding any interface access codes.
+
+ - Path Request : 51 bytes
+ - Announce : 167 bytes
+ - Link Request : 83 bytes
+ - Link Proof : 115 bytes
+ - Link RTT packet : 99 bytes
+ - Link keepalive : 20 bytes
+
+
+.. _understanding-announcepropagation:
+
+Announce Propagation Rules
+--------------------------
+
+The following table illustrates the rules for automatically propagating announces
+from one interface type to another, for all possible combinations. For the purpose
+of announce propagation, the *Full* and *Gateway* modes are identical.
+
+.. image:: graphics/if_mode_graph_b.png
+
+See the :ref:`Interface Modes` section for a conceptual overview
+of the different interface modes, and how they are configured.
+
+..
+ (.. code-block:: text)
+ Full ────── ✓ ──┐ ┌── ✓ ── Full
+ AP ──────── ✓ ──┼───> Full >───┼── ✕ ── AP
+ Boundary ── ✓ ──┤ ├── ✓ ── Boundary
+ Roaming ─── ✓ ──┘ └── ✓ ── Roaming
+
+ Full ────── ✕ ──┐ ┌── ✓ ── Full
+ AP ──────── ✕ ──┼────> AP >────┼── ✕ ── AP
+ Boundary ── ✕ ──┤ ├── ✓ ── Boundary
+ Roaming ─── ✕ ──┘ └── ✓ ── Roaming
+
+ Full ────── ✓ ──┐ ┌── ✓ ── Full
+ AP ──────── ✓ ──┼─> Roaming >──┼── ✕ ── AP
+ Boundary ── ✕ ──┤ ├── ✕ ── Boundary
+ Roaming ─── ✕ ──┘ └── ✕ ── Roaming
+
+ Full ────── ✓ ──┐ ┌── ✓ ── Full
+ AP ──────── ✓ ──┼─> Boundary >─┼── ✕ ── AP
+ Boundary ── ✓ ──┤ ├── ✓ ── Boundary
+ Roaming ─── ✕ ──┘ └── ✕ ── Roaming
+
+
+.. _understanding-primitives:
+
+Cryptographic Primitives
+------------------------
+
+Reticulum uses a simple suite of efficient, strong and well-tested cryptographic
+primitives, with widely available implementations that can be used both on
+general-purpose CPUs and on microcontrollers.
+
+One of the primary considerations for choosing this particular set of primitives is
+that they can be implemented *safely* with relatively few pitfalls, on practically
+all current computing platforms.
+
+The primitives listed here **are authoritative**. Anything claiming to be Reticulum,
+but not using these exact primitives **is not** Reticulum, and possibly an
+intentionally compromised or weakened clone. The utilised primitives are:
+
+* Ed25519 for signatures
+
+* X25519 for ECDH key exchanges
+
+* HKDF for key derivation
+
+* Encrypted tokens are based on the Fernet spec
+
+ * Ephemeral keys derived from an ECDH key exchange on Curve25519
+
+ * AES-256 in CBC mode with PKCS7 padding
+
+ * HMAC using SHA256 for message authentication
+
+ * IVs must be generated through ``os.urandom()`` or better
+
+ * No Fernet version and timestamp metadata fields
+
+* SHA-256
+
+* SHA-512
+
+In the default installation configuration, the ``X25519``, ``Ed25519`` and ``AES-256-CBC``
+primitives are provided by `OpenSSL `_
+package). The hashing functions ``SHA-256`` and ``SHA-512`` are provided by the standard
+Python `hashlib `_. The ``HKDF``, ``HMAC``,
+``Token`` primitives, and the ``PKCS7`` padding function are always provided by the
+following internal implementations:
+
+- ``RNS/Cryptography/HKDF.py``
+- ``RNS/Cryptography/HMAC.py``
+- ``RNS/Cryptography/Token.py``
+- ``RNS/Cryptography/PKCS7.py``
+
+
+Reticulum also includes a complete implementation of all necessary primitives in pure Python.
+If OpenSSL & PyCA are not available on the system when Reticulum is started, Reticulum will
+instead use the internal pure-python primitives. A trivial consequence of this is performance,
+with the OpenSSL backend being *much* faster. The most important consequence however, is the
+potential loss of security by using primitives that has not seen the same amount of scrutiny,
+testing and review as those from OpenSSL.
+
+.. warning::
+ If you want to use the internal pure-python primitives, it is **highly advisable** that you
+ have a good understanding of the risks that this pose, and make an informed decision on whether
+ those risks are acceptable to you.
\ No newline at end of file
diff --git a/docs/manual/_sources/using.rst.txt b/docs/manual/_sources/using.rst.txt
new file mode 100644
index 0000000..e54d2ce
--- /dev/null
+++ b/docs/manual/_sources/using.rst.txt
@@ -0,0 +1,971 @@
+.. _using-main:
+
+******************************
+Using Reticulum on Your System
+******************************
+
+Reticulum is not installed as a driver or kernel module, as one might expect
+of a networking stack. Instead, Reticulum is distributed as a Python module,
+containing the networking core, and a set of utility and daemon programs.
+
+This means that no special privileges are required to install or use it. It
+is also very light-weight, and easy to transfer to, and install on new systems.
+
+When you have Reticulum installed, any program or application that uses Reticulum
+will automatically load and initialise Reticulum when it starts, if it is not
+already running.
+
+In many cases, this approach is sufficient. When any program needs to use
+Reticulum, it is loaded, initialised, interfaces are brought up, and the
+program can now communicate over any Reticulum networks available. If another
+program starts up and also wants access to the same Reticulum network, the already
+running instance is simply shared. This works for any number of programs running
+concurrently, and is very easy to use, but depending on your use case, there
+are other options.
+
+Configuration & Data
+--------------------
+
+Reticulum stores all information that it needs to function in a single file-system
+directory. When Reticulum is started, it will look for a valid configuration
+directory in the following places:
+
+- ``/etc/reticulum``
+- ``~/.config/reticulum``
+- ``~/.reticulum``
+
+If no existing configuration directory is found, the directory ``~/.reticulum``
+is created, and the default configuration will be automatically created here.
+You can move it to one of the other locations if you wish.
+
+It is also possible to use completely arbitrary configuration directories by
+specifying the relevant command-line parameters when running Reticulum-based
+programs. You can also run multiple separate Reticulum instances on the same
+physical system, either in isolation from each other, or connected together.
+
+In most cases, a single physical system will only need to run one Reticulum
+instance. This can either be launched at boot, as a system service, or simply
+be brought up when a program needs it. In either case, any number of programs
+running on the same system will automatically share the same Reticulum instance,
+if the configuration allows for it, which it does by default.
+
+The entire configuration of Reticulum is found in the ``~/.reticulum/config``
+file. When Reticulum is first started on a new system, a basic, but fully functional
+configuration file is created. The default configuration looks like this:
+
+.. code::
+
+ # This is the default Reticulum config file.
+ # You should probably edit it to include any additional,
+ # interfaces and settings you might need.
+
+ # Only the most basic options are included in this default
+ # configuration. To see a more verbose, and much longer,
+ # configuration example, you can run the command:
+ # rnsd --exampleconfig
+
+
+ [reticulum]
+
+ # If you enable Transport, your system will route traffic
+ # for other peers, pass announces and serve path requests.
+ # This should be done for systems that are suited to act
+ # as transport nodes, ie. if they are stationary and
+ # always-on. This directive is optional and can be removed
+ # for brevity.
+
+ enable_transport = No
+
+
+ # By default, the first program to launch the Reticulum
+ # Network Stack will create a shared instance, that other
+ # programs can communicate with. Only the shared instance
+ # opens all the configured interfaces directly, and other
+ # local programs communicate with the shared instance over
+ # a local socket. This is completely transparent to the
+ # user, and should generally be turned on. This directive
+ # is optional and can be removed for brevity.
+
+ share_instance = Yes
+
+
+ # If you want to run multiple *different* shared instances
+ # on the same system, you will need to specify different
+ # instance names for each. On platforms supporting domain
+ # sockets, this can be done with the instance_name option:
+
+ instance_name = default
+
+ # Some platforms don't support domain sockets, and if that
+ # is the case, you can isolate different instances by
+ # specifying a unique set of ports for each:
+
+ # shared_instance_port = 37428
+ # instance_control_port = 37429
+
+
+ # If you want to explicitly use TCP for shared instance
+ # communication, instead of domain sockets, this is also
+ # possible, by using the following option:
+
+ # shared_instance_type = tcp
+
+
+ # On systems where running instances may not have access
+ # to the same shared Reticulum configuration directory,
+ # it is still possible to allow full interactivity for
+ # running instances, by manually specifying a shared RPC
+ # key. In almost all cases, this option is not needed, but
+ # it can be useful on operating systems such as Android.
+ # The key must be specified as bytes in hexadecimal.
+
+ # rpc_key = e5c032d3ec4e64a6aca9927ba8ab73336780f6d71790
+
+
+ # It is possible to allow remote management of Reticulum
+ # systems using the various built-in utilities, such as
+ # rnstatus and rnpath. You will need to specify one or
+ # more Reticulum Identity hashes for authenticating the
+ # queries from client programs. For this purpose, you can
+ # use existing identity files, or generate new ones with
+ # the rnid utility.
+
+ # enable_remote_management = yes
+ # remote_management_allowed = 9fb6d773498fb3feda407ed8ef2c3229, 2d882c5586e548d79b5af27bca1776dc
+
+
+ # You can configure Reticulum to panic and forcibly close
+ # if an unrecoverable interface error occurs, such as the
+ # hardware device for an interface disappearing. This is
+ # an optional directive, and can be left out for brevity.
+ # This behaviour is disabled by default.
+
+ # panic_on_interface_error = No
+
+
+ # When Transport is enabled, it is possible to allow the
+ # Transport Instance to respond to probe requests from
+ # the rnprobe utility. This can be a useful tool to test
+ # connectivity. When this option is enabled, the probe
+ # destination will be generated from the Identity of the
+ # Transport Instance, and printed to the log at startup.
+ # Optional, and disabled by default.
+
+ # respond_to_probes = No
+
+
+ [logging]
+ # Valid log levels are 0 through 7:
+ # 0: Log only critical information
+ # 1: Log errors and lower log levels
+ # 2: Log warnings and lower log levels
+ # 3: Log notices and lower log levels
+ # 4: Log info and lower (this is the default)
+ # 5: Verbose logging
+ # 6: Debug logging
+ # 7: Extreme logging
+
+ loglevel = 4
+
+
+ # The interfaces section defines the physical and virtual
+ # interfaces Reticulum will use to communicate on. This
+ # section will contain examples for a variety of interface
+ # types. You can modify these or use them as a basis for
+ # your own config, or simply remove the unused ones.
+
+ [interfaces]
+
+ # This interface enables communication with other
+ # link-local Reticulum nodes over UDP. It does not
+ # need any functional IP infrastructure like routers
+ # or DHCP servers, but will require that at least link-
+ # local IPv6 is enabled in your operating system, which
+ # should be enabled by default in almost any OS. See
+ # the Reticulum Manual for more configuration options.
+
+ [[Default Interface]]
+ type = AutoInterface
+ interface_enabled = True
+
+If Reticulum infrastructure already exists locally, you probably don't need to
+change anything, and you may already be connected to a wider network. If not,
+you will probably need to add relevant *interfaces* to the configuration, in
+order to communicate with other systems.
+
+You can generate a much more verbose configuration example by running the command:
+
+``rnsd --exampleconfig``
+
+The output includes examples for most interface types supported
+by Reticulum, along with additional options and configuration parameters.
+
+It is a good idea to read the comments and explanations in the above default config.
+It will teach you the basic concepts you need to understand to configure your network.
+Once you have done that, take a look at the :ref:`Interfaces` chapter
+of this manual.
+
+Included Utility Programs
+-------------------------
+
+Reticulum includes a range of useful utilities, both for managing your Reticulum
+networks, and for carrying out common tasks over Reticulum networks, such as
+transferring files to remote systems, and executing commands and programs remotely.
+
+If you often use Reticulum from several different programs, or simply want
+Reticulum to stay available all the time, for example if you are hosting
+a transport node, you might want to run Reticulum as a separate service that
+other programs, applications and services can utilise.
+
+The rnsd Utility
+================
+
+It is very easy to run Reticulum as a service. Simply run the included ``rnsd`` command.
+When ``rnsd`` is running, it will keep all configured interfaces open, handle transport if
+it is enabled, and allow any other programs to immediately utilise the
+Reticulum network it is configured for.
+
+You can even run multiple instances of ``rnsd`` with different configurations on
+the same system.
+
+**Usage Examples**
+
+Run ``rnsd``:
+
+.. code:: text
+
+ $ rnsd
+
+ [2023-08-18 17:59:56] [Notice] Started rnsd version 0.5.8
+
+Run ``rnsd`` in service mode, ensuring all logging output is sent directly to file:
+
+.. code:: text
+
+ $ rnsd -s
+
+Generate a verbose and detailed configuration example, with explanations of all the
+various configuration options, and interface configuration examples:
+
+.. code:: text
+
+ $ rnsd --exampleconfig
+
+**All Command-Line Options**
+
+.. code:: text
+
+ usage: rnsd.py [-h] [--config CONFIG] [-v] [-q] [-s] [--exampleconfig] [--version]
+
+ Reticulum Network Stack Daemon
+
+ options:
+ -h, --help show this help message and exit
+ --config CONFIG path to alternative Reticulum config directory
+ -v, --verbose
+ -q, --quiet
+ -s, --service rnsd is running as a service and should log to file
+ --exampleconfig print verbose configuration example to stdout and exit
+ --version show program's version number and exit
+
+You can easily add ``rnsd`` as an always-on service by :ref:`configuring a service`.
+
+The rnstatus Utility
+====================
+
+Using the ``rnstatus`` utility, you can view the status of configured Reticulum
+interfaces, similar to the ``ifconfig`` program.
+
+**Usage Examples**
+
+Run ``rnstatus``:
+
+.. code:: text
+
+ $ rnstatus
+
+ Shared Instance[37428]
+ Status : Up
+ Serving : 1 program
+ Rate : 1.00 Gbps
+ Traffic : 83.13 KB↑
+ 86.10 KB↓
+
+ AutoInterface[Local]
+ Status : Up
+ Mode : Full
+ Rate : 10.00 Mbps
+ Peers : 1 reachable
+ Traffic : 63.23 KB↑
+ 80.17 KB↓
+
+ TCPInterface[RNS Testnet Dublin/dublin.connect.reticulum.network:4965]
+ Status : Up
+ Mode : Full
+ Rate : 10.00 Mbps
+ Traffic : 187.27 KB↑
+ 74.17 KB↓
+
+ RNodeInterface[RNode UHF]
+ Status : Up
+ Mode : Access Point
+ Rate : 1.30 kbps
+ Access : 64-bit IFAC by <…e702c42ba8>
+ Traffic : 8.49 KB↑
+ 9.23 KB↓
+
+ Reticulum Transport Instance <5245a8efe1788c6a1cd36144a270e13b> running
+
+Filter output to only show some interfaces:
+
+.. code:: text
+
+ $ rnstatus rnode
+
+ RNodeInterface[RNode UHF]
+ Status : Up
+ Mode : Access Point
+ Rate : 1.30 kbps
+ Access : 64-bit IFAC by <…e702c42ba8>
+ Traffic : 8.49 KB↑
+ 9.23 KB↓
+
+ Reticulum Transport Instance <5245a8efe1788c6a1cd36144a270e13b> running
+
+**All Command-Line Options**
+
+.. code:: text
+
+ usage: rnstatus [-h] [--config CONFIG] [--version] [-a] [-A]
+ [-l] [-s SORT] [-r] [-j] [-R hash] [-i path]
+ [-w seconds] [-v] [filter]
+
+ Reticulum Network Stack Status
+
+ positional arguments:
+ filter only display interfaces with names including filter
+
+ options:
+ -h, --help show this help message and exit
+ --config CONFIG path to alternative Reticulum config directory
+ --version show program's version number and exit
+ -a, --all show all interfaces
+ -A, --announce-stats show announce stats
+ -l, --link-stats show link stats
+ -s SORT, --sort SORT sort interfaces by [rate, traffic, rx, tx, announces, arx, atx, held]
+ -r, --reverse reverse sorting
+ -j, --json output in JSON format
+ -R hash transport identity hash of remote instance to get status from (requires -i)
+ -i path path to identity used for remote management
+ -w seconds timeout before giving up on remote queries
+ -v, --verbose
+
+
+.. note::
+ When using ``-R`` to query a remote transport instance, you must also specify ``-i`` with the path to a management identity file that is authorized for remote management on the target system.
+
+The rnid Utility
+====================
+
+With the ``rnid`` utility, you can generate, manage and view Reticulum Identities.
+The program can also calculate Destination hashes, and perform encryption and
+decryption of files.
+
+Using ``rnid``, it is possible to asymmetrically encrypt files and information for
+any Reticulum destination hash, and also to create and verify cryptographic signatures.
+
+**Usage Examples**
+
+Generate a new Identity:
+
+.. code:: text
+
+ $ rnid -g ./new_identity
+
+Display Identity key information:
+
+.. code:: text
+
+ $ rnid -i ./new_identity -p
+
+ Loaded Identity <984b74a3f768bef236af4371e6f248cd> from new_id
+ Public Key : 0f4259fef4521ab75a3409e353fe9073eb10783b4912a6a9937c57bf44a62c1e
+ Private Key : Hidden
+
+Encrypt a file for an LXMF user:
+
+.. code:: text
+
+ $ rnid -i 8dd57a738226809646089335a6b03695 -e my_file.txt
+
+ Recalled Identity for destination <8dd57a738226809646089335a6b03695>
+ Encrypting my_file.txt
+ File my_file.txt encrypted for to my_file.txt.rfe
+
+If the Identity for the destination is not already known, you can fetch it from the network by using the ``-R`` command-line option:
+
+.. code:: text
+
+ $ rnid -R -i 30602def3b3506a28ed33db6f60cc6c9 -e my_file.txt
+
+ Requesting unknown Identity for <30602def3b3506a28ed33db6f60cc6c9>...
+ Received Identity <2b489d06eaf7c543808c76a5332a447d> for destination <30602def3b3506a28ed33db6f60cc6c9> from the network
+ Encrypting my_file.txt
+ File my_file.txt encrypted for <2b489d06eaf7c543808c76a5332a447d> to my_file.txt.rfe
+
+Decrypt a file using the Reticulum Identity it was encrypted for:
+
+.. code:: text
+
+ $ rnid -i ./my_identity -d my_file.txt.rfe
+
+ Loaded Identity <2225fdeecaf6e2db4556c3c2d7637294> from ./my_identity
+ Decrypting ./my_file.txt.rfe...
+ File ./my_file.txt.rfe decrypted with <2225fdeecaf6e2db4556c3c2d7637294> to ./my_file.txt
+
+**All Command-Line Options**
+
+.. code:: text
+
+ usage: rnid.py [-h] [--config path] [-i identity] [-g path] [-v] [-q] [-a aspects]
+ [-H aspects] [-e path] [-d path] [-s path] [-V path] [-r path] [-w path]
+ [-f] [-R] [-t seconds] [-p] [-P] [--version]
+
+ Reticulum Identity & Encryption Utility
+
+ options:
+ -h, --help show this help message and exit
+ --config path path to alternative Reticulum config directory
+ -i identity, --identity identity
+ hexadecimal Reticulum Destination hash or path to Identity file
+ -g path, --generate path
+ generate a new Identity
+ -v, --verbose increase verbosity
+ -q, --quiet decrease verbosity
+ -a aspects, --announce aspects
+ announce a destination based on this Identity
+ -H aspects, --hash aspects
+ show destination hashes for other aspects for this Identity
+ -e path, --encrypt path
+ encrypt file
+ -d path, --decrypt path
+ decrypt file
+ -s path, --sign path sign file
+ -V path, --validate path
+ validate signature
+ -r path, --read path input file path
+ -w path, --write path
+ output file path
+ -f, --force write output even if it overwrites existing files
+ -R, --request request unknown Identities from the network
+ -t seconds identity request timeout before giving up
+ -p, --print-identity print identity info and exit
+ -P, --print-private allow displaying private keys
+ --version show program's version number and exit
+
+
+The rnpath Utility
+====================
+
+With the ``rnpath`` utility, you can look up and view paths for
+destinations on the Reticulum network.
+
+**Usage Examples**
+
+Resolve path to a destination:
+
+.. code:: text
+
+ $ rnpath c89b4da064bf66d280f0e4d8abfd9806
+
+ Path found, destination is 4 hops away via on TCPInterface[Testnet/dublin.connect.reticulum.network:4965]
+
+**All Command-Line Options**
+
+.. code:: text
+
+ usage: rnpath [-h] [--config CONFIG] [--version] [-t] [-m hops]
+ [-r] [-d] [-D] [-x] [-w seconds] [-R hash] [-i path]
+ [-W seconds] [-j] [-v] [destination]
+
+ Reticulum Path Discovery Utility
+
+ positional arguments:
+ destination hexadecimal hash of the destination
+
+ options:
+ -h, --help show this help message and exit
+ --config CONFIG path to alternative Reticulum config directory
+ --version show program's version number and exit
+ -t, --table show all known paths
+ -m hops, --max hops maximum hops to filter path table by
+ -r, --rates show announce rate info
+ -d, --drop remove the path to a destination
+ -D, --drop-announces drop all queued announces
+ -x, --drop-via drop all paths via specified transport instance
+ -w seconds timeout before giving up
+ -R hash transport identity hash of remote instance to manage
+ -i path path to identity used for remote management
+ -W seconds timeout before giving up on remote queries
+ -j, --json output in JSON format
+ -v, --verbose
+
+
+The rnprobe Utility
+====================
+
+The ``rnprobe`` utility lets you probe a destination for connectivity, similar
+to the ``ping`` program. Please note that probes will only be answered if the
+specified destination is configured to send proofs for received packets. Many
+destinations will not have this option enabled, so most destinations will not
+be probable.
+
+You can enable a probe-reply destination on Reticulum Transport Instances by
+setting the ``respond_to_probes`` configuration directive. Reticulum will then
+print the probe destination to the log on Transport Instance startup.
+
+**Usage Examples**
+
+Probe a destination:
+
+.. code:: text
+
+ $ rnprobe rnstransport.probe 2d03725b327348980d570f739a3a5708
+
+ Sent 16 byte probe to <2d03725b327348980d570f739a3a5708>
+ Valid reply received from <2d03725b327348980d570f739a3a5708>
+ Round-trip time is 38.469 milliseconds over 2 hops
+
+Send a larger probe:
+
+.. code:: text
+
+ $ rnprobe rnstransport.probe 2d03725b327348980d570f739a3a5708 -s 256
+
+ Sent 16 byte probe to <2d03725b327348980d570f739a3a5708>
+ Valid reply received from <2d03725b327348980d570f739a3a5708>
+ Round-trip time is 38.781 milliseconds over 2 hops
+
+If the interface that receives the probe replies supports reporting radio
+parameters such as **RSSI** and **SNR**, the ``rnprobe`` utility will print
+these as part of the result as well.
+
+.. code:: text
+
+ $ rnprobe rnstransport.probe e7536ee90bd4a440e130490b87a25124
+
+ Sent 16 byte probe to
+ Valid reply received from
+ Round-trip time is 1.809 seconds over 1 hop [RSSI -73 dBm] [SNR 12.0 dB]
+
+**All Command-Line Options**
+
+.. code:: text
+
+ usage: rnprobe [-h] [--config CONFIG] [-s SIZE] [-n PROBES]
+ [-t seconds] [-w seconds] [--version] [-v]
+ [full_name] [destination_hash]
+
+ Reticulum Probe Utility
+
+ positional arguments:
+ full_name full destination name in dotted notation
+ destination_hash hexadecimal hash of the destination
+
+ options:
+ -h, --help show this help message and exit
+ --config CONFIG path to alternative Reticulum config directory
+ -s SIZE, --size SIZE size of probe packet payload in bytes
+ -n PROBES, --probes PROBES
+ number of probes to send
+ -t seconds, --timeout seconds
+ timeout before giving up
+ -w seconds, --wait seconds
+ time between each probe
+ --version show program's version number and exit
+ -v, --verbose
+
+
+The rncp Utility
+================
+
+The ``rncp`` utility is a simple file transfer tool. Using it, you can transfer
+files through Reticulum.
+
+**Usage Examples**
+
+Run rncp on the receiving system, specifying which identities are allowed to send files:
+
+.. code:: text
+
+ $ rncp --listen -a 1726dbad538775b5bf9b0ea25a4079c8 -a c50cc4e4f7838b6c31f60ab9032cbc62
+
+You can also specify allowed identity hashes (one per line) in the file ~/.rncp/allowed_identities
+and simply running the program in listener mode:
+
+.. code:: text
+
+ $ rncp --listen
+
+From another system, copy a file to the receiving system:
+
+.. code:: text
+
+ $ rncp ~/path/to/file.tgz 73cbd378bb0286ed11a707c13447bb1e
+
+Or fetch a file from the remote system:
+
+.. code:: text
+
+ $ rncp --fetch ~/path/to/file.tgz 73cbd378bb0286ed11a707c13447bb1e
+
+**All Command-Line Options**
+
+.. code:: text
+
+ usage: rncp [-h] [--config path] [-v] [-q] [-S] [-l] [-F] [-f]
+ [-j path] [-b seconds] [-a allowed_hash] [-n] [-p]
+ [-w seconds] [--version] [file] [destination]
+
+ Reticulum File Transfer Utility
+
+ positional arguments:
+ file file to be transferred
+ destination hexadecimal hash of the receiver
+
+ options:
+ -h, --help show this help message and exit
+ --config path path to alternative Reticulum config directory
+ -v, --verbose increase verbosity
+ -q, --quiet decrease verbosity
+ -S, --silent disable transfer progress output
+ -l, --listen listen for incoming transfer requests
+ -F, --allow-fetch allow authenticated clients to fetch files
+ -f, --fetch fetch file from remote listener instead of sending
+ -j path, --jail path restrict fetch requests to specified path
+ -b seconds announce interval, 0 to only announce at startup
+ -a allowed_hash allow this identity
+ -n, --no-auth accept requests from anyone
+ -p, --print-identity print identity and destination info and exit
+ -w seconds sender timeout before giving up
+ --version show program's version number and exit
+
+
+The rnx Utility
+================
+
+The ``rnx`` utility is a basic remote command execution program. It allows you to
+execute commands on remote systems over Reticulum, and to view returned command
+output. For a fully interactive remote shell solution, be sure to also take a look
+at the `rnsh `_ program.
+
+**Usage Examples**
+
+Run rnx on the listening system, specifying which identities are allowed to execute commands:
+
+.. code:: text
+
+ $ rnx --listen -a 941bed5e228775e5a8079fc38b1ccf3f -a 1b03013c25f1c2ca068a4f080b844a10
+
+From another system, run a command on the remote:
+
+.. code:: text
+
+ $ rnx 7a55144adf826958a9529a3bcf08b149 "cat /proc/cpuinfo"
+
+Or enter the interactive mode pseudo-shell:
+
+.. code:: text
+
+ $ rnx 7a55144adf826958a9529a3bcf08b149 -x
+
+The default identity file is stored in ``~/.reticulum/identities/rnx``, but you can use
+another one, which will be created if it does not already exist
+
+.. code:: text
+
+ $ rnx 7a55144adf826958a9529a3bcf08b149 -i /path/to/identity -x
+
+**All Command-Line Options**
+
+.. code:: text
+
+ usage: rnx [-h] [--config path] [-v] [-q] [-p] [-l] [-i identity] [-x] [-b] [-n] [-N]
+ [-d] [-m] [-a allowed_hash] [-w seconds] [-W seconds] [--stdin STDIN]
+ [--stdout STDOUT] [--stderr STDERR] [--version] [destination] [command]
+
+ Reticulum Remote Execution Utility
+
+ positional arguments:
+ destination hexadecimal hash of the listener
+ command command to be execute
+
+ optional arguments:
+ -h, --help show this help message and exit
+ --config path path to alternative Reticulum config directory
+ -v, --verbose increase verbosity
+ -q, --quiet decrease verbosity
+ -p, --print-identity print identity and destination info and exit
+ -l, --listen listen for incoming commands
+ -i identity path to identity to use
+ -x, --interactive enter interactive mode
+ -b, --no-announce don't announce at program start
+ -a allowed_hash accept from this identity
+ -n, --noauth accept files from anyone
+ -N, --noid don't identify to listener
+ -d, --detailed show detailed result output
+ -m mirror exit code of remote command
+ -w seconds connect and request timeout before giving up
+ -W seconds max result download time
+ --stdin STDIN pass input to stdin
+ --stdout STDOUT max size in bytes of returned stdout
+ --stderr STDERR max size in bytes of returned stderr
+ --version show program's version number and exit
+
+
+The rnodeconf Utility
+=====================
+
+The ``rnodeconf`` utility allows you to inspect and configure existing :ref:`RNodes`, and
+to create and provision new :ref:`RNodes` from any supported hardware devices.
+
+**All Command-Line Options**
+
+.. code:: text
+
+ usage: rnodeconf [-h] [-i] [-a] [-u] [-U] [--fw-version version]
+ [--fw-url url] [--nocheck] [-e] [-E] [-C]
+ [--baud-flash baud_flash] [-N] [-T] [-b] [-B] [-p] [-D i]
+ [--display-addr byte] [--freq Hz] [--bw Hz] [--txp dBm]
+ [--sf factor] [--cr rate] [--eeprom-backup] [--eeprom-dump]
+ [--eeprom-wipe] [-P] [--trust-key hexbytes] [--version] [-f]
+ [-r] [-k] [-S] [-H FIRMWARE_HASH] [--platform platform]
+ [--product product] [--model model] [--hwrev revision]
+ [port]
+
+ RNode Configuration and firmware utility. This program allows you to change
+ various settings and startup modes of RNode. It can also install, flash and
+ update the firmware on supported devices.
+
+ positional arguments:
+ port serial port where RNode is attached
+
+ options:
+ -h, --help show this help message and exit
+ -i, --info Show device info
+ -a, --autoinstall Automatic installation on various supported devices
+ -u, --update Update firmware to the latest version
+ -U, --force-update Update to specified firmware even if version matches
+ or is older than installed version
+ --fw-version version Use a specific firmware version for update or
+ autoinstall
+ --fw-url url Use an alternate firmware download URL
+ --nocheck Don't check for firmware updates online
+ -e, --extract Extract firmware from connected RNode for later use
+ -E, --use-extracted Use the extracted firmware for autoinstallation or
+ update
+ -C, --clear-cache Clear locally cached firmware files
+ --baud-flash baud_flash
+ Set specific baud rate when flashing device. Default
+ is 921600
+ -N, --normal Switch device to normal mode
+ -T, --tnc Switch device to TNC mode
+ -b, --bluetooth-on Turn device bluetooth on
+ -B, --bluetooth-off Turn device bluetooth off
+ -p, --bluetooth-pair Put device into bluetooth pairing mode
+ -D i, --display i Set display intensity (0-255)
+ --display-addr byte Set display address as hex byte (00 - FF)
+ --freq Hz Frequency in Hz for TNC mode
+ --bw Hz Bandwidth in Hz for TNC mode
+ --txp dBm TX power in dBm for TNC mode
+ --sf factor Spreading factor for TNC mode (7 - 12)
+ --cr rate Coding rate for TNC mode (5 - 8)
+ --eeprom-backup Backup EEPROM to file
+ --eeprom-dump Dump EEPROM to console
+ --eeprom-wipe Unlock and wipe EEPROM
+ -P, --public Display public part of signing key
+ --trust-key hexbytes Public key to trust for device verification
+ --version Print program version and exit
+ -f, --flash Flash firmware and bootstrap EEPROM
+ -r, --rom Bootstrap EEPROM without flashing firmware
+ -k, --key Generate a new signing key and exit
+ -S, --sign Display public part of signing key
+ -H FIRMWARE_HASH, --firmware-hash FIRMWARE_HASH
+ Display installed firmware hash
+ --platform platform Platform specification for device bootstrap
+ --product product Product specification for device bootstrap
+ --model model Model code for device bootstrap
+ --hwrev revision Hardware revision for device bootstrap
+
+
+For more information on how to create your own RNodes, please read the :ref:`Creating RNodes`
+section of this manual.
+
+Remote Management
+-----------------
+
+It is possible to allow remote management of Reticulum
+systems using the various built-in utilities, such as
+``rnstatus`` and ``rnpath``. To do so, you will need to set
+the ``enable_remote_management`` directive in the ``[reticulum]``
+section of the configuration file. You will also need to specify
+one or more Reticulum Identity hashes for authenticating the
+queries from client programs. For this purpose, you can use
+existing identity files, or generate new ones with the rnid utility.
+
+The following is a truncated example of enabling remote management
+in the Reticulum configuration file:
+
+.. code:: text
+
+ [reticulum]
+ ...
+ enable_remote_management = yes
+ remote_management_allowed = 9fb6d773498fb3feda407ed8ef2c3229, 2d882c5586e548d79b5af27bca1776dc
+ ...
+
+For a complete example configuration, you can run ``rnsd --exampleconfig``.
+
+Improving System Configuration
+------------------------------
+
+If you are setting up a system for permanent use with Reticulum, there is a
+few system configuration changes that can make this easier to administrate.
+These changes will be detailed here.
+
+
+Fixed Serial Port Names
+=======================
+
+On a Reticulum instance with several serial port based interfaces, it can be
+beneficial to use the fixed device names for the serial ports, instead
+of the dynamically allocated shorthands such as ``/dev/ttyUSB0``. Under most
+Debian-based distributions, including Ubuntu and Raspberry Pi OS, these nodes
+can be found under ``/dev/serial/by-id``.
+
+You can use such a device path directly in place of the numbered shorthands.
+Here is an example of a packet radio TNC configured as such:
+
+.. code:: text
+
+ [[Packet Radio KISS Interface]]
+ type = KISSInterface
+ interface_enabled = True
+ outgoing = true
+ port = /dev/serial/by-id/usb-FTDI_FT230X_Basic_UART_43891CKM-if00-port0
+ speed = 115200
+ databits = 8
+ parity = none
+ stopbits = 1
+ preamble = 150
+ txtail = 10
+ persistence = 200
+ slottime = 20
+
+Using this methodology avoids potential naming mix-ups where physical devices
+might be plugged and unplugged in different orders, or when device name
+assignment varies from one boot to another.
+
+.. _using-systemd:
+
+Reticulum as a System Service
+=============================
+
+Instead of starting Reticulum manually, you can install ``rnsd`` as a system
+service and have it start automatically at boot.
+
+Systemwide Service
+^^^^^^^^^^^^^^^^^^
+
+If you installed Reticulum with ``pip``, the ``rnsd`` program will most likely
+be located in a user-local installation path only, which means ``systemd`` will not
+be able to execute it. In this case, you can simply symlink the ``rnsd`` program
+into a directory that is in systemd's path:
+
+.. code:: text
+
+ sudo ln -s $(which rnsd) /usr/local/bin/
+
+You can then create the service file ``/etc/systemd/system/rnsd.service`` with the
+following content:
+
+.. code:: text
+
+ [Unit]
+ Description=Reticulum Network Stack Daemon
+ After=multi-user.target
+
+ [Service]
+ # If you run Reticulum on WiFi devices,
+ # or other devices that need some extra
+ # time to initialise, you might want to
+ # add a short delay before Reticulum is
+ # started by systemd:
+ # ExecStartPre=/bin/sleep 10
+ Type=simple
+ Restart=always
+ RestartSec=3
+ User=USERNAMEHERE
+ ExecStart=rnsd --service
+
+ [Install]
+ WantedBy=multi-user.target
+
+Be sure to replace ``USERNAMEHERE`` with the user you want to run ``rnsd`` as.
+
+To manually start ``rnsd`` run:
+
+.. code:: text
+
+ sudo systemctl start rnsd
+
+If you want to automatically start ``rnsd`` at boot, run:
+
+.. code:: text
+
+ sudo systemctl enable rnsd
+
+Userspace Service
+^^^^^^^^^^^^^^^^^
+
+Alternatively you can use a user systemd service instead of a system wide one. This way the whole setup can be done as a regular user.
+Create a user systemd service files ``~/.config/systemd/user/rnsd.service`` with the following content:
+
+.. code:: text
+
+ [Unit]
+ Description=Reticulum Network Stack Daemon
+ After=default.target
+
+ [Service]
+ # If you run Reticulum on WiFi devices,
+ # or other devices that need some extra
+ # time to initialise, you might want to
+ # add a short delay before Reticulum is
+ # started by systemd:
+ # ExecStartPre=/bin/sleep 10
+ Type=simple
+ Restart=always
+ RestartSec=3
+ ExecStart=RNS_BIN_DIR/rnsd --service
+
+ [Install]
+ WantedBy=default.target
+
+Replace ``RNS_BIN_DIR`` with the path to your Reticulum binary directory (eg. /home/USERNAMEHERE/rns/bin).
+
+Start user service:
+
+.. code:: text
+
+ systemctl --user daemon-reload
+ systemctl --user start rnsd.service
+
+If you want to automatically start ``rnsd`` without having to log in as the USERNAMEHERE, do:
+
+.. code:: text
+
+ sudo loginctl enable-linger USERNAMEHERE
+ systemctl --user enable rnsd.service
+
+
diff --git a/docs/manual/_sources/whatis.rst.txt b/docs/manual/_sources/whatis.rst.txt
new file mode 100644
index 0000000..698c06b
--- /dev/null
+++ b/docs/manual/_sources/whatis.rst.txt
@@ -0,0 +1,191 @@
+******************
+What is Reticulum?
+******************
+
+Reticulum is a cryptography-based networking stack for building both local and
+wide-area networks with readily available hardware, that can continue to operate
+under adverse conditions, such as extremely low bandwidth and very high latency.
+
+Reticulum allows you to build wide-area networks with off-the-shelf tools, and
+offers end-to-end encryption, forward secrecy, autoconfiguring cryptographically
+backed multi-hop transport, efficient addressing, unforgeable packet
+acknowledgements and more.
+
+From a users perspective, Reticulum allows the creation of applications that
+respect and empower the autonomy and sovereignty of communities and individuals.
+Reticulum enables secure digital communication that cannot be subjected to
+outside control, manipulation or censorship.
+
+Reticulum enables the construction of both small and potentially planetary-scale
+networks, without any need for hierarchical or bureaucratic structures to control
+or manage them, while ensuring individuals and communities full sovereignty
+over their own network segments.
+
+Reticulum is a **complete networking stack**, and does not need IP or higher
+layers, although it is easy to utilise IP (with TCP or UDP) as the underlying
+carrier for Reticulum. It is therefore trivial to tunnel Reticulum over the
+Internet or private IP networks. Reticulum is built directly on cryptographic
+principles, allowing resilience and stable functionality in open and trustless
+networks.
+
+No kernel modules or drivers are required. Reticulum can run completely in
+userland, and will run on practically any system that runs Python 3. Reticulum
+runs well even on small single-board computers like the Pi Zero.
+
+
+Current Status
+==============
+All core protocol features are implemented and functioning, but additions will probably occur as
+real-world use is explored. The API and wire-format can be considered complete and stable, but
+could change if absolutely warranted.
+
+
+What does Reticulum Offer?
+==========================
+
+* Coordination-less globally unique addressing and identification
+
+* Fully self-configuring multi-hop routing over heterogeneous carriers
+
+* Flexible scalability over heterogeneous topologies
+
+ * Reticulum can carry data over any mixture of physical mediums and topologies
+
+ * Low-bandwidth networks can co-exist and interoperate with large, high-bandwidth networks
+
+* Initiator anonymity, communicate without revealing your identity
+
+ * Reticulum does not include source addresses on any packets
+
+* Asymmetric X25519 encryption and Ed25519 signatures as a basis for all communication
+
+ * The foundational Reticulum Identity Keys are 512-bit Elliptic Curve keysets
+
+* Forward Secrecy is available for all communication types, both for single packets and over links
+
+* Reticulum uses the following format for encrypted tokens:
+
+ * Ephemeral per-packet and link keys and derived from an ECDH key exchange on Curve25519
+
+ * AES-256 in CBC mode with PKCS7 padding
+
+ * HMAC using SHA256 for authentication
+
+ * IVs are generated through os.urandom()
+
+* Unforgeable packet delivery confirmations
+
+* Flexible and extensible interface system
+
+ * Reticulum includes a large variety of built-in interface types
+
+ * Ability to load and utilise custom user- or community-supplied interface types
+
+ * Easily create your own custom interfaces for communicating over anything
+
+* Authentication and virtual network segmentation on all supported interface types
+
+* An intuitive and easy-to-use API
+
+ * Simpler and easier to use than sockets APIs and simpler, but more powerful
+
+ * Makes building distributed and decentralised applications much simpler
+
+* Reliable and efficient transfer of arbitrary amounts of data
+
+ * Reticulum can handle a few bytes of data or files of many gigabytes
+
+ * Sequencing, compression, transfer coordination and checksumming are automatic
+
+ * The API is very easy to use, and provides transfer progress
+
+* Lightweight, flexible and expandable Request/Response mechanism
+
+* Efficient link establishment
+
+ * Total cost of setting up an encrypted and verified link is only 3 packets, totalling 297 bytes
+
+ * Low cost of keeping links open at only 0.44 bits per second
+
+* Reliable sequential delivery with Channel and Buffer mechanisms
+
+
+Where can Reticulum be Used?
+============================
+Over practically any medium that can support at least a half-duplex channel
+with greater throughput than 5 bits per second, and an MTU of 500 bytes. Data radios,
+modems, LoRa radios, serial lines, AX.25 TNCs, amateur radio digital modes,
+ad-hoc WiFi, free-space optical links and similar systems are all examples
+of the types of interfaces Reticulum was designed for.
+
+An open-source LoRa-based interface called `RNode `_
+has been designed as an example transceiver that is very suitable for
+Reticulum. It is possible to build it yourself, to transform a common LoRa
+development board into one, or it can be purchased as a complete transceiver
+from various vendors.
+
+Reticulum can also be encapsulated over existing IP networks, so there's
+nothing stopping you from using it over wired Ethernet or your local WiFi
+network, where it'll work just as well. In fact, one of the strengths of
+Reticulum is how easily it allows you to connect different mediums into a
+self-configuring, resilient and encrypted mesh.
+
+As an example, it's possible to set up a Raspberry Pi connected to both a
+LoRa radio, a packet radio TNC and a WiFi network. Once the interfaces are
+added, Reticulum will take care of the rest, and any device on the WiFi
+network can communicate with nodes on the LoRa and packet radio sides of the
+network, and vice versa.
+
+Interface Types and Devices
+===========================
+Reticulum implements a range of generalised interface types that covers the communications hardware that Reticulum can run over. If your hardware is not supported, it's simple to :ref:`implement an interface class`. Currently, Reticulum can use the following devices and communication mediums:
+
+* Any Ethernet device
+
+ * WiFi devices
+
+ * Wired Ethernet devices
+
+ * Fibre-optic transceivers
+
+ * Data radios with Ethernet ports
+
+* LoRa using `RNode `_
+
+ * Can be installed on `many popular LoRa boards `_
+
+ * Can be purchased as a `ready to use transceiver `_
+
+* Packet Radio TNCs, such as `OpenModem `_
+
+ * Any packet radio TNC in KISS mode
+
+ * Ideal for VHF and UHF radio
+
+* Any device with a serial port
+
+* The I2P network
+
+* TCP over IP networks
+
+* UDP over IP networks
+
+* Anything you can connect via stdio
+
+ * Reticulum can use external programs and pipes as interfaces
+
+ * This can be used to easily hack in virtual interfaces
+
+ * Or to quickly create interfaces with custom hardware
+
+For a full list and more details, see the :ref:`Supported Interfaces` chapter.
+
+
+Caveat Emptor
+==============
+Reticulum is an experimental networking stack, and should be considered as
+such. While it has been built with cryptography best-practices very foremost in
+mind, it has not yet been externally security audited, and there could very well be
+privacy-breaking bugs. To be considered secure, Reticulum needs a thorough
+security review by independent cryptographers and security researchers. If you
+want to help out with this, or can help sponsor an audit, please do get in touch.
\ No newline at end of file
diff --git a/docs/manual/_static/.nojekyll b/docs/manual/_static/.nojekyll
new file mode 100644
index 0000000..e69de29
diff --git a/docs/manual/_static/_sphinx_javascript_frameworks_compat.js b/docs/manual/_static/_sphinx_javascript_frameworks_compat.js
new file mode 100644
index 0000000..8549469
--- /dev/null
+++ b/docs/manual/_static/_sphinx_javascript_frameworks_compat.js
@@ -0,0 +1,134 @@
+/*
+ * _sphinx_javascript_frameworks_compat.js
+ * ~~~~~~~~~~
+ *
+ * Compatability shim for jQuery and underscores.js.
+ *
+ * WILL BE REMOVED IN Sphinx 6.0
+ * xref RemovedInSphinx60Warning
+ *
+ */
+
+/**
+ * select a different prefix for underscore
+ */
+$u = _.noConflict();
+
+
+/**
+ * small helper function to urldecode strings
+ *
+ * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
+ */
+jQuery.urldecode = function(x) {
+ if (!x) {
+ return x
+ }
+ return decodeURIComponent(x.replace(/\+/g, ' '));
+};
+
+/**
+ * small helper function to urlencode strings
+ */
+jQuery.urlencode = encodeURIComponent;
+
+/**
+ * This function returns the parsed url parameters of the
+ * current request. Multiple values per key are supported,
+ * it will always return arrays of strings for the value parts.
+ */
+jQuery.getQueryParameters = function(s) {
+ if (typeof s === 'undefined')
+ s = document.location.search;
+ var parts = s.substr(s.indexOf('?') + 1).split('&');
+ var result = {};
+ for (var i = 0; i < parts.length; i++) {
+ var tmp = parts[i].split('=', 2);
+ var key = jQuery.urldecode(tmp[0]);
+ var value = jQuery.urldecode(tmp[1]);
+ if (key in result)
+ result[key].push(value);
+ else
+ result[key] = [value];
+ }
+ return result;
+};
+
+/**
+ * highlight a given string on a jquery object by wrapping it in
+ * span elements with the given class name.
+ */
+jQuery.fn.highlightText = function(text, className) {
+ function highlight(node, addItems) {
+ if (node.nodeType === 3) {
+ var val = node.nodeValue;
+ var pos = val.toLowerCase().indexOf(text);
+ if (pos >= 0 &&
+ !jQuery(node.parentNode).hasClass(className) &&
+ !jQuery(node.parentNode).hasClass("nohighlight")) {
+ var span;
+ var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
+ if (isInSVG) {
+ span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
+ } else {
+ span = document.createElement("span");
+ span.className = className;
+ }
+ span.appendChild(document.createTextNode(val.substr(pos, text.length)));
+ node.parentNode.insertBefore(span, node.parentNode.insertBefore(
+ document.createTextNode(val.substr(pos + text.length)),
+ node.nextSibling));
+ node.nodeValue = val.substr(0, pos);
+ if (isInSVG) {
+ var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
+ var bbox = node.parentElement.getBBox();
+ rect.x.baseVal.value = bbox.x;
+ rect.y.baseVal.value = bbox.y;
+ rect.width.baseVal.value = bbox.width;
+ rect.height.baseVal.value = bbox.height;
+ rect.setAttribute('class', className);
+ addItems.push({
+ "parent": node.parentNode,
+ "target": rect});
+ }
+ }
+ }
+ else if (!jQuery(node).is("button, select, textarea")) {
+ jQuery.each(node.childNodes, function() {
+ highlight(this, addItems);
+ });
+ }
+ }
+ var addItems = [];
+ var result = this.each(function() {
+ highlight(this, addItems);
+ });
+ for (var i = 0; i < addItems.length; ++i) {
+ jQuery(addItems[i].parent).before(addItems[i].target);
+ }
+ return result;
+};
+
+/*
+ * backward compatibility for jQuery.browser
+ * This will be supported until firefox bug is fixed.
+ */
+if (!jQuery.browser) {
+ jQuery.uaMatch = function(ua) {
+ ua = ua.toLowerCase();
+
+ var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
+ /(webkit)[ \/]([\w.]+)/.exec(ua) ||
+ /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
+ /(msie) ([\w.]+)/.exec(ua) ||
+ ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
+ [];
+
+ return {
+ browser: match[ 1 ] || "",
+ version: match[ 2 ] || "0"
+ };
+ };
+ jQuery.browser = {};
+ jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
+}
diff --git a/docs/manual/_static/basic.css b/docs/manual/_static/basic.css
new file mode 100644
index 0000000..4e9a9f1
--- /dev/null
+++ b/docs/manual/_static/basic.css
@@ -0,0 +1,900 @@
+/*
+ * basic.css
+ * ~~~~~~~~~
+ *
+ * Sphinx stylesheet -- basic theme.
+ *
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+/* -- main layout ----------------------------------------------------------- */
+
+div.clearer {
+ clear: both;
+}
+
+div.section::after {
+ display: block;
+ content: '';
+ clear: left;
+}
+
+/* -- relbar ---------------------------------------------------------------- */
+
+div.related {
+ width: 100%;
+ font-size: 90%;
+}
+
+div.related h3 {
+ display: none;
+}
+
+div.related ul {
+ margin: 0;
+ padding: 0 0 0 10px;
+ list-style: none;
+}
+
+div.related li {
+ display: inline;
+}
+
+div.related li.right {
+ float: right;
+ margin-right: 5px;
+}
+
+/* -- sidebar --------------------------------------------------------------- */
+
+div.sphinxsidebarwrapper {
+ padding: 10px 5px 0 10px;
+}
+
+div.sphinxsidebar {
+ float: left;
+ width: 230px;
+ margin-left: -100%;
+ font-size: 90%;
+ word-wrap: break-word;
+ overflow-wrap : break-word;
+}
+
+div.sphinxsidebar ul {
+ list-style: none;
+}
+
+div.sphinxsidebar ul ul,
+div.sphinxsidebar ul.want-points {
+ margin-left: 20px;
+ list-style: square;
+}
+
+div.sphinxsidebar ul ul {
+ margin-top: 0;
+ margin-bottom: 0;
+}
+
+div.sphinxsidebar form {
+ margin-top: 10px;
+}
+
+div.sphinxsidebar input {
+ border: 1px solid #98dbcc;
+ font-family: sans-serif;
+ font-size: 1em;
+}
+
+div.sphinxsidebar #searchbox form.search {
+ overflow: hidden;
+}
+
+div.sphinxsidebar #searchbox input[type="text"] {
+ float: left;
+ width: 80%;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+div.sphinxsidebar #searchbox input[type="submit"] {
+ float: left;
+ width: 20%;
+ border-left: none;
+ padding: 0.25em;
+ box-sizing: border-box;
+}
+
+
+img {
+ border: 0;
+ max-width: 100%;
+}
+
+/* -- search page ----------------------------------------------------------- */
+
+ul.search {
+ margin: 10px 0 0 20px;
+ padding: 0;
+}
+
+ul.search li {
+ padding: 5px 0 5px 20px;
+ background-image: url(file.png);
+ background-repeat: no-repeat;
+ background-position: 0 7px;
+}
+
+ul.search li a {
+ font-weight: bold;
+}
+
+ul.search li p.context {
+ color: #888;
+ margin: 2px 0 0 30px;
+ text-align: left;
+}
+
+ul.keywordmatches li.goodmatch a {
+ font-weight: bold;
+}
+
+/* -- index page ------------------------------------------------------------ */
+
+table.contentstable {
+ width: 90%;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.contentstable p.biglink {
+ line-height: 150%;
+}
+
+a.biglink {
+ font-size: 1.3em;
+}
+
+span.linkdescr {
+ font-style: italic;
+ padding-top: 5px;
+ font-size: 90%;
+}
+
+/* -- general index --------------------------------------------------------- */
+
+table.indextable {
+ width: 100%;
+}
+
+table.indextable td {
+ text-align: left;
+ vertical-align: top;
+}
+
+table.indextable ul {
+ margin-top: 0;
+ margin-bottom: 0;
+ list-style-type: none;
+}
+
+table.indextable > tbody > tr > td > ul {
+ padding-left: 0em;
+}
+
+table.indextable tr.pcap {
+ height: 10px;
+}
+
+table.indextable tr.cap {
+ margin-top: 10px;
+ background-color: #f2f2f2;
+}
+
+img.toggler {
+ margin-right: 3px;
+ margin-top: 3px;
+ cursor: pointer;
+}
+
+div.modindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+div.genindex-jumpbox {
+ border-top: 1px solid #ddd;
+ border-bottom: 1px solid #ddd;
+ margin: 1em 0 1em 0;
+ padding: 0.4em;
+}
+
+/* -- domain module index --------------------------------------------------- */
+
+table.modindextable td {
+ padding: 2px;
+ border-collapse: collapse;
+}
+
+/* -- general body styles --------------------------------------------------- */
+
+div.body {
+ min-width: 360px;
+ max-width: 800px;
+}
+
+div.body p, div.body dd, div.body li, div.body blockquote {
+ -moz-hyphens: auto;
+ -ms-hyphens: auto;
+ -webkit-hyphens: auto;
+ hyphens: auto;
+}
+
+a.headerlink {
+ visibility: hidden;
+}
+
+h1:hover > a.headerlink,
+h2:hover > a.headerlink,
+h3:hover > a.headerlink,
+h4:hover > a.headerlink,
+h5:hover > a.headerlink,
+h6:hover > a.headerlink,
+dt:hover > a.headerlink,
+caption:hover > a.headerlink,
+p.caption:hover > a.headerlink,
+div.code-block-caption:hover > a.headerlink {
+ visibility: visible;
+}
+
+div.body p.caption {
+ text-align: inherit;
+}
+
+div.body td {
+ text-align: left;
+}
+
+.first {
+ margin-top: 0 !important;
+}
+
+p.rubric {
+ margin-top: 30px;
+ font-weight: bold;
+}
+
+img.align-left, figure.align-left, .figure.align-left, object.align-left {
+ clear: left;
+ float: left;
+ margin-right: 1em;
+}
+
+img.align-right, figure.align-right, .figure.align-right, object.align-right {
+ clear: right;
+ float: right;
+ margin-left: 1em;
+}
+
+img.align-center, figure.align-center, .figure.align-center, object.align-center {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+img.align-default, figure.align-default, .figure.align-default {
+ display: block;
+ margin-left: auto;
+ margin-right: auto;
+}
+
+.align-left {
+ text-align: left;
+}
+
+.align-center {
+ text-align: center;
+}
+
+.align-default {
+ text-align: center;
+}
+
+.align-right {
+ text-align: right;
+}
+
+/* -- sidebars -------------------------------------------------------------- */
+
+div.sidebar,
+aside.sidebar {
+ margin: 0 0 0.5em 1em;
+ border: 1px solid #ddb;
+ padding: 7px;
+ background-color: #ffe;
+ width: 40%;
+ float: right;
+ clear: right;
+ overflow-x: auto;
+}
+
+p.sidebar-title {
+ font-weight: bold;
+}
+nav.contents,
+aside.topic,
+div.admonition, div.topic, blockquote {
+ clear: left;
+}
+
+/* -- topics ---------------------------------------------------------------- */
+nav.contents,
+aside.topic,
+div.topic {
+ border: 1px solid #ccc;
+ padding: 7px;
+ margin: 10px 0 10px 0;
+}
+
+p.topic-title {
+ font-size: 1.1em;
+ font-weight: bold;
+ margin-top: 10px;
+}
+
+/* -- admonitions ----------------------------------------------------------- */
+
+div.admonition {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ padding: 7px;
+}
+
+div.admonition dt {
+ font-weight: bold;
+}
+
+p.admonition-title {
+ margin: 0px 10px 5px 0px;
+ font-weight: bold;
+}
+
+div.body p.centered {
+ text-align: center;
+ margin-top: 25px;
+}
+
+/* -- content of sidebars/topics/admonitions -------------------------------- */
+
+div.sidebar > :last-child,
+aside.sidebar > :last-child,
+nav.contents > :last-child,
+aside.topic > :last-child,
+div.topic > :last-child,
+div.admonition > :last-child {
+ margin-bottom: 0;
+}
+
+div.sidebar::after,
+aside.sidebar::after,
+nav.contents::after,
+aside.topic::after,
+div.topic::after,
+div.admonition::after,
+blockquote::after {
+ display: block;
+ content: '';
+ clear: both;
+}
+
+/* -- tables ---------------------------------------------------------------- */
+
+table.docutils {
+ margin-top: 10px;
+ margin-bottom: 10px;
+ border: 0;
+ border-collapse: collapse;
+}
+
+table.align-center {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table.align-default {
+ margin-left: auto;
+ margin-right: auto;
+}
+
+table caption span.caption-number {
+ font-style: italic;
+}
+
+table caption span.caption-text {
+}
+
+table.docutils td, table.docutils th {
+ padding: 1px 8px 1px 5px;
+ border-top: 0;
+ border-left: 0;
+ border-right: 0;
+ border-bottom: 1px solid #aaa;
+}
+
+th {
+ text-align: left;
+ padding-right: 5px;
+}
+
+table.citation {
+ border-left: solid 1px gray;
+ margin-left: 1px;
+}
+
+table.citation td {
+ border-bottom: none;
+}
+
+th > :first-child,
+td > :first-child {
+ margin-top: 0px;
+}
+
+th > :last-child,
+td > :last-child {
+ margin-bottom: 0px;
+}
+
+/* -- figures --------------------------------------------------------------- */
+
+div.figure, figure {
+ margin: 0.5em;
+ padding: 0.5em;
+}
+
+div.figure p.caption, figcaption {
+ padding: 0.3em;
+}
+
+div.figure p.caption span.caption-number,
+figcaption span.caption-number {
+ font-style: italic;
+}
+
+div.figure p.caption span.caption-text,
+figcaption span.caption-text {
+}
+
+/* -- field list styles ----------------------------------------------------- */
+
+table.field-list td, table.field-list th {
+ border: 0 !important;
+}
+
+.field-list ul {
+ margin: 0;
+ padding-left: 1em;
+}
+
+.field-list p {
+ margin: 0;
+}
+
+.field-name {
+ -moz-hyphens: manual;
+ -ms-hyphens: manual;
+ -webkit-hyphens: manual;
+ hyphens: manual;
+}
+
+/* -- hlist styles ---------------------------------------------------------- */
+
+table.hlist {
+ margin: 1em 0;
+}
+
+table.hlist td {
+ vertical-align: top;
+}
+
+/* -- object description styles --------------------------------------------- */
+
+.sig {
+ font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
+}
+
+.sig-name, code.descname {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+.sig-name {
+ font-size: 1.1em;
+}
+
+code.descname {
+ font-size: 1.2em;
+}
+
+.sig-prename, code.descclassname {
+ background-color: transparent;
+}
+
+.optional {
+ font-size: 1.3em;
+}
+
+.sig-paren {
+ font-size: larger;
+}
+
+.sig-param.n {
+ font-style: italic;
+}
+
+/* C++ specific styling */
+
+.sig-inline.c-texpr,
+.sig-inline.cpp-texpr {
+ font-family: unset;
+}
+
+.sig.c .k, .sig.c .kt,
+.sig.cpp .k, .sig.cpp .kt {
+ color: #0033B3;
+}
+
+.sig.c .m,
+.sig.cpp .m {
+ color: #1750EB;
+}
+
+.sig.c .s, .sig.c .sc,
+.sig.cpp .s, .sig.cpp .sc {
+ color: #067D17;
+}
+
+
+/* -- other body styles ----------------------------------------------------- */
+
+ol.arabic {
+ list-style: decimal;
+}
+
+ol.loweralpha {
+ list-style: lower-alpha;
+}
+
+ol.upperalpha {
+ list-style: upper-alpha;
+}
+
+ol.lowerroman {
+ list-style: lower-roman;
+}
+
+ol.upperroman {
+ list-style: upper-roman;
+}
+
+:not(li) > ol > li:first-child > :first-child,
+:not(li) > ul > li:first-child > :first-child {
+ margin-top: 0px;
+}
+
+:not(li) > ol > li:last-child > :last-child,
+:not(li) > ul > li:last-child > :last-child {
+ margin-bottom: 0px;
+}
+
+ol.simple ol p,
+ol.simple ul p,
+ul.simple ol p,
+ul.simple ul p {
+ margin-top: 0;
+}
+
+ol.simple > li:not(:first-child) > p,
+ul.simple > li:not(:first-child) > p {
+ margin-top: 0;
+}
+
+ol.simple p,
+ul.simple p {
+ margin-bottom: 0;
+}
+aside.footnote > span,
+div.citation > span {
+ float: left;
+}
+aside.footnote > span:last-of-type,
+div.citation > span:last-of-type {
+ padding-right: 0.5em;
+}
+aside.footnote > p {
+ margin-left: 2em;
+}
+div.citation > p {
+ margin-left: 4em;
+}
+aside.footnote > p:last-of-type,
+div.citation > p:last-of-type {
+ margin-bottom: 0em;
+}
+aside.footnote > p:last-of-type:after,
+div.citation > p:last-of-type:after {
+ content: "";
+ clear: both;
+}
+
+dl.field-list {
+ display: grid;
+ grid-template-columns: fit-content(30%) auto;
+}
+
+dl.field-list > dt {
+ font-weight: bold;
+ word-break: break-word;
+ padding-left: 0.5em;
+ padding-right: 5px;
+}
+
+dl.field-list > dd {
+ padding-left: 0.5em;
+ margin-top: 0em;
+ margin-left: 0em;
+ margin-bottom: 0em;
+}
+
+dl {
+ margin-bottom: 15px;
+}
+
+dd > :first-child {
+ margin-top: 0px;
+}
+
+dd ul, dd table {
+ margin-bottom: 10px;
+}
+
+dd {
+ margin-top: 3px;
+ margin-bottom: 10px;
+ margin-left: 30px;
+}
+
+dl > dd:last-child,
+dl > dd:last-child > :last-child {
+ margin-bottom: 0;
+}
+
+dt:target, span.highlighted {
+ background-color: #fbe54e;
+}
+
+rect.highlighted {
+ fill: #fbe54e;
+}
+
+dl.glossary dt {
+ font-weight: bold;
+ font-size: 1.1em;
+}
+
+.versionmodified {
+ font-style: italic;
+}
+
+.system-message {
+ background-color: #fda;
+ padding: 5px;
+ border: 3px solid red;
+}
+
+.footnote:target {
+ background-color: #ffa;
+}
+
+.line-block {
+ display: block;
+ margin-top: 1em;
+ margin-bottom: 1em;
+}
+
+.line-block .line-block {
+ margin-top: 0;
+ margin-bottom: 0;
+ margin-left: 1.5em;
+}
+
+.guilabel, .menuselection {
+ font-family: sans-serif;
+}
+
+.accelerator {
+ text-decoration: underline;
+}
+
+.classifier {
+ font-style: oblique;
+}
+
+.classifier:before {
+ font-style: normal;
+ margin: 0 0.5em;
+ content: ":";
+ display: inline-block;
+}
+
+abbr, acronym {
+ border-bottom: dotted 1px;
+ cursor: help;
+}
+
+/* -- code displays --------------------------------------------------------- */
+
+pre {
+ overflow: auto;
+ overflow-y: hidden; /* fixes display issues on Chrome browsers */
+}
+
+pre, div[class*="highlight-"] {
+ clear: both;
+}
+
+span.pre {
+ -moz-hyphens: none;
+ -ms-hyphens: none;
+ -webkit-hyphens: none;
+ hyphens: none;
+ white-space: nowrap;
+}
+
+div[class*="highlight-"] {
+ margin: 1em 0;
+}
+
+td.linenos pre {
+ border: 0;
+ background-color: transparent;
+ color: #aaa;
+}
+
+table.highlighttable {
+ display: block;
+}
+
+table.highlighttable tbody {
+ display: block;
+}
+
+table.highlighttable tr {
+ display: flex;
+}
+
+table.highlighttable td {
+ margin: 0;
+ padding: 0;
+}
+
+table.highlighttable td.linenos {
+ padding-right: 0.5em;
+}
+
+table.highlighttable td.code {
+ flex: 1;
+ overflow: hidden;
+}
+
+.highlight .hll {
+ display: block;
+}
+
+div.highlight pre,
+table.highlighttable pre {
+ margin: 0;
+}
+
+div.code-block-caption + div {
+ margin-top: 0;
+}
+
+div.code-block-caption {
+ margin-top: 1em;
+ padding: 2px 5px;
+ font-size: small;
+}
+
+div.code-block-caption code {
+ background-color: transparent;
+}
+
+table.highlighttable td.linenos,
+span.linenos,
+div.highlight span.gp { /* gp: Generic.Prompt */
+ user-select: none;
+ -webkit-user-select: text; /* Safari fallback only */
+ -webkit-user-select: none; /* Chrome/Safari */
+ -moz-user-select: none; /* Firefox */
+ -ms-user-select: none; /* IE10+ */
+}
+
+div.code-block-caption span.caption-number {
+ padding: 0.1em 0.3em;
+ font-style: italic;
+}
+
+div.code-block-caption span.caption-text {
+}
+
+div.literal-block-wrapper {
+ margin: 1em 0;
+}
+
+code.xref, a code {
+ background-color: transparent;
+ font-weight: bold;
+}
+
+h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
+ background-color: transparent;
+}
+
+.viewcode-link {
+ float: right;
+}
+
+.viewcode-back {
+ float: right;
+ font-family: sans-serif;
+}
+
+div.viewcode-block:target {
+ margin: -1px -10px;
+ padding: 0 10px;
+}
+
+/* -- math display ---------------------------------------------------------- */
+
+img.math {
+ vertical-align: middle;
+}
+
+div.body div.math p {
+ text-align: center;
+}
+
+span.eqno {
+ float: right;
+}
+
+span.eqno a.headerlink {
+ position: absolute;
+ z-index: 1;
+}
+
+div.math:hover a.headerlink {
+ visibility: visible;
+}
+
+/* -- printout stylesheet --------------------------------------------------- */
+
+@media print {
+ div.document,
+ div.documentwrapper,
+ div.bodywrapper {
+ margin: 0 !important;
+ width: 100%;
+ }
+
+ div.sphinxsidebar,
+ div.related,
+ div.footer,
+ #top-link {
+ display: none;
+ }
+}
\ No newline at end of file
diff --git a/docs/manual/_static/check-solid.svg b/docs/manual/_static/check-solid.svg
new file mode 100644
index 0000000..92fad4b
--- /dev/null
+++ b/docs/manual/_static/check-solid.svg
@@ -0,0 +1,4 @@
+
+
diff --git a/docs/manual/_static/clipboard.min.js b/docs/manual/_static/clipboard.min.js
new file mode 100644
index 0000000..54b3c46
--- /dev/null
+++ b/docs/manual/_static/clipboard.min.js
@@ -0,0 +1,7 @@
+/*!
+ * clipboard.js v2.0.8
+ * https://clipboardjs.com/
+ *
+ * Licensed MIT © Zeno Rocha
+ */
+!function(t,e){"object"==typeof exports&&"object"==typeof module?module.exports=e():"function"==typeof define&&define.amd?define([],e):"object"==typeof exports?exports.ClipboardJS=e():t.ClipboardJS=e()}(this,function(){return n={686:function(t,e,n){"use strict";n.d(e,{default:function(){return o}});var e=n(279),i=n.n(e),e=n(370),u=n.n(e),e=n(817),c=n.n(e);function a(t){try{return document.execCommand(t)}catch(t){return}}var f=function(t){t=c()(t);return a("cut"),t};var l=function(t){var e,n,o,r=1
+ Short
+ */
+ .o-tooltip--left {
+ position: relative;
+ }
+
+ .o-tooltip--left:after {
+ opacity: 0;
+ visibility: hidden;
+ position: absolute;
+ content: attr(data-tooltip);
+ padding: .2em;
+ font-size: .8em;
+ left: -.2em;
+ background: grey;
+ color: white;
+ white-space: nowrap;
+ z-index: 2;
+ border-radius: 2px;
+ transform: translateX(-102%) translateY(0);
+ transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1);
+}
+
+.o-tooltip--left:hover:after {
+ display: block;
+ opacity: 1;
+ visibility: visible;
+ transform: translateX(-100%) translateY(0);
+ transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1);
+ transition-delay: .5s;
+}
+
+/* By default the copy button shouldn't show up when printing a page */
+@media print {
+ button.copybtn {
+ display: none;
+ }
+}
diff --git a/docs/manual/_static/copybutton.js b/docs/manual/_static/copybutton.js
new file mode 100644
index 0000000..2ea7ff3
--- /dev/null
+++ b/docs/manual/_static/copybutton.js
@@ -0,0 +1,248 @@
+// Localization support
+const messages = {
+ 'en': {
+ 'copy': 'Copy',
+ 'copy_to_clipboard': 'Copy to clipboard',
+ 'copy_success': 'Copied!',
+ 'copy_failure': 'Failed to copy',
+ },
+ 'es' : {
+ 'copy': 'Copiar',
+ 'copy_to_clipboard': 'Copiar al portapapeles',
+ 'copy_success': '¡Copiado!',
+ 'copy_failure': 'Error al copiar',
+ },
+ 'de' : {
+ 'copy': 'Kopieren',
+ 'copy_to_clipboard': 'In die Zwischenablage kopieren',
+ 'copy_success': 'Kopiert!',
+ 'copy_failure': 'Fehler beim Kopieren',
+ },
+ 'fr' : {
+ 'copy': 'Copier',
+ 'copy_to_clipboard': 'Copier dans le presse-papier',
+ 'copy_success': 'Copié !',
+ 'copy_failure': 'Échec de la copie',
+ },
+ 'ru': {
+ 'copy': 'Скопировать',
+ 'copy_to_clipboard': 'Скопировать в буфер',
+ 'copy_success': 'Скопировано!',
+ 'copy_failure': 'Не удалось скопировать',
+ },
+ 'zh-CN': {
+ 'copy': '复制',
+ 'copy_to_clipboard': '复制到剪贴板',
+ 'copy_success': '复制成功!',
+ 'copy_failure': '复制失败',
+ },
+ 'it' : {
+ 'copy': 'Copiare',
+ 'copy_to_clipboard': 'Copiato negli appunti',
+ 'copy_success': 'Copiato!',
+ 'copy_failure': 'Errore durante la copia',
+ }
+}
+
+let locale = 'en'
+if( document.documentElement.lang !== undefined
+ && messages[document.documentElement.lang] !== undefined ) {
+ locale = document.documentElement.lang
+}
+
+let doc_url_root = DOCUMENTATION_OPTIONS.URL_ROOT;
+if (doc_url_root == '#') {
+ doc_url_root = '';
+}
+
+/**
+ * SVG files for our copy buttons
+ */
+let iconCheck = `
+ ${messages[locale]['copy_success']}
+ `
+
+// If the user specified their own SVG use that, otherwise use the default
+let iconCopy = ``;
+if (!iconCopy) {
+ iconCopy = `
+ ${messages[locale]['copy_to_clipboard']}
+ `
+}
+
+/**
+ * Set up copy/paste for code blocks
+ */
+
+const runWhenDOMLoaded = cb => {
+ if (document.readyState != 'loading') {
+ cb()
+ } else if (document.addEventListener) {
+ document.addEventListener('DOMContentLoaded', cb)
+ } else {
+ document.attachEvent('onreadystatechange', function() {
+ if (document.readyState == 'complete') cb()
+ })
+ }
+}
+
+const codeCellId = index => `codecell${index}`
+
+// Clears selected text since ClipboardJS will select the text when copying
+const clearSelection = () => {
+ if (window.getSelection) {
+ window.getSelection().removeAllRanges()
+ } else if (document.selection) {
+ document.selection.empty()
+ }
+}
+
+// Changes tooltip text for a moment, then changes it back
+// We want the timeout of our `success` class to be a bit shorter than the
+// tooltip and icon change, so that we can hide the icon before changing back.
+var timeoutIcon = 2000;
+var timeoutSuccessClass = 1500;
+
+const temporarilyChangeTooltip = (el, oldText, newText) => {
+ el.setAttribute('data-tooltip', newText)
+ el.classList.add('success')
+ // Remove success a little bit sooner than we change the tooltip
+ // So that we can use CSS to hide the copybutton first
+ setTimeout(() => el.classList.remove('success'), timeoutSuccessClass)
+ setTimeout(() => el.setAttribute('data-tooltip', oldText), timeoutIcon)
+}
+
+// Changes the copy button icon for two seconds, then changes it back
+const temporarilyChangeIcon = (el) => {
+ el.innerHTML = iconCheck;
+ setTimeout(() => {el.innerHTML = iconCopy}, timeoutIcon)
+}
+
+const addCopyButtonToCodeCells = () => {
+ // If ClipboardJS hasn't loaded, wait a bit and try again. This
+ // happens because we load ClipboardJS asynchronously.
+ if (window.ClipboardJS === undefined) {
+ setTimeout(addCopyButtonToCodeCells, 250)
+ return
+ }
+
+ // Add copybuttons to all of our code cells
+ const COPYBUTTON_SELECTOR = 'div.highlight pre';
+ const codeCells = document.querySelectorAll(COPYBUTTON_SELECTOR)
+ codeCells.forEach((codeCell, index) => {
+ const id = codeCellId(index)
+ codeCell.setAttribute('id', id)
+
+ const clipboardButton = id =>
+ `
+ ${iconCopy}
+ `
+ codeCell.insertAdjacentHTML('afterend', clipboardButton(id))
+ })
+
+function escapeRegExp(string) {
+ return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+}
+
+/**
+ * Removes excluded text from a Node.
+ *
+ * @param {Node} target Node to filter.
+ * @param {string} exclude CSS selector of nodes to exclude.
+ * @returns {DOMString} Text from `target` with text removed.
+ */
+function filterText(target, exclude) {
+ const clone = target.cloneNode(true); // clone as to not modify the live DOM
+ if (exclude) {
+ // remove excluded nodes
+ clone.querySelectorAll(exclude).forEach(node => node.remove());
+ }
+ return clone.innerText;
+}
+
+// Callback when a copy button is clicked. Will be passed the node that was clicked
+// should then grab the text and replace pieces of text that shouldn't be used in output
+function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") {
+ var regexp;
+ var match;
+
+ // Do we check for line continuation characters and "HERE-documents"?
+ var useLineCont = !!lineContinuationChar
+ var useHereDoc = !!hereDocDelim
+
+ // create regexp to capture prompt and remaining line
+ if (isRegexp) {
+ regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)')
+ } else {
+ regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)')
+ }
+
+ const outputLines = [];
+ var promptFound = false;
+ var gotLineCont = false;
+ var gotHereDoc = false;
+ const lineGotPrompt = [];
+ for (const line of textContent.split('\n')) {
+ match = line.match(regexp)
+ if (match || gotLineCont || gotHereDoc) {
+ promptFound = regexp.test(line)
+ lineGotPrompt.push(promptFound)
+ if (removePrompts && promptFound) {
+ outputLines.push(match[2])
+ } else {
+ outputLines.push(line)
+ }
+ gotLineCont = line.endsWith(lineContinuationChar) & useLineCont
+ if (line.includes(hereDocDelim) & useHereDoc)
+ gotHereDoc = !gotHereDoc
+ } else if (!onlyCopyPromptLines) {
+ outputLines.push(line)
+ } else if (copyEmptyLines && line.trim() === '') {
+ outputLines.push(line)
+ }
+ }
+
+ // If no lines with the prompt were found then just use original lines
+ if (lineGotPrompt.some(v => v === true)) {
+ textContent = outputLines.join('\n');
+ }
+
+ // Remove a trailing newline to avoid auto-running when pasting
+ if (textContent.endsWith("\n")) {
+ textContent = textContent.slice(0, -1)
+ }
+ return textContent
+}
+
+
+var copyTargetText = (trigger) => {
+ var target = document.querySelector(trigger.attributes['data-clipboard-target'].value);
+
+ // get filtered text
+ let exclude = '.linenos';
+
+ let text = filterText(target, exclude);
+ return formatCopyText(text, '', false, true, true, true, '', '')
+}
+
+ // Initialize with a callback so we can modify the text before copy
+ const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText})
+
+ // Update UI with error/success messages
+ clipboard.on('success', event => {
+ clearSelection()
+ temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_success'])
+ temporarilyChangeIcon(event.trigger)
+ })
+
+ clipboard.on('error', event => {
+ temporarilyChangeTooltip(event.trigger, messages[locale]['copy'], messages[locale]['copy_failure'])
+ })
+}
+
+runWhenDOMLoaded(addCopyButtonToCodeCells)
\ No newline at end of file
diff --git a/docs/manual/_static/copybutton_funcs.js b/docs/manual/_static/copybutton_funcs.js
new file mode 100644
index 0000000..dbe1aaa
--- /dev/null
+++ b/docs/manual/_static/copybutton_funcs.js
@@ -0,0 +1,73 @@
+function escapeRegExp(string) {
+ return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
+}
+
+/**
+ * Removes excluded text from a Node.
+ *
+ * @param {Node} target Node to filter.
+ * @param {string} exclude CSS selector of nodes to exclude.
+ * @returns {DOMString} Text from `target` with text removed.
+ */
+export function filterText(target, exclude) {
+ const clone = target.cloneNode(true); // clone as to not modify the live DOM
+ if (exclude) {
+ // remove excluded nodes
+ clone.querySelectorAll(exclude).forEach(node => node.remove());
+ }
+ return clone.innerText;
+}
+
+// Callback when a copy button is clicked. Will be passed the node that was clicked
+// should then grab the text and replace pieces of text that shouldn't be used in output
+export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true, copyEmptyLines = true, lineContinuationChar = "", hereDocDelim = "") {
+ var regexp;
+ var match;
+
+ // Do we check for line continuation characters and "HERE-documents"?
+ var useLineCont = !!lineContinuationChar
+ var useHereDoc = !!hereDocDelim
+
+ // create regexp to capture prompt and remaining line
+ if (isRegexp) {
+ regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)')
+ } else {
+ regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)')
+ }
+
+ const outputLines = [];
+ var promptFound = false;
+ var gotLineCont = false;
+ var gotHereDoc = false;
+ const lineGotPrompt = [];
+ for (const line of textContent.split('\n')) {
+ match = line.match(regexp)
+ if (match || gotLineCont || gotHereDoc) {
+ promptFound = regexp.test(line)
+ lineGotPrompt.push(promptFound)
+ if (removePrompts && promptFound) {
+ outputLines.push(match[2])
+ } else {
+ outputLines.push(line)
+ }
+ gotLineCont = line.endsWith(lineContinuationChar) & useLineCont
+ if (line.includes(hereDocDelim) & useHereDoc)
+ gotHereDoc = !gotHereDoc
+ } else if (!onlyCopyPromptLines) {
+ outputLines.push(line)
+ } else if (copyEmptyLines && line.trim() === '') {
+ outputLines.push(line)
+ }
+ }
+
+ // If no lines with the prompt were found then just use original lines
+ if (lineGotPrompt.some(v => v === true)) {
+ textContent = outputLines.join('\n');
+ }
+
+ // Remove a trailing newline to avoid auto-running when pasting
+ if (textContent.endsWith("\n")) {
+ textContent = textContent.slice(0, -1)
+ }
+ return textContent
+}
diff --git a/docs/manual/_static/custom.css b/docs/manual/_static/custom.css
new file mode 100644
index 0000000..603b20f
--- /dev/null
+++ b/docs/manual/_static/custom.css
@@ -0,0 +1,20 @@
+h3 {
+ margin-top: 1.75rem;
+ margin-bottom: 0.5rem;
+}
+
+code.literal {
+ padding-left: 0.25rem !important;
+ padding-right: 0.25rem !important;
+ padding-top: 0.25rem !important;
+ padding-bottom: 0.15rem !important;
+}
+
+img[src*="if_mode_graph_b.png"] {
+ background-color: rgb(169, 177, 186);
+}
+
+dt.sig {
+ margin-bottom: 0.75rem;
+ margin-top: 1.75rem;
+}
diff --git a/docs/manual/_static/debug.css b/docs/manual/_static/debug.css
new file mode 100644
index 0000000..74d4aec
--- /dev/null
+++ b/docs/manual/_static/debug.css
@@ -0,0 +1,69 @@
+/*
+ This CSS file should be overridden by the theme authors. It's
+ meant for debugging and developing the skeleton that this theme provides.
+*/
+body {
+ font-family: -apple-system, "Segoe UI", Roboto, Helvetica, Arial, sans-serif,
+ "Apple Color Emoji", "Segoe UI Emoji";
+ background: lavender;
+}
+.sb-announcement {
+ background: rgb(131, 131, 131);
+}
+.sb-announcement__inner {
+ background: black;
+ color: white;
+}
+.sb-header {
+ background: lightskyblue;
+}
+.sb-header__inner {
+ background: royalblue;
+ color: white;
+}
+.sb-header-secondary {
+ background: lightcyan;
+}
+.sb-header-secondary__inner {
+ background: cornflowerblue;
+ color: white;
+}
+.sb-sidebar-primary {
+ background: lightgreen;
+}
+.sb-main {
+ background: blanchedalmond;
+}
+.sb-main__inner {
+ background: antiquewhite;
+}
+.sb-header-article {
+ background: lightsteelblue;
+}
+.sb-article-container {
+ background: snow;
+}
+.sb-article-main {
+ background: white;
+}
+.sb-footer-article {
+ background: lightpink;
+}
+.sb-sidebar-secondary {
+ background: lightgoldenrodyellow;
+}
+.sb-footer-content {
+ background: plum;
+}
+.sb-footer-content__inner {
+ background: palevioletred;
+}
+.sb-footer {
+ background: pink;
+}
+.sb-footer__inner {
+ background: salmon;
+}
+.sb-article {
+ background: white;
+}
diff --git a/docs/manual/_static/doctools.js b/docs/manual/_static/doctools.js
new file mode 100644
index 0000000..527b876
--- /dev/null
+++ b/docs/manual/_static/doctools.js
@@ -0,0 +1,156 @@
+/*
+ * doctools.js
+ * ~~~~~~~~~~~
+ *
+ * Base JavaScript utilities for all Sphinx HTML documentation.
+ *
+ * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"use strict";
+
+const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
+ "TEXTAREA",
+ "INPUT",
+ "SELECT",
+ "BUTTON",
+]);
+
+const _ready = (callback) => {
+ if (document.readyState !== "loading") {
+ callback();
+ } else {
+ document.addEventListener("DOMContentLoaded", callback);
+ }
+};
+
+/**
+ * Small JavaScript module for the documentation.
+ */
+const Documentation = {
+ init: () => {
+ Documentation.initDomainIndexTable();
+ Documentation.initOnKeyListeners();
+ },
+
+ /**
+ * i18n support
+ */
+ TRANSLATIONS: {},
+ PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
+ LOCALE: "unknown",
+
+ // gettext and ngettext don't access this so that the functions
+ // can safely bound to a different name (_ = Documentation.gettext)
+ gettext: (string) => {
+ const translated = Documentation.TRANSLATIONS[string];
+ switch (typeof translated) {
+ case "undefined":
+ return string; // no translation
+ case "string":
+ return translated; // translation exists
+ default:
+ return translated[0]; // (singular, plural) translation tuple exists
+ }
+ },
+
+ ngettext: (singular, plural, n) => {
+ const translated = Documentation.TRANSLATIONS[singular];
+ if (typeof translated !== "undefined")
+ return translated[Documentation.PLURAL_EXPR(n)];
+ return n === 1 ? singular : plural;
+ },
+
+ addTranslations: (catalog) => {
+ Object.assign(Documentation.TRANSLATIONS, catalog.messages);
+ Documentation.PLURAL_EXPR = new Function(
+ "n",
+ `return (${catalog.plural_expr})`
+ );
+ Documentation.LOCALE = catalog.locale;
+ },
+
+ /**
+ * helper function to focus on search bar
+ */
+ focusSearchBar: () => {
+ document.querySelectorAll("input[name=q]")[0]?.focus();
+ },
+
+ /**
+ * Initialise the domain index toggle buttons
+ */
+ initDomainIndexTable: () => {
+ const toggler = (el) => {
+ const idNumber = el.id.substr(7);
+ const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
+ if (el.src.substr(-9) === "minus.png") {
+ el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
+ toggledRows.forEach((el) => (el.style.display = "none"));
+ } else {
+ el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
+ toggledRows.forEach((el) => (el.style.display = ""));
+ }
+ };
+
+ const togglerElements = document.querySelectorAll("img.toggler");
+ togglerElements.forEach((el) =>
+ el.addEventListener("click", (event) => toggler(event.currentTarget))
+ );
+ togglerElements.forEach((el) => (el.style.display = ""));
+ if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
+ },
+
+ initOnKeyListeners: () => {
+ // only install a listener if it is really needed
+ if (
+ !DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
+ !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
+ )
+ return;
+
+ document.addEventListener("keydown", (event) => {
+ // bail for input elements
+ if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
+ // bail with special keys
+ if (event.altKey || event.ctrlKey || event.metaKey) return;
+
+ if (!event.shiftKey) {
+ switch (event.key) {
+ case "ArrowLeft":
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+ const prevLink = document.querySelector('link[rel="prev"]');
+ if (prevLink && prevLink.href) {
+ window.location.href = prevLink.href;
+ event.preventDefault();
+ }
+ break;
+ case "ArrowRight":
+ if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
+
+ const nextLink = document.querySelector('link[rel="next"]');
+ if (nextLink && nextLink.href) {
+ window.location.href = nextLink.href;
+ event.preventDefault();
+ }
+ break;
+ }
+ }
+
+ // some keyboard layouts may need Shift to get /
+ switch (event.key) {
+ case "/":
+ if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
+ Documentation.focusSearchBar();
+ event.preventDefault();
+ }
+ });
+ },
+};
+
+// quick alias for translations
+const _ = Documentation.gettext;
+
+_ready(Documentation.init);
diff --git a/docs/manual/_static/documentation_options.js b/docs/manual/_static/documentation_options.js
new file mode 100644
index 0000000..995f333
--- /dev/null
+++ b/docs/manual/_static/documentation_options.js
@@ -0,0 +1,14 @@
+var DOCUMENTATION_OPTIONS = {
+ URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
+ VERSION: '1.0.0',
+ LANGUAGE: 'en',
+ COLLAPSE_INDEX: false,
+ BUILDER: 'html',
+ FILE_SUFFIX: '.html',
+ LINK_SUFFIX: '.html',
+ HAS_SOURCE: true,
+ SOURCELINK_SUFFIX: '.txt',
+ NAVIGATION_WITH_KEYS: false,
+ SHOW_SEARCH_SUMMARY: true,
+ ENABLE_SEARCH_SHORTCUTS: true,
+};
\ No newline at end of file
diff --git a/docs/manual/_static/file.png b/docs/manual/_static/file.png
new file mode 100644
index 0000000..a858a41
Binary files /dev/null and b/docs/manual/_static/file.png differ
diff --git a/docs/manual/_static/jquery-3.6.0.js b/docs/manual/_static/jquery-3.6.0.js
new file mode 100644
index 0000000..fc6c299
--- /dev/null
+++ b/docs/manual/_static/jquery-3.6.0.js
@@ -0,0 +1,10881 @@
+/*!
+ * jQuery JavaScript Library v3.6.0
+ * https://jquery.com/
+ *
+ * Includes Sizzle.js
+ * https://sizzlejs.com/
+ *
+ * Copyright OpenJS Foundation and other contributors
+ * Released under the MIT license
+ * https://jquery.org/license
+ *
+ * Date: 2021-03-02T17:08Z
+ */
+( function( global, factory ) {
+
+ "use strict";
+
+ if ( typeof module === "object" && typeof module.exports === "object" ) {
+
+ // For CommonJS and CommonJS-like environments where a proper `window`
+ // is present, execute the factory and get jQuery.
+ // For environments that do not have a `window` with a `document`
+ // (such as Node.js), expose a factory as module.exports.
+ // This accentuates the need for the creation of a real `window`.
+ // e.g. var jQuery = require("jquery")(window);
+ // See ticket #14549 for more info.
+ module.exports = global.document ?
+ factory( global, true ) :
+ function( w ) {
+ if ( !w.document ) {
+ throw new Error( "jQuery requires a window with a document" );
+ }
+ return factory( w );
+ };
+ } else {
+ factory( global );
+ }
+
+// Pass this if window is not defined yet
+} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) {
+
+// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1
+// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode
+// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common
+// enough that all such attempts are guarded in a try block.
+"use strict";
+
+var arr = [];
+
+var getProto = Object.getPrototypeOf;
+
+var slice = arr.slice;
+
+var flat = arr.flat ? function( array ) {
+ return arr.flat.call( array );
+} : function( array ) {
+ return arr.concat.apply( [], array );
+};
+
+
+var push = arr.push;
+
+var indexOf = arr.indexOf;
+
+var class2type = {};
+
+var toString = class2type.toString;
+
+var hasOwn = class2type.hasOwnProperty;
+
+var fnToString = hasOwn.toString;
+
+var ObjectFunctionString = fnToString.call( Object );
+
+var support = {};
+
+var isFunction = function isFunction( obj ) {
+
+ // Support: Chrome <=57, Firefox <=52
+ // In some browsers, typeof returns "function" for HTML elements
+ // (i.e., `typeof document.createElement( "object" ) === "function"`).
+ // We don't want to classify *any* DOM node as a function.
+ // Support: QtWeb <=3.8.5, WebKit <=534.34, wkhtmltopdf tool <=0.12.5
+ // Plus for old WebKit, typeof returns "function" for HTML collections
+ // (e.g., `typeof document.getElementsByTagName("div") === "function"`). (gh-4756)
+ return typeof obj === "function" && typeof obj.nodeType !== "number" &&
+ typeof obj.item !== "function";
+ };
+
+
+var isWindow = function isWindow( obj ) {
+ return obj != null && obj === obj.window;
+ };
+
+
+var document = window.document;
+
+
+
+ var preservedScriptAttributes = {
+ type: true,
+ src: true,
+ nonce: true,
+ noModule: true
+ };
+
+ function DOMEval( code, node, doc ) {
+ doc = doc || document;
+
+ var i, val,
+ script = doc.createElement( "script" );
+
+ script.text = code;
+ if ( node ) {
+ for ( i in preservedScriptAttributes ) {
+
+ // Support: Firefox 64+, Edge 18+
+ // Some browsers don't support the "nonce" property on scripts.
+ // On the other hand, just using `getAttribute` is not enough as
+ // the `nonce` attribute is reset to an empty string whenever it
+ // becomes browsing-context connected.
+ // See https://github.com/whatwg/html/issues/2369
+ // See https://html.spec.whatwg.org/#nonce-attributes
+ // The `node.getAttribute` check was added for the sake of
+ // `jQuery.globalEval` so that it can fake a nonce-containing node
+ // via an object.
+ val = node[ i ] || node.getAttribute && node.getAttribute( i );
+ if ( val ) {
+ script.setAttribute( i, val );
+ }
+ }
+ }
+ doc.head.appendChild( script ).parentNode.removeChild( script );
+ }
+
+
+function toType( obj ) {
+ if ( obj == null ) {
+ return obj + "";
+ }
+
+ // Support: Android <=2.3 only (functionish RegExp)
+ return typeof obj === "object" || typeof obj === "function" ?
+ class2type[ toString.call( obj ) ] || "object" :
+ typeof obj;
+}
+/* global Symbol */
+// Defining this global in .eslintrc.json would create a danger of using the global
+// unguarded in another place, it seems safer to define global only for this module
+
+
+
+var
+ version = "3.6.0",
+
+ // Define a local copy of jQuery
+ jQuery = function( selector, context ) {
+
+ // The jQuery object is actually just the init constructor 'enhanced'
+ // Need init if jQuery is called (just allow error to be thrown if not included)
+ return new jQuery.fn.init( selector, context );
+ };
+
+jQuery.fn = jQuery.prototype = {
+
+ // The current version of jQuery being used
+ jquery: version,
+
+ constructor: jQuery,
+
+ // The default length of a jQuery object is 0
+ length: 0,
+
+ toArray: function() {
+ return slice.call( this );
+ },
+
+ // Get the Nth element in the matched element set OR
+ // Get the whole matched element set as a clean array
+ get: function( num ) {
+
+ // Return all the elements in a clean array
+ if ( num == null ) {
+ return slice.call( this );
+ }
+
+ // Return just the one element from the set
+ return num < 0 ? this[ num + this.length ] : this[ num ];
+ },
+
+ // Take an array of elements and push it onto the stack
+ // (returning the new matched element set)
+ pushStack: function( elems ) {
+
+ // Build a new jQuery matched element set
+ var ret = jQuery.merge( this.constructor(), elems );
+
+ // Add the old object onto the stack (as a reference)
+ ret.prevObject = this;
+
+ // Return the newly-formed element set
+ return ret;
+ },
+
+ // Execute a callback for every element in the matched set.
+ each: function( callback ) {
+ return jQuery.each( this, callback );
+ },
+
+ map: function( callback ) {
+ return this.pushStack( jQuery.map( this, function( elem, i ) {
+ return callback.call( elem, i, elem );
+ } ) );
+ },
+
+ slice: function() {
+ return this.pushStack( slice.apply( this, arguments ) );
+ },
+
+ first: function() {
+ return this.eq( 0 );
+ },
+
+ last: function() {
+ return this.eq( -1 );
+ },
+
+ even: function() {
+ return this.pushStack( jQuery.grep( this, function( _elem, i ) {
+ return ( i + 1 ) % 2;
+ } ) );
+ },
+
+ odd: function() {
+ return this.pushStack( jQuery.grep( this, function( _elem, i ) {
+ return i % 2;
+ } ) );
+ },
+
+ eq: function( i ) {
+ var len = this.length,
+ j = +i + ( i < 0 ? len : 0 );
+ return this.pushStack( j >= 0 && j < len ? [ this[ j ] ] : [] );
+ },
+
+ end: function() {
+ return this.prevObject || this.constructor();
+ },
+
+ // For internal use only.
+ // Behaves like an Array's method, not like a jQuery method.
+ push: push,
+ sort: arr.sort,
+ splice: arr.splice
+};
+
+jQuery.extend = jQuery.fn.extend = function() {
+ var options, name, src, copy, copyIsArray, clone,
+ target = arguments[ 0 ] || {},
+ i = 1,
+ length = arguments.length,
+ deep = false;
+
+ // Handle a deep copy situation
+ if ( typeof target === "boolean" ) {
+ deep = target;
+
+ // Skip the boolean and the target
+ target = arguments[ i ] || {};
+ i++;
+ }
+
+ // Handle case when target is a string or something (possible in deep copy)
+ if ( typeof target !== "object" && !isFunction( target ) ) {
+ target = {};
+ }
+
+ // Extend jQuery itself if only one argument is passed
+ if ( i === length ) {
+ target = this;
+ i--;
+ }
+
+ for ( ; i < length; i++ ) {
+
+ // Only deal with non-null/undefined values
+ if ( ( options = arguments[ i ] ) != null ) {
+
+ // Extend the base object
+ for ( name in options ) {
+ copy = options[ name ];
+
+ // Prevent Object.prototype pollution
+ // Prevent never-ending loop
+ if ( name === "__proto__" || target === copy ) {
+ continue;
+ }
+
+ // Recurse if we're merging plain objects or arrays
+ if ( deep && copy && ( jQuery.isPlainObject( copy ) ||
+ ( copyIsArray = Array.isArray( copy ) ) ) ) {
+ src = target[ name ];
+
+ // Ensure proper type for the source value
+ if ( copyIsArray && !Array.isArray( src ) ) {
+ clone = [];
+ } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) {
+ clone = {};
+ } else {
+ clone = src;
+ }
+ copyIsArray = false;
+
+ // Never move original objects, clone them
+ target[ name ] = jQuery.extend( deep, clone, copy );
+
+ // Don't bring in undefined values
+ } else if ( copy !== undefined ) {
+ target[ name ] = copy;
+ }
+ }
+ }
+ }
+
+ // Return the modified object
+ return target;
+};
+
+jQuery.extend( {
+
+ // Unique for each copy of jQuery on the page
+ expando: "jQuery" + ( version + Math.random() ).replace( /\D/g, "" ),
+
+ // Assume jQuery is ready without the ready module
+ isReady: true,
+
+ error: function( msg ) {
+ throw new Error( msg );
+ },
+
+ noop: function() {},
+
+ isPlainObject: function( obj ) {
+ var proto, Ctor;
+
+ // Detect obvious negatives
+ // Use toString instead of jQuery.type to catch host objects
+ if ( !obj || toString.call( obj ) !== "[object Object]" ) {
+ return false;
+ }
+
+ proto = getProto( obj );
+
+ // Objects with no prototype (e.g., `Object.create( null )`) are plain
+ if ( !proto ) {
+ return true;
+ }
+
+ // Objects with prototype are plain iff they were constructed by a global Object function
+ Ctor = hasOwn.call( proto, "constructor" ) && proto.constructor;
+ return typeof Ctor === "function" && fnToString.call( Ctor ) === ObjectFunctionString;
+ },
+
+ isEmptyObject: function( obj ) {
+ var name;
+
+ for ( name in obj ) {
+ return false;
+ }
+ return true;
+ },
+
+ // Evaluates a script in a provided context; falls back to the global one
+ // if not specified.
+ globalEval: function( code, options, doc ) {
+ DOMEval( code, { nonce: options && options.nonce }, doc );
+ },
+
+ each: function( obj, callback ) {
+ var length, i = 0;
+
+ if ( isArrayLike( obj ) ) {
+ length = obj.length;
+ for ( ; i < length; i++ ) {
+ if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
+ break;
+ }
+ }
+ } else {
+ for ( i in obj ) {
+ if ( callback.call( obj[ i ], i, obj[ i ] ) === false ) {
+ break;
+ }
+ }
+ }
+
+ return obj;
+ },
+
+ // results is for internal usage only
+ makeArray: function( arr, results ) {
+ var ret = results || [];
+
+ if ( arr != null ) {
+ if ( isArrayLike( Object( arr ) ) ) {
+ jQuery.merge( ret,
+ typeof arr === "string" ?
+ [ arr ] : arr
+ );
+ } else {
+ push.call( ret, arr );
+ }
+ }
+
+ return ret;
+ },
+
+ inArray: function( elem, arr, i ) {
+ return arr == null ? -1 : indexOf.call( arr, elem, i );
+ },
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ merge: function( first, second ) {
+ var len = +second.length,
+ j = 0,
+ i = first.length;
+
+ for ( ; j < len; j++ ) {
+ first[ i++ ] = second[ j ];
+ }
+
+ first.length = i;
+
+ return first;
+ },
+
+ grep: function( elems, callback, invert ) {
+ var callbackInverse,
+ matches = [],
+ i = 0,
+ length = elems.length,
+ callbackExpect = !invert;
+
+ // Go through the array, only saving the items
+ // that pass the validator function
+ for ( ; i < length; i++ ) {
+ callbackInverse = !callback( elems[ i ], i );
+ if ( callbackInverse !== callbackExpect ) {
+ matches.push( elems[ i ] );
+ }
+ }
+
+ return matches;
+ },
+
+ // arg is for internal usage only
+ map: function( elems, callback, arg ) {
+ var length, value,
+ i = 0,
+ ret = [];
+
+ // Go through the array, translating each of the items to their new values
+ if ( isArrayLike( elems ) ) {
+ length = elems.length;
+ for ( ; i < length; i++ ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+
+ // Go through every key on the object,
+ } else {
+ for ( i in elems ) {
+ value = callback( elems[ i ], i, arg );
+
+ if ( value != null ) {
+ ret.push( value );
+ }
+ }
+ }
+
+ // Flatten any nested arrays
+ return flat( ret );
+ },
+
+ // A global GUID counter for objects
+ guid: 1,
+
+ // jQuery.support is not used in Core but other projects attach their
+ // properties to it so it needs to exist.
+ support: support
+} );
+
+if ( typeof Symbol === "function" ) {
+ jQuery.fn[ Symbol.iterator ] = arr[ Symbol.iterator ];
+}
+
+// Populate the class2type map
+jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ),
+ function( _i, name ) {
+ class2type[ "[object " + name + "]" ] = name.toLowerCase();
+ } );
+
+function isArrayLike( obj ) {
+
+ // Support: real iOS 8.2 only (not reproducible in simulator)
+ // `in` check used to prevent JIT error (gh-2145)
+ // hasOwn isn't used here due to false negatives
+ // regarding Nodelist length in IE
+ var length = !!obj && "length" in obj && obj.length,
+ type = toType( obj );
+
+ if ( isFunction( obj ) || isWindow( obj ) ) {
+ return false;
+ }
+
+ return type === "array" || length === 0 ||
+ typeof length === "number" && length > 0 && ( length - 1 ) in obj;
+}
+var Sizzle =
+/*!
+ * Sizzle CSS Selector Engine v2.3.6
+ * https://sizzlejs.com/
+ *
+ * Copyright JS Foundation and other contributors
+ * Released under the MIT license
+ * https://js.foundation/
+ *
+ * Date: 2021-02-16
+ */
+( function( window ) {
+var i,
+ support,
+ Expr,
+ getText,
+ isXML,
+ tokenize,
+ compile,
+ select,
+ outermostContext,
+ sortInput,
+ hasDuplicate,
+
+ // Local document vars
+ setDocument,
+ document,
+ docElem,
+ documentIsHTML,
+ rbuggyQSA,
+ rbuggyMatches,
+ matches,
+ contains,
+
+ // Instance-specific data
+ expando = "sizzle" + 1 * new Date(),
+ preferredDoc = window.document,
+ dirruns = 0,
+ done = 0,
+ classCache = createCache(),
+ tokenCache = createCache(),
+ compilerCache = createCache(),
+ nonnativeSelectorCache = createCache(),
+ sortOrder = function( a, b ) {
+ if ( a === b ) {
+ hasDuplicate = true;
+ }
+ return 0;
+ },
+
+ // Instance methods
+ hasOwn = ( {} ).hasOwnProperty,
+ arr = [],
+ pop = arr.pop,
+ pushNative = arr.push,
+ push = arr.push,
+ slice = arr.slice,
+
+ // Use a stripped-down indexOf as it's faster than native
+ // https://jsperf.com/thor-indexof-vs-for/5
+ indexOf = function( list, elem ) {
+ var i = 0,
+ len = list.length;
+ for ( ; i < len; i++ ) {
+ if ( list[ i ] === elem ) {
+ return i;
+ }
+ }
+ return -1;
+ },
+
+ booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" +
+ "ismap|loop|multiple|open|readonly|required|scoped",
+
+ // Regular expressions
+
+ // http://www.w3.org/TR/css3-selectors/#whitespace
+ whitespace = "[\\x20\\t\\r\\n\\f]",
+
+ // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram
+ identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace +
+ "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+",
+
+ // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors
+ attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace +
+
+ // Operator (capture 2)
+ "*([*^$|!~]?=)" + whitespace +
+
+ // "Attribute values must be CSS identifiers [capture 5]
+ // or strings [capture 3 or capture 4]"
+ "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" +
+ whitespace + "*\\]",
+
+ pseudos = ":(" + identifier + ")(?:\\((" +
+
+ // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments:
+ // 1. quoted (capture 3; capture 4 or capture 5)
+ "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" +
+
+ // 2. simple (capture 6)
+ "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" +
+
+ // 3. anything else (capture 2)
+ ".*" +
+ ")\\)|)",
+
+ // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter
+ rwhitespace = new RegExp( whitespace + "+", "g" ),
+ rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" +
+ whitespace + "+$", "g" ),
+
+ rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ),
+ rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace +
+ "*" ),
+ rdescend = new RegExp( whitespace + "|>" ),
+
+ rpseudo = new RegExp( pseudos ),
+ ridentifier = new RegExp( "^" + identifier + "$" ),
+
+ matchExpr = {
+ "ID": new RegExp( "^#(" + identifier + ")" ),
+ "CLASS": new RegExp( "^\\.(" + identifier + ")" ),
+ "TAG": new RegExp( "^(" + identifier + "|[*])" ),
+ "ATTR": new RegExp( "^" + attributes ),
+ "PSEUDO": new RegExp( "^" + pseudos ),
+ "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" +
+ whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" +
+ whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ),
+ "bool": new RegExp( "^(?:" + booleans + ")$", "i" ),
+
+ // For use in libraries implementing .is()
+ // We use this for POS matching in `select`
+ "needsContext": new RegExp( "^" + whitespace +
+ "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace +
+ "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" )
+ },
+
+ rhtml = /HTML$/i,
+ rinputs = /^(?:input|select|textarea|button)$/i,
+ rheader = /^h\d$/i,
+
+ rnative = /^[^{]+\{\s*\[native \w/,
+
+ // Easily-parseable/retrievable ID or TAG or CLASS selectors
+ rquickExpr = /^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,
+
+ rsibling = /[+~]/,
+
+ // CSS escapes
+ // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters
+ runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ),
+ funescape = function( escape, nonHex ) {
+ var high = "0x" + escape.slice( 1 ) - 0x10000;
+
+ return nonHex ?
+
+ // Strip the backslash prefix from a non-hex escape sequence
+ nonHex :
+
+ // Replace a hexadecimal escape sequence with the encoded Unicode code point
+ // Support: IE <=11+
+ // For values outside the Basic Multilingual Plane (BMP), manually construct a
+ // surrogate pair
+ high < 0 ?
+ String.fromCharCode( high + 0x10000 ) :
+ String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 );
+ },
+
+ // CSS string/identifier serialization
+ // https://drafts.csswg.org/cssom/#common-serializing-idioms
+ rcssescape = /([\0-\x1f\x7f]|^-?\d)|^-$|[^\0-\x1f\x7f-\uFFFF\w-]/g,
+ fcssescape = function( ch, asCodePoint ) {
+ if ( asCodePoint ) {
+
+ // U+0000 NULL becomes U+FFFD REPLACEMENT CHARACTER
+ if ( ch === "\0" ) {
+ return "\uFFFD";
+ }
+
+ // Control characters and (dependent upon position) numbers get escaped as code points
+ return ch.slice( 0, -1 ) + "\\" +
+ ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " ";
+ }
+
+ // Other potentially-special ASCII characters get backslash-escaped
+ return "\\" + ch;
+ },
+
+ // Used for iframes
+ // See setDocument()
+ // Removing the function wrapper causes a "Permission Denied"
+ // error in IE
+ unloadHandler = function() {
+ setDocument();
+ },
+
+ inDisabledFieldset = addCombinator(
+ function( elem ) {
+ return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset";
+ },
+ { dir: "parentNode", next: "legend" }
+ );
+
+// Optimize for push.apply( _, NodeList )
+try {
+ push.apply(
+ ( arr = slice.call( preferredDoc.childNodes ) ),
+ preferredDoc.childNodes
+ );
+
+ // Support: Android<4.0
+ // Detect silently failing push.apply
+ // eslint-disable-next-line no-unused-expressions
+ arr[ preferredDoc.childNodes.length ].nodeType;
+} catch ( e ) {
+ push = { apply: arr.length ?
+
+ // Leverage slice if possible
+ function( target, els ) {
+ pushNative.apply( target, slice.call( els ) );
+ } :
+
+ // Support: IE<9
+ // Otherwise append directly
+ function( target, els ) {
+ var j = target.length,
+ i = 0;
+
+ // Can't trust NodeList.length
+ while ( ( target[ j++ ] = els[ i++ ] ) ) {}
+ target.length = j - 1;
+ }
+ };
+}
+
+function Sizzle( selector, context, results, seed ) {
+ var m, i, elem, nid, match, groups, newSelector,
+ newContext = context && context.ownerDocument,
+
+ // nodeType defaults to 9, since context defaults to document
+ nodeType = context ? context.nodeType : 9;
+
+ results = results || [];
+
+ // Return early from calls with invalid selector or context
+ if ( typeof selector !== "string" || !selector ||
+ nodeType !== 1 && nodeType !== 9 && nodeType !== 11 ) {
+
+ return results;
+ }
+
+ // Try to shortcut find operations (as opposed to filters) in HTML documents
+ if ( !seed ) {
+ setDocument( context );
+ context = context || document;
+
+ if ( documentIsHTML ) {
+
+ // If the selector is sufficiently simple, try using a "get*By*" DOM method
+ // (excepting DocumentFragment context, where the methods don't exist)
+ if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) {
+
+ // ID selector
+ if ( ( m = match[ 1 ] ) ) {
+
+ // Document context
+ if ( nodeType === 9 ) {
+ if ( ( elem = context.getElementById( m ) ) ) {
+
+ // Support: IE, Opera, Webkit
+ // TODO: identify versions
+ // getElementById can match elements by name instead of ID
+ if ( elem.id === m ) {
+ results.push( elem );
+ return results;
+ }
+ } else {
+ return results;
+ }
+
+ // Element context
+ } else {
+
+ // Support: IE, Opera, Webkit
+ // TODO: identify versions
+ // getElementById can match elements by name instead of ID
+ if ( newContext && ( elem = newContext.getElementById( m ) ) &&
+ contains( context, elem ) &&
+ elem.id === m ) {
+
+ results.push( elem );
+ return results;
+ }
+ }
+
+ // Type selector
+ } else if ( match[ 2 ] ) {
+ push.apply( results, context.getElementsByTagName( selector ) );
+ return results;
+
+ // Class selector
+ } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName &&
+ context.getElementsByClassName ) {
+
+ push.apply( results, context.getElementsByClassName( m ) );
+ return results;
+ }
+ }
+
+ // Take advantage of querySelectorAll
+ if ( support.qsa &&
+ !nonnativeSelectorCache[ selector + " " ] &&
+ ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) &&
+
+ // Support: IE 8 only
+ // Exclude object elements
+ ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) {
+
+ newSelector = selector;
+ newContext = context;
+
+ // qSA considers elements outside a scoping root when evaluating child or
+ // descendant combinators, which is not what we want.
+ // In such cases, we work around the behavior by prefixing every selector in the
+ // list with an ID selector referencing the scope context.
+ // The technique has to be used as well when a leading combinator is used
+ // as such selectors are not recognized by querySelectorAll.
+ // Thanks to Andrew Dupont for this technique.
+ if ( nodeType === 1 &&
+ ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) {
+
+ // Expand context for sibling selectors
+ newContext = rsibling.test( selector ) && testContext( context.parentNode ) ||
+ context;
+
+ // We can use :scope instead of the ID hack if the browser
+ // supports it & if we're not changing the context.
+ if ( newContext !== context || !support.scope ) {
+
+ // Capture the context ID, setting it first if necessary
+ if ( ( nid = context.getAttribute( "id" ) ) ) {
+ nid = nid.replace( rcssescape, fcssescape );
+ } else {
+ context.setAttribute( "id", ( nid = expando ) );
+ }
+ }
+
+ // Prefix every selector in the list
+ groups = tokenize( selector );
+ i = groups.length;
+ while ( i-- ) {
+ groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " +
+ toSelector( groups[ i ] );
+ }
+ newSelector = groups.join( "," );
+ }
+
+ try {
+ push.apply( results,
+ newContext.querySelectorAll( newSelector )
+ );
+ return results;
+ } catch ( qsaError ) {
+ nonnativeSelectorCache( selector, true );
+ } finally {
+ if ( nid === expando ) {
+ context.removeAttribute( "id" );
+ }
+ }
+ }
+ }
+ }
+
+ // All others
+ return select( selector.replace( rtrim, "$1" ), context, results, seed );
+}
+
+/**
+ * Create key-value caches of limited size
+ * @returns {function(string, object)} Returns the Object data after storing it on itself with
+ * property name the (space-suffixed) string and (if the cache is larger than Expr.cacheLength)
+ * deleting the oldest entry
+ */
+function createCache() {
+ var keys = [];
+
+ function cache( key, value ) {
+
+ // Use (key + " ") to avoid collision with native prototype properties (see Issue #157)
+ if ( keys.push( key + " " ) > Expr.cacheLength ) {
+
+ // Only keep the most recent entries
+ delete cache[ keys.shift() ];
+ }
+ return ( cache[ key + " " ] = value );
+ }
+ return cache;
+}
+
+/**
+ * Mark a function for special use by Sizzle
+ * @param {Function} fn The function to mark
+ */
+function markFunction( fn ) {
+ fn[ expando ] = true;
+ return fn;
+}
+
+/**
+ * Support testing using an element
+ * @param {Function} fn Passed the created element and returns a boolean result
+ */
+function assert( fn ) {
+ var el = document.createElement( "fieldset" );
+
+ try {
+ return !!fn( el );
+ } catch ( e ) {
+ return false;
+ } finally {
+
+ // Remove from its parent by default
+ if ( el.parentNode ) {
+ el.parentNode.removeChild( el );
+ }
+
+ // release memory in IE
+ el = null;
+ }
+}
+
+/**
+ * Adds the same handler for all of the specified attrs
+ * @param {String} attrs Pipe-separated list of attributes
+ * @param {Function} handler The method that will be applied
+ */
+function addHandle( attrs, handler ) {
+ var arr = attrs.split( "|" ),
+ i = arr.length;
+
+ while ( i-- ) {
+ Expr.attrHandle[ arr[ i ] ] = handler;
+ }
+}
+
+/**
+ * Checks document order of two siblings
+ * @param {Element} a
+ * @param {Element} b
+ * @returns {Number} Returns less than 0 if a precedes b, greater than 0 if a follows b
+ */
+function siblingCheck( a, b ) {
+ var cur = b && a,
+ diff = cur && a.nodeType === 1 && b.nodeType === 1 &&
+ a.sourceIndex - b.sourceIndex;
+
+ // Use IE sourceIndex if available on both nodes
+ if ( diff ) {
+ return diff;
+ }
+
+ // Check if b follows a
+ if ( cur ) {
+ while ( ( cur = cur.nextSibling ) ) {
+ if ( cur === b ) {
+ return -1;
+ }
+ }
+ }
+
+ return a ? 1 : -1;
+}
+
+/**
+ * Returns a function to use in pseudos for input types
+ * @param {String} type
+ */
+function createInputPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return name === "input" && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for buttons
+ * @param {String} type
+ */
+function createButtonPseudo( type ) {
+ return function( elem ) {
+ var name = elem.nodeName.toLowerCase();
+ return ( name === "input" || name === "button" ) && elem.type === type;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for :enabled/:disabled
+ * @param {Boolean} disabled true for :disabled; false for :enabled
+ */
+function createDisabledPseudo( disabled ) {
+
+ // Known :disabled false positives: fieldset[disabled] > legend:nth-of-type(n+2) :can-disable
+ return function( elem ) {
+
+ // Only certain elements can match :enabled or :disabled
+ // https://html.spec.whatwg.org/multipage/scripting.html#selector-enabled
+ // https://html.spec.whatwg.org/multipage/scripting.html#selector-disabled
+ if ( "form" in elem ) {
+
+ // Check for inherited disabledness on relevant non-disabled elements:
+ // * listed form-associated elements in a disabled fieldset
+ // https://html.spec.whatwg.org/multipage/forms.html#category-listed
+ // https://html.spec.whatwg.org/multipage/forms.html#concept-fe-disabled
+ // * option elements in a disabled optgroup
+ // https://html.spec.whatwg.org/multipage/forms.html#concept-option-disabled
+ // All such elements have a "form" property.
+ if ( elem.parentNode && elem.disabled === false ) {
+
+ // Option elements defer to a parent optgroup if present
+ if ( "label" in elem ) {
+ if ( "label" in elem.parentNode ) {
+ return elem.parentNode.disabled === disabled;
+ } else {
+ return elem.disabled === disabled;
+ }
+ }
+
+ // Support: IE 6 - 11
+ // Use the isDisabled shortcut property to check for disabled fieldset ancestors
+ return elem.isDisabled === disabled ||
+
+ // Where there is no isDisabled, check manually
+ /* jshint -W018 */
+ elem.isDisabled !== !disabled &&
+ inDisabledFieldset( elem ) === disabled;
+ }
+
+ return elem.disabled === disabled;
+
+ // Try to winnow out elements that can't be disabled before trusting the disabled property.
+ // Some victims get caught in our net (label, legend, menu, track), but it shouldn't
+ // even exist on them, let alone have a boolean value.
+ } else if ( "label" in elem ) {
+ return elem.disabled === disabled;
+ }
+
+ // Remaining elements are neither :enabled nor :disabled
+ return false;
+ };
+}
+
+/**
+ * Returns a function to use in pseudos for positionals
+ * @param {Function} fn
+ */
+function createPositionalPseudo( fn ) {
+ return markFunction( function( argument ) {
+ argument = +argument;
+ return markFunction( function( seed, matches ) {
+ var j,
+ matchIndexes = fn( [], seed.length, argument ),
+ i = matchIndexes.length;
+
+ // Match elements found at the specified indexes
+ while ( i-- ) {
+ if ( seed[ ( j = matchIndexes[ i ] ) ] ) {
+ seed[ j ] = !( matches[ j ] = seed[ j ] );
+ }
+ }
+ } );
+ } );
+}
+
+/**
+ * Checks a node for validity as a Sizzle context
+ * @param {Element|Object=} context
+ * @returns {Element|Object|Boolean} The input node if acceptable, otherwise a falsy value
+ */
+function testContext( context ) {
+ return context && typeof context.getElementsByTagName !== "undefined" && context;
+}
+
+// Expose support vars for convenience
+support = Sizzle.support = {};
+
+/**
+ * Detects XML nodes
+ * @param {Element|Object} elem An element or a document
+ * @returns {Boolean} True iff elem is a non-HTML XML node
+ */
+isXML = Sizzle.isXML = function( elem ) {
+ var namespace = elem && elem.namespaceURI,
+ docElem = elem && ( elem.ownerDocument || elem ).documentElement;
+
+ // Support: IE <=8
+ // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes
+ // https://bugs.jquery.com/ticket/4833
+ return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" );
+};
+
+/**
+ * Sets document-related variables once based on the current document
+ * @param {Element|Object} [doc] An element or document object to use to set the document
+ * @returns {Object} Returns the current document
+ */
+setDocument = Sizzle.setDocument = function( node ) {
+ var hasCompare, subWindow,
+ doc = node ? node.ownerDocument || node : preferredDoc;
+
+ // Return early if doc is invalid or already selected
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) {
+ return document;
+ }
+
+ // Update global variables
+ document = doc;
+ docElem = document.documentElement;
+ documentIsHTML = !isXML( document );
+
+ // Support: IE 9 - 11+, Edge 12 - 18+
+ // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936)
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ if ( preferredDoc != document &&
+ ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) {
+
+ // Support: IE 11, Edge
+ if ( subWindow.addEventListener ) {
+ subWindow.addEventListener( "unload", unloadHandler, false );
+
+ // Support: IE 9 - 10 only
+ } else if ( subWindow.attachEvent ) {
+ subWindow.attachEvent( "onunload", unloadHandler );
+ }
+ }
+
+ // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only,
+ // Safari 4 - 5 only, Opera <=11.6 - 12.x only
+ // IE/Edge & older browsers don't support the :scope pseudo-class.
+ // Support: Safari 6.0 only
+ // Safari 6.0 supports :scope but it's an alias of :root there.
+ support.scope = assert( function( el ) {
+ docElem.appendChild( el ).appendChild( document.createElement( "div" ) );
+ return typeof el.querySelectorAll !== "undefined" &&
+ !el.querySelectorAll( ":scope fieldset div" ).length;
+ } );
+
+ /* Attributes
+ ---------------------------------------------------------------------- */
+
+ // Support: IE<8
+ // Verify that getAttribute really returns attributes and not properties
+ // (excepting IE8 booleans)
+ support.attributes = assert( function( el ) {
+ el.className = "i";
+ return !el.getAttribute( "className" );
+ } );
+
+ /* getElement(s)By*
+ ---------------------------------------------------------------------- */
+
+ // Check if getElementsByTagName("*") returns only elements
+ support.getElementsByTagName = assert( function( el ) {
+ el.appendChild( document.createComment( "" ) );
+ return !el.getElementsByTagName( "*" ).length;
+ } );
+
+ // Support: IE<9
+ support.getElementsByClassName = rnative.test( document.getElementsByClassName );
+
+ // Support: IE<10
+ // Check if getElementById returns elements by name
+ // The broken getElementById methods don't pick up programmatically-set names,
+ // so use a roundabout getElementsByName test
+ support.getById = assert( function( el ) {
+ docElem.appendChild( el ).id = expando;
+ return !document.getElementsByName || !document.getElementsByName( expando ).length;
+ } );
+
+ // ID filter and find
+ if ( support.getById ) {
+ Expr.filter[ "ID" ] = function( id ) {
+ var attrId = id.replace( runescape, funescape );
+ return function( elem ) {
+ return elem.getAttribute( "id" ) === attrId;
+ };
+ };
+ Expr.find[ "ID" ] = function( id, context ) {
+ if ( typeof context.getElementById !== "undefined" && documentIsHTML ) {
+ var elem = context.getElementById( id );
+ return elem ? [ elem ] : [];
+ }
+ };
+ } else {
+ Expr.filter[ "ID" ] = function( id ) {
+ var attrId = id.replace( runescape, funescape );
+ return function( elem ) {
+ var node = typeof elem.getAttributeNode !== "undefined" &&
+ elem.getAttributeNode( "id" );
+ return node && node.value === attrId;
+ };
+ };
+
+ // Support: IE 6 - 7 only
+ // getElementById is not reliable as a find shortcut
+ Expr.find[ "ID" ] = function( id, context ) {
+ if ( typeof context.getElementById !== "undefined" && documentIsHTML ) {
+ var node, i, elems,
+ elem = context.getElementById( id );
+
+ if ( elem ) {
+
+ // Verify the id attribute
+ node = elem.getAttributeNode( "id" );
+ if ( node && node.value === id ) {
+ return [ elem ];
+ }
+
+ // Fall back on getElementsByName
+ elems = context.getElementsByName( id );
+ i = 0;
+ while ( ( elem = elems[ i++ ] ) ) {
+ node = elem.getAttributeNode( "id" );
+ if ( node && node.value === id ) {
+ return [ elem ];
+ }
+ }
+ }
+
+ return [];
+ }
+ };
+ }
+
+ // Tag
+ Expr.find[ "TAG" ] = support.getElementsByTagName ?
+ function( tag, context ) {
+ if ( typeof context.getElementsByTagName !== "undefined" ) {
+ return context.getElementsByTagName( tag );
+
+ // DocumentFragment nodes don't have gEBTN
+ } else if ( support.qsa ) {
+ return context.querySelectorAll( tag );
+ }
+ } :
+
+ function( tag, context ) {
+ var elem,
+ tmp = [],
+ i = 0,
+
+ // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too
+ results = context.getElementsByTagName( tag );
+
+ // Filter out possible comments
+ if ( tag === "*" ) {
+ while ( ( elem = results[ i++ ] ) ) {
+ if ( elem.nodeType === 1 ) {
+ tmp.push( elem );
+ }
+ }
+
+ return tmp;
+ }
+ return results;
+ };
+
+ // Class
+ Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) {
+ if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) {
+ return context.getElementsByClassName( className );
+ }
+ };
+
+ /* QSA/matchesSelector
+ ---------------------------------------------------------------------- */
+
+ // QSA and matchesSelector support
+
+ // matchesSelector(:active) reports false when true (IE9/Opera 11.5)
+ rbuggyMatches = [];
+
+ // qSa(:focus) reports false when true (Chrome 21)
+ // We allow this because of a bug in IE8/9 that throws an error
+ // whenever `document.activeElement` is accessed on an iframe
+ // So, we allow :focus to pass through QSA all the time to avoid the IE error
+ // See https://bugs.jquery.com/ticket/13378
+ rbuggyQSA = [];
+
+ if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) {
+
+ // Build QSA regex
+ // Regex strategy adopted from Diego Perini
+ assert( function( el ) {
+
+ var input;
+
+ // Select is set to empty string on purpose
+ // This is to test IE's treatment of not explicitly
+ // setting a boolean content attribute,
+ // since its presence should be enough
+ // https://bugs.jquery.com/ticket/12359
+ docElem.appendChild( el ).innerHTML = "" +
+ " ";
+
+ // Support: IE8, Opera 11-12.16
+ // Nothing should be selected when empty strings follow ^= or $= or *=
+ // The test attribute must be unknown in Opera but "safe" for WinRT
+ // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section
+ if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) {
+ rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" );
+ }
+
+ // Support: IE8
+ // Boolean attributes and "value" are not treated correctly
+ if ( !el.querySelectorAll( "[selected]" ).length ) {
+ rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" );
+ }
+
+ // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+
+ if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) {
+ rbuggyQSA.push( "~=" );
+ }
+
+ // Support: IE 11+, Edge 15 - 18+
+ // IE 11/Edge don't find elements on a `[name='']` query in some cases.
+ // Adding a temporary attribute to the document before the selection works
+ // around the issue.
+ // Interestingly, IE 10 & older don't seem to have the issue.
+ input = document.createElement( "input" );
+ input.setAttribute( "name", "" );
+ el.appendChild( input );
+ if ( !el.querySelectorAll( "[name='']" ).length ) {
+ rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" +
+ whitespace + "*(?:''|\"\")" );
+ }
+
+ // Webkit/Opera - :checked should return selected option elements
+ // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked
+ // IE8 throws error here and will not see later tests
+ if ( !el.querySelectorAll( ":checked" ).length ) {
+ rbuggyQSA.push( ":checked" );
+ }
+
+ // Support: Safari 8+, iOS 8+
+ // https://bugs.webkit.org/show_bug.cgi?id=136851
+ // In-page `selector#id sibling-combinator selector` fails
+ if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) {
+ rbuggyQSA.push( ".#.+[+~]" );
+ }
+
+ // Support: Firefox <=3.6 - 5 only
+ // Old Firefox doesn't throw on a badly-escaped identifier.
+ el.querySelectorAll( "\\\f" );
+ rbuggyQSA.push( "[\\r\\n\\f]" );
+ } );
+
+ assert( function( el ) {
+ el.innerHTML = ") matching elements by id
+ for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) {
+ if ( byElement && elem ) {
+ j = 0;
+
+ // Support: IE 11+, Edge 17 - 18+
+ // IE/Edge sometimes throw a "Permission denied" error when strict-comparing
+ // two documents; shallow comparisons work.
+ // eslint-disable-next-line eqeqeq
+ if ( !context && elem.ownerDocument != document ) {
+ setDocument( elem );
+ xml = !documentIsHTML;
+ }
+ while ( ( matcher = elementMatchers[ j++ ] ) ) {
+ if ( matcher( elem, context || document, xml ) ) {
+ results.push( elem );
+ break;
+ }
+ }
+ if ( outermost ) {
+ dirruns = dirrunsUnique;
+ }
+ }
+
+ // Track unmatched elements for set filters
+ if ( bySet ) {
+
+ // They will have gone through all possible matchers
+ if ( ( elem = !matcher && elem ) ) {
+ matchedCount--;
+ }
+
+ // Lengthen the array for every element, matched or not
+ if ( seed ) {
+ unmatched.push( elem );
+ }
+ }
+ }
+
+ // `i` is now the count of elements visited above, and adding it to `matchedCount`
+ // makes the latter nonnegative.
+ matchedCount += i;
+
+ // Apply set filters to unmatched elements
+ // NOTE: This can be skipped if there are no unmatched elements (i.e., `matchedCount`
+ // equals `i`), unless we didn't visit _any_ elements in the above loop because we have
+ // no element matchers and no seed.
+ // Incrementing an initially-string "0" `i` allows `i` to remain a string only in that
+ // case, which will result in a "00" `matchedCount` that differs from `i` but is also
+ // numerically zero.
+ if ( bySet && i !== matchedCount ) {
+ j = 0;
+ while ( ( matcher = setMatchers[ j++ ] ) ) {
+ matcher( unmatched, setMatched, context, xml );
+ }
+
+ if ( seed ) {
+
+ // Reintegrate element matches to eliminate the need for sorting
+ if ( matchedCount > 0 ) {
+ while ( i-- ) {
+ if ( !( unmatched[ i ] || setMatched[ i ] ) ) {
+ setMatched[ i ] = pop.call( results );
+ }
+ }
+ }
+
+ // Discard index placeholder values to get only actual matches
+ setMatched = condense( setMatched );
+ }
+
+ // Add matches to results
+ push.apply( results, setMatched );
+
+ // Seedless set matches succeeding multiple successful matchers stipulate sorting
+ if ( outermost && !seed && setMatched.length > 0 &&
+ ( matchedCount + setMatchers.length ) > 1 ) {
+
+ Sizzle.uniqueSort( results );
+ }
+ }
+
+ // Override manipulation of globals by nested matchers
+ if ( outermost ) {
+ dirruns = dirrunsUnique;
+ outermostContext = contextBackup;
+ }
+
+ return unmatched;
+ };
+
+ return bySet ?
+ markFunction( superMatcher ) :
+ superMatcher;
+}
+
+compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) {
+ var i,
+ setMatchers = [],
+ elementMatchers = [],
+ cached = compilerCache[ selector + " " ];
+
+ if ( !cached ) {
+
+ // Generate a function of recursive functions that can be used to check each element
+ if ( !match ) {
+ match = tokenize( selector );
+ }
+ i = match.length;
+ while ( i-- ) {
+ cached = matcherFromTokens( match[ i ] );
+ if ( cached[ expando ] ) {
+ setMatchers.push( cached );
+ } else {
+ elementMatchers.push( cached );
+ }
+ }
+
+ // Cache the compiled function
+ cached = compilerCache(
+ selector,
+ matcherFromGroupMatchers( elementMatchers, setMatchers )
+ );
+
+ // Save selector and tokenization
+ cached.selector = selector;
+ }
+ return cached;
+};
+
+/**
+ * A low-level selection function that works with Sizzle's compiled
+ * selector functions
+ * @param {String|Function} selector A selector or a pre-compiled
+ * selector function built with Sizzle.compile
+ * @param {Element} context
+ * @param {Array} [results]
+ * @param {Array} [seed] A set of elements to match against
+ */
+select = Sizzle.select = function( selector, context, results, seed ) {
+ var i, tokens, token, type, find,
+ compiled = typeof selector === "function" && selector,
+ match = !seed && tokenize( ( selector = compiled.selector || selector ) );
+
+ results = results || [];
+
+ // Try to minimize operations if there is only one selector in the list and no seed
+ // (the latter of which guarantees us context)
+ if ( match.length === 1 ) {
+
+ // Reduce context if the leading compound selector is an ID
+ tokens = match[ 0 ] = match[ 0 ].slice( 0 );
+ if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" &&
+ context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) {
+
+ context = ( Expr.find[ "ID" ]( token.matches[ 0 ]
+ .replace( runescape, funescape ), context ) || [] )[ 0 ];
+ if ( !context ) {
+ return results;
+
+ // Precompiled matchers will still verify ancestry, so step up a level
+ } else if ( compiled ) {
+ context = context.parentNode;
+ }
+
+ selector = selector.slice( tokens.shift().value.length );
+ }
+
+ // Fetch a seed set for right-to-left matching
+ i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length;
+ while ( i-- ) {
+ token = tokens[ i ];
+
+ // Abort if we hit a combinator
+ if ( Expr.relative[ ( type = token.type ) ] ) {
+ break;
+ }
+ if ( ( find = Expr.find[ type ] ) ) {
+
+ // Search, expanding context for leading sibling combinators
+ if ( ( seed = find(
+ token.matches[ 0 ].replace( runescape, funescape ),
+ rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) ||
+ context
+ ) ) ) {
+
+ // If seed is empty or no tokens remain, we can return early
+ tokens.splice( i, 1 );
+ selector = seed.length && toSelector( tokens );
+ if ( !selector ) {
+ push.apply( results, seed );
+ return results;
+ }
+
+ break;
+ }
+ }
+ }
+ }
+
+ // Compile and execute a filtering function if one is not provided
+ // Provide `match` to avoid retokenization if we modified the selector above
+ ( compiled || compile( selector, match ) )(
+ seed,
+ context,
+ !documentIsHTML,
+ results,
+ !context || rsibling.test( selector ) && testContext( context.parentNode ) || context
+ );
+ return results;
+};
+
+// One-time assignments
+
+// Sort stability
+support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando;
+
+// Support: Chrome 14-35+
+// Always assume duplicates if they aren't passed to the comparison function
+support.detectDuplicates = !!hasDuplicate;
+
+// Initialize against the default document
+setDocument();
+
+// Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27)
+// Detached nodes confoundingly follow *each other*
+support.sortDetached = assert( function( el ) {
+
+ // Should return 1, but returns 4 (following)
+ return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1;
+} );
+
+// Support: IE<8
+// Prevent attribute/property "interpolation"
+// https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx
+if ( !assert( function( el ) {
+ el.innerHTML = " to avoid XSS via location.hash (#9521)
+ // Strict HTML recognition (#11290: must start with <)
+ // Shortcut simple #id case for speed
+ rquickExpr = /^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]+))$/,
+
+ init = jQuery.fn.init = function( selector, context, root ) {
+ var match, elem;
+
+ // HANDLE: $(""), $(null), $(undefined), $(false)
+ if ( !selector ) {
+ return this;
+ }
+
+ // Method init() accepts an alternate rootjQuery
+ // so migrate can support jQuery.sub (gh-2101)
+ root = root || rootjQuery;
+
+ // Handle HTML strings
+ if ( typeof selector === "string" ) {
+ if ( selector[ 0 ] === "<" &&
+ selector[ selector.length - 1 ] === ">" &&
+ selector.length >= 3 ) {
+
+ // Assume that strings that start and end with <> are HTML and skip the regex check
+ match = [ null, selector, null ];
+
+ } else {
+ match = rquickExpr.exec( selector );
+ }
+
+ // Match html or make sure no context is specified for #id
+ if ( match && ( match[ 1 ] || !context ) ) {
+
+ // HANDLE: $(html) -> $(array)
+ if ( match[ 1 ] ) {
+ context = context instanceof jQuery ? context[ 0 ] : context;
+
+ // Option to run scripts is true for back-compat
+ // Intentionally let the error be thrown if parseHTML is not present
+ jQuery.merge( this, jQuery.parseHTML(
+ match[ 1 ],
+ context && context.nodeType ? context.ownerDocument || context : document,
+ true
+ ) );
+
+ // HANDLE: $(html, props)
+ if ( rsingleTag.test( match[ 1 ] ) && jQuery.isPlainObject( context ) ) {
+ for ( match in context ) {
+
+ // Properties of context are called as methods if possible
+ if ( isFunction( this[ match ] ) ) {
+ this[ match ]( context[ match ] );
+
+ // ...and otherwise set as attributes
+ } else {
+ this.attr( match, context[ match ] );
+ }
+ }
+ }
+
+ return this;
+
+ // HANDLE: $(#id)
+ } else {
+ elem = document.getElementById( match[ 2 ] );
+
+ if ( elem ) {
+
+ // Inject the element directly into the jQuery object
+ this[ 0 ] = elem;
+ this.length = 1;
+ }
+ return this;
+ }
+
+ // HANDLE: $(expr, $(...))
+ } else if ( !context || context.jquery ) {
+ return ( context || root ).find( selector );
+
+ // HANDLE: $(expr, context)
+ // (which is just equivalent to: $(context).find(expr)
+ } else {
+ return this.constructor( context ).find( selector );
+ }
+
+ // HANDLE: $(DOMElement)
+ } else if ( selector.nodeType ) {
+ this[ 0 ] = selector;
+ this.length = 1;
+ return this;
+
+ // HANDLE: $(function)
+ // Shortcut for document ready
+ } else if ( isFunction( selector ) ) {
+ return root.ready !== undefined ?
+ root.ready( selector ) :
+
+ // Execute immediately if ready is not present
+ selector( jQuery );
+ }
+
+ return jQuery.makeArray( selector, this );
+ };
+
+// Give the init function the jQuery prototype for later instantiation
+init.prototype = jQuery.fn;
+
+// Initialize central reference
+rootjQuery = jQuery( document );
+
+
+var rparentsprev = /^(?:parents|prev(?:Until|All))/,
+
+ // Methods guaranteed to produce a unique set when starting from a unique set
+ guaranteedUnique = {
+ children: true,
+ contents: true,
+ next: true,
+ prev: true
+ };
+
+jQuery.fn.extend( {
+ has: function( target ) {
+ var targets = jQuery( target, this ),
+ l = targets.length;
+
+ return this.filter( function() {
+ var i = 0;
+ for ( ; i < l; i++ ) {
+ if ( jQuery.contains( this, targets[ i ] ) ) {
+ return true;
+ }
+ }
+ } );
+ },
+
+ closest: function( selectors, context ) {
+ var cur,
+ i = 0,
+ l = this.length,
+ matched = [],
+ targets = typeof selectors !== "string" && jQuery( selectors );
+
+ // Positional selectors never match, since there's no _selection_ context
+ if ( !rneedsContext.test( selectors ) ) {
+ for ( ; i < l; i++ ) {
+ for ( cur = this[ i ]; cur && cur !== context; cur = cur.parentNode ) {
+
+ // Always skip document fragments
+ if ( cur.nodeType < 11 && ( targets ?
+ targets.index( cur ) > -1 :
+
+ // Don't pass non-elements to Sizzle
+ cur.nodeType === 1 &&
+ jQuery.find.matchesSelector( cur, selectors ) ) ) {
+
+ matched.push( cur );
+ break;
+ }
+ }
+ }
+ }
+
+ return this.pushStack( matched.length > 1 ? jQuery.uniqueSort( matched ) : matched );
+ },
+
+ // Determine the position of an element within the set
+ index: function( elem ) {
+
+ // No argument, return index in parent
+ if ( !elem ) {
+ return ( this[ 0 ] && this[ 0 ].parentNode ) ? this.first().prevAll().length : -1;
+ }
+
+ // Index in selector
+ if ( typeof elem === "string" ) {
+ return indexOf.call( jQuery( elem ), this[ 0 ] );
+ }
+
+ // Locate the position of the desired element
+ return indexOf.call( this,
+
+ // If it receives a jQuery object, the first element is used
+ elem.jquery ? elem[ 0 ] : elem
+ );
+ },
+
+ add: function( selector, context ) {
+ return this.pushStack(
+ jQuery.uniqueSort(
+ jQuery.merge( this.get(), jQuery( selector, context ) )
+ )
+ );
+ },
+
+ addBack: function( selector ) {
+ return this.add( selector == null ?
+ this.prevObject : this.prevObject.filter( selector )
+ );
+ }
+} );
+
+function sibling( cur, dir ) {
+ while ( ( cur = cur[ dir ] ) && cur.nodeType !== 1 ) {}
+ return cur;
+}
+
+jQuery.each( {
+ parent: function( elem ) {
+ var parent = elem.parentNode;
+ return parent && parent.nodeType !== 11 ? parent : null;
+ },
+ parents: function( elem ) {
+ return dir( elem, "parentNode" );
+ },
+ parentsUntil: function( elem, _i, until ) {
+ return dir( elem, "parentNode", until );
+ },
+ next: function( elem ) {
+ return sibling( elem, "nextSibling" );
+ },
+ prev: function( elem ) {
+ return sibling( elem, "previousSibling" );
+ },
+ nextAll: function( elem ) {
+ return dir( elem, "nextSibling" );
+ },
+ prevAll: function( elem ) {
+ return dir( elem, "previousSibling" );
+ },
+ nextUntil: function( elem, _i, until ) {
+ return dir( elem, "nextSibling", until );
+ },
+ prevUntil: function( elem, _i, until ) {
+ return dir( elem, "previousSibling", until );
+ },
+ siblings: function( elem ) {
+ return siblings( ( elem.parentNode || {} ).firstChild, elem );
+ },
+ children: function( elem ) {
+ return siblings( elem.firstChild );
+ },
+ contents: function( elem ) {
+ if ( elem.contentDocument != null &&
+
+ // Support: IE 11+
+ // elements with no `data` attribute has an object
+ // `contentDocument` with a `null` prototype.
+ getProto( elem.contentDocument ) ) {
+
+ return elem.contentDocument;
+ }
+
+ // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only
+ // Treat the template element as a regular one in browsers that
+ // don't support it.
+ if ( nodeName( elem, "template" ) ) {
+ elem = elem.content || elem;
+ }
+
+ return jQuery.merge( [], elem.childNodes );
+ }
+}, function( name, fn ) {
+ jQuery.fn[ name ] = function( until, selector ) {
+ var matched = jQuery.map( this, fn, until );
+
+ if ( name.slice( -5 ) !== "Until" ) {
+ selector = until;
+ }
+
+ if ( selector && typeof selector === "string" ) {
+ matched = jQuery.filter( selector, matched );
+ }
+
+ if ( this.length > 1 ) {
+
+ // Remove duplicates
+ if ( !guaranteedUnique[ name ] ) {
+ jQuery.uniqueSort( matched );
+ }
+
+ // Reverse order for parents* and prev-derivatives
+ if ( rparentsprev.test( name ) ) {
+ matched.reverse();
+ }
+ }
+
+ return this.pushStack( matched );
+ };
+} );
+var rnothtmlwhite = ( /[^\x20\t\r\n\f]+/g );
+
+
+
+// Convert String-formatted options into Object-formatted ones
+function createOptions( options ) {
+ var object = {};
+ jQuery.each( options.match( rnothtmlwhite ) || [], function( _, flag ) {
+ object[ flag ] = true;
+ } );
+ return object;
+}
+
+/*
+ * Create a callback list using the following parameters:
+ *
+ * options: an optional list of space-separated options that will change how
+ * the callback list behaves or a more traditional option object
+ *
+ * By default a callback list will act like an event callback list and can be
+ * "fired" multiple times.
+ *
+ * Possible options:
+ *
+ * once: will ensure the callback list can only be fired once (like a Deferred)
+ *
+ * memory: will keep track of previous values and will call any callback added
+ * after the list has been fired right away with the latest "memorized"
+ * values (like a Deferred)
+ *
+ * unique: will ensure a callback can only be added once (no duplicate in the list)
+ *
+ * stopOnFalse: interrupt callings when a callback returns false
+ *
+ */
+jQuery.Callbacks = function( options ) {
+
+ // Convert options from String-formatted to Object-formatted if needed
+ // (we check in cache first)
+ options = typeof options === "string" ?
+ createOptions( options ) :
+ jQuery.extend( {}, options );
+
+ var // Flag to know if list is currently firing
+ firing,
+
+ // Last fire value for non-forgettable lists
+ memory,
+
+ // Flag to know if list was already fired
+ fired,
+
+ // Flag to prevent firing
+ locked,
+
+ // Actual callback list
+ list = [],
+
+ // Queue of execution data for repeatable lists
+ queue = [],
+
+ // Index of currently firing callback (modified by add/remove as needed)
+ firingIndex = -1,
+
+ // Fire callbacks
+ fire = function() {
+
+ // Enforce single-firing
+ locked = locked || options.once;
+
+ // Execute callbacks for all pending executions,
+ // respecting firingIndex overrides and runtime changes
+ fired = firing = true;
+ for ( ; queue.length; firingIndex = -1 ) {
+ memory = queue.shift();
+ while ( ++firingIndex < list.length ) {
+
+ // Run callback and check for early termination
+ if ( list[ firingIndex ].apply( memory[ 0 ], memory[ 1 ] ) === false &&
+ options.stopOnFalse ) {
+
+ // Jump to end and forget the data so .add doesn't re-fire
+ firingIndex = list.length;
+ memory = false;
+ }
+ }
+ }
+
+ // Forget the data if we're done with it
+ if ( !options.memory ) {
+ memory = false;
+ }
+
+ firing = false;
+
+ // Clean up if we're done firing for good
+ if ( locked ) {
+
+ // Keep an empty list if we have data for future add calls
+ if ( memory ) {
+ list = [];
+
+ // Otherwise, this object is spent
+ } else {
+ list = "";
+ }
+ }
+ },
+
+ // Actual Callbacks object
+ self = {
+
+ // Add a callback or a collection of callbacks to the list
+ add: function() {
+ if ( list ) {
+
+ // If we have memory from a past run, we should fire after adding
+ if ( memory && !firing ) {
+ firingIndex = list.length - 1;
+ queue.push( memory );
+ }
+
+ ( function add( args ) {
+ jQuery.each( args, function( _, arg ) {
+ if ( isFunction( arg ) ) {
+ if ( !options.unique || !self.has( arg ) ) {
+ list.push( arg );
+ }
+ } else if ( arg && arg.length && toType( arg ) !== "string" ) {
+
+ // Inspect recursively
+ add( arg );
+ }
+ } );
+ } )( arguments );
+
+ if ( memory && !firing ) {
+ fire();
+ }
+ }
+ return this;
+ },
+
+ // Remove a callback from the list
+ remove: function() {
+ jQuery.each( arguments, function( _, arg ) {
+ var index;
+ while ( ( index = jQuery.inArray( arg, list, index ) ) > -1 ) {
+ list.splice( index, 1 );
+
+ // Handle firing indexes
+ if ( index <= firingIndex ) {
+ firingIndex--;
+ }
+ }
+ } );
+ return this;
+ },
+
+ // Check if a given callback is in the list.
+ // If no argument is given, return whether or not list has callbacks attached.
+ has: function( fn ) {
+ return fn ?
+ jQuery.inArray( fn, list ) > -1 :
+ list.length > 0;
+ },
+
+ // Remove all callbacks from the list
+ empty: function() {
+ if ( list ) {
+ list = [];
+ }
+ return this;
+ },
+
+ // Disable .fire and .add
+ // Abort any current/pending executions
+ // Clear all callbacks and values
+ disable: function() {
+ locked = queue = [];
+ list = memory = "";
+ return this;
+ },
+ disabled: function() {
+ return !list;
+ },
+
+ // Disable .fire
+ // Also disable .add unless we have memory (since it would have no effect)
+ // Abort any pending executions
+ lock: function() {
+ locked = queue = [];
+ if ( !memory && !firing ) {
+ list = memory = "";
+ }
+ return this;
+ },
+ locked: function() {
+ return !!locked;
+ },
+
+ // Call all callbacks with the given context and arguments
+ fireWith: function( context, args ) {
+ if ( !locked ) {
+ args = args || [];
+ args = [ context, args.slice ? args.slice() : args ];
+ queue.push( args );
+ if ( !firing ) {
+ fire();
+ }
+ }
+ return this;
+ },
+
+ // Call all the callbacks with the given arguments
+ fire: function() {
+ self.fireWith( this, arguments );
+ return this;
+ },
+
+ // To know if the callbacks have already been called at least once
+ fired: function() {
+ return !!fired;
+ }
+ };
+
+ return self;
+};
+
+
+function Identity( v ) {
+ return v;
+}
+function Thrower( ex ) {
+ throw ex;
+}
+
+function adoptValue( value, resolve, reject, noValue ) {
+ var method;
+
+ try {
+
+ // Check for promise aspect first to privilege synchronous behavior
+ if ( value && isFunction( ( method = value.promise ) ) ) {
+ method.call( value ).done( resolve ).fail( reject );
+
+ // Other thenables
+ } else if ( value && isFunction( ( method = value.then ) ) ) {
+ method.call( value, resolve, reject );
+
+ // Other non-thenables
+ } else {
+
+ // Control `resolve` arguments by letting Array#slice cast boolean `noValue` to integer:
+ // * false: [ value ].slice( 0 ) => resolve( value )
+ // * true: [ value ].slice( 1 ) => resolve()
+ resolve.apply( undefined, [ value ].slice( noValue ) );
+ }
+
+ // For Promises/A+, convert exceptions into rejections
+ // Since jQuery.when doesn't unwrap thenables, we can skip the extra checks appearing in
+ // Deferred#then to conditionally suppress rejection.
+ } catch ( value ) {
+
+ // Support: Android 4.0 only
+ // Strict mode functions invoked without .call/.apply get global-object context
+ reject.apply( undefined, [ value ] );
+ }
+}
+
+jQuery.extend( {
+
+ Deferred: function( func ) {
+ var tuples = [
+
+ // action, add listener, callbacks,
+ // ... .then handlers, argument index, [final state]
+ [ "notify", "progress", jQuery.Callbacks( "memory" ),
+ jQuery.Callbacks( "memory" ), 2 ],
+ [ "resolve", "done", jQuery.Callbacks( "once memory" ),
+ jQuery.Callbacks( "once memory" ), 0, "resolved" ],
+ [ "reject", "fail", jQuery.Callbacks( "once memory" ),
+ jQuery.Callbacks( "once memory" ), 1, "rejected" ]
+ ],
+ state = "pending",
+ promise = {
+ state: function() {
+ return state;
+ },
+ always: function() {
+ deferred.done( arguments ).fail( arguments );
+ return this;
+ },
+ "catch": function( fn ) {
+ return promise.then( null, fn );
+ },
+
+ // Keep pipe for back-compat
+ pipe: function( /* fnDone, fnFail, fnProgress */ ) {
+ var fns = arguments;
+
+ return jQuery.Deferred( function( newDefer ) {
+ jQuery.each( tuples, function( _i, tuple ) {
+
+ // Map tuples (progress, done, fail) to arguments (done, fail, progress)
+ var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ];
+
+ // deferred.progress(function() { bind to newDefer or newDefer.notify })
+ // deferred.done(function() { bind to newDefer or newDefer.resolve })
+ // deferred.fail(function() { bind to newDefer or newDefer.reject })
+ deferred[ tuple[ 1 ] ]( function() {
+ var returned = fn && fn.apply( this, arguments );
+ if ( returned && isFunction( returned.promise ) ) {
+ returned.promise()
+ .progress( newDefer.notify )
+ .done( newDefer.resolve )
+ .fail( newDefer.reject );
+ } else {
+ newDefer[ tuple[ 0 ] + "With" ](
+ this,
+ fn ? [ returned ] : arguments
+ );
+ }
+ } );
+ } );
+ fns = null;
+ } ).promise();
+ },
+ then: function( onFulfilled, onRejected, onProgress ) {
+ var maxDepth = 0;
+ function resolve( depth, deferred, handler, special ) {
+ return function() {
+ var that = this,
+ args = arguments,
+ mightThrow = function() {
+ var returned, then;
+
+ // Support: Promises/A+ section 2.3.3.3.3
+ // https://promisesaplus.com/#point-59
+ // Ignore double-resolution attempts
+ if ( depth < maxDepth ) {
+ return;
+ }
+
+ returned = handler.apply( that, args );
+
+ // Support: Promises/A+ section 2.3.1
+ // https://promisesaplus.com/#point-48
+ if ( returned === deferred.promise() ) {
+ throw new TypeError( "Thenable self-resolution" );
+ }
+
+ // Support: Promises/A+ sections 2.3.3.1, 3.5
+ // https://promisesaplus.com/#point-54
+ // https://promisesaplus.com/#point-75
+ // Retrieve `then` only once
+ then = returned &&
+
+ // Support: Promises/A+ section 2.3.4
+ // https://promisesaplus.com/#point-64
+ // Only check objects and functions for thenability
+ ( typeof returned === "object" ||
+ typeof returned === "function" ) &&
+ returned.then;
+
+ // Handle a returned thenable
+ if ( isFunction( then ) ) {
+
+ // Special processors (notify) just wait for resolution
+ if ( special ) {
+ then.call(
+ returned,
+ resolve( maxDepth, deferred, Identity, special ),
+ resolve( maxDepth, deferred, Thrower, special )
+ );
+
+ // Normal processors (resolve) also hook into progress
+ } else {
+
+ // ...and disregard older resolution values
+ maxDepth++;
+
+ then.call(
+ returned,
+ resolve( maxDepth, deferred, Identity, special ),
+ resolve( maxDepth, deferred, Thrower, special ),
+ resolve( maxDepth, deferred, Identity,
+ deferred.notifyWith )
+ );
+ }
+
+ // Handle all other returned values
+ } else {
+
+ // Only substitute handlers pass on context
+ // and multiple values (non-spec behavior)
+ if ( handler !== Identity ) {
+ that = undefined;
+ args = [ returned ];
+ }
+
+ // Process the value(s)
+ // Default process is resolve
+ ( special || deferred.resolveWith )( that, args );
+ }
+ },
+
+ // Only normal processors (resolve) catch and reject exceptions
+ process = special ?
+ mightThrow :
+ function() {
+ try {
+ mightThrow();
+ } catch ( e ) {
+
+ if ( jQuery.Deferred.exceptionHook ) {
+ jQuery.Deferred.exceptionHook( e,
+ process.stackTrace );
+ }
+
+ // Support: Promises/A+ section 2.3.3.3.4.1
+ // https://promisesaplus.com/#point-61
+ // Ignore post-resolution exceptions
+ if ( depth + 1 >= maxDepth ) {
+
+ // Only substitute handlers pass on context
+ // and multiple values (non-spec behavior)
+ if ( handler !== Thrower ) {
+ that = undefined;
+ args = [ e ];
+ }
+
+ deferred.rejectWith( that, args );
+ }
+ }
+ };
+
+ // Support: Promises/A+ section 2.3.3.3.1
+ // https://promisesaplus.com/#point-57
+ // Re-resolve promises immediately to dodge false rejection from
+ // subsequent errors
+ if ( depth ) {
+ process();
+ } else {
+
+ // Call an optional hook to record the stack, in case of exception
+ // since it's otherwise lost when execution goes async
+ if ( jQuery.Deferred.getStackHook ) {
+ process.stackTrace = jQuery.Deferred.getStackHook();
+ }
+ window.setTimeout( process );
+ }
+ };
+ }
+
+ return jQuery.Deferred( function( newDefer ) {
+
+ // progress_handlers.add( ... )
+ tuples[ 0 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ isFunction( onProgress ) ?
+ onProgress :
+ Identity,
+ newDefer.notifyWith
+ )
+ );
+
+ // fulfilled_handlers.add( ... )
+ tuples[ 1 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ isFunction( onFulfilled ) ?
+ onFulfilled :
+ Identity
+ )
+ );
+
+ // rejected_handlers.add( ... )
+ tuples[ 2 ][ 3 ].add(
+ resolve(
+ 0,
+ newDefer,
+ isFunction( onRejected ) ?
+ onRejected :
+ Thrower
+ )
+ );
+ } ).promise();
+ },
+
+ // Get a promise for this deferred
+ // If obj is provided, the promise aspect is added to the object
+ promise: function( obj ) {
+ return obj != null ? jQuery.extend( obj, promise ) : promise;
+ }
+ },
+ deferred = {};
+
+ // Add list-specific methods
+ jQuery.each( tuples, function( i, tuple ) {
+ var list = tuple[ 2 ],
+ stateString = tuple[ 5 ];
+
+ // promise.progress = list.add
+ // promise.done = list.add
+ // promise.fail = list.add
+ promise[ tuple[ 1 ] ] = list.add;
+
+ // Handle state
+ if ( stateString ) {
+ list.add(
+ function() {
+
+ // state = "resolved" (i.e., fulfilled)
+ // state = "rejected"
+ state = stateString;
+ },
+
+ // rejected_callbacks.disable
+ // fulfilled_callbacks.disable
+ tuples[ 3 - i ][ 2 ].disable,
+
+ // rejected_handlers.disable
+ // fulfilled_handlers.disable
+ tuples[ 3 - i ][ 3 ].disable,
+
+ // progress_callbacks.lock
+ tuples[ 0 ][ 2 ].lock,
+
+ // progress_handlers.lock
+ tuples[ 0 ][ 3 ].lock
+ );
+ }
+
+ // progress_handlers.fire
+ // fulfilled_handlers.fire
+ // rejected_handlers.fire
+ list.add( tuple[ 3 ].fire );
+
+ // deferred.notify = function() { deferred.notifyWith(...) }
+ // deferred.resolve = function() { deferred.resolveWith(...) }
+ // deferred.reject = function() { deferred.rejectWith(...) }
+ deferred[ tuple[ 0 ] ] = function() {
+ deferred[ tuple[ 0 ] + "With" ]( this === deferred ? undefined : this, arguments );
+ return this;
+ };
+
+ // deferred.notifyWith = list.fireWith
+ // deferred.resolveWith = list.fireWith
+ // deferred.rejectWith = list.fireWith
+ deferred[ tuple[ 0 ] + "With" ] = list.fireWith;
+ } );
+
+ // Make the deferred a promise
+ promise.promise( deferred );
+
+ // Call given func if any
+ if ( func ) {
+ func.call( deferred, deferred );
+ }
+
+ // All done!
+ return deferred;
+ },
+
+ // Deferred helper
+ when: function( singleValue ) {
+ var
+
+ // count of uncompleted subordinates
+ remaining = arguments.length,
+
+ // count of unprocessed arguments
+ i = remaining,
+
+ // subordinate fulfillment data
+ resolveContexts = Array( i ),
+ resolveValues = slice.call( arguments ),
+
+ // the primary Deferred
+ primary = jQuery.Deferred(),
+
+ // subordinate callback factory
+ updateFunc = function( i ) {
+ return function( value ) {
+ resolveContexts[ i ] = this;
+ resolveValues[ i ] = arguments.length > 1 ? slice.call( arguments ) : value;
+ if ( !( --remaining ) ) {
+ primary.resolveWith( resolveContexts, resolveValues );
+ }
+ };
+ };
+
+ // Single- and empty arguments are adopted like Promise.resolve
+ if ( remaining <= 1 ) {
+ adoptValue( singleValue, primary.done( updateFunc( i ) ).resolve, primary.reject,
+ !remaining );
+
+ // Use .then() to unwrap secondary thenables (cf. gh-3000)
+ if ( primary.state() === "pending" ||
+ isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) {
+
+ return primary.then();
+ }
+ }
+
+ // Multiple arguments are aggregated like Promise.all array elements
+ while ( i-- ) {
+ adoptValue( resolveValues[ i ], updateFunc( i ), primary.reject );
+ }
+
+ return primary.promise();
+ }
+} );
+
+
+// These usually indicate a programmer mistake during development,
+// warn about them ASAP rather than swallowing them by default.
+var rerrorNames = /^(Eval|Internal|Range|Reference|Syntax|Type|URI)Error$/;
+
+jQuery.Deferred.exceptionHook = function( error, stack ) {
+
+ // Support: IE 8 - 9 only
+ // Console exists when dev tools are open, which can happen at any time
+ if ( window.console && window.console.warn && error && rerrorNames.test( error.name ) ) {
+ window.console.warn( "jQuery.Deferred exception: " + error.message, error.stack, stack );
+ }
+};
+
+
+
+
+jQuery.readyException = function( error ) {
+ window.setTimeout( function() {
+ throw error;
+ } );
+};
+
+
+
+
+// The deferred used on DOM ready
+var readyList = jQuery.Deferred();
+
+jQuery.fn.ready = function( fn ) {
+
+ readyList
+ .then( fn )
+
+ // Wrap jQuery.readyException in a function so that the lookup
+ // happens at the time of error handling instead of callback
+ // registration.
+ .catch( function( error ) {
+ jQuery.readyException( error );
+ } );
+
+ return this;
+};
+
+jQuery.extend( {
+
+ // Is the DOM ready to be used? Set to true once it occurs.
+ isReady: false,
+
+ // A counter to track how many items to wait for before
+ // the ready event fires. See #6781
+ readyWait: 1,
+
+ // Handle when the DOM is ready
+ ready: function( wait ) {
+
+ // Abort if there are pending holds or we're already ready
+ if ( wait === true ? --jQuery.readyWait : jQuery.isReady ) {
+ return;
+ }
+
+ // Remember that the DOM is ready
+ jQuery.isReady = true;
+
+ // If a normal DOM Ready event fired, decrement, and wait if need be
+ if ( wait !== true && --jQuery.readyWait > 0 ) {
+ return;
+ }
+
+ // If there are functions bound, to execute
+ readyList.resolveWith( document, [ jQuery ] );
+ }
+} );
+
+jQuery.ready.then = readyList.then;
+
+// The ready event handler and self cleanup method
+function completed() {
+ document.removeEventListener( "DOMContentLoaded", completed );
+ window.removeEventListener( "load", completed );
+ jQuery.ready();
+}
+
+// Catch cases where $(document).ready() is called
+// after the browser event has already occurred.
+// Support: IE <=9 - 10 only
+// Older IE sometimes signals "interactive" too soon
+if ( document.readyState === "complete" ||
+ ( document.readyState !== "loading" && !document.documentElement.doScroll ) ) {
+
+ // Handle it asynchronously to allow scripts the opportunity to delay ready
+ window.setTimeout( jQuery.ready );
+
+} else {
+
+ // Use the handy event callback
+ document.addEventListener( "DOMContentLoaded", completed );
+
+ // A fallback to window.onload, that will always work
+ window.addEventListener( "load", completed );
+}
+
+
+
+
+// Multifunctional method to get and set values of a collection
+// The value/s can optionally be executed if it's a function
+var access = function( elems, fn, key, value, chainable, emptyGet, raw ) {
+ var i = 0,
+ len = elems.length,
+ bulk = key == null;
+
+ // Sets many values
+ if ( toType( key ) === "object" ) {
+ chainable = true;
+ for ( i in key ) {
+ access( elems, fn, i, key[ i ], true, emptyGet, raw );
+ }
+
+ // Sets one value
+ } else if ( value !== undefined ) {
+ chainable = true;
+
+ if ( !isFunction( value ) ) {
+ raw = true;
+ }
+
+ if ( bulk ) {
+
+ // Bulk operations run against the entire set
+ if ( raw ) {
+ fn.call( elems, value );
+ fn = null;
+
+ // ...except when executing function values
+ } else {
+ bulk = fn;
+ fn = function( elem, _key, value ) {
+ return bulk.call( jQuery( elem ), value );
+ };
+ }
+ }
+
+ if ( fn ) {
+ for ( ; i < len; i++ ) {
+ fn(
+ elems[ i ], key, raw ?
+ value :
+ value.call( elems[ i ], i, fn( elems[ i ], key ) )
+ );
+ }
+ }
+ }
+
+ if ( chainable ) {
+ return elems;
+ }
+
+ // Gets
+ if ( bulk ) {
+ return fn.call( elems );
+ }
+
+ return len ? fn( elems[ 0 ], key ) : emptyGet;
+};
+
+
+// Matches dashed string for camelizing
+var rmsPrefix = /^-ms-/,
+ rdashAlpha = /-([a-z])/g;
+
+// Used by camelCase as callback to replace()
+function fcamelCase( _all, letter ) {
+ return letter.toUpperCase();
+}
+
+// Convert dashed to camelCase; used by the css and data modules
+// Support: IE <=9 - 11, Edge 12 - 15
+// Microsoft forgot to hump their vendor prefix (#9572)
+function camelCase( string ) {
+ return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase );
+}
+var acceptData = function( owner ) {
+
+ // Accepts only:
+ // - Node
+ // - Node.ELEMENT_NODE
+ // - Node.DOCUMENT_NODE
+ // - Object
+ // - Any
+ return owner.nodeType === 1 || owner.nodeType === 9 || !( +owner.nodeType );
+};
+
+
+
+
+function Data() {
+ this.expando = jQuery.expando + Data.uid++;
+}
+
+Data.uid = 1;
+
+Data.prototype = {
+
+ cache: function( owner ) {
+
+ // Check if the owner object already has a cache
+ var value = owner[ this.expando ];
+
+ // If not, create one
+ if ( !value ) {
+ value = {};
+
+ // We can accept data for non-element nodes in modern browsers,
+ // but we should not, see #8335.
+ // Always return an empty object.
+ if ( acceptData( owner ) ) {
+
+ // If it is a node unlikely to be stringify-ed or looped over
+ // use plain assignment
+ if ( owner.nodeType ) {
+ owner[ this.expando ] = value;
+
+ // Otherwise secure it in a non-enumerable property
+ // configurable must be true to allow the property to be
+ // deleted when data is removed
+ } else {
+ Object.defineProperty( owner, this.expando, {
+ value: value,
+ configurable: true
+ } );
+ }
+ }
+ }
+
+ return value;
+ },
+ set: function( owner, data, value ) {
+ var prop,
+ cache = this.cache( owner );
+
+ // Handle: [ owner, key, value ] args
+ // Always use camelCase key (gh-2257)
+ if ( typeof data === "string" ) {
+ cache[ camelCase( data ) ] = value;
+
+ // Handle: [ owner, { properties } ] args
+ } else {
+
+ // Copy the properties one-by-one to the cache object
+ for ( prop in data ) {
+ cache[ camelCase( prop ) ] = data[ prop ];
+ }
+ }
+ return cache;
+ },
+ get: function( owner, key ) {
+ return key === undefined ?
+ this.cache( owner ) :
+
+ // Always use camelCase key (gh-2257)
+ owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ];
+ },
+ access: function( owner, key, value ) {
+
+ // In cases where either:
+ //
+ // 1. No key was specified
+ // 2. A string key was specified, but no value provided
+ //
+ // Take the "read" path and allow the get method to determine
+ // which value to return, respectively either:
+ //
+ // 1. The entire cache object
+ // 2. The data stored at the key
+ //
+ if ( key === undefined ||
+ ( ( key && typeof key === "string" ) && value === undefined ) ) {
+
+ return this.get( owner, key );
+ }
+
+ // When the key is not a string, or both a key and value
+ // are specified, set or extend (existing objects) with either:
+ //
+ // 1. An object of properties
+ // 2. A key and value
+ //
+ this.set( owner, key, value );
+
+ // Since the "set" path can have two possible entry points
+ // return the expected data based on which path was taken[*]
+ return value !== undefined ? value : key;
+ },
+ remove: function( owner, key ) {
+ var i,
+ cache = owner[ this.expando ];
+
+ if ( cache === undefined ) {
+ return;
+ }
+
+ if ( key !== undefined ) {
+
+ // Support array or space separated string of keys
+ if ( Array.isArray( key ) ) {
+
+ // If key is an array of keys...
+ // We always set camelCase keys, so remove that.
+ key = key.map( camelCase );
+ } else {
+ key = camelCase( key );
+
+ // If a key with the spaces exists, use it.
+ // Otherwise, create an array by matching non-whitespace
+ key = key in cache ?
+ [ key ] :
+ ( key.match( rnothtmlwhite ) || [] );
+ }
+
+ i = key.length;
+
+ while ( i-- ) {
+ delete cache[ key[ i ] ];
+ }
+ }
+
+ // Remove the expando if there's no more data
+ if ( key === undefined || jQuery.isEmptyObject( cache ) ) {
+
+ // Support: Chrome <=35 - 45
+ // Webkit & Blink performance suffers when deleting properties
+ // from DOM nodes, so set to undefined instead
+ // https://bugs.chromium.org/p/chromium/issues/detail?id=378607 (bug restricted)
+ if ( owner.nodeType ) {
+ owner[ this.expando ] = undefined;
+ } else {
+ delete owner[ this.expando ];
+ }
+ }
+ },
+ hasData: function( owner ) {
+ var cache = owner[ this.expando ];
+ return cache !== undefined && !jQuery.isEmptyObject( cache );
+ }
+};
+var dataPriv = new Data();
+
+var dataUser = new Data();
+
+
+
+// Implementation Summary
+//
+// 1. Enforce API surface and semantic compatibility with 1.9.x branch
+// 2. Improve the module's maintainability by reducing the storage
+// paths to a single mechanism.
+// 3. Use the same single mechanism to support "private" and "user" data.
+// 4. _Never_ expose "private" data to user code (TODO: Drop _data, _removeData)
+// 5. Avoid exposing implementation details on user objects (eg. expando properties)
+// 6. Provide a clear path for implementation upgrade to WeakMap in 2014
+
+var rbrace = /^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,
+ rmultiDash = /[A-Z]/g;
+
+function getData( data ) {
+ if ( data === "true" ) {
+ return true;
+ }
+
+ if ( data === "false" ) {
+ return false;
+ }
+
+ if ( data === "null" ) {
+ return null;
+ }
+
+ // Only convert to a number if it doesn't change the string
+ if ( data === +data + "" ) {
+ return +data;
+ }
+
+ if ( rbrace.test( data ) ) {
+ return JSON.parse( data );
+ }
+
+ return data;
+}
+
+function dataAttr( elem, key, data ) {
+ var name;
+
+ // If nothing was found internally, try to fetch any
+ // data from the HTML5 data-* attribute
+ if ( data === undefined && elem.nodeType === 1 ) {
+ name = "data-" + key.replace( rmultiDash, "-$&" ).toLowerCase();
+ data = elem.getAttribute( name );
+
+ if ( typeof data === "string" ) {
+ try {
+ data = getData( data );
+ } catch ( e ) {}
+
+ // Make sure we set the data so it isn't changed later
+ dataUser.set( elem, key, data );
+ } else {
+ data = undefined;
+ }
+ }
+ return data;
+}
+
+jQuery.extend( {
+ hasData: function( elem ) {
+ return dataUser.hasData( elem ) || dataPriv.hasData( elem );
+ },
+
+ data: function( elem, name, data ) {
+ return dataUser.access( elem, name, data );
+ },
+
+ removeData: function( elem, name ) {
+ dataUser.remove( elem, name );
+ },
+
+ // TODO: Now that all calls to _data and _removeData have been replaced
+ // with direct calls to dataPriv methods, these can be deprecated.
+ _data: function( elem, name, data ) {
+ return dataPriv.access( elem, name, data );
+ },
+
+ _removeData: function( elem, name ) {
+ dataPriv.remove( elem, name );
+ }
+} );
+
+jQuery.fn.extend( {
+ data: function( key, value ) {
+ var i, name, data,
+ elem = this[ 0 ],
+ attrs = elem && elem.attributes;
+
+ // Gets all values
+ if ( key === undefined ) {
+ if ( this.length ) {
+ data = dataUser.get( elem );
+
+ if ( elem.nodeType === 1 && !dataPriv.get( elem, "hasDataAttrs" ) ) {
+ i = attrs.length;
+ while ( i-- ) {
+
+ // Support: IE 11 only
+ // The attrs elements can be null (#14894)
+ if ( attrs[ i ] ) {
+ name = attrs[ i ].name;
+ if ( name.indexOf( "data-" ) === 0 ) {
+ name = camelCase( name.slice( 5 ) );
+ dataAttr( elem, name, data[ name ] );
+ }
+ }
+ }
+ dataPriv.set( elem, "hasDataAttrs", true );
+ }
+ }
+
+ return data;
+ }
+
+ // Sets multiple values
+ if ( typeof key === "object" ) {
+ return this.each( function() {
+ dataUser.set( this, key );
+ } );
+ }
+
+ return access( this, function( value ) {
+ var data;
+
+ // The calling jQuery object (element matches) is not empty
+ // (and therefore has an element appears at this[ 0 ]) and the
+ // `value` parameter was not undefined. An empty jQuery object
+ // will result in `undefined` for elem = this[ 0 ] which will
+ // throw an exception if an attempt to read a data cache is made.
+ if ( elem && value === undefined ) {
+
+ // Attempt to get data from the cache
+ // The key will always be camelCased in Data
+ data = dataUser.get( elem, key );
+ if ( data !== undefined ) {
+ return data;
+ }
+
+ // Attempt to "discover" the data in
+ // HTML5 custom data-* attrs
+ data = dataAttr( elem, key );
+ if ( data !== undefined ) {
+ return data;
+ }
+
+ // We tried really hard, but the data doesn't exist.
+ return;
+ }
+
+ // Set the data...
+ this.each( function() {
+
+ // We always store the camelCased key
+ dataUser.set( this, key, value );
+ } );
+ }, null, value, arguments.length > 1, null, true );
+ },
+
+ removeData: function( key ) {
+ return this.each( function() {
+ dataUser.remove( this, key );
+ } );
+ }
+} );
+
+
+jQuery.extend( {
+ queue: function( elem, type, data ) {
+ var queue;
+
+ if ( elem ) {
+ type = ( type || "fx" ) + "queue";
+ queue = dataPriv.get( elem, type );
+
+ // Speed up dequeue by getting out quickly if this is just a lookup
+ if ( data ) {
+ if ( !queue || Array.isArray( data ) ) {
+ queue = dataPriv.access( elem, type, jQuery.makeArray( data ) );
+ } else {
+ queue.push( data );
+ }
+ }
+ return queue || [];
+ }
+ },
+
+ dequeue: function( elem, type ) {
+ type = type || "fx";
+
+ var queue = jQuery.queue( elem, type ),
+ startLength = queue.length,
+ fn = queue.shift(),
+ hooks = jQuery._queueHooks( elem, type ),
+ next = function() {
+ jQuery.dequeue( elem, type );
+ };
+
+ // If the fx queue is dequeued, always remove the progress sentinel
+ if ( fn === "inprogress" ) {
+ fn = queue.shift();
+ startLength--;
+ }
+
+ if ( fn ) {
+
+ // Add a progress sentinel to prevent the fx queue from being
+ // automatically dequeued
+ if ( type === "fx" ) {
+ queue.unshift( "inprogress" );
+ }
+
+ // Clear up the last queue stop function
+ delete hooks.stop;
+ fn.call( elem, next, hooks );
+ }
+
+ if ( !startLength && hooks ) {
+ hooks.empty.fire();
+ }
+ },
+
+ // Not public - generate a queueHooks object, or return the current one
+ _queueHooks: function( elem, type ) {
+ var key = type + "queueHooks";
+ return dataPriv.get( elem, key ) || dataPriv.access( elem, key, {
+ empty: jQuery.Callbacks( "once memory" ).add( function() {
+ dataPriv.remove( elem, [ type + "queue", key ] );
+ } )
+ } );
+ }
+} );
+
+jQuery.fn.extend( {
+ queue: function( type, data ) {
+ var setter = 2;
+
+ if ( typeof type !== "string" ) {
+ data = type;
+ type = "fx";
+ setter--;
+ }
+
+ if ( arguments.length < setter ) {
+ return jQuery.queue( this[ 0 ], type );
+ }
+
+ return data === undefined ?
+ this :
+ this.each( function() {
+ var queue = jQuery.queue( this, type, data );
+
+ // Ensure a hooks for this queue
+ jQuery._queueHooks( this, type );
+
+ if ( type === "fx" && queue[ 0 ] !== "inprogress" ) {
+ jQuery.dequeue( this, type );
+ }
+ } );
+ },
+ dequeue: function( type ) {
+ return this.each( function() {
+ jQuery.dequeue( this, type );
+ } );
+ },
+ clearQueue: function( type ) {
+ return this.queue( type || "fx", [] );
+ },
+
+ // Get a promise resolved when queues of a certain type
+ // are emptied (fx is the type by default)
+ promise: function( type, obj ) {
+ var tmp,
+ count = 1,
+ defer = jQuery.Deferred(),
+ elements = this,
+ i = this.length,
+ resolve = function() {
+ if ( !( --count ) ) {
+ defer.resolveWith( elements, [ elements ] );
+ }
+ };
+
+ if ( typeof type !== "string" ) {
+ obj = type;
+ type = undefined;
+ }
+ type = type || "fx";
+
+ while ( i-- ) {
+ tmp = dataPriv.get( elements[ i ], type + "queueHooks" );
+ if ( tmp && tmp.empty ) {
+ count++;
+ tmp.empty.add( resolve );
+ }
+ }
+ resolve();
+ return defer.promise( obj );
+ }
+} );
+var pnum = ( /[+-]?(?:\d*\.|)\d+(?:[eE][+-]?\d+|)/ ).source;
+
+var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" );
+
+
+var cssExpand = [ "Top", "Right", "Bottom", "Left" ];
+
+var documentElement = document.documentElement;
+
+
+
+ var isAttached = function( elem ) {
+ return jQuery.contains( elem.ownerDocument, elem );
+ },
+ composed = { composed: true };
+
+ // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only
+ // Check attachment across shadow DOM boundaries when possible (gh-3504)
+ // Support: iOS 10.0-10.2 only
+ // Early iOS 10 versions support `attachShadow` but not `getRootNode`,
+ // leading to errors. We need to check for `getRootNode`.
+ if ( documentElement.getRootNode ) {
+ isAttached = function( elem ) {
+ return jQuery.contains( elem.ownerDocument, elem ) ||
+ elem.getRootNode( composed ) === elem.ownerDocument;
+ };
+ }
+var isHiddenWithinTree = function( elem, el ) {
+
+ // isHiddenWithinTree might be called from jQuery#filter function;
+ // in that case, element will be second argument
+ elem = el || elem;
+
+ // Inline style trumps all
+ return elem.style.display === "none" ||
+ elem.style.display === "" &&
+
+ // Otherwise, check computed style
+ // Support: Firefox <=43 - 45
+ // Disconnected elements can have computed display: none, so first confirm that elem is
+ // in the document.
+ isAttached( elem ) &&
+
+ jQuery.css( elem, "display" ) === "none";
+ };
+
+
+
+function adjustCSS( elem, prop, valueParts, tween ) {
+ var adjusted, scale,
+ maxIterations = 20,
+ currentValue = tween ?
+ function() {
+ return tween.cur();
+ } :
+ function() {
+ return jQuery.css( elem, prop, "" );
+ },
+ initial = currentValue(),
+ unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ),
+
+ // Starting value computation is required for potential unit mismatches
+ initialInUnit = elem.nodeType &&
+ ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) &&
+ rcssNum.exec( jQuery.css( elem, prop ) );
+
+ if ( initialInUnit && initialInUnit[ 3 ] !== unit ) {
+
+ // Support: Firefox <=54
+ // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144)
+ initial = initial / 2;
+
+ // Trust units reported by jQuery.css
+ unit = unit || initialInUnit[ 3 ];
+
+ // Iteratively approximate from a nonzero starting point
+ initialInUnit = +initial || 1;
+
+ while ( maxIterations-- ) {
+
+ // Evaluate and update our best guess (doubling guesses that zero out).
+ // Finish if the scale equals or crosses 1 (making the old*new product non-positive).
+ jQuery.style( elem, prop, initialInUnit + unit );
+ if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) {
+ maxIterations = 0;
+ }
+ initialInUnit = initialInUnit / scale;
+
+ }
+
+ initialInUnit = initialInUnit * 2;
+ jQuery.style( elem, prop, initialInUnit + unit );
+
+ // Make sure we update the tween properties later on
+ valueParts = valueParts || [];
+ }
+
+ if ( valueParts ) {
+ initialInUnit = +initialInUnit || +initial || 0;
+
+ // Apply relative offset (+=/-=) if specified
+ adjusted = valueParts[ 1 ] ?
+ initialInUnit + ( valueParts[ 1 ] + 1 ) * valueParts[ 2 ] :
+ +valueParts[ 2 ];
+ if ( tween ) {
+ tween.unit = unit;
+ tween.start = initialInUnit;
+ tween.end = adjusted;
+ }
+ }
+ return adjusted;
+}
+
+
+var defaultDisplayMap = {};
+
+function getDefaultDisplay( elem ) {
+ var temp,
+ doc = elem.ownerDocument,
+ nodeName = elem.nodeName,
+ display = defaultDisplayMap[ nodeName ];
+
+ if ( display ) {
+ return display;
+ }
+
+ temp = doc.body.appendChild( doc.createElement( nodeName ) );
+ display = jQuery.css( temp, "display" );
+
+ temp.parentNode.removeChild( temp );
+
+ if ( display === "none" ) {
+ display = "block";
+ }
+ defaultDisplayMap[ nodeName ] = display;
+
+ return display;
+}
+
+function showHide( elements, show ) {
+ var display, elem,
+ values = [],
+ index = 0,
+ length = elements.length;
+
+ // Determine new display value for elements that need to change
+ for ( ; index < length; index++ ) {
+ elem = elements[ index ];
+ if ( !elem.style ) {
+ continue;
+ }
+
+ display = elem.style.display;
+ if ( show ) {
+
+ // Since we force visibility upon cascade-hidden elements, an immediate (and slow)
+ // check is required in this first loop unless we have a nonempty display value (either
+ // inline or about-to-be-restored)
+ if ( display === "none" ) {
+ values[ index ] = dataPriv.get( elem, "display" ) || null;
+ if ( !values[ index ] ) {
+ elem.style.display = "";
+ }
+ }
+ if ( elem.style.display === "" && isHiddenWithinTree( elem ) ) {
+ values[ index ] = getDefaultDisplay( elem );
+ }
+ } else {
+ if ( display !== "none" ) {
+ values[ index ] = "none";
+
+ // Remember what we're overwriting
+ dataPriv.set( elem, "display", display );
+ }
+ }
+ }
+
+ // Set the display of the elements in a second loop to avoid constant reflow
+ for ( index = 0; index < length; index++ ) {
+ if ( values[ index ] != null ) {
+ elements[ index ].style.display = values[ index ];
+ }
+ }
+
+ return elements;
+}
+
+jQuery.fn.extend( {
+ show: function() {
+ return showHide( this, true );
+ },
+ hide: function() {
+ return showHide( this );
+ },
+ toggle: function( state ) {
+ if ( typeof state === "boolean" ) {
+ return state ? this.show() : this.hide();
+ }
+
+ return this.each( function() {
+ if ( isHiddenWithinTree( this ) ) {
+ jQuery( this ).show();
+ } else {
+ jQuery( this ).hide();
+ }
+ } );
+ }
+} );
+var rcheckableType = ( /^(?:checkbox|radio)$/i );
+
+var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i );
+
+var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i );
+
+
+
+( function() {
+ var fragment = document.createDocumentFragment(),
+ div = fragment.appendChild( document.createElement( "div" ) ),
+ input = document.createElement( "input" );
+
+ // Support: Android 4.0 - 4.3 only
+ // Check state lost if the name is set (#11217)
+ // Support: Windows Web Apps (WWA)
+ // `name` and `type` must use .setAttribute for WWA (#14901)
+ input.setAttribute( "type", "radio" );
+ input.setAttribute( "checked", "checked" );
+ input.setAttribute( "name", "t" );
+
+ div.appendChild( input );
+
+ // Support: Android <=4.1 only
+ // Older WebKit doesn't clone checked state correctly in fragments
+ support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked;
+
+ // Support: IE <=11 only
+ // Make sure textarea (and checkbox) defaultValue is properly cloned
+ div.innerHTML = "";
+ support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue;
+
+ // Support: IE <=9 only
+ // IE <=9 replaces tags with their contents when inserted outside of
+ // the select element.
+ div.innerHTML = " or other required elements.
+ thead: [ 1, "" ],
+ col: [ 2, "" ],
+ tr: [ 2, "" ],
+ td: [ 3, "" ],
+
+ _default: [ 0, "", "" ]
+};
+
+wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead;
+wrapMap.th = wrapMap.td;
+
+// Support: IE <=9 only
+if ( !support.option ) {
+ wrapMap.optgroup = wrapMap.option = [ 1, "", " " ];
+}
+
+
+function getAll( context, tag ) {
+
+ // Support: IE <=9 - 11 only
+ // Use typeof to avoid zero-argument method invocation on host objects (#15151)
+ var ret;
+
+ if ( typeof context.getElementsByTagName !== "undefined" ) {
+ ret = context.getElementsByTagName( tag || "*" );
+
+ } else if ( typeof context.querySelectorAll !== "undefined" ) {
+ ret = context.querySelectorAll( tag || "*" );
+
+ } else {
+ ret = [];
+ }
+
+ if ( tag === undefined || tag && nodeName( context, tag ) ) {
+ return jQuery.merge( [ context ], ret );
+ }
+
+ return ret;
+}
+
+
+// Mark scripts as having already been evaluated
+function setGlobalEval( elems, refElements ) {
+ var i = 0,
+ l = elems.length;
+
+ for ( ; i < l; i++ ) {
+ dataPriv.set(
+ elems[ i ],
+ "globalEval",
+ !refElements || dataPriv.get( refElements[ i ], "globalEval" )
+ );
+ }
+}
+
+
+var rhtml = /<|&#?\w+;/;
+
+function buildFragment( elems, context, scripts, selection, ignored ) {
+ var elem, tmp, tag, wrap, attached, j,
+ fragment = context.createDocumentFragment(),
+ nodes = [],
+ i = 0,
+ l = elems.length;
+
+ for ( ; i < l; i++ ) {
+ elem = elems[ i ];
+
+ if ( elem || elem === 0 ) {
+
+ // Add nodes directly
+ if ( toType( elem ) === "object" ) {
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( nodes, elem.nodeType ? [ elem ] : elem );
+
+ // Convert non-html into a text node
+ } else if ( !rhtml.test( elem ) ) {
+ nodes.push( context.createTextNode( elem ) );
+
+ // Convert html into DOM nodes
+ } else {
+ tmp = tmp || fragment.appendChild( context.createElement( "div" ) );
+
+ // Deserialize a standard representation
+ tag = ( rtagName.exec( elem ) || [ "", "" ] )[ 1 ].toLowerCase();
+ wrap = wrapMap[ tag ] || wrapMap._default;
+ tmp.innerHTML = wrap[ 1 ] + jQuery.htmlPrefilter( elem ) + wrap[ 2 ];
+
+ // Descend through wrappers to the right content
+ j = wrap[ 0 ];
+ while ( j-- ) {
+ tmp = tmp.lastChild;
+ }
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( nodes, tmp.childNodes );
+
+ // Remember the top-level container
+ tmp = fragment.firstChild;
+
+ // Ensure the created nodes are orphaned (#12392)
+ tmp.textContent = "";
+ }
+ }
+ }
+
+ // Remove wrapper from fragment
+ fragment.textContent = "";
+
+ i = 0;
+ while ( ( elem = nodes[ i++ ] ) ) {
+
+ // Skip elements already in the context collection (trac-4087)
+ if ( selection && jQuery.inArray( elem, selection ) > -1 ) {
+ if ( ignored ) {
+ ignored.push( elem );
+ }
+ continue;
+ }
+
+ attached = isAttached( elem );
+
+ // Append to fragment
+ tmp = getAll( fragment.appendChild( elem ), "script" );
+
+ // Preserve script evaluation history
+ if ( attached ) {
+ setGlobalEval( tmp );
+ }
+
+ // Capture executables
+ if ( scripts ) {
+ j = 0;
+ while ( ( elem = tmp[ j++ ] ) ) {
+ if ( rscriptType.test( elem.type || "" ) ) {
+ scripts.push( elem );
+ }
+ }
+ }
+ }
+
+ return fragment;
+}
+
+
+var rtypenamespace = /^([^.]*)(?:\.(.+)|)/;
+
+function returnTrue() {
+ return true;
+}
+
+function returnFalse() {
+ return false;
+}
+
+// Support: IE <=9 - 11+
+// focus() and blur() are asynchronous, except when they are no-op.
+// So expect focus to be synchronous when the element is already active,
+// and blur to be synchronous when the element is not already active.
+// (focus and blur are always synchronous in other supported browsers,
+// this just defines when we can count on it).
+function expectSync( elem, type ) {
+ return ( elem === safeActiveElement() ) === ( type === "focus" );
+}
+
+// Support: IE <=9 only
+// Accessing document.activeElement can throw unexpectedly
+// https://bugs.jquery.com/ticket/13393
+function safeActiveElement() {
+ try {
+ return document.activeElement;
+ } catch ( err ) { }
+}
+
+function on( elem, types, selector, data, fn, one ) {
+ var origFn, type;
+
+ // Types can be a map of types/handlers
+ if ( typeof types === "object" ) {
+
+ // ( types-Object, selector, data )
+ if ( typeof selector !== "string" ) {
+
+ // ( types-Object, data )
+ data = data || selector;
+ selector = undefined;
+ }
+ for ( type in types ) {
+ on( elem, type, selector, data, types[ type ], one );
+ }
+ return elem;
+ }
+
+ if ( data == null && fn == null ) {
+
+ // ( types, fn )
+ fn = selector;
+ data = selector = undefined;
+ } else if ( fn == null ) {
+ if ( typeof selector === "string" ) {
+
+ // ( types, selector, fn )
+ fn = data;
+ data = undefined;
+ } else {
+
+ // ( types, data, fn )
+ fn = data;
+ data = selector;
+ selector = undefined;
+ }
+ }
+ if ( fn === false ) {
+ fn = returnFalse;
+ } else if ( !fn ) {
+ return elem;
+ }
+
+ if ( one === 1 ) {
+ origFn = fn;
+ fn = function( event ) {
+
+ // Can use an empty set, since event contains the info
+ jQuery().off( event );
+ return origFn.apply( this, arguments );
+ };
+
+ // Use same guid so caller can remove using origFn
+ fn.guid = origFn.guid || ( origFn.guid = jQuery.guid++ );
+ }
+ return elem.each( function() {
+ jQuery.event.add( this, types, fn, data, selector );
+ } );
+}
+
+/*
+ * Helper functions for managing events -- not part of the public interface.
+ * Props to Dean Edwards' addEvent library for many of the ideas.
+ */
+jQuery.event = {
+
+ global: {},
+
+ add: function( elem, types, handler, data, selector ) {
+
+ var handleObjIn, eventHandle, tmp,
+ events, t, handleObj,
+ special, handlers, type, namespaces, origType,
+ elemData = dataPriv.get( elem );
+
+ // Only attach events to objects that accept data
+ if ( !acceptData( elem ) ) {
+ return;
+ }
+
+ // Caller can pass in an object of custom data in lieu of the handler
+ if ( handler.handler ) {
+ handleObjIn = handler;
+ handler = handleObjIn.handler;
+ selector = handleObjIn.selector;
+ }
+
+ // Ensure that invalid selectors throw exceptions at attach time
+ // Evaluate against documentElement in case elem is a non-element node (e.g., document)
+ if ( selector ) {
+ jQuery.find.matchesSelector( documentElement, selector );
+ }
+
+ // Make sure that the handler has a unique ID, used to find/remove it later
+ if ( !handler.guid ) {
+ handler.guid = jQuery.guid++;
+ }
+
+ // Init the element's event structure and main handler, if this is the first
+ if ( !( events = elemData.events ) ) {
+ events = elemData.events = Object.create( null );
+ }
+ if ( !( eventHandle = elemData.handle ) ) {
+ eventHandle = elemData.handle = function( e ) {
+
+ // Discard the second event of a jQuery.event.trigger() and
+ // when an event is called after a page has unloaded
+ return typeof jQuery !== "undefined" && jQuery.event.triggered !== e.type ?
+ jQuery.event.dispatch.apply( elem, arguments ) : undefined;
+ };
+ }
+
+ // Handle multiple events separated by a space
+ types = ( types || "" ).match( rnothtmlwhite ) || [ "" ];
+ t = types.length;
+ while ( t-- ) {
+ tmp = rtypenamespace.exec( types[ t ] ) || [];
+ type = origType = tmp[ 1 ];
+ namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort();
+
+ // There *must* be a type, no attaching namespace-only handlers
+ if ( !type ) {
+ continue;
+ }
+
+ // If event changes its type, use the special event handlers for the changed type
+ special = jQuery.event.special[ type ] || {};
+
+ // If selector defined, determine special event api type, otherwise given type
+ type = ( selector ? special.delegateType : special.bindType ) || type;
+
+ // Update special based on newly reset type
+ special = jQuery.event.special[ type ] || {};
+
+ // handleObj is passed to all event handlers
+ handleObj = jQuery.extend( {
+ type: type,
+ origType: origType,
+ data: data,
+ handler: handler,
+ guid: handler.guid,
+ selector: selector,
+ needsContext: selector && jQuery.expr.match.needsContext.test( selector ),
+ namespace: namespaces.join( "." )
+ }, handleObjIn );
+
+ // Init the event handler queue if we're the first
+ if ( !( handlers = events[ type ] ) ) {
+ handlers = events[ type ] = [];
+ handlers.delegateCount = 0;
+
+ // Only use addEventListener if the special events handler returns false
+ if ( !special.setup ||
+ special.setup.call( elem, data, namespaces, eventHandle ) === false ) {
+
+ if ( elem.addEventListener ) {
+ elem.addEventListener( type, eventHandle );
+ }
+ }
+ }
+
+ if ( special.add ) {
+ special.add.call( elem, handleObj );
+
+ if ( !handleObj.handler.guid ) {
+ handleObj.handler.guid = handler.guid;
+ }
+ }
+
+ // Add to the element's handler list, delegates in front
+ if ( selector ) {
+ handlers.splice( handlers.delegateCount++, 0, handleObj );
+ } else {
+ handlers.push( handleObj );
+ }
+
+ // Keep track of which events have ever been used, for event optimization
+ jQuery.event.global[ type ] = true;
+ }
+
+ },
+
+ // Detach an event or set of events from an element
+ remove: function( elem, types, handler, selector, mappedTypes ) {
+
+ var j, origCount, tmp,
+ events, t, handleObj,
+ special, handlers, type, namespaces, origType,
+ elemData = dataPriv.hasData( elem ) && dataPriv.get( elem );
+
+ if ( !elemData || !( events = elemData.events ) ) {
+ return;
+ }
+
+ // Once for each type.namespace in types; type may be omitted
+ types = ( types || "" ).match( rnothtmlwhite ) || [ "" ];
+ t = types.length;
+ while ( t-- ) {
+ tmp = rtypenamespace.exec( types[ t ] ) || [];
+ type = origType = tmp[ 1 ];
+ namespaces = ( tmp[ 2 ] || "" ).split( "." ).sort();
+
+ // Unbind all events (on this namespace, if provided) for the element
+ if ( !type ) {
+ for ( type in events ) {
+ jQuery.event.remove( elem, type + types[ t ], handler, selector, true );
+ }
+ continue;
+ }
+
+ special = jQuery.event.special[ type ] || {};
+ type = ( selector ? special.delegateType : special.bindType ) || type;
+ handlers = events[ type ] || [];
+ tmp = tmp[ 2 ] &&
+ new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" );
+
+ // Remove matching events
+ origCount = j = handlers.length;
+ while ( j-- ) {
+ handleObj = handlers[ j ];
+
+ if ( ( mappedTypes || origType === handleObj.origType ) &&
+ ( !handler || handler.guid === handleObj.guid ) &&
+ ( !tmp || tmp.test( handleObj.namespace ) ) &&
+ ( !selector || selector === handleObj.selector ||
+ selector === "**" && handleObj.selector ) ) {
+ handlers.splice( j, 1 );
+
+ if ( handleObj.selector ) {
+ handlers.delegateCount--;
+ }
+ if ( special.remove ) {
+ special.remove.call( elem, handleObj );
+ }
+ }
+ }
+
+ // Remove generic event handler if we removed something and no more handlers exist
+ // (avoids potential for endless recursion during removal of special event handlers)
+ if ( origCount && !handlers.length ) {
+ if ( !special.teardown ||
+ special.teardown.call( elem, namespaces, elemData.handle ) === false ) {
+
+ jQuery.removeEvent( elem, type, elemData.handle );
+ }
+
+ delete events[ type ];
+ }
+ }
+
+ // Remove data and the expando if it's no longer used
+ if ( jQuery.isEmptyObject( events ) ) {
+ dataPriv.remove( elem, "handle events" );
+ }
+ },
+
+ dispatch: function( nativeEvent ) {
+
+ var i, j, ret, matched, handleObj, handlerQueue,
+ args = new Array( arguments.length ),
+
+ // Make a writable jQuery.Event from the native event object
+ event = jQuery.event.fix( nativeEvent ),
+
+ handlers = (
+ dataPriv.get( this, "events" ) || Object.create( null )
+ )[ event.type ] || [],
+ special = jQuery.event.special[ event.type ] || {};
+
+ // Use the fix-ed jQuery.Event rather than the (read-only) native event
+ args[ 0 ] = event;
+
+ for ( i = 1; i < arguments.length; i++ ) {
+ args[ i ] = arguments[ i ];
+ }
+
+ event.delegateTarget = this;
+
+ // Call the preDispatch hook for the mapped type, and let it bail if desired
+ if ( special.preDispatch && special.preDispatch.call( this, event ) === false ) {
+ return;
+ }
+
+ // Determine handlers
+ handlerQueue = jQuery.event.handlers.call( this, event, handlers );
+
+ // Run delegates first; they may want to stop propagation beneath us
+ i = 0;
+ while ( ( matched = handlerQueue[ i++ ] ) && !event.isPropagationStopped() ) {
+ event.currentTarget = matched.elem;
+
+ j = 0;
+ while ( ( handleObj = matched.handlers[ j++ ] ) &&
+ !event.isImmediatePropagationStopped() ) {
+
+ // If the event is namespaced, then each handler is only invoked if it is
+ // specially universal or its namespaces are a superset of the event's.
+ if ( !event.rnamespace || handleObj.namespace === false ||
+ event.rnamespace.test( handleObj.namespace ) ) {
+
+ event.handleObj = handleObj;
+ event.data = handleObj.data;
+
+ ret = ( ( jQuery.event.special[ handleObj.origType ] || {} ).handle ||
+ handleObj.handler ).apply( matched.elem, args );
+
+ if ( ret !== undefined ) {
+ if ( ( event.result = ret ) === false ) {
+ event.preventDefault();
+ event.stopPropagation();
+ }
+ }
+ }
+ }
+ }
+
+ // Call the postDispatch hook for the mapped type
+ if ( special.postDispatch ) {
+ special.postDispatch.call( this, event );
+ }
+
+ return event.result;
+ },
+
+ handlers: function( event, handlers ) {
+ var i, handleObj, sel, matchedHandlers, matchedSelectors,
+ handlerQueue = [],
+ delegateCount = handlers.delegateCount,
+ cur = event.target;
+
+ // Find delegate handlers
+ if ( delegateCount &&
+
+ // Support: IE <=9
+ // Black-hole SVG instance trees (trac-13180)
+ cur.nodeType &&
+
+ // Support: Firefox <=42
+ // Suppress spec-violating clicks indicating a non-primary pointer button (trac-3861)
+ // https://www.w3.org/TR/DOM-Level-3-Events/#event-type-click
+ // Support: IE 11 only
+ // ...but not arrow key "clicks" of radio inputs, which can have `button` -1 (gh-2343)
+ !( event.type === "click" && event.button >= 1 ) ) {
+
+ for ( ; cur !== this; cur = cur.parentNode || this ) {
+
+ // Don't check non-elements (#13208)
+ // Don't process clicks on disabled elements (#6911, #8165, #11382, #11764)
+ if ( cur.nodeType === 1 && !( event.type === "click" && cur.disabled === true ) ) {
+ matchedHandlers = [];
+ matchedSelectors = {};
+ for ( i = 0; i < delegateCount; i++ ) {
+ handleObj = handlers[ i ];
+
+ // Don't conflict with Object.prototype properties (#13203)
+ sel = handleObj.selector + " ";
+
+ if ( matchedSelectors[ sel ] === undefined ) {
+ matchedSelectors[ sel ] = handleObj.needsContext ?
+ jQuery( sel, this ).index( cur ) > -1 :
+ jQuery.find( sel, this, null, [ cur ] ).length;
+ }
+ if ( matchedSelectors[ sel ] ) {
+ matchedHandlers.push( handleObj );
+ }
+ }
+ if ( matchedHandlers.length ) {
+ handlerQueue.push( { elem: cur, handlers: matchedHandlers } );
+ }
+ }
+ }
+ }
+
+ // Add the remaining (directly-bound) handlers
+ cur = this;
+ if ( delegateCount < handlers.length ) {
+ handlerQueue.push( { elem: cur, handlers: handlers.slice( delegateCount ) } );
+ }
+
+ return handlerQueue;
+ },
+
+ addProp: function( name, hook ) {
+ Object.defineProperty( jQuery.Event.prototype, name, {
+ enumerable: true,
+ configurable: true,
+
+ get: isFunction( hook ) ?
+ function() {
+ if ( this.originalEvent ) {
+ return hook( this.originalEvent );
+ }
+ } :
+ function() {
+ if ( this.originalEvent ) {
+ return this.originalEvent[ name ];
+ }
+ },
+
+ set: function( value ) {
+ Object.defineProperty( this, name, {
+ enumerable: true,
+ configurable: true,
+ writable: true,
+ value: value
+ } );
+ }
+ } );
+ },
+
+ fix: function( originalEvent ) {
+ return originalEvent[ jQuery.expando ] ?
+ originalEvent :
+ new jQuery.Event( originalEvent );
+ },
+
+ special: {
+ load: {
+
+ // Prevent triggered image.load events from bubbling to window.load
+ noBubble: true
+ },
+ click: {
+
+ // Utilize native event to ensure correct state for checkable inputs
+ setup: function( data ) {
+
+ // For mutual compressibility with _default, replace `this` access with a local var.
+ // `|| data` is dead code meant only to preserve the variable through minification.
+ var el = this || data;
+
+ // Claim the first handler
+ if ( rcheckableType.test( el.type ) &&
+ el.click && nodeName( el, "input" ) ) {
+
+ // dataPriv.set( el, "click", ... )
+ leverageNative( el, "click", returnTrue );
+ }
+
+ // Return false to allow normal processing in the caller
+ return false;
+ },
+ trigger: function( data ) {
+
+ // For mutual compressibility with _default, replace `this` access with a local var.
+ // `|| data` is dead code meant only to preserve the variable through minification.
+ var el = this || data;
+
+ // Force setup before triggering a click
+ if ( rcheckableType.test( el.type ) &&
+ el.click && nodeName( el, "input" ) ) {
+
+ leverageNative( el, "click" );
+ }
+
+ // Return non-false to allow normal event-path propagation
+ return true;
+ },
+
+ // For cross-browser consistency, suppress native .click() on links
+ // Also prevent it if we're currently inside a leveraged native-event stack
+ _default: function( event ) {
+ var target = event.target;
+ return rcheckableType.test( target.type ) &&
+ target.click && nodeName( target, "input" ) &&
+ dataPriv.get( target, "click" ) ||
+ nodeName( target, "a" );
+ }
+ },
+
+ beforeunload: {
+ postDispatch: function( event ) {
+
+ // Support: Firefox 20+
+ // Firefox doesn't alert if the returnValue field is not set.
+ if ( event.result !== undefined && event.originalEvent ) {
+ event.originalEvent.returnValue = event.result;
+ }
+ }
+ }
+ }
+};
+
+// Ensure the presence of an event listener that handles manually-triggered
+// synthetic events by interrupting progress until reinvoked in response to
+// *native* events that it fires directly, ensuring that state changes have
+// already occurred before other listeners are invoked.
+function leverageNative( el, type, expectSync ) {
+
+ // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add
+ if ( !expectSync ) {
+ if ( dataPriv.get( el, type ) === undefined ) {
+ jQuery.event.add( el, type, returnTrue );
+ }
+ return;
+ }
+
+ // Register the controller as a special universal handler for all event namespaces
+ dataPriv.set( el, type, false );
+ jQuery.event.add( el, type, {
+ namespace: false,
+ handler: function( event ) {
+ var notAsync, result,
+ saved = dataPriv.get( this, type );
+
+ if ( ( event.isTrigger & 1 ) && this[ type ] ) {
+
+ // Interrupt processing of the outer synthetic .trigger()ed event
+ // Saved data should be false in such cases, but might be a leftover capture object
+ // from an async native handler (gh-4350)
+ if ( !saved.length ) {
+
+ // Store arguments for use when handling the inner native event
+ // There will always be at least one argument (an event object), so this array
+ // will not be confused with a leftover capture object.
+ saved = slice.call( arguments );
+ dataPriv.set( this, type, saved );
+
+ // Trigger the native event and capture its result
+ // Support: IE <=9 - 11+
+ // focus() and blur() are asynchronous
+ notAsync = expectSync( this, type );
+ this[ type ]();
+ result = dataPriv.get( this, type );
+ if ( saved !== result || notAsync ) {
+ dataPriv.set( this, type, false );
+ } else {
+ result = {};
+ }
+ if ( saved !== result ) {
+
+ // Cancel the outer synthetic event
+ event.stopImmediatePropagation();
+ event.preventDefault();
+
+ // Support: Chrome 86+
+ // In Chrome, if an element having a focusout handler is blurred by
+ // clicking outside of it, it invokes the handler synchronously. If
+ // that handler calls `.remove()` on the element, the data is cleared,
+ // leaving `result` undefined. We need to guard against this.
+ return result && result.value;
+ }
+
+ // If this is an inner synthetic event for an event with a bubbling surrogate
+ // (focus or blur), assume that the surrogate already propagated from triggering the
+ // native event and prevent that from happening again here.
+ // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the
+ // bubbling surrogate propagates *after* the non-bubbling base), but that seems
+ // less bad than duplication.
+ } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) {
+ event.stopPropagation();
+ }
+
+ // If this is a native event triggered above, everything is now in order
+ // Fire an inner synthetic event with the original arguments
+ } else if ( saved.length ) {
+
+ // ...and capture the result
+ dataPriv.set( this, type, {
+ value: jQuery.event.trigger(
+
+ // Support: IE <=9 - 11+
+ // Extend with the prototype to reset the above stopImmediatePropagation()
+ jQuery.extend( saved[ 0 ], jQuery.Event.prototype ),
+ saved.slice( 1 ),
+ this
+ )
+ } );
+
+ // Abort handling of the native event
+ event.stopImmediatePropagation();
+ }
+ }
+ } );
+}
+
+jQuery.removeEvent = function( elem, type, handle ) {
+
+ // This "if" is needed for plain objects
+ if ( elem.removeEventListener ) {
+ elem.removeEventListener( type, handle );
+ }
+};
+
+jQuery.Event = function( src, props ) {
+
+ // Allow instantiation without the 'new' keyword
+ if ( !( this instanceof jQuery.Event ) ) {
+ return new jQuery.Event( src, props );
+ }
+
+ // Event object
+ if ( src && src.type ) {
+ this.originalEvent = src;
+ this.type = src.type;
+
+ // Events bubbling up the document may have been marked as prevented
+ // by a handler lower down the tree; reflect the correct value.
+ this.isDefaultPrevented = src.defaultPrevented ||
+ src.defaultPrevented === undefined &&
+
+ // Support: Android <=2.3 only
+ src.returnValue === false ?
+ returnTrue :
+ returnFalse;
+
+ // Create target properties
+ // Support: Safari <=6 - 7 only
+ // Target should not be a text node (#504, #13143)
+ this.target = ( src.target && src.target.nodeType === 3 ) ?
+ src.target.parentNode :
+ src.target;
+
+ this.currentTarget = src.currentTarget;
+ this.relatedTarget = src.relatedTarget;
+
+ // Event type
+ } else {
+ this.type = src;
+ }
+
+ // Put explicitly provided properties onto the event object
+ if ( props ) {
+ jQuery.extend( this, props );
+ }
+
+ // Create a timestamp if incoming event doesn't have one
+ this.timeStamp = src && src.timeStamp || Date.now();
+
+ // Mark it as fixed
+ this[ jQuery.expando ] = true;
+};
+
+// jQuery.Event is based on DOM3 Events as specified by the ECMAScript Language Binding
+// https://www.w3.org/TR/2003/WD-DOM-Level-3-Events-20030331/ecma-script-binding.html
+jQuery.Event.prototype = {
+ constructor: jQuery.Event,
+ isDefaultPrevented: returnFalse,
+ isPropagationStopped: returnFalse,
+ isImmediatePropagationStopped: returnFalse,
+ isSimulated: false,
+
+ preventDefault: function() {
+ var e = this.originalEvent;
+
+ this.isDefaultPrevented = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.preventDefault();
+ }
+ },
+ stopPropagation: function() {
+ var e = this.originalEvent;
+
+ this.isPropagationStopped = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.stopPropagation();
+ }
+ },
+ stopImmediatePropagation: function() {
+ var e = this.originalEvent;
+
+ this.isImmediatePropagationStopped = returnTrue;
+
+ if ( e && !this.isSimulated ) {
+ e.stopImmediatePropagation();
+ }
+
+ this.stopPropagation();
+ }
+};
+
+// Includes all common event props including KeyEvent and MouseEvent specific props
+jQuery.each( {
+ altKey: true,
+ bubbles: true,
+ cancelable: true,
+ changedTouches: true,
+ ctrlKey: true,
+ detail: true,
+ eventPhase: true,
+ metaKey: true,
+ pageX: true,
+ pageY: true,
+ shiftKey: true,
+ view: true,
+ "char": true,
+ code: true,
+ charCode: true,
+ key: true,
+ keyCode: true,
+ button: true,
+ buttons: true,
+ clientX: true,
+ clientY: true,
+ offsetX: true,
+ offsetY: true,
+ pointerId: true,
+ pointerType: true,
+ screenX: true,
+ screenY: true,
+ targetTouches: true,
+ toElement: true,
+ touches: true,
+ which: true
+}, jQuery.event.addProp );
+
+jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) {
+ jQuery.event.special[ type ] = {
+
+ // Utilize native event if possible so blur/focus sequence is correct
+ setup: function() {
+
+ // Claim the first handler
+ // dataPriv.set( this, "focus", ... )
+ // dataPriv.set( this, "blur", ... )
+ leverageNative( this, type, expectSync );
+
+ // Return false to allow normal processing in the caller
+ return false;
+ },
+ trigger: function() {
+
+ // Force setup before trigger
+ leverageNative( this, type );
+
+ // Return non-false to allow normal event-path propagation
+ return true;
+ },
+
+ // Suppress native focus or blur as it's already being fired
+ // in leverageNative.
+ _default: function() {
+ return true;
+ },
+
+ delegateType: delegateType
+ };
+} );
+
+// Create mouseenter/leave events using mouseover/out and event-time checks
+// so that event delegation works in jQuery.
+// Do the same for pointerenter/pointerleave and pointerover/pointerout
+//
+// Support: Safari 7 only
+// Safari sends mouseenter too often; see:
+// https://bugs.chromium.org/p/chromium/issues/detail?id=470258
+// for the description of the bug (it existed in older Chrome versions as well).
+jQuery.each( {
+ mouseenter: "mouseover",
+ mouseleave: "mouseout",
+ pointerenter: "pointerover",
+ pointerleave: "pointerout"
+}, function( orig, fix ) {
+ jQuery.event.special[ orig ] = {
+ delegateType: fix,
+ bindType: fix,
+
+ handle: function( event ) {
+ var ret,
+ target = this,
+ related = event.relatedTarget,
+ handleObj = event.handleObj;
+
+ // For mouseenter/leave call the handler if related is outside the target.
+ // NB: No relatedTarget if the mouse left/entered the browser window
+ if ( !related || ( related !== target && !jQuery.contains( target, related ) ) ) {
+ event.type = handleObj.origType;
+ ret = handleObj.handler.apply( this, arguments );
+ event.type = fix;
+ }
+ return ret;
+ }
+ };
+} );
+
+jQuery.fn.extend( {
+
+ on: function( types, selector, data, fn ) {
+ return on( this, types, selector, data, fn );
+ },
+ one: function( types, selector, data, fn ) {
+ return on( this, types, selector, data, fn, 1 );
+ },
+ off: function( types, selector, fn ) {
+ var handleObj, type;
+ if ( types && types.preventDefault && types.handleObj ) {
+
+ // ( event ) dispatched jQuery.Event
+ handleObj = types.handleObj;
+ jQuery( types.delegateTarget ).off(
+ handleObj.namespace ?
+ handleObj.origType + "." + handleObj.namespace :
+ handleObj.origType,
+ handleObj.selector,
+ handleObj.handler
+ );
+ return this;
+ }
+ if ( typeof types === "object" ) {
+
+ // ( types-object [, selector] )
+ for ( type in types ) {
+ this.off( type, selector, types[ type ] );
+ }
+ return this;
+ }
+ if ( selector === false || typeof selector === "function" ) {
+
+ // ( types [, fn] )
+ fn = selector;
+ selector = undefined;
+ }
+ if ( fn === false ) {
+ fn = returnFalse;
+ }
+ return this.each( function() {
+ jQuery.event.remove( this, types, fn, selector );
+ } );
+ }
+} );
+
+
+var
+
+ // Support: IE <=10 - 11, Edge 12 - 13 only
+ // In IE/Edge using regex groups here causes severe slowdowns.
+ // See https://connect.microsoft.com/IE/feedback/details/1736512/
+ rnoInnerhtml = /\s*$/g;
+
+// Prefer a tbody over its parent table for containing new rows
+function manipulationTarget( elem, content ) {
+ if ( nodeName( elem, "table" ) &&
+ nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) {
+
+ return jQuery( elem ).children( "tbody" )[ 0 ] || elem;
+ }
+
+ return elem;
+}
+
+// Replace/restore the type attribute of script elements for safe DOM manipulation
+function disableScript( elem ) {
+ elem.type = ( elem.getAttribute( "type" ) !== null ) + "/" + elem.type;
+ return elem;
+}
+function restoreScript( elem ) {
+ if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) {
+ elem.type = elem.type.slice( 5 );
+ } else {
+ elem.removeAttribute( "type" );
+ }
+
+ return elem;
+}
+
+function cloneCopyEvent( src, dest ) {
+ var i, l, type, pdataOld, udataOld, udataCur, events;
+
+ if ( dest.nodeType !== 1 ) {
+ return;
+ }
+
+ // 1. Copy private data: events, handlers, etc.
+ if ( dataPriv.hasData( src ) ) {
+ pdataOld = dataPriv.get( src );
+ events = pdataOld.events;
+
+ if ( events ) {
+ dataPriv.remove( dest, "handle events" );
+
+ for ( type in events ) {
+ for ( i = 0, l = events[ type ].length; i < l; i++ ) {
+ jQuery.event.add( dest, type, events[ type ][ i ] );
+ }
+ }
+ }
+ }
+
+ // 2. Copy user data
+ if ( dataUser.hasData( src ) ) {
+ udataOld = dataUser.access( src );
+ udataCur = jQuery.extend( {}, udataOld );
+
+ dataUser.set( dest, udataCur );
+ }
+}
+
+// Fix IE bugs, see support tests
+function fixInput( src, dest ) {
+ var nodeName = dest.nodeName.toLowerCase();
+
+ // Fails to persist the checked state of a cloned checkbox or radio button.
+ if ( nodeName === "input" && rcheckableType.test( src.type ) ) {
+ dest.checked = src.checked;
+
+ // Fails to return the selected option to the default selected state when cloning options
+ } else if ( nodeName === "input" || nodeName === "textarea" ) {
+ dest.defaultValue = src.defaultValue;
+ }
+}
+
+function domManip( collection, args, callback, ignored ) {
+
+ // Flatten any nested arrays
+ args = flat( args );
+
+ var fragment, first, scripts, hasScripts, node, doc,
+ i = 0,
+ l = collection.length,
+ iNoClone = l - 1,
+ value = args[ 0 ],
+ valueIsFunction = isFunction( value );
+
+ // We can't cloneNode fragments that contain checked, in WebKit
+ if ( valueIsFunction ||
+ ( l > 1 && typeof value === "string" &&
+ !support.checkClone && rchecked.test( value ) ) ) {
+ return collection.each( function( index ) {
+ var self = collection.eq( index );
+ if ( valueIsFunction ) {
+ args[ 0 ] = value.call( this, index, self.html() );
+ }
+ domManip( self, args, callback, ignored );
+ } );
+ }
+
+ if ( l ) {
+ fragment = buildFragment( args, collection[ 0 ].ownerDocument, false, collection, ignored );
+ first = fragment.firstChild;
+
+ if ( fragment.childNodes.length === 1 ) {
+ fragment = first;
+ }
+
+ // Require either new content or an interest in ignored elements to invoke the callback
+ if ( first || ignored ) {
+ scripts = jQuery.map( getAll( fragment, "script" ), disableScript );
+ hasScripts = scripts.length;
+
+ // Use the original fragment for the last item
+ // instead of the first because it can end up
+ // being emptied incorrectly in certain situations (#8070).
+ for ( ; i < l; i++ ) {
+ node = fragment;
+
+ if ( i !== iNoClone ) {
+ node = jQuery.clone( node, true, true );
+
+ // Keep references to cloned scripts for later restoration
+ if ( hasScripts ) {
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // push.apply(_, arraylike) throws on ancient WebKit
+ jQuery.merge( scripts, getAll( node, "script" ) );
+ }
+ }
+
+ callback.call( collection[ i ], node, i );
+ }
+
+ if ( hasScripts ) {
+ doc = scripts[ scripts.length - 1 ].ownerDocument;
+
+ // Reenable scripts
+ jQuery.map( scripts, restoreScript );
+
+ // Evaluate executable scripts on first document insertion
+ for ( i = 0; i < hasScripts; i++ ) {
+ node = scripts[ i ];
+ if ( rscriptType.test( node.type || "" ) &&
+ !dataPriv.access( node, "globalEval" ) &&
+ jQuery.contains( doc, node ) ) {
+
+ if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) {
+
+ // Optional AJAX dependency, but won't run scripts if not present
+ if ( jQuery._evalUrl && !node.noModule ) {
+ jQuery._evalUrl( node.src, {
+ nonce: node.nonce || node.getAttribute( "nonce" )
+ }, doc );
+ }
+ } else {
+ DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc );
+ }
+ }
+ }
+ }
+ }
+ }
+
+ return collection;
+}
+
+function remove( elem, selector, keepData ) {
+ var node,
+ nodes = selector ? jQuery.filter( selector, elem ) : elem,
+ i = 0;
+
+ for ( ; ( node = nodes[ i ] ) != null; i++ ) {
+ if ( !keepData && node.nodeType === 1 ) {
+ jQuery.cleanData( getAll( node ) );
+ }
+
+ if ( node.parentNode ) {
+ if ( keepData && isAttached( node ) ) {
+ setGlobalEval( getAll( node, "script" ) );
+ }
+ node.parentNode.removeChild( node );
+ }
+ }
+
+ return elem;
+}
+
+jQuery.extend( {
+ htmlPrefilter: function( html ) {
+ return html;
+ },
+
+ clone: function( elem, dataAndEvents, deepDataAndEvents ) {
+ var i, l, srcElements, destElements,
+ clone = elem.cloneNode( true ),
+ inPage = isAttached( elem );
+
+ // Fix IE cloning issues
+ if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) &&
+ !jQuery.isXMLDoc( elem ) ) {
+
+ // We eschew Sizzle here for performance reasons: https://jsperf.com/getall-vs-sizzle/2
+ destElements = getAll( clone );
+ srcElements = getAll( elem );
+
+ for ( i = 0, l = srcElements.length; i < l; i++ ) {
+ fixInput( srcElements[ i ], destElements[ i ] );
+ }
+ }
+
+ // Copy the events from the original to the clone
+ if ( dataAndEvents ) {
+ if ( deepDataAndEvents ) {
+ srcElements = srcElements || getAll( elem );
+ destElements = destElements || getAll( clone );
+
+ for ( i = 0, l = srcElements.length; i < l; i++ ) {
+ cloneCopyEvent( srcElements[ i ], destElements[ i ] );
+ }
+ } else {
+ cloneCopyEvent( elem, clone );
+ }
+ }
+
+ // Preserve script evaluation history
+ destElements = getAll( clone, "script" );
+ if ( destElements.length > 0 ) {
+ setGlobalEval( destElements, !inPage && getAll( elem, "script" ) );
+ }
+
+ // Return the cloned set
+ return clone;
+ },
+
+ cleanData: function( elems ) {
+ var data, elem, type,
+ special = jQuery.event.special,
+ i = 0;
+
+ for ( ; ( elem = elems[ i ] ) !== undefined; i++ ) {
+ if ( acceptData( elem ) ) {
+ if ( ( data = elem[ dataPriv.expando ] ) ) {
+ if ( data.events ) {
+ for ( type in data.events ) {
+ if ( special[ type ] ) {
+ jQuery.event.remove( elem, type );
+
+ // This is a shortcut to avoid jQuery.event.remove's overhead
+ } else {
+ jQuery.removeEvent( elem, type, data.handle );
+ }
+ }
+ }
+
+ // Support: Chrome <=35 - 45+
+ // Assign undefined instead of using delete, see Data#remove
+ elem[ dataPriv.expando ] = undefined;
+ }
+ if ( elem[ dataUser.expando ] ) {
+
+ // Support: Chrome <=35 - 45+
+ // Assign undefined instead of using delete, see Data#remove
+ elem[ dataUser.expando ] = undefined;
+ }
+ }
+ }
+ }
+} );
+
+jQuery.fn.extend( {
+ detach: function( selector ) {
+ return remove( this, selector, true );
+ },
+
+ remove: function( selector ) {
+ return remove( this, selector );
+ },
+
+ text: function( value ) {
+ return access( this, function( value ) {
+ return value === undefined ?
+ jQuery.text( this ) :
+ this.empty().each( function() {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ this.textContent = value;
+ }
+ } );
+ }, null, value, arguments.length );
+ },
+
+ append: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ var target = manipulationTarget( this, elem );
+ target.appendChild( elem );
+ }
+ } );
+ },
+
+ prepend: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.nodeType === 1 || this.nodeType === 11 || this.nodeType === 9 ) {
+ var target = manipulationTarget( this, elem );
+ target.insertBefore( elem, target.firstChild );
+ }
+ } );
+ },
+
+ before: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.parentNode ) {
+ this.parentNode.insertBefore( elem, this );
+ }
+ } );
+ },
+
+ after: function() {
+ return domManip( this, arguments, function( elem ) {
+ if ( this.parentNode ) {
+ this.parentNode.insertBefore( elem, this.nextSibling );
+ }
+ } );
+ },
+
+ empty: function() {
+ var elem,
+ i = 0;
+
+ for ( ; ( elem = this[ i ] ) != null; i++ ) {
+ if ( elem.nodeType === 1 ) {
+
+ // Prevent memory leaks
+ jQuery.cleanData( getAll( elem, false ) );
+
+ // Remove any remaining nodes
+ elem.textContent = "";
+ }
+ }
+
+ return this;
+ },
+
+ clone: function( dataAndEvents, deepDataAndEvents ) {
+ dataAndEvents = dataAndEvents == null ? false : dataAndEvents;
+ deepDataAndEvents = deepDataAndEvents == null ? dataAndEvents : deepDataAndEvents;
+
+ return this.map( function() {
+ return jQuery.clone( this, dataAndEvents, deepDataAndEvents );
+ } );
+ },
+
+ html: function( value ) {
+ return access( this, function( value ) {
+ var elem = this[ 0 ] || {},
+ i = 0,
+ l = this.length;
+
+ if ( value === undefined && elem.nodeType === 1 ) {
+ return elem.innerHTML;
+ }
+
+ // See if we can take a shortcut and just use innerHTML
+ if ( typeof value === "string" && !rnoInnerhtml.test( value ) &&
+ !wrapMap[ ( rtagName.exec( value ) || [ "", "" ] )[ 1 ].toLowerCase() ] ) {
+
+ value = jQuery.htmlPrefilter( value );
+
+ try {
+ for ( ; i < l; i++ ) {
+ elem = this[ i ] || {};
+
+ // Remove element nodes and prevent memory leaks
+ if ( elem.nodeType === 1 ) {
+ jQuery.cleanData( getAll( elem, false ) );
+ elem.innerHTML = value;
+ }
+ }
+
+ elem = 0;
+
+ // If using innerHTML throws an exception, use the fallback method
+ } catch ( e ) {}
+ }
+
+ if ( elem ) {
+ this.empty().append( value );
+ }
+ }, null, value, arguments.length );
+ },
+
+ replaceWith: function() {
+ var ignored = [];
+
+ // Make the changes, replacing each non-ignored context element with the new content
+ return domManip( this, arguments, function( elem ) {
+ var parent = this.parentNode;
+
+ if ( jQuery.inArray( this, ignored ) < 0 ) {
+ jQuery.cleanData( getAll( this ) );
+ if ( parent ) {
+ parent.replaceChild( elem, this );
+ }
+ }
+
+ // Force callback invocation
+ }, ignored );
+ }
+} );
+
+jQuery.each( {
+ appendTo: "append",
+ prependTo: "prepend",
+ insertBefore: "before",
+ insertAfter: "after",
+ replaceAll: "replaceWith"
+}, function( name, original ) {
+ jQuery.fn[ name ] = function( selector ) {
+ var elems,
+ ret = [],
+ insert = jQuery( selector ),
+ last = insert.length - 1,
+ i = 0;
+
+ for ( ; i <= last; i++ ) {
+ elems = i === last ? this : this.clone( true );
+ jQuery( insert[ i ] )[ original ]( elems );
+
+ // Support: Android <=4.0 only, PhantomJS 1 only
+ // .get() because push.apply(_, arraylike) throws on ancient WebKit
+ push.apply( ret, elems.get() );
+ }
+
+ return this.pushStack( ret );
+ };
+} );
+var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" );
+
+var getStyles = function( elem ) {
+
+ // Support: IE <=11 only, Firefox <=30 (#15098, #14150)
+ // IE throws on elements created in popups
+ // FF meanwhile throws on frame elements through "defaultView.getComputedStyle"
+ var view = elem.ownerDocument.defaultView;
+
+ if ( !view || !view.opener ) {
+ view = window;
+ }
+
+ return view.getComputedStyle( elem );
+ };
+
+var swap = function( elem, options, callback ) {
+ var ret, name,
+ old = {};
+
+ // Remember the old values, and insert the new ones
+ for ( name in options ) {
+ old[ name ] = elem.style[ name ];
+ elem.style[ name ] = options[ name ];
+ }
+
+ ret = callback.call( elem );
+
+ // Revert the old values
+ for ( name in options ) {
+ elem.style[ name ] = old[ name ];
+ }
+
+ return ret;
+};
+
+
+var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" );
+
+
+
+( function() {
+
+ // Executing both pixelPosition & boxSizingReliable tests require only one layout
+ // so they're executed at the same time to save the second computation.
+ function computeStyleTests() {
+
+ // This is a singleton, we need to execute it only once
+ if ( !div ) {
+ return;
+ }
+
+ container.style.cssText = "position:absolute;left:-11111px;width:60px;" +
+ "margin-top:1px;padding:0;border:0";
+ div.style.cssText =
+ "position:relative;display:block;box-sizing:border-box;overflow:scroll;" +
+ "margin:auto;border:1px;padding:1px;" +
+ "width:60%;top:1%";
+ documentElement.appendChild( container ).appendChild( div );
+
+ var divStyle = window.getComputedStyle( div );
+ pixelPositionVal = divStyle.top !== "1%";
+
+ // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44
+ reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12;
+
+ // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3
+ // Some styles come back with percentage values, even though they shouldn't
+ div.style.right = "60%";
+ pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36;
+
+ // Support: IE 9 - 11 only
+ // Detect misreporting of content dimensions for box-sizing:border-box elements
+ boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36;
+
+ // Support: IE 9 only
+ // Detect overflow:scroll screwiness (gh-3699)
+ // Support: Chrome <=64
+ // Don't get tricked when zoom affects offsetWidth (gh-4029)
+ div.style.position = "absolute";
+ scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12;
+
+ documentElement.removeChild( container );
+
+ // Nullify the div so it wouldn't be stored in the memory and
+ // it will also be a sign that checks already performed
+ div = null;
+ }
+
+ function roundPixelMeasures( measure ) {
+ return Math.round( parseFloat( measure ) );
+ }
+
+ var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal,
+ reliableTrDimensionsVal, reliableMarginLeftVal,
+ container = document.createElement( "div" ),
+ div = document.createElement( "div" );
+
+ // Finish early in limited (non-browser) environments
+ if ( !div.style ) {
+ return;
+ }
+
+ // Support: IE <=9 - 11 only
+ // Style of cloned element affects source element cloned (#8908)
+ div.style.backgroundClip = "content-box";
+ div.cloneNode( true ).style.backgroundClip = "";
+ support.clearCloneStyle = div.style.backgroundClip === "content-box";
+
+ jQuery.extend( support, {
+ boxSizingReliable: function() {
+ computeStyleTests();
+ return boxSizingReliableVal;
+ },
+ pixelBoxStyles: function() {
+ computeStyleTests();
+ return pixelBoxStylesVal;
+ },
+ pixelPosition: function() {
+ computeStyleTests();
+ return pixelPositionVal;
+ },
+ reliableMarginLeft: function() {
+ computeStyleTests();
+ return reliableMarginLeftVal;
+ },
+ scrollboxSize: function() {
+ computeStyleTests();
+ return scrollboxSizeVal;
+ },
+
+ // Support: IE 9 - 11+, Edge 15 - 18+
+ // IE/Edge misreport `getComputedStyle` of table rows with width/height
+ // set in CSS while `offset*` properties report correct values.
+ // Behavior in IE 9 is more subtle than in newer versions & it passes
+ // some versions of this test; make sure not to make it pass there!
+ //
+ // Support: Firefox 70+
+ // Only Firefox includes border widths
+ // in computed dimensions. (gh-4529)
+ reliableTrDimensions: function() {
+ var table, tr, trChild, trStyle;
+ if ( reliableTrDimensionsVal == null ) {
+ table = document.createElement( "table" );
+ tr = document.createElement( "tr" );
+ trChild = document.createElement( "div" );
+
+ table.style.cssText = "position:absolute;left:-11111px;border-collapse:separate";
+ tr.style.cssText = "border:1px solid";
+
+ // Support: Chrome 86+
+ // Height set through cssText does not get applied.
+ // Computed height then comes back as 0.
+ tr.style.height = "1px";
+ trChild.style.height = "9px";
+
+ // Support: Android 8 Chrome 86+
+ // In our bodyBackground.html iframe,
+ // display for all div elements is set to "inline",
+ // which causes a problem only in Android 8 Chrome 86.
+ // Ensuring the div is display: block
+ // gets around this issue.
+ trChild.style.display = "block";
+
+ documentElement
+ .appendChild( table )
+ .appendChild( tr )
+ .appendChild( trChild );
+
+ trStyle = window.getComputedStyle( tr );
+ reliableTrDimensionsVal = ( parseInt( trStyle.height, 10 ) +
+ parseInt( trStyle.borderTopWidth, 10 ) +
+ parseInt( trStyle.borderBottomWidth, 10 ) ) === tr.offsetHeight;
+
+ documentElement.removeChild( table );
+ }
+ return reliableTrDimensionsVal;
+ }
+ } );
+} )();
+
+
+function curCSS( elem, name, computed ) {
+ var width, minWidth, maxWidth, ret,
+
+ // Support: Firefox 51+
+ // Retrieving style before computed somehow
+ // fixes an issue with getting wrong values
+ // on detached elements
+ style = elem.style;
+
+ computed = computed || getStyles( elem );
+
+ // getPropertyValue is needed for:
+ // .css('filter') (IE 9 only, #12537)
+ // .css('--customProperty) (#3144)
+ if ( computed ) {
+ ret = computed.getPropertyValue( name ) || computed[ name ];
+
+ if ( ret === "" && !isAttached( elem ) ) {
+ ret = jQuery.style( elem, name );
+ }
+
+ // A tribute to the "awesome hack by Dean Edwards"
+ // Android Browser returns percentage for some values,
+ // but width seems to be reliably pixels.
+ // This is against the CSSOM draft spec:
+ // https://drafts.csswg.org/cssom/#resolved-values
+ if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) {
+
+ // Remember the original values
+ width = style.width;
+ minWidth = style.minWidth;
+ maxWidth = style.maxWidth;
+
+ // Put in the new values to get a computed value out
+ style.minWidth = style.maxWidth = style.width = ret;
+ ret = computed.width;
+
+ // Revert the changed values
+ style.width = width;
+ style.minWidth = minWidth;
+ style.maxWidth = maxWidth;
+ }
+ }
+
+ return ret !== undefined ?
+
+ // Support: IE <=9 - 11 only
+ // IE returns zIndex value as an integer.
+ ret + "" :
+ ret;
+}
+
+
+function addGetHookIf( conditionFn, hookFn ) {
+
+ // Define the hook, we'll check on the first run if it's really needed.
+ return {
+ get: function() {
+ if ( conditionFn() ) {
+
+ // Hook not needed (or it's not possible to use it due
+ // to missing dependency), remove it.
+ delete this.get;
+ return;
+ }
+
+ // Hook needed; redefine it so that the support test is not executed again.
+ return ( this.get = hookFn ).apply( this, arguments );
+ }
+ };
+}
+
+
+var cssPrefixes = [ "Webkit", "Moz", "ms" ],
+ emptyStyle = document.createElement( "div" ).style,
+ vendorProps = {};
+
+// Return a vendor-prefixed property or undefined
+function vendorPropName( name ) {
+
+ // Check for vendor prefixed names
+ var capName = name[ 0 ].toUpperCase() + name.slice( 1 ),
+ i = cssPrefixes.length;
+
+ while ( i-- ) {
+ name = cssPrefixes[ i ] + capName;
+ if ( name in emptyStyle ) {
+ return name;
+ }
+ }
+}
+
+// Return a potentially-mapped jQuery.cssProps or vendor prefixed property
+function finalPropName( name ) {
+ var final = jQuery.cssProps[ name ] || vendorProps[ name ];
+
+ if ( final ) {
+ return final;
+ }
+ if ( name in emptyStyle ) {
+ return name;
+ }
+ return vendorProps[ name ] = vendorPropName( name ) || name;
+}
+
+
+var
+
+ // Swappable if display is none or starts with table
+ // except "table", "table-cell", or "table-caption"
+ // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display
+ rdisplayswap = /^(none|table(?!-c[ea]).+)/,
+ rcustomProp = /^--/,
+ cssShow = { position: "absolute", visibility: "hidden", display: "block" },
+ cssNormalTransform = {
+ letterSpacing: "0",
+ fontWeight: "400"
+ };
+
+function setPositiveNumber( _elem, value, subtract ) {
+
+ // Any relative (+/-) values have already been
+ // normalized at this point
+ var matches = rcssNum.exec( value );
+ return matches ?
+
+ // Guard against undefined "subtract", e.g., when used as in cssHooks
+ Math.max( 0, matches[ 2 ] - ( subtract || 0 ) ) + ( matches[ 3 ] || "px" ) :
+ value;
+}
+
+function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) {
+ var i = dimension === "width" ? 1 : 0,
+ extra = 0,
+ delta = 0;
+
+ // Adjustment may not be necessary
+ if ( box === ( isBorderBox ? "border" : "content" ) ) {
+ return 0;
+ }
+
+ for ( ; i < 4; i += 2 ) {
+
+ // Both box models exclude margin
+ if ( box === "margin" ) {
+ delta += jQuery.css( elem, box + cssExpand[ i ], true, styles );
+ }
+
+ // If we get here with a content-box, we're seeking "padding" or "border" or "margin"
+ if ( !isBorderBox ) {
+
+ // Add padding
+ delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles );
+
+ // For "border" or "margin", add border
+ if ( box !== "padding" ) {
+ delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
+
+ // But still keep track of it otherwise
+ } else {
+ extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
+ }
+
+ // If we get here with a border-box (content + padding + border), we're seeking "content" or
+ // "padding" or "margin"
+ } else {
+
+ // For "content", subtract padding
+ if ( box === "content" ) {
+ delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles );
+ }
+
+ // For "content" or "padding", subtract border
+ if ( box !== "margin" ) {
+ delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles );
+ }
+ }
+ }
+
+ // Account for positive content-box scroll gutter when requested by providing computedVal
+ if ( !isBorderBox && computedVal >= 0 ) {
+
+ // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border
+ // Assuming integer scroll gutter, subtract the rest and round down
+ delta += Math.max( 0, Math.ceil(
+ elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] -
+ computedVal -
+ delta -
+ extra -
+ 0.5
+
+ // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter
+ // Use an explicit zero to avoid NaN (gh-3964)
+ ) ) || 0;
+ }
+
+ return delta;
+}
+
+function getWidthOrHeight( elem, dimension, extra ) {
+
+ // Start with computed style
+ var styles = getStyles( elem ),
+
+ // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322).
+ // Fake content-box until we know it's needed to know the true value.
+ boxSizingNeeded = !support.boxSizingReliable() || extra,
+ isBorderBox = boxSizingNeeded &&
+ jQuery.css( elem, "boxSizing", false, styles ) === "border-box",
+ valueIsBorderBox = isBorderBox,
+
+ val = curCSS( elem, dimension, styles ),
+ offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 );
+
+ // Support: Firefox <=54
+ // Return a confounding non-pixel value or feign ignorance, as appropriate.
+ if ( rnumnonpx.test( val ) ) {
+ if ( !extra ) {
+ return val;
+ }
+ val = "auto";
+ }
+
+
+ // Support: IE 9 - 11 only
+ // Use offsetWidth/offsetHeight for when box sizing is unreliable.
+ // In those cases, the computed value can be trusted to be border-box.
+ if ( ( !support.boxSizingReliable() && isBorderBox ||
+
+ // Support: IE 10 - 11+, Edge 15 - 18+
+ // IE/Edge misreport `getComputedStyle` of table rows with width/height
+ // set in CSS while `offset*` properties report correct values.
+ // Interestingly, in some cases IE 9 doesn't suffer from this issue.
+ !support.reliableTrDimensions() && nodeName( elem, "tr" ) ||
+
+ // Fall back to offsetWidth/offsetHeight when value is "auto"
+ // This happens for inline elements with no explicit setting (gh-3571)
+ val === "auto" ||
+
+ // Support: Android <=4.1 - 4.3 only
+ // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602)
+ !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) &&
+
+ // Make sure the element is visible & connected
+ elem.getClientRects().length ) {
+
+ isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box";
+
+ // Where available, offsetWidth/offsetHeight approximate border box dimensions.
+ // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the
+ // retrieved value as a content box dimension.
+ valueIsBorderBox = offsetProp in elem;
+ if ( valueIsBorderBox ) {
+ val = elem[ offsetProp ];
+ }
+ }
+
+ // Normalize "" and auto
+ val = parseFloat( val ) || 0;
+
+ // Adjust for the element's box model
+ return ( val +
+ boxModelAdjustment(
+ elem,
+ dimension,
+ extra || ( isBorderBox ? "border" : "content" ),
+ valueIsBorderBox,
+ styles,
+
+ // Provide the current computed size to request scroll gutter calculation (gh-3589)
+ val
+ )
+ ) + "px";
+}
+
+jQuery.extend( {
+
+ // Add in style property hooks for overriding the default
+ // behavior of getting and setting a style property
+ cssHooks: {
+ opacity: {
+ get: function( elem, computed ) {
+ if ( computed ) {
+
+ // We should always get a number back from opacity
+ var ret = curCSS( elem, "opacity" );
+ return ret === "" ? "1" : ret;
+ }
+ }
+ }
+ },
+
+ // Don't automatically add "px" to these possibly-unitless properties
+ cssNumber: {
+ "animationIterationCount": true,
+ "columnCount": true,
+ "fillOpacity": true,
+ "flexGrow": true,
+ "flexShrink": true,
+ "fontWeight": true,
+ "gridArea": true,
+ "gridColumn": true,
+ "gridColumnEnd": true,
+ "gridColumnStart": true,
+ "gridRow": true,
+ "gridRowEnd": true,
+ "gridRowStart": true,
+ "lineHeight": true,
+ "opacity": true,
+ "order": true,
+ "orphans": true,
+ "widows": true,
+ "zIndex": true,
+ "zoom": true
+ },
+
+ // Add in properties whose names you wish to fix before
+ // setting or getting the value
+ cssProps: {},
+
+ // Get and set the style property on a DOM Node
+ style: function( elem, name, value, extra ) {
+
+ // Don't set styles on text and comment nodes
+ if ( !elem || elem.nodeType === 3 || elem.nodeType === 8 || !elem.style ) {
+ return;
+ }
+
+ // Make sure that we're working with the right name
+ var ret, type, hooks,
+ origName = camelCase( name ),
+ isCustomProp = rcustomProp.test( name ),
+ style = elem.style;
+
+ // Make sure that we're working with the right name. We don't
+ // want to query the value if it is a CSS custom property
+ // since they are user-defined.
+ if ( !isCustomProp ) {
+ name = finalPropName( origName );
+ }
+
+ // Gets hook for the prefixed version, then unprefixed version
+ hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];
+
+ // Check if we're setting a value
+ if ( value !== undefined ) {
+ type = typeof value;
+
+ // Convert "+=" or "-=" to relative numbers (#7345)
+ if ( type === "string" && ( ret = rcssNum.exec( value ) ) && ret[ 1 ] ) {
+ value = adjustCSS( elem, name, ret );
+
+ // Fixes bug #9237
+ type = "number";
+ }
+
+ // Make sure that null and NaN values aren't set (#7116)
+ if ( value == null || value !== value ) {
+ return;
+ }
+
+ // If a number was passed in, add the unit (except for certain CSS properties)
+ // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append
+ // "px" to a few hardcoded values.
+ if ( type === "number" && !isCustomProp ) {
+ value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" );
+ }
+
+ // background-* props affect original clone's values
+ if ( !support.clearCloneStyle && value === "" && name.indexOf( "background" ) === 0 ) {
+ style[ name ] = "inherit";
+ }
+
+ // If a hook was provided, use that value, otherwise just set the specified value
+ if ( !hooks || !( "set" in hooks ) ||
+ ( value = hooks.set( elem, value, extra ) ) !== undefined ) {
+
+ if ( isCustomProp ) {
+ style.setProperty( name, value );
+ } else {
+ style[ name ] = value;
+ }
+ }
+
+ } else {
+
+ // If a hook was provided get the non-computed value from there
+ if ( hooks && "get" in hooks &&
+ ( ret = hooks.get( elem, false, extra ) ) !== undefined ) {
+
+ return ret;
+ }
+
+ // Otherwise just get the value from the style object
+ return style[ name ];
+ }
+ },
+
+ css: function( elem, name, extra, styles ) {
+ var val, num, hooks,
+ origName = camelCase( name ),
+ isCustomProp = rcustomProp.test( name );
+
+ // Make sure that we're working with the right name. We don't
+ // want to modify the value if it is a CSS custom property
+ // since they are user-defined.
+ if ( !isCustomProp ) {
+ name = finalPropName( origName );
+ }
+
+ // Try prefixed name followed by the unprefixed name
+ hooks = jQuery.cssHooks[ name ] || jQuery.cssHooks[ origName ];
+
+ // If a hook was provided get the computed value from there
+ if ( hooks && "get" in hooks ) {
+ val = hooks.get( elem, true, extra );
+ }
+
+ // Otherwise, if a way to get the computed value exists, use that
+ if ( val === undefined ) {
+ val = curCSS( elem, name, styles );
+ }
+
+ // Convert "normal" to computed value
+ if ( val === "normal" && name in cssNormalTransform ) {
+ val = cssNormalTransform[ name ];
+ }
+
+ // Make numeric if forced or a qualifier was provided and val looks numeric
+ if ( extra === "" || extra ) {
+ num = parseFloat( val );
+ return extra === true || isFinite( num ) ? num || 0 : val;
+ }
+
+ return val;
+ }
+} );
+
+jQuery.each( [ "height", "width" ], function( _i, dimension ) {
+ jQuery.cssHooks[ dimension ] = {
+ get: function( elem, computed, extra ) {
+ if ( computed ) {
+
+ // Certain elements can have dimension info if we invisibly show them
+ // but it must have a current display style that would benefit
+ return rdisplayswap.test( jQuery.css( elem, "display" ) ) &&
+
+ // Support: Safari 8+
+ // Table columns in Safari have non-zero offsetWidth & zero
+ // getBoundingClientRect().width unless display is changed.
+ // Support: IE <=11 only
+ // Running getBoundingClientRect on a disconnected node
+ // in IE throws an error.
+ ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ?
+ swap( elem, cssShow, function() {
+ return getWidthOrHeight( elem, dimension, extra );
+ } ) :
+ getWidthOrHeight( elem, dimension, extra );
+ }
+ },
+
+ set: function( elem, value, extra ) {
+ var matches,
+ styles = getStyles( elem ),
+
+ // Only read styles.position if the test has a chance to fail
+ // to avoid forcing a reflow.
+ scrollboxSizeBuggy = !support.scrollboxSize() &&
+ styles.position === "absolute",
+
+ // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991)
+ boxSizingNeeded = scrollboxSizeBuggy || extra,
+ isBorderBox = boxSizingNeeded &&
+ jQuery.css( elem, "boxSizing", false, styles ) === "border-box",
+ subtract = extra ?
+ boxModelAdjustment(
+ elem,
+ dimension,
+ extra,
+ isBorderBox,
+ styles
+ ) :
+ 0;
+
+ // Account for unreliable border-box dimensions by comparing offset* to computed and
+ // faking a content-box to get border and padding (gh-3699)
+ if ( isBorderBox && scrollboxSizeBuggy ) {
+ subtract -= Math.ceil(
+ elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] -
+ parseFloat( styles[ dimension ] ) -
+ boxModelAdjustment( elem, dimension, "border", false, styles ) -
+ 0.5
+ );
+ }
+
+ // Convert to pixels if value adjustment is needed
+ if ( subtract && ( matches = rcssNum.exec( value ) ) &&
+ ( matches[ 3 ] || "px" ) !== "px" ) {
+
+ elem.style[ dimension ] = value;
+ value = jQuery.css( elem, dimension );
+ }
+
+ return setPositiveNumber( elem, value, subtract );
+ }
+ };
+} );
+
+jQuery.cssHooks.marginLeft = addGetHookIf( support.reliableMarginLeft,
+ function( elem, computed ) {
+ if ( computed ) {
+ return ( parseFloat( curCSS( elem, "marginLeft" ) ) ||
+ elem.getBoundingClientRect().left -
+ swap( elem, { marginLeft: 0 }, function() {
+ return elem.getBoundingClientRect().left;
+ } )
+ ) + "px";
+ }
+ }
+);
+
+// These hooks are used by animate to expand properties
+jQuery.each( {
+ margin: "",
+ padding: "",
+ border: "Width"
+}, function( prefix, suffix ) {
+ jQuery.cssHooks[ prefix + suffix ] = {
+ expand: function( value ) {
+ var i = 0,
+ expanded = {},
+
+ // Assumes a single number if not a string
+ parts = typeof value === "string" ? value.split( " " ) : [ value ];
+
+ for ( ; i < 4; i++ ) {
+ expanded[ prefix + cssExpand[ i ] + suffix ] =
+ parts[ i ] || parts[ i - 2 ] || parts[ 0 ];
+ }
+
+ return expanded;
+ }
+ };
+
+ if ( prefix !== "margin" ) {
+ jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber;
+ }
+} );
+
+jQuery.fn.extend( {
+ css: function( name, value ) {
+ return access( this, function( elem, name, value ) {
+ var styles, len,
+ map = {},
+ i = 0;
+
+ if ( Array.isArray( name ) ) {
+ styles = getStyles( elem );
+ len = name.length;
+
+ for ( ; i < len; i++ ) {
+ map[ name[ i ] ] = jQuery.css( elem, name[ i ], false, styles );
+ }
+
+ return map;
+ }
+
+ return value !== undefined ?
+ jQuery.style( elem, name, value ) :
+ jQuery.css( elem, name );
+ }, name, value, arguments.length > 1 );
+ }
+} );
+
+
+function Tween( elem, options, prop, end, easing ) {
+ return new Tween.prototype.init( elem, options, prop, end, easing );
+}
+jQuery.Tween = Tween;
+
+Tween.prototype = {
+ constructor: Tween,
+ init: function( elem, options, prop, end, easing, unit ) {
+ this.elem = elem;
+ this.prop = prop;
+ this.easing = easing || jQuery.easing._default;
+ this.options = options;
+ this.start = this.now = this.cur();
+ this.end = end;
+ this.unit = unit || ( jQuery.cssNumber[ prop ] ? "" : "px" );
+ },
+ cur: function() {
+ var hooks = Tween.propHooks[ this.prop ];
+
+ return hooks && hooks.get ?
+ hooks.get( this ) :
+ Tween.propHooks._default.get( this );
+ },
+ run: function( percent ) {
+ var eased,
+ hooks = Tween.propHooks[ this.prop ];
+
+ if ( this.options.duration ) {
+ this.pos = eased = jQuery.easing[ this.easing ](
+ percent, this.options.duration * percent, 0, 1, this.options.duration
+ );
+ } else {
+ this.pos = eased = percent;
+ }
+ this.now = ( this.end - this.start ) * eased + this.start;
+
+ if ( this.options.step ) {
+ this.options.step.call( this.elem, this.now, this );
+ }
+
+ if ( hooks && hooks.set ) {
+ hooks.set( this );
+ } else {
+ Tween.propHooks._default.set( this );
+ }
+ return this;
+ }
+};
+
+Tween.prototype.init.prototype = Tween.prototype;
+
+Tween.propHooks = {
+ _default: {
+ get: function( tween ) {
+ var result;
+
+ // Use a property on the element directly when it is not a DOM element,
+ // or when there is no matching style property that exists.
+ if ( tween.elem.nodeType !== 1 ||
+ tween.elem[ tween.prop ] != null && tween.elem.style[ tween.prop ] == null ) {
+ return tween.elem[ tween.prop ];
+ }
+
+ // Passing an empty string as a 3rd parameter to .css will automatically
+ // attempt a parseFloat and fallback to a string if the parse fails.
+ // Simple values such as "10px" are parsed to Float;
+ // complex values such as "rotate(1rad)" are returned as-is.
+ result = jQuery.css( tween.elem, tween.prop, "" );
+
+ // Empty strings, null, undefined and "auto" are converted to 0.
+ return !result || result === "auto" ? 0 : result;
+ },
+ set: function( tween ) {
+
+ // Use step hook for back compat.
+ // Use cssHook if its there.
+ // Use .style if available and use plain properties where available.
+ if ( jQuery.fx.step[ tween.prop ] ) {
+ jQuery.fx.step[ tween.prop ]( tween );
+ } else if ( tween.elem.nodeType === 1 && (
+ jQuery.cssHooks[ tween.prop ] ||
+ tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) {
+ jQuery.style( tween.elem, tween.prop, tween.now + tween.unit );
+ } else {
+ tween.elem[ tween.prop ] = tween.now;
+ }
+ }
+ }
+};
+
+// Support: IE <=9 only
+// Panic based approach to setting things on disconnected nodes
+Tween.propHooks.scrollTop = Tween.propHooks.scrollLeft = {
+ set: function( tween ) {
+ if ( tween.elem.nodeType && tween.elem.parentNode ) {
+ tween.elem[ tween.prop ] = tween.now;
+ }
+ }
+};
+
+jQuery.easing = {
+ linear: function( p ) {
+ return p;
+ },
+ swing: function( p ) {
+ return 0.5 - Math.cos( p * Math.PI ) / 2;
+ },
+ _default: "swing"
+};
+
+jQuery.fx = Tween.prototype.init;
+
+// Back compat <1.8 extension point
+jQuery.fx.step = {};
+
+
+
+
+var
+ fxNow, inProgress,
+ rfxtypes = /^(?:toggle|show|hide)$/,
+ rrun = /queueHooks$/;
+
+function schedule() {
+ if ( inProgress ) {
+ if ( document.hidden === false && window.requestAnimationFrame ) {
+ window.requestAnimationFrame( schedule );
+ } else {
+ window.setTimeout( schedule, jQuery.fx.interval );
+ }
+
+ jQuery.fx.tick();
+ }
+}
+
+// Animations created synchronously will run synchronously
+function createFxNow() {
+ window.setTimeout( function() {
+ fxNow = undefined;
+ } );
+ return ( fxNow = Date.now() );
+}
+
+// Generate parameters to create a standard animation
+function genFx( type, includeWidth ) {
+ var which,
+ i = 0,
+ attrs = { height: type };
+
+ // If we include width, step value is 1 to do all cssExpand values,
+ // otherwise step value is 2 to skip over Left and Right
+ includeWidth = includeWidth ? 1 : 0;
+ for ( ; i < 4; i += 2 - includeWidth ) {
+ which = cssExpand[ i ];
+ attrs[ "margin" + which ] = attrs[ "padding" + which ] = type;
+ }
+
+ if ( includeWidth ) {
+ attrs.opacity = attrs.width = type;
+ }
+
+ return attrs;
+}
+
+function createTween( value, prop, animation ) {
+ var tween,
+ collection = ( Animation.tweeners[ prop ] || [] ).concat( Animation.tweeners[ "*" ] ),
+ index = 0,
+ length = collection.length;
+ for ( ; index < length; index++ ) {
+ if ( ( tween = collection[ index ].call( animation, prop, value ) ) ) {
+
+ // We're done with this property
+ return tween;
+ }
+ }
+}
+
+function defaultPrefilter( elem, props, opts ) {
+ var prop, value, toggle, hooks, oldfire, propTween, restoreDisplay, display,
+ isBox = "width" in props || "height" in props,
+ anim = this,
+ orig = {},
+ style = elem.style,
+ hidden = elem.nodeType && isHiddenWithinTree( elem ),
+ dataShow = dataPriv.get( elem, "fxshow" );
+
+ // Queue-skipping animations hijack the fx hooks
+ if ( !opts.queue ) {
+ hooks = jQuery._queueHooks( elem, "fx" );
+ if ( hooks.unqueued == null ) {
+ hooks.unqueued = 0;
+ oldfire = hooks.empty.fire;
+ hooks.empty.fire = function() {
+ if ( !hooks.unqueued ) {
+ oldfire();
+ }
+ };
+ }
+ hooks.unqueued++;
+
+ anim.always( function() {
+
+ // Ensure the complete handler is called before this completes
+ anim.always( function() {
+ hooks.unqueued--;
+ if ( !jQuery.queue( elem, "fx" ).length ) {
+ hooks.empty.fire();
+ }
+ } );
+ } );
+ }
+
+ // Detect show/hide animations
+ for ( prop in props ) {
+ value = props[ prop ];
+ if ( rfxtypes.test( value ) ) {
+ delete props[ prop ];
+ toggle = toggle || value === "toggle";
+ if ( value === ( hidden ? "hide" : "show" ) ) {
+
+ // Pretend to be hidden if this is a "show" and
+ // there is still data from a stopped show/hide
+ if ( value === "show" && dataShow && dataShow[ prop ] !== undefined ) {
+ hidden = true;
+
+ // Ignore all other no-op show/hide data
+ } else {
+ continue;
+ }
+ }
+ orig[ prop ] = dataShow && dataShow[ prop ] || jQuery.style( elem, prop );
+ }
+ }
+
+ // Bail out if this is a no-op like .hide().hide()
+ propTween = !jQuery.isEmptyObject( props );
+ if ( !propTween && jQuery.isEmptyObject( orig ) ) {
+ return;
+ }
+
+ // Restrict "overflow" and "display" styles during box animations
+ if ( isBox && elem.nodeType === 1 ) {
+
+ // Support: IE <=9 - 11, Edge 12 - 15
+ // Record all 3 overflow attributes because IE does not infer the shorthand
+ // from identically-valued overflowX and overflowY and Edge just mirrors
+ // the overflowX value there.
+ opts.overflow = [ style.overflow, style.overflowX, style.overflowY ];
+
+ // Identify a display type, preferring old show/hide data over the CSS cascade
+ restoreDisplay = dataShow && dataShow.display;
+ if ( restoreDisplay == null ) {
+ restoreDisplay = dataPriv.get( elem, "display" );
+ }
+ display = jQuery.css( elem, "display" );
+ if ( display === "none" ) {
+ if ( restoreDisplay ) {
+ display = restoreDisplay;
+ } else {
+
+ // Get nonempty value(s) by temporarily forcing visibility
+ showHide( [ elem ], true );
+ restoreDisplay = elem.style.display || restoreDisplay;
+ display = jQuery.css( elem, "display" );
+ showHide( [ elem ] );
+ }
+ }
+
+ // Animate inline elements as inline-block
+ if ( display === "inline" || display === "inline-block" && restoreDisplay != null ) {
+ if ( jQuery.css( elem, "float" ) === "none" ) {
+
+ // Restore the original display value at the end of pure show/hide animations
+ if ( !propTween ) {
+ anim.done( function() {
+ style.display = restoreDisplay;
+ } );
+ if ( restoreDisplay == null ) {
+ display = style.display;
+ restoreDisplay = display === "none" ? "" : display;
+ }
+ }
+ style.display = "inline-block";
+ }
+ }
+ }
+
+ if ( opts.overflow ) {
+ style.overflow = "hidden";
+ anim.always( function() {
+ style.overflow = opts.overflow[ 0 ];
+ style.overflowX = opts.overflow[ 1 ];
+ style.overflowY = opts.overflow[ 2 ];
+ } );
+ }
+
+ // Implement show/hide animations
+ propTween = false;
+ for ( prop in orig ) {
+
+ // General show/hide setup for this element animation
+ if ( !propTween ) {
+ if ( dataShow ) {
+ if ( "hidden" in dataShow ) {
+ hidden = dataShow.hidden;
+ }
+ } else {
+ dataShow = dataPriv.access( elem, "fxshow", { display: restoreDisplay } );
+ }
+
+ // Store hidden/visible for toggle so `.stop().toggle()` "reverses"
+ if ( toggle ) {
+ dataShow.hidden = !hidden;
+ }
+
+ // Show elements before animating them
+ if ( hidden ) {
+ showHide( [ elem ], true );
+ }
+
+ /* eslint-disable no-loop-func */
+
+ anim.done( function() {
+
+ /* eslint-enable no-loop-func */
+
+ // The final step of a "hide" animation is actually hiding the element
+ if ( !hidden ) {
+ showHide( [ elem ] );
+ }
+ dataPriv.remove( elem, "fxshow" );
+ for ( prop in orig ) {
+ jQuery.style( elem, prop, orig[ prop ] );
+ }
+ } );
+ }
+
+ // Per-property setup
+ propTween = createTween( hidden ? dataShow[ prop ] : 0, prop, anim );
+ if ( !( prop in dataShow ) ) {
+ dataShow[ prop ] = propTween.start;
+ if ( hidden ) {
+ propTween.end = propTween.start;
+ propTween.start = 0;
+ }
+ }
+ }
+}
+
+function propFilter( props, specialEasing ) {
+ var index, name, easing, value, hooks;
+
+ // camelCase, specialEasing and expand cssHook pass
+ for ( index in props ) {
+ name = camelCase( index );
+ easing = specialEasing[ name ];
+ value = props[ index ];
+ if ( Array.isArray( value ) ) {
+ easing = value[ 1 ];
+ value = props[ index ] = value[ 0 ];
+ }
+
+ if ( index !== name ) {
+ props[ name ] = value;
+ delete props[ index ];
+ }
+
+ hooks = jQuery.cssHooks[ name ];
+ if ( hooks && "expand" in hooks ) {
+ value = hooks.expand( value );
+ delete props[ name ];
+
+ // Not quite $.extend, this won't overwrite existing keys.
+ // Reusing 'index' because we have the correct "name"
+ for ( index in value ) {
+ if ( !( index in props ) ) {
+ props[ index ] = value[ index ];
+ specialEasing[ index ] = easing;
+ }
+ }
+ } else {
+ specialEasing[ name ] = easing;
+ }
+ }
+}
+
+function Animation( elem, properties, options ) {
+ var result,
+ stopped,
+ index = 0,
+ length = Animation.prefilters.length,
+ deferred = jQuery.Deferred().always( function() {
+
+ // Don't match elem in the :animated selector
+ delete tick.elem;
+ } ),
+ tick = function() {
+ if ( stopped ) {
+ return false;
+ }
+ var currentTime = fxNow || createFxNow(),
+ remaining = Math.max( 0, animation.startTime + animation.duration - currentTime ),
+
+ // Support: Android 2.3 only
+ // Archaic crash bug won't allow us to use `1 - ( 0.5 || 0 )` (#12497)
+ temp = remaining / animation.duration || 0,
+ percent = 1 - temp,
+ index = 0,
+ length = animation.tweens.length;
+
+ for ( ; index < length; index++ ) {
+ animation.tweens[ index ].run( percent );
+ }
+
+ deferred.notifyWith( elem, [ animation, percent, remaining ] );
+
+ // If there's more to do, yield
+ if ( percent < 1 && length ) {
+ return remaining;
+ }
+
+ // If this was an empty animation, synthesize a final progress notification
+ if ( !length ) {
+ deferred.notifyWith( elem, [ animation, 1, 0 ] );
+ }
+
+ // Resolve the animation and report its conclusion
+ deferred.resolveWith( elem, [ animation ] );
+ return false;
+ },
+ animation = deferred.promise( {
+ elem: elem,
+ props: jQuery.extend( {}, properties ),
+ opts: jQuery.extend( true, {
+ specialEasing: {},
+ easing: jQuery.easing._default
+ }, options ),
+ originalProperties: properties,
+ originalOptions: options,
+ startTime: fxNow || createFxNow(),
+ duration: options.duration,
+ tweens: [],
+ createTween: function( prop, end ) {
+ var tween = jQuery.Tween( elem, animation.opts, prop, end,
+ animation.opts.specialEasing[ prop ] || animation.opts.easing );
+ animation.tweens.push( tween );
+ return tween;
+ },
+ stop: function( gotoEnd ) {
+ var index = 0,
+
+ // If we are going to the end, we want to run all the tweens
+ // otherwise we skip this part
+ length = gotoEnd ? animation.tweens.length : 0;
+ if ( stopped ) {
+ return this;
+ }
+ stopped = true;
+ for ( ; index < length; index++ ) {
+ animation.tweens[ index ].run( 1 );
+ }
+
+ // Resolve when we played the last frame; otherwise, reject
+ if ( gotoEnd ) {
+ deferred.notifyWith( elem, [ animation, 1, 0 ] );
+ deferred.resolveWith( elem, [ animation, gotoEnd ] );
+ } else {
+ deferred.rejectWith( elem, [ animation, gotoEnd ] );
+ }
+ return this;
+ }
+ } ),
+ props = animation.props;
+
+ propFilter( props, animation.opts.specialEasing );
+
+ for ( ; index < length; index++ ) {
+ result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts );
+ if ( result ) {
+ if ( isFunction( result.stop ) ) {
+ jQuery._queueHooks( animation.elem, animation.opts.queue ).stop =
+ result.stop.bind( result );
+ }
+ return result;
+ }
+ }
+
+ jQuery.map( props, createTween, animation );
+
+ if ( isFunction( animation.opts.start ) ) {
+ animation.opts.start.call( elem, animation );
+ }
+
+ // Attach callbacks from options
+ animation
+ .progress( animation.opts.progress )
+ .done( animation.opts.done, animation.opts.complete )
+ .fail( animation.opts.fail )
+ .always( animation.opts.always );
+
+ jQuery.fx.timer(
+ jQuery.extend( tick, {
+ elem: elem,
+ anim: animation,
+ queue: animation.opts.queue
+ } )
+ );
+
+ return animation;
+}
+
+jQuery.Animation = jQuery.extend( Animation, {
+
+ tweeners: {
+ "*": [ function( prop, value ) {
+ var tween = this.createTween( prop, value );
+ adjustCSS( tween.elem, prop, rcssNum.exec( value ), tween );
+ return tween;
+ } ]
+ },
+
+ tweener: function( props, callback ) {
+ if ( isFunction( props ) ) {
+ callback = props;
+ props = [ "*" ];
+ } else {
+ props = props.match( rnothtmlwhite );
+ }
+
+ var prop,
+ index = 0,
+ length = props.length;
+
+ for ( ; index < length; index++ ) {
+ prop = props[ index ];
+ Animation.tweeners[ prop ] = Animation.tweeners[ prop ] || [];
+ Animation.tweeners[ prop ].unshift( callback );
+ }
+ },
+
+ prefilters: [ defaultPrefilter ],
+
+ prefilter: function( callback, prepend ) {
+ if ( prepend ) {
+ Animation.prefilters.unshift( callback );
+ } else {
+ Animation.prefilters.push( callback );
+ }
+ }
+} );
+
+jQuery.speed = function( speed, easing, fn ) {
+ var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : {
+ complete: fn || !fn && easing ||
+ isFunction( speed ) && speed,
+ duration: speed,
+ easing: fn && easing || easing && !isFunction( easing ) && easing
+ };
+
+ // Go to the end state if fx are off
+ if ( jQuery.fx.off ) {
+ opt.duration = 0;
+
+ } else {
+ if ( typeof opt.duration !== "number" ) {
+ if ( opt.duration in jQuery.fx.speeds ) {
+ opt.duration = jQuery.fx.speeds[ opt.duration ];
+
+ } else {
+ opt.duration = jQuery.fx.speeds._default;
+ }
+ }
+ }
+
+ // Normalize opt.queue - true/undefined/null -> "fx"
+ if ( opt.queue == null || opt.queue === true ) {
+ opt.queue = "fx";
+ }
+
+ // Queueing
+ opt.old = opt.complete;
+
+ opt.complete = function() {
+ if ( isFunction( opt.old ) ) {
+ opt.old.call( this );
+ }
+
+ if ( opt.queue ) {
+ jQuery.dequeue( this, opt.queue );
+ }
+ };
+
+ return opt;
+};
+
+jQuery.fn.extend( {
+ fadeTo: function( speed, to, easing, callback ) {
+
+ // Show any hidden elements after setting opacity to 0
+ return this.filter( isHiddenWithinTree ).css( "opacity", 0 ).show()
+
+ // Animate to the value specified
+ .end().animate( { opacity: to }, speed, easing, callback );
+ },
+ animate: function( prop, speed, easing, callback ) {
+ var empty = jQuery.isEmptyObject( prop ),
+ optall = jQuery.speed( speed, easing, callback ),
+ doAnimation = function() {
+
+ // Operate on a copy of prop so per-property easing won't be lost
+ var anim = Animation( this, jQuery.extend( {}, prop ), optall );
+
+ // Empty animations, or finishing resolves immediately
+ if ( empty || dataPriv.get( this, "finish" ) ) {
+ anim.stop( true );
+ }
+ };
+
+ doAnimation.finish = doAnimation;
+
+ return empty || optall.queue === false ?
+ this.each( doAnimation ) :
+ this.queue( optall.queue, doAnimation );
+ },
+ stop: function( type, clearQueue, gotoEnd ) {
+ var stopQueue = function( hooks ) {
+ var stop = hooks.stop;
+ delete hooks.stop;
+ stop( gotoEnd );
+ };
+
+ if ( typeof type !== "string" ) {
+ gotoEnd = clearQueue;
+ clearQueue = type;
+ type = undefined;
+ }
+ if ( clearQueue ) {
+ this.queue( type || "fx", [] );
+ }
+
+ return this.each( function() {
+ var dequeue = true,
+ index = type != null && type + "queueHooks",
+ timers = jQuery.timers,
+ data = dataPriv.get( this );
+
+ if ( index ) {
+ if ( data[ index ] && data[ index ].stop ) {
+ stopQueue( data[ index ] );
+ }
+ } else {
+ for ( index in data ) {
+ if ( data[ index ] && data[ index ].stop && rrun.test( index ) ) {
+ stopQueue( data[ index ] );
+ }
+ }
+ }
+
+ for ( index = timers.length; index--; ) {
+ if ( timers[ index ].elem === this &&
+ ( type == null || timers[ index ].queue === type ) ) {
+
+ timers[ index ].anim.stop( gotoEnd );
+ dequeue = false;
+ timers.splice( index, 1 );
+ }
+ }
+
+ // Start the next in the queue if the last step wasn't forced.
+ // Timers currently will call their complete callbacks, which
+ // will dequeue but only if they were gotoEnd.
+ if ( dequeue || !gotoEnd ) {
+ jQuery.dequeue( this, type );
+ }
+ } );
+ },
+ finish: function( type ) {
+ if ( type !== false ) {
+ type = type || "fx";
+ }
+ return this.each( function() {
+ var index,
+ data = dataPriv.get( this ),
+ queue = data[ type + "queue" ],
+ hooks = data[ type + "queueHooks" ],
+ timers = jQuery.timers,
+ length = queue ? queue.length : 0;
+
+ // Enable finishing flag on private data
+ data.finish = true;
+
+ // Empty the queue first
+ jQuery.queue( this, type, [] );
+
+ if ( hooks && hooks.stop ) {
+ hooks.stop.call( this, true );
+ }
+
+ // Look for any active animations, and finish them
+ for ( index = timers.length; index--; ) {
+ if ( timers[ index ].elem === this && timers[ index ].queue === type ) {
+ timers[ index ].anim.stop( true );
+ timers.splice( index, 1 );
+ }
+ }
+
+ // Look for any animations in the old queue and finish them
+ for ( index = 0; index < length; index++ ) {
+ if ( queue[ index ] && queue[ index ].finish ) {
+ queue[ index ].finish.call( this );
+ }
+ }
+
+ // Turn off finishing flag
+ delete data.finish;
+ } );
+ }
+} );
+
+jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) {
+ var cssFn = jQuery.fn[ name ];
+ jQuery.fn[ name ] = function( speed, easing, callback ) {
+ return speed == null || typeof speed === "boolean" ?
+ cssFn.apply( this, arguments ) :
+ this.animate( genFx( name, true ), speed, easing, callback );
+ };
+} );
+
+// Generate shortcuts for custom animations
+jQuery.each( {
+ slideDown: genFx( "show" ),
+ slideUp: genFx( "hide" ),
+ slideToggle: genFx( "toggle" ),
+ fadeIn: { opacity: "show" },
+ fadeOut: { opacity: "hide" },
+ fadeToggle: { opacity: "toggle" }
+}, function( name, props ) {
+ jQuery.fn[ name ] = function( speed, easing, callback ) {
+ return this.animate( props, speed, easing, callback );
+ };
+} );
+
+jQuery.timers = [];
+jQuery.fx.tick = function() {
+ var timer,
+ i = 0,
+ timers = jQuery.timers;
+
+ fxNow = Date.now();
+
+ for ( ; i < timers.length; i++ ) {
+ timer = timers[ i ];
+
+ // Run the timer and safely remove it when done (allowing for external removal)
+ if ( !timer() && timers[ i ] === timer ) {
+ timers.splice( i--, 1 );
+ }
+ }
+
+ if ( !timers.length ) {
+ jQuery.fx.stop();
+ }
+ fxNow = undefined;
+};
+
+jQuery.fx.timer = function( timer ) {
+ jQuery.timers.push( timer );
+ jQuery.fx.start();
+};
+
+jQuery.fx.interval = 13;
+jQuery.fx.start = function() {
+ if ( inProgress ) {
+ return;
+ }
+
+ inProgress = true;
+ schedule();
+};
+
+jQuery.fx.stop = function() {
+ inProgress = null;
+};
+
+jQuery.fx.speeds = {
+ slow: 600,
+ fast: 200,
+
+ // Default speed
+ _default: 400
+};
+
+
+// Based off of the plugin by Clint Helfers, with permission.
+// https://web.archive.org/web/20100324014747/http://blindsignals.com/index.php/2009/07/jquery-delay/
+jQuery.fn.delay = function( time, type ) {
+ time = jQuery.fx ? jQuery.fx.speeds[ time ] || time : time;
+ type = type || "fx";
+
+ return this.queue( type, function( next, hooks ) {
+ var timeout = window.setTimeout( next, time );
+ hooks.stop = function() {
+ window.clearTimeout( timeout );
+ };
+ } );
+};
+
+
+( function() {
+ var input = document.createElement( "input" ),
+ select = document.createElement( "select" ),
+ opt = select.appendChild( document.createElement( "option" ) );
+
+ input.type = "checkbox";
+
+ // Support: Android <=4.3 only
+ // Default value for a checkbox should be "on"
+ support.checkOn = input.value !== "";
+
+ // Support: IE <=11 only
+ // Must access selectedIndex to make default options select
+ support.optSelected = opt.selected;
+
+ // Support: IE <=11 only
+ // An input loses its value after becoming a radio
+ input = document.createElement( "input" );
+ input.value = "t";
+ input.type = "radio";
+ support.radioValue = input.value === "t";
+} )();
+
+
+var boolHook,
+ attrHandle = jQuery.expr.attrHandle;
+
+jQuery.fn.extend( {
+ attr: function( name, value ) {
+ return access( this, jQuery.attr, name, value, arguments.length > 1 );
+ },
+
+ removeAttr: function( name ) {
+ return this.each( function() {
+ jQuery.removeAttr( this, name );
+ } );
+ }
+} );
+
+jQuery.extend( {
+ attr: function( elem, name, value ) {
+ var ret, hooks,
+ nType = elem.nodeType;
+
+ // Don't get/set attributes on text, comment and attribute nodes
+ if ( nType === 3 || nType === 8 || nType === 2 ) {
+ return;
+ }
+
+ // Fallback to prop when attributes are not supported
+ if ( typeof elem.getAttribute === "undefined" ) {
+ return jQuery.prop( elem, name, value );
+ }
+
+ // Attribute hooks are determined by the lowercase version
+ // Grab necessary hook if one is defined
+ if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {
+ hooks = jQuery.attrHooks[ name.toLowerCase() ] ||
+ ( jQuery.expr.match.bool.test( name ) ? boolHook : undefined );
+ }
+
+ if ( value !== undefined ) {
+ if ( value === null ) {
+ jQuery.removeAttr( elem, name );
+ return;
+ }
+
+ if ( hooks && "set" in hooks &&
+ ( ret = hooks.set( elem, value, name ) ) !== undefined ) {
+ return ret;
+ }
+
+ elem.setAttribute( name, value + "" );
+ return value;
+ }
+
+ if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {
+ return ret;
+ }
+
+ ret = jQuery.find.attr( elem, name );
+
+ // Non-existent attributes return null, we normalize to undefined
+ return ret == null ? undefined : ret;
+ },
+
+ attrHooks: {
+ type: {
+ set: function( elem, value ) {
+ if ( !support.radioValue && value === "radio" &&
+ nodeName( elem, "input" ) ) {
+ var val = elem.value;
+ elem.setAttribute( "type", value );
+ if ( val ) {
+ elem.value = val;
+ }
+ return value;
+ }
+ }
+ }
+ },
+
+ removeAttr: function( elem, value ) {
+ var name,
+ i = 0,
+
+ // Attribute names can contain non-HTML whitespace characters
+ // https://html.spec.whatwg.org/multipage/syntax.html#attributes-2
+ attrNames = value && value.match( rnothtmlwhite );
+
+ if ( attrNames && elem.nodeType === 1 ) {
+ while ( ( name = attrNames[ i++ ] ) ) {
+ elem.removeAttribute( name );
+ }
+ }
+ }
+} );
+
+// Hooks for boolean attributes
+boolHook = {
+ set: function( elem, value, name ) {
+ if ( value === false ) {
+
+ // Remove boolean attributes when set to false
+ jQuery.removeAttr( elem, name );
+ } else {
+ elem.setAttribute( name, name );
+ }
+ return name;
+ }
+};
+
+jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) {
+ var getter = attrHandle[ name ] || jQuery.find.attr;
+
+ attrHandle[ name ] = function( elem, name, isXML ) {
+ var ret, handle,
+ lowercaseName = name.toLowerCase();
+
+ if ( !isXML ) {
+
+ // Avoid an infinite loop by temporarily removing this function from the getter
+ handle = attrHandle[ lowercaseName ];
+ attrHandle[ lowercaseName ] = ret;
+ ret = getter( elem, name, isXML ) != null ?
+ lowercaseName :
+ null;
+ attrHandle[ lowercaseName ] = handle;
+ }
+ return ret;
+ };
+} );
+
+
+
+
+var rfocusable = /^(?:input|select|textarea|button)$/i,
+ rclickable = /^(?:a|area)$/i;
+
+jQuery.fn.extend( {
+ prop: function( name, value ) {
+ return access( this, jQuery.prop, name, value, arguments.length > 1 );
+ },
+
+ removeProp: function( name ) {
+ return this.each( function() {
+ delete this[ jQuery.propFix[ name ] || name ];
+ } );
+ }
+} );
+
+jQuery.extend( {
+ prop: function( elem, name, value ) {
+ var ret, hooks,
+ nType = elem.nodeType;
+
+ // Don't get/set properties on text, comment and attribute nodes
+ if ( nType === 3 || nType === 8 || nType === 2 ) {
+ return;
+ }
+
+ if ( nType !== 1 || !jQuery.isXMLDoc( elem ) ) {
+
+ // Fix name and attach hooks
+ name = jQuery.propFix[ name ] || name;
+ hooks = jQuery.propHooks[ name ];
+ }
+
+ if ( value !== undefined ) {
+ if ( hooks && "set" in hooks &&
+ ( ret = hooks.set( elem, value, name ) ) !== undefined ) {
+ return ret;
+ }
+
+ return ( elem[ name ] = value );
+ }
+
+ if ( hooks && "get" in hooks && ( ret = hooks.get( elem, name ) ) !== null ) {
+ return ret;
+ }
+
+ return elem[ name ];
+ },
+
+ propHooks: {
+ tabIndex: {
+ get: function( elem ) {
+
+ // Support: IE <=9 - 11 only
+ // elem.tabIndex doesn't always return the
+ // correct value when it hasn't been explicitly set
+ // https://web.archive.org/web/20141116233347/http://fluidproject.org/blog/2008/01/09/getting-setting-and-removing-tabindex-values-with-javascript/
+ // Use proper attribute retrieval(#12072)
+ var tabindex = jQuery.find.attr( elem, "tabindex" );
+
+ if ( tabindex ) {
+ return parseInt( tabindex, 10 );
+ }
+
+ if (
+ rfocusable.test( elem.nodeName ) ||
+ rclickable.test( elem.nodeName ) &&
+ elem.href
+ ) {
+ return 0;
+ }
+
+ return -1;
+ }
+ }
+ },
+
+ propFix: {
+ "for": "htmlFor",
+ "class": "className"
+ }
+} );
+
+// Support: IE <=11 only
+// Accessing the selectedIndex property
+// forces the browser to respect setting selected
+// on the option
+// The getter ensures a default option is selected
+// when in an optgroup
+// eslint rule "no-unused-expressions" is disabled for this code
+// since it considers such accessions noop
+if ( !support.optSelected ) {
+ jQuery.propHooks.selected = {
+ get: function( elem ) {
+
+ /* eslint no-unused-expressions: "off" */
+
+ var parent = elem.parentNode;
+ if ( parent && parent.parentNode ) {
+ parent.parentNode.selectedIndex;
+ }
+ return null;
+ },
+ set: function( elem ) {
+
+ /* eslint no-unused-expressions: "off" */
+
+ var parent = elem.parentNode;
+ if ( parent ) {
+ parent.selectedIndex;
+
+ if ( parent.parentNode ) {
+ parent.parentNode.selectedIndex;
+ }
+ }
+ }
+ };
+}
+
+jQuery.each( [
+ "tabIndex",
+ "readOnly",
+ "maxLength",
+ "cellSpacing",
+ "cellPadding",
+ "rowSpan",
+ "colSpan",
+ "useMap",
+ "frameBorder",
+ "contentEditable"
+], function() {
+ jQuery.propFix[ this.toLowerCase() ] = this;
+} );
+
+
+
+
+ // Strip and collapse whitespace according to HTML spec
+ // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace
+ function stripAndCollapse( value ) {
+ var tokens = value.match( rnothtmlwhite ) || [];
+ return tokens.join( " " );
+ }
+
+
+function getClass( elem ) {
+ return elem.getAttribute && elem.getAttribute( "class" ) || "";
+}
+
+function classesToArray( value ) {
+ if ( Array.isArray( value ) ) {
+ return value;
+ }
+ if ( typeof value === "string" ) {
+ return value.match( rnothtmlwhite ) || [];
+ }
+ return [];
+}
+
+jQuery.fn.extend( {
+ addClass: function( value ) {
+ var classes, elem, cur, curValue, clazz, j, finalValue,
+ i = 0;
+
+ if ( isFunction( value ) ) {
+ return this.each( function( j ) {
+ jQuery( this ).addClass( value.call( this, j, getClass( this ) ) );
+ } );
+ }
+
+ classes = classesToArray( value );
+
+ if ( classes.length ) {
+ while ( ( elem = this[ i++ ] ) ) {
+ curValue = getClass( elem );
+ cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " );
+
+ if ( cur ) {
+ j = 0;
+ while ( ( clazz = classes[ j++ ] ) ) {
+ if ( cur.indexOf( " " + clazz + " " ) < 0 ) {
+ cur += clazz + " ";
+ }
+ }
+
+ // Only assign if different to avoid unneeded rendering.
+ finalValue = stripAndCollapse( cur );
+ if ( curValue !== finalValue ) {
+ elem.setAttribute( "class", finalValue );
+ }
+ }
+ }
+ }
+
+ return this;
+ },
+
+ removeClass: function( value ) {
+ var classes, elem, cur, curValue, clazz, j, finalValue,
+ i = 0;
+
+ if ( isFunction( value ) ) {
+ return this.each( function( j ) {
+ jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) );
+ } );
+ }
+
+ if ( !arguments.length ) {
+ return this.attr( "class", "" );
+ }
+
+ classes = classesToArray( value );
+
+ if ( classes.length ) {
+ while ( ( elem = this[ i++ ] ) ) {
+ curValue = getClass( elem );
+
+ // This expression is here for better compressibility (see addClass)
+ cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " );
+
+ if ( cur ) {
+ j = 0;
+ while ( ( clazz = classes[ j++ ] ) ) {
+
+ // Remove *all* instances
+ while ( cur.indexOf( " " + clazz + " " ) > -1 ) {
+ cur = cur.replace( " " + clazz + " ", " " );
+ }
+ }
+
+ // Only assign if different to avoid unneeded rendering.
+ finalValue = stripAndCollapse( cur );
+ if ( curValue !== finalValue ) {
+ elem.setAttribute( "class", finalValue );
+ }
+ }
+ }
+ }
+
+ return this;
+ },
+
+ toggleClass: function( value, stateVal ) {
+ var type = typeof value,
+ isValidValue = type === "string" || Array.isArray( value );
+
+ if ( typeof stateVal === "boolean" && isValidValue ) {
+ return stateVal ? this.addClass( value ) : this.removeClass( value );
+ }
+
+ if ( isFunction( value ) ) {
+ return this.each( function( i ) {
+ jQuery( this ).toggleClass(
+ value.call( this, i, getClass( this ), stateVal ),
+ stateVal
+ );
+ } );
+ }
+
+ return this.each( function() {
+ var className, i, self, classNames;
+
+ if ( isValidValue ) {
+
+ // Toggle individual class names
+ i = 0;
+ self = jQuery( this );
+ classNames = classesToArray( value );
+
+ while ( ( className = classNames[ i++ ] ) ) {
+
+ // Check each className given, space separated list
+ if ( self.hasClass( className ) ) {
+ self.removeClass( className );
+ } else {
+ self.addClass( className );
+ }
+ }
+
+ // Toggle whole class name
+ } else if ( value === undefined || type === "boolean" ) {
+ className = getClass( this );
+ if ( className ) {
+
+ // Store className if set
+ dataPriv.set( this, "__className__", className );
+ }
+
+ // If the element has a class name or if we're passed `false`,
+ // then remove the whole classname (if there was one, the above saved it).
+ // Otherwise bring back whatever was previously saved (if anything),
+ // falling back to the empty string if nothing was stored.
+ if ( this.setAttribute ) {
+ this.setAttribute( "class",
+ className || value === false ?
+ "" :
+ dataPriv.get( this, "__className__" ) || ""
+ );
+ }
+ }
+ } );
+ },
+
+ hasClass: function( selector ) {
+ var className, elem,
+ i = 0;
+
+ className = " " + selector + " ";
+ while ( ( elem = this[ i++ ] ) ) {
+ if ( elem.nodeType === 1 &&
+ ( " " + stripAndCollapse( getClass( elem ) ) + " " ).indexOf( className ) > -1 ) {
+ return true;
+ }
+ }
+
+ return false;
+ }
+} );
+
+
+
+
+var rreturn = /\r/g;
+
+jQuery.fn.extend( {
+ val: function( value ) {
+ var hooks, ret, valueIsFunction,
+ elem = this[ 0 ];
+
+ if ( !arguments.length ) {
+ if ( elem ) {
+ hooks = jQuery.valHooks[ elem.type ] ||
+ jQuery.valHooks[ elem.nodeName.toLowerCase() ];
+
+ if ( hooks &&
+ "get" in hooks &&
+ ( ret = hooks.get( elem, "value" ) ) !== undefined
+ ) {
+ return ret;
+ }
+
+ ret = elem.value;
+
+ // Handle most common string cases
+ if ( typeof ret === "string" ) {
+ return ret.replace( rreturn, "" );
+ }
+
+ // Handle cases where value is null/undef or number
+ return ret == null ? "" : ret;
+ }
+
+ return;
+ }
+
+ valueIsFunction = isFunction( value );
+
+ return this.each( function( i ) {
+ var val;
+
+ if ( this.nodeType !== 1 ) {
+ return;
+ }
+
+ if ( valueIsFunction ) {
+ val = value.call( this, i, jQuery( this ).val() );
+ } else {
+ val = value;
+ }
+
+ // Treat null/undefined as ""; convert numbers to string
+ if ( val == null ) {
+ val = "";
+
+ } else if ( typeof val === "number" ) {
+ val += "";
+
+ } else if ( Array.isArray( val ) ) {
+ val = jQuery.map( val, function( value ) {
+ return value == null ? "" : value + "";
+ } );
+ }
+
+ hooks = jQuery.valHooks[ this.type ] || jQuery.valHooks[ this.nodeName.toLowerCase() ];
+
+ // If set returns undefined, fall back to normal setting
+ if ( !hooks || !( "set" in hooks ) || hooks.set( this, val, "value" ) === undefined ) {
+ this.value = val;
+ }
+ } );
+ }
+} );
+
+jQuery.extend( {
+ valHooks: {
+ option: {
+ get: function( elem ) {
+
+ var val = jQuery.find.attr( elem, "value" );
+ return val != null ?
+ val :
+
+ // Support: IE <=10 - 11 only
+ // option.text throws exceptions (#14686, #14858)
+ // Strip and collapse whitespace
+ // https://html.spec.whatwg.org/#strip-and-collapse-whitespace
+ stripAndCollapse( jQuery.text( elem ) );
+ }
+ },
+ select: {
+ get: function( elem ) {
+ var value, option, i,
+ options = elem.options,
+ index = elem.selectedIndex,
+ one = elem.type === "select-one",
+ values = one ? null : [],
+ max = one ? index + 1 : options.length;
+
+ if ( index < 0 ) {
+ i = max;
+
+ } else {
+ i = one ? index : 0;
+ }
+
+ // Loop through all the selected options
+ for ( ; i < max; i++ ) {
+ option = options[ i ];
+
+ // Support: IE <=9 only
+ // IE8-9 doesn't update selected after form reset (#2551)
+ if ( ( option.selected || i === index ) &&
+
+ // Don't return options that are disabled or in a disabled optgroup
+ !option.disabled &&
+ ( !option.parentNode.disabled ||
+ !nodeName( option.parentNode, "optgroup" ) ) ) {
+
+ // Get the specific value for the option
+ value = jQuery( option ).val();
+
+ // We don't need an array for one selects
+ if ( one ) {
+ return value;
+ }
+
+ // Multi-Selects return an array
+ values.push( value );
+ }
+ }
+
+ return values;
+ },
+
+ set: function( elem, value ) {
+ var optionSet, option,
+ options = elem.options,
+ values = jQuery.makeArray( value ),
+ i = options.length;
+
+ while ( i-- ) {
+ option = options[ i ];
+
+ /* eslint-disable no-cond-assign */
+
+ if ( option.selected =
+ jQuery.inArray( jQuery.valHooks.option.get( option ), values ) > -1
+ ) {
+ optionSet = true;
+ }
+
+ /* eslint-enable no-cond-assign */
+ }
+
+ // Force browsers to behave consistently when non-matching value is set
+ if ( !optionSet ) {
+ elem.selectedIndex = -1;
+ }
+ return values;
+ }
+ }
+ }
+} );
+
+// Radios and checkboxes getter/setter
+jQuery.each( [ "radio", "checkbox" ], function() {
+ jQuery.valHooks[ this ] = {
+ set: function( elem, value ) {
+ if ( Array.isArray( value ) ) {
+ return ( elem.checked = jQuery.inArray( jQuery( elem ).val(), value ) > -1 );
+ }
+ }
+ };
+ if ( !support.checkOn ) {
+ jQuery.valHooks[ this ].get = function( elem ) {
+ return elem.getAttribute( "value" ) === null ? "on" : elem.value;
+ };
+ }
+} );
+
+
+
+
+// Return jQuery for attributes-only inclusion
+
+
+support.focusin = "onfocusin" in window;
+
+
+var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/,
+ stopPropagationCallback = function( e ) {
+ e.stopPropagation();
+ };
+
+jQuery.extend( jQuery.event, {
+
+ trigger: function( event, data, elem, onlyHandlers ) {
+
+ var i, cur, tmp, bubbleType, ontype, handle, special, lastElement,
+ eventPath = [ elem || document ],
+ type = hasOwn.call( event, "type" ) ? event.type : event,
+ namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : [];
+
+ cur = lastElement = tmp = elem = elem || document;
+
+ // Don't do events on text and comment nodes
+ if ( elem.nodeType === 3 || elem.nodeType === 8 ) {
+ return;
+ }
+
+ // focus/blur morphs to focusin/out; ensure we're not firing them right now
+ if ( rfocusMorph.test( type + jQuery.event.triggered ) ) {
+ return;
+ }
+
+ if ( type.indexOf( "." ) > -1 ) {
+
+ // Namespaced trigger; create a regexp to match event type in handle()
+ namespaces = type.split( "." );
+ type = namespaces.shift();
+ namespaces.sort();
+ }
+ ontype = type.indexOf( ":" ) < 0 && "on" + type;
+
+ // Caller can pass in a jQuery.Event object, Object, or just an event type string
+ event = event[ jQuery.expando ] ?
+ event :
+ new jQuery.Event( type, typeof event === "object" && event );
+
+ // Trigger bitmask: & 1 for native handlers; & 2 for jQuery (always true)
+ event.isTrigger = onlyHandlers ? 2 : 3;
+ event.namespace = namespaces.join( "." );
+ event.rnamespace = event.namespace ?
+ new RegExp( "(^|\\.)" + namespaces.join( "\\.(?:.*\\.|)" ) + "(\\.|$)" ) :
+ null;
+
+ // Clean up the event in case it is being reused
+ event.result = undefined;
+ if ( !event.target ) {
+ event.target = elem;
+ }
+
+ // Clone any incoming data and prepend the event, creating the handler arg list
+ data = data == null ?
+ [ event ] :
+ jQuery.makeArray( data, [ event ] );
+
+ // Allow special events to draw outside the lines
+ special = jQuery.event.special[ type ] || {};
+ if ( !onlyHandlers && special.trigger && special.trigger.apply( elem, data ) === false ) {
+ return;
+ }
+
+ // Determine event propagation path in advance, per W3C events spec (#9951)
+ // Bubble up to document, then to window; watch for a global ownerDocument var (#9724)
+ if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) {
+
+ bubbleType = special.delegateType || type;
+ if ( !rfocusMorph.test( bubbleType + type ) ) {
+ cur = cur.parentNode;
+ }
+ for ( ; cur; cur = cur.parentNode ) {
+ eventPath.push( cur );
+ tmp = cur;
+ }
+
+ // Only add window if we got to document (e.g., not plain obj or detached DOM)
+ if ( tmp === ( elem.ownerDocument || document ) ) {
+ eventPath.push( tmp.defaultView || tmp.parentWindow || window );
+ }
+ }
+
+ // Fire handlers on the event path
+ i = 0;
+ while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) {
+ lastElement = cur;
+ event.type = i > 1 ?
+ bubbleType :
+ special.bindType || type;
+
+ // jQuery handler
+ handle = ( dataPriv.get( cur, "events" ) || Object.create( null ) )[ event.type ] &&
+ dataPriv.get( cur, "handle" );
+ if ( handle ) {
+ handle.apply( cur, data );
+ }
+
+ // Native handler
+ handle = ontype && cur[ ontype ];
+ if ( handle && handle.apply && acceptData( cur ) ) {
+ event.result = handle.apply( cur, data );
+ if ( event.result === false ) {
+ event.preventDefault();
+ }
+ }
+ }
+ event.type = type;
+
+ // If nobody prevented the default action, do it now
+ if ( !onlyHandlers && !event.isDefaultPrevented() ) {
+
+ if ( ( !special._default ||
+ special._default.apply( eventPath.pop(), data ) === false ) &&
+ acceptData( elem ) ) {
+
+ // Call a native DOM method on the target with the same name as the event.
+ // Don't do default actions on window, that's where global variables be (#6170)
+ if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) {
+
+ // Don't re-trigger an onFOO event when we call its FOO() method
+ tmp = elem[ ontype ];
+
+ if ( tmp ) {
+ elem[ ontype ] = null;
+ }
+
+ // Prevent re-triggering of the same event, since we already bubbled it above
+ jQuery.event.triggered = type;
+
+ if ( event.isPropagationStopped() ) {
+ lastElement.addEventListener( type, stopPropagationCallback );
+ }
+
+ elem[ type ]();
+
+ if ( event.isPropagationStopped() ) {
+ lastElement.removeEventListener( type, stopPropagationCallback );
+ }
+
+ jQuery.event.triggered = undefined;
+
+ if ( tmp ) {
+ elem[ ontype ] = tmp;
+ }
+ }
+ }
+ }
+
+ return event.result;
+ },
+
+ // Piggyback on a donor event to simulate a different one
+ // Used only for `focus(in | out)` events
+ simulate: function( type, elem, event ) {
+ var e = jQuery.extend(
+ new jQuery.Event(),
+ event,
+ {
+ type: type,
+ isSimulated: true
+ }
+ );
+
+ jQuery.event.trigger( e, null, elem );
+ }
+
+} );
+
+jQuery.fn.extend( {
+
+ trigger: function( type, data ) {
+ return this.each( function() {
+ jQuery.event.trigger( type, data, this );
+ } );
+ },
+ triggerHandler: function( type, data ) {
+ var elem = this[ 0 ];
+ if ( elem ) {
+ return jQuery.event.trigger( type, data, elem, true );
+ }
+ }
+} );
+
+
+// Support: Firefox <=44
+// Firefox doesn't have focus(in | out) events
+// Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787
+//
+// Support: Chrome <=48 - 49, Safari <=9.0 - 9.1
+// focus(in | out) events fire after focus & blur events,
+// which is spec violation - http://www.w3.org/TR/DOM-Level-3-Events/#events-focusevent-event-order
+// Related ticket - https://bugs.chromium.org/p/chromium/issues/detail?id=449857
+if ( !support.focusin ) {
+ jQuery.each( { focus: "focusin", blur: "focusout" }, function( orig, fix ) {
+
+ // Attach a single capturing handler on the document while someone wants focusin/focusout
+ var handler = function( event ) {
+ jQuery.event.simulate( fix, event.target, jQuery.event.fix( event ) );
+ };
+
+ jQuery.event.special[ fix ] = {
+ setup: function() {
+
+ // Handle: regular nodes (via `this.ownerDocument`), window
+ // (via `this.document`) & document (via `this`).
+ var doc = this.ownerDocument || this.document || this,
+ attaches = dataPriv.access( doc, fix );
+
+ if ( !attaches ) {
+ doc.addEventListener( orig, handler, true );
+ }
+ dataPriv.access( doc, fix, ( attaches || 0 ) + 1 );
+ },
+ teardown: function() {
+ var doc = this.ownerDocument || this.document || this,
+ attaches = dataPriv.access( doc, fix ) - 1;
+
+ if ( !attaches ) {
+ doc.removeEventListener( orig, handler, true );
+ dataPriv.remove( doc, fix );
+
+ } else {
+ dataPriv.access( doc, fix, attaches );
+ }
+ }
+ };
+ } );
+}
+var location = window.location;
+
+var nonce = { guid: Date.now() };
+
+var rquery = ( /\?/ );
+
+
+
+// Cross-browser xml parsing
+jQuery.parseXML = function( data ) {
+ var xml, parserErrorElem;
+ if ( !data || typeof data !== "string" ) {
+ return null;
+ }
+
+ // Support: IE 9 - 11 only
+ // IE throws on parseFromString with invalid input.
+ try {
+ xml = ( new window.DOMParser() ).parseFromString( data, "text/xml" );
+ } catch ( e ) {}
+
+ parserErrorElem = xml && xml.getElementsByTagName( "parsererror" )[ 0 ];
+ if ( !xml || parserErrorElem ) {
+ jQuery.error( "Invalid XML: " + (
+ parserErrorElem ?
+ jQuery.map( parserErrorElem.childNodes, function( el ) {
+ return el.textContent;
+ } ).join( "\n" ) :
+ data
+ ) );
+ }
+ return xml;
+};
+
+
+var
+ rbracket = /\[\]$/,
+ rCRLF = /\r?\n/g,
+ rsubmitterTypes = /^(?:submit|button|image|reset|file)$/i,
+ rsubmittable = /^(?:input|select|textarea|keygen)/i;
+
+function buildParams( prefix, obj, traditional, add ) {
+ var name;
+
+ if ( Array.isArray( obj ) ) {
+
+ // Serialize array item.
+ jQuery.each( obj, function( i, v ) {
+ if ( traditional || rbracket.test( prefix ) ) {
+
+ // Treat each array item as a scalar.
+ add( prefix, v );
+
+ } else {
+
+ // Item is non-scalar (array or object), encode its numeric index.
+ buildParams(
+ prefix + "[" + ( typeof v === "object" && v != null ? i : "" ) + "]",
+ v,
+ traditional,
+ add
+ );
+ }
+ } );
+
+ } else if ( !traditional && toType( obj ) === "object" ) {
+
+ // Serialize object item.
+ for ( name in obj ) {
+ buildParams( prefix + "[" + name + "]", obj[ name ], traditional, add );
+ }
+
+ } else {
+
+ // Serialize scalar item.
+ add( prefix, obj );
+ }
+}
+
+// Serialize an array of form elements or a set of
+// key/values into a query string
+jQuery.param = function( a, traditional ) {
+ var prefix,
+ s = [],
+ add = function( key, valueOrFunction ) {
+
+ // If value is a function, invoke it and use its return value
+ var value = isFunction( valueOrFunction ) ?
+ valueOrFunction() :
+ valueOrFunction;
+
+ s[ s.length ] = encodeURIComponent( key ) + "=" +
+ encodeURIComponent( value == null ? "" : value );
+ };
+
+ if ( a == null ) {
+ return "";
+ }
+
+ // If an array was passed in, assume that it is an array of form elements.
+ if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) {
+
+ // Serialize the form elements
+ jQuery.each( a, function() {
+ add( this.name, this.value );
+ } );
+
+ } else {
+
+ // If traditional, encode the "old" way (the way 1.3.2 or older
+ // did it), otherwise encode params recursively.
+ for ( prefix in a ) {
+ buildParams( prefix, a[ prefix ], traditional, add );
+ }
+ }
+
+ // Return the resulting serialization
+ return s.join( "&" );
+};
+
+jQuery.fn.extend( {
+ serialize: function() {
+ return jQuery.param( this.serializeArray() );
+ },
+ serializeArray: function() {
+ return this.map( function() {
+
+ // Can add propHook for "elements" to filter or add form elements
+ var elements = jQuery.prop( this, "elements" );
+ return elements ? jQuery.makeArray( elements ) : this;
+ } ).filter( function() {
+ var type = this.type;
+
+ // Use .is( ":disabled" ) so that fieldset[disabled] works
+ return this.name && !jQuery( this ).is( ":disabled" ) &&
+ rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) &&
+ ( this.checked || !rcheckableType.test( type ) );
+ } ).map( function( _i, elem ) {
+ var val = jQuery( this ).val();
+
+ if ( val == null ) {
+ return null;
+ }
+
+ if ( Array.isArray( val ) ) {
+ return jQuery.map( val, function( val ) {
+ return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
+ } );
+ }
+
+ return { name: elem.name, value: val.replace( rCRLF, "\r\n" ) };
+ } ).get();
+ }
+} );
+
+
+var
+ r20 = /%20/g,
+ rhash = /#.*$/,
+ rantiCache = /([?&])_=[^&]*/,
+ rheaders = /^(.*?):[ \t]*([^\r\n]*)$/mg,
+
+ // #7653, #8125, #8152: local protocol detection
+ rlocalProtocol = /^(?:about|app|app-storage|.+-extension|file|res|widget):$/,
+ rnoContent = /^(?:GET|HEAD)$/,
+ rprotocol = /^\/\//,
+
+ /* Prefilters
+ * 1) They are useful to introduce custom dataTypes (see ajax/jsonp.js for an example)
+ * 2) These are called:
+ * - BEFORE asking for a transport
+ * - AFTER param serialization (s.data is a string if s.processData is true)
+ * 3) key is the dataType
+ * 4) the catchall symbol "*" can be used
+ * 5) execution will start with transport dataType and THEN continue down to "*" if needed
+ */
+ prefilters = {},
+
+ /* Transports bindings
+ * 1) key is the dataType
+ * 2) the catchall symbol "*" can be used
+ * 3) selection will start with transport dataType and THEN go to "*" if needed
+ */
+ transports = {},
+
+ // Avoid comment-prolog char sequence (#10098); must appease lint and evade compression
+ allTypes = "*/".concat( "*" ),
+
+ // Anchor tag for parsing the document origin
+ originAnchor = document.createElement( "a" );
+
+originAnchor.href = location.href;
+
+// Base "constructor" for jQuery.ajaxPrefilter and jQuery.ajaxTransport
+function addToPrefiltersOrTransports( structure ) {
+
+ // dataTypeExpression is optional and defaults to "*"
+ return function( dataTypeExpression, func ) {
+
+ if ( typeof dataTypeExpression !== "string" ) {
+ func = dataTypeExpression;
+ dataTypeExpression = "*";
+ }
+
+ var dataType,
+ i = 0,
+ dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || [];
+
+ if ( isFunction( func ) ) {
+
+ // For each dataType in the dataTypeExpression
+ while ( ( dataType = dataTypes[ i++ ] ) ) {
+
+ // Prepend if requested
+ if ( dataType[ 0 ] === "+" ) {
+ dataType = dataType.slice( 1 ) || "*";
+ ( structure[ dataType ] = structure[ dataType ] || [] ).unshift( func );
+
+ // Otherwise append
+ } else {
+ ( structure[ dataType ] = structure[ dataType ] || [] ).push( func );
+ }
+ }
+ }
+ };
+}
+
+// Base inspection function for prefilters and transports
+function inspectPrefiltersOrTransports( structure, options, originalOptions, jqXHR ) {
+
+ var inspected = {},
+ seekingTransport = ( structure === transports );
+
+ function inspect( dataType ) {
+ var selected;
+ inspected[ dataType ] = true;
+ jQuery.each( structure[ dataType ] || [], function( _, prefilterOrFactory ) {
+ var dataTypeOrTransport = prefilterOrFactory( options, originalOptions, jqXHR );
+ if ( typeof dataTypeOrTransport === "string" &&
+ !seekingTransport && !inspected[ dataTypeOrTransport ] ) {
+
+ options.dataTypes.unshift( dataTypeOrTransport );
+ inspect( dataTypeOrTransport );
+ return false;
+ } else if ( seekingTransport ) {
+ return !( selected = dataTypeOrTransport );
+ }
+ } );
+ return selected;
+ }
+
+ return inspect( options.dataTypes[ 0 ] ) || !inspected[ "*" ] && inspect( "*" );
+}
+
+// A special extend for ajax options
+// that takes "flat" options (not to be deep extended)
+// Fixes #9887
+function ajaxExtend( target, src ) {
+ var key, deep,
+ flatOptions = jQuery.ajaxSettings.flatOptions || {};
+
+ for ( key in src ) {
+ if ( src[ key ] !== undefined ) {
+ ( flatOptions[ key ] ? target : ( deep || ( deep = {} ) ) )[ key ] = src[ key ];
+ }
+ }
+ if ( deep ) {
+ jQuery.extend( true, target, deep );
+ }
+
+ return target;
+}
+
+/* Handles responses to an ajax request:
+ * - finds the right dataType (mediates between content-type and expected dataType)
+ * - returns the corresponding response
+ */
+function ajaxHandleResponses( s, jqXHR, responses ) {
+
+ var ct, type, finalDataType, firstDataType,
+ contents = s.contents,
+ dataTypes = s.dataTypes;
+
+ // Remove auto dataType and get content-type in the process
+ while ( dataTypes[ 0 ] === "*" ) {
+ dataTypes.shift();
+ if ( ct === undefined ) {
+ ct = s.mimeType || jqXHR.getResponseHeader( "Content-Type" );
+ }
+ }
+
+ // Check if we're dealing with a known content-type
+ if ( ct ) {
+ for ( type in contents ) {
+ if ( contents[ type ] && contents[ type ].test( ct ) ) {
+ dataTypes.unshift( type );
+ break;
+ }
+ }
+ }
+
+ // Check to see if we have a response for the expected dataType
+ if ( dataTypes[ 0 ] in responses ) {
+ finalDataType = dataTypes[ 0 ];
+ } else {
+
+ // Try convertible dataTypes
+ for ( type in responses ) {
+ if ( !dataTypes[ 0 ] || s.converters[ type + " " + dataTypes[ 0 ] ] ) {
+ finalDataType = type;
+ break;
+ }
+ if ( !firstDataType ) {
+ firstDataType = type;
+ }
+ }
+
+ // Or just use first one
+ finalDataType = finalDataType || firstDataType;
+ }
+
+ // If we found a dataType
+ // We add the dataType to the list if needed
+ // and return the corresponding response
+ if ( finalDataType ) {
+ if ( finalDataType !== dataTypes[ 0 ] ) {
+ dataTypes.unshift( finalDataType );
+ }
+ return responses[ finalDataType ];
+ }
+}
+
+/* Chain conversions given the request and the original response
+ * Also sets the responseXXX fields on the jqXHR instance
+ */
+function ajaxConvert( s, response, jqXHR, isSuccess ) {
+ var conv2, current, conv, tmp, prev,
+ converters = {},
+
+ // Work with a copy of dataTypes in case we need to modify it for conversion
+ dataTypes = s.dataTypes.slice();
+
+ // Create converters map with lowercased keys
+ if ( dataTypes[ 1 ] ) {
+ for ( conv in s.converters ) {
+ converters[ conv.toLowerCase() ] = s.converters[ conv ];
+ }
+ }
+
+ current = dataTypes.shift();
+
+ // Convert to each sequential dataType
+ while ( current ) {
+
+ if ( s.responseFields[ current ] ) {
+ jqXHR[ s.responseFields[ current ] ] = response;
+ }
+
+ // Apply the dataFilter if provided
+ if ( !prev && isSuccess && s.dataFilter ) {
+ response = s.dataFilter( response, s.dataType );
+ }
+
+ prev = current;
+ current = dataTypes.shift();
+
+ if ( current ) {
+
+ // There's only work to do if current dataType is non-auto
+ if ( current === "*" ) {
+
+ current = prev;
+
+ // Convert response if prev dataType is non-auto and differs from current
+ } else if ( prev !== "*" && prev !== current ) {
+
+ // Seek a direct converter
+ conv = converters[ prev + " " + current ] || converters[ "* " + current ];
+
+ // If none found, seek a pair
+ if ( !conv ) {
+ for ( conv2 in converters ) {
+
+ // If conv2 outputs current
+ tmp = conv2.split( " " );
+ if ( tmp[ 1 ] === current ) {
+
+ // If prev can be converted to accepted input
+ conv = converters[ prev + " " + tmp[ 0 ] ] ||
+ converters[ "* " + tmp[ 0 ] ];
+ if ( conv ) {
+
+ // Condense equivalence converters
+ if ( conv === true ) {
+ conv = converters[ conv2 ];
+
+ // Otherwise, insert the intermediate dataType
+ } else if ( converters[ conv2 ] !== true ) {
+ current = tmp[ 0 ];
+ dataTypes.unshift( tmp[ 1 ] );
+ }
+ break;
+ }
+ }
+ }
+ }
+
+ // Apply converter (if not an equivalence)
+ if ( conv !== true ) {
+
+ // Unless errors are allowed to bubble, catch and return them
+ if ( conv && s.throws ) {
+ response = conv( response );
+ } else {
+ try {
+ response = conv( response );
+ } catch ( e ) {
+ return {
+ state: "parsererror",
+ error: conv ? e : "No conversion from " + prev + " to " + current
+ };
+ }
+ }
+ }
+ }
+ }
+ }
+
+ return { state: "success", data: response };
+}
+
+jQuery.extend( {
+
+ // Counter for holding the number of active queries
+ active: 0,
+
+ // Last-Modified header cache for next request
+ lastModified: {},
+ etag: {},
+
+ ajaxSettings: {
+ url: location.href,
+ type: "GET",
+ isLocal: rlocalProtocol.test( location.protocol ),
+ global: true,
+ processData: true,
+ async: true,
+ contentType: "application/x-www-form-urlencoded; charset=UTF-8",
+
+ /*
+ timeout: 0,
+ data: null,
+ dataType: null,
+ username: null,
+ password: null,
+ cache: null,
+ throws: false,
+ traditional: false,
+ headers: {},
+ */
+
+ accepts: {
+ "*": allTypes,
+ text: "text/plain",
+ html: "text/html",
+ xml: "application/xml, text/xml",
+ json: "application/json, text/javascript"
+ },
+
+ contents: {
+ xml: /\bxml\b/,
+ html: /\bhtml/,
+ json: /\bjson\b/
+ },
+
+ responseFields: {
+ xml: "responseXML",
+ text: "responseText",
+ json: "responseJSON"
+ },
+
+ // Data converters
+ // Keys separate source (or catchall "*") and destination types with a single space
+ converters: {
+
+ // Convert anything to text
+ "* text": String,
+
+ // Text to html (true = no transformation)
+ "text html": true,
+
+ // Evaluate text as a json expression
+ "text json": JSON.parse,
+
+ // Parse text as xml
+ "text xml": jQuery.parseXML
+ },
+
+ // For options that shouldn't be deep extended:
+ // you can add your own custom options here if
+ // and when you create one that shouldn't be
+ // deep extended (see ajaxExtend)
+ flatOptions: {
+ url: true,
+ context: true
+ }
+ },
+
+ // Creates a full fledged settings object into target
+ // with both ajaxSettings and settings fields.
+ // If target is omitted, writes into ajaxSettings.
+ ajaxSetup: function( target, settings ) {
+ return settings ?
+
+ // Building a settings object
+ ajaxExtend( ajaxExtend( target, jQuery.ajaxSettings ), settings ) :
+
+ // Extending ajaxSettings
+ ajaxExtend( jQuery.ajaxSettings, target );
+ },
+
+ ajaxPrefilter: addToPrefiltersOrTransports( prefilters ),
+ ajaxTransport: addToPrefiltersOrTransports( transports ),
+
+ // Main method
+ ajax: function( url, options ) {
+
+ // If url is an object, simulate pre-1.5 signature
+ if ( typeof url === "object" ) {
+ options = url;
+ url = undefined;
+ }
+
+ // Force options to be an object
+ options = options || {};
+
+ var transport,
+
+ // URL without anti-cache param
+ cacheURL,
+
+ // Response headers
+ responseHeadersString,
+ responseHeaders,
+
+ // timeout handle
+ timeoutTimer,
+
+ // Url cleanup var
+ urlAnchor,
+
+ // Request state (becomes false upon send and true upon completion)
+ completed,
+
+ // To know if global events are to be dispatched
+ fireGlobals,
+
+ // Loop variable
+ i,
+
+ // uncached part of the url
+ uncached,
+
+ // Create the final options object
+ s = jQuery.ajaxSetup( {}, options ),
+
+ // Callbacks context
+ callbackContext = s.context || s,
+
+ // Context for global events is callbackContext if it is a DOM node or jQuery collection
+ globalEventContext = s.context &&
+ ( callbackContext.nodeType || callbackContext.jquery ) ?
+ jQuery( callbackContext ) :
+ jQuery.event,
+
+ // Deferreds
+ deferred = jQuery.Deferred(),
+ completeDeferred = jQuery.Callbacks( "once memory" ),
+
+ // Status-dependent callbacks
+ statusCode = s.statusCode || {},
+
+ // Headers (they are sent all at once)
+ requestHeaders = {},
+ requestHeadersNames = {},
+
+ // Default abort message
+ strAbort = "canceled",
+
+ // Fake xhr
+ jqXHR = {
+ readyState: 0,
+
+ // Builds headers hashtable if needed
+ getResponseHeader: function( key ) {
+ var match;
+ if ( completed ) {
+ if ( !responseHeaders ) {
+ responseHeaders = {};
+ while ( ( match = rheaders.exec( responseHeadersString ) ) ) {
+ responseHeaders[ match[ 1 ].toLowerCase() + " " ] =
+ ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] )
+ .concat( match[ 2 ] );
+ }
+ }
+ match = responseHeaders[ key.toLowerCase() + " " ];
+ }
+ return match == null ? null : match.join( ", " );
+ },
+
+ // Raw string
+ getAllResponseHeaders: function() {
+ return completed ? responseHeadersString : null;
+ },
+
+ // Caches the header
+ setRequestHeader: function( name, value ) {
+ if ( completed == null ) {
+ name = requestHeadersNames[ name.toLowerCase() ] =
+ requestHeadersNames[ name.toLowerCase() ] || name;
+ requestHeaders[ name ] = value;
+ }
+ return this;
+ },
+
+ // Overrides response content-type header
+ overrideMimeType: function( type ) {
+ if ( completed == null ) {
+ s.mimeType = type;
+ }
+ return this;
+ },
+
+ // Status-dependent callbacks
+ statusCode: function( map ) {
+ var code;
+ if ( map ) {
+ if ( completed ) {
+
+ // Execute the appropriate callbacks
+ jqXHR.always( map[ jqXHR.status ] );
+ } else {
+
+ // Lazy-add the new callbacks in a way that preserves old ones
+ for ( code in map ) {
+ statusCode[ code ] = [ statusCode[ code ], map[ code ] ];
+ }
+ }
+ }
+ return this;
+ },
+
+ // Cancel the request
+ abort: function( statusText ) {
+ var finalText = statusText || strAbort;
+ if ( transport ) {
+ transport.abort( finalText );
+ }
+ done( 0, finalText );
+ return this;
+ }
+ };
+
+ // Attach deferreds
+ deferred.promise( jqXHR );
+
+ // Add protocol if not provided (prefilters might expect it)
+ // Handle falsy url in the settings object (#10093: consistency with old signature)
+ // We also use the url parameter if available
+ s.url = ( ( url || s.url || location.href ) + "" )
+ .replace( rprotocol, location.protocol + "//" );
+
+ // Alias method option to type as per ticket #12004
+ s.type = options.method || options.type || s.method || s.type;
+
+ // Extract dataTypes list
+ s.dataTypes = ( s.dataType || "*" ).toLowerCase().match( rnothtmlwhite ) || [ "" ];
+
+ // A cross-domain request is in order when the origin doesn't match the current origin.
+ if ( s.crossDomain == null ) {
+ urlAnchor = document.createElement( "a" );
+
+ // Support: IE <=8 - 11, Edge 12 - 15
+ // IE throws exception on accessing the href property if url is malformed,
+ // e.g. http://example.com:80x/
+ try {
+ urlAnchor.href = s.url;
+
+ // Support: IE <=8 - 11 only
+ // Anchor's host property isn't correctly set when s.url is relative
+ urlAnchor.href = urlAnchor.href;
+ s.crossDomain = originAnchor.protocol + "//" + originAnchor.host !==
+ urlAnchor.protocol + "//" + urlAnchor.host;
+ } catch ( e ) {
+
+ // If there is an error parsing the URL, assume it is crossDomain,
+ // it can be rejected by the transport if it is invalid
+ s.crossDomain = true;
+ }
+ }
+
+ // Convert data if not already a string
+ if ( s.data && s.processData && typeof s.data !== "string" ) {
+ s.data = jQuery.param( s.data, s.traditional );
+ }
+
+ // Apply prefilters
+ inspectPrefiltersOrTransports( prefilters, s, options, jqXHR );
+
+ // If request was aborted inside a prefilter, stop there
+ if ( completed ) {
+ return jqXHR;
+ }
+
+ // We can fire global events as of now if asked to
+ // Don't fire events if jQuery.event is undefined in an AMD-usage scenario (#15118)
+ fireGlobals = jQuery.event && s.global;
+
+ // Watch for a new set of requests
+ if ( fireGlobals && jQuery.active++ === 0 ) {
+ jQuery.event.trigger( "ajaxStart" );
+ }
+
+ // Uppercase the type
+ s.type = s.type.toUpperCase();
+
+ // Determine if request has content
+ s.hasContent = !rnoContent.test( s.type );
+
+ // Save the URL in case we're toying with the If-Modified-Since
+ // and/or If-None-Match header later on
+ // Remove hash to simplify url manipulation
+ cacheURL = s.url.replace( rhash, "" );
+
+ // More options handling for requests with no content
+ if ( !s.hasContent ) {
+
+ // Remember the hash so we can put it back
+ uncached = s.url.slice( cacheURL.length );
+
+ // If data is available and should be processed, append data to url
+ if ( s.data && ( s.processData || typeof s.data === "string" ) ) {
+ cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data;
+
+ // #9682: remove data so that it's not used in an eventual retry
+ delete s.data;
+ }
+
+ // Add or update anti-cache param if needed
+ if ( s.cache === false ) {
+ cacheURL = cacheURL.replace( rantiCache, "$1" );
+ uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) +
+ uncached;
+ }
+
+ // Put hash and anti-cache on the URL that will be requested (gh-1732)
+ s.url = cacheURL + uncached;
+
+ // Change '%20' to '+' if this is encoded form body content (gh-2658)
+ } else if ( s.data && s.processData &&
+ ( s.contentType || "" ).indexOf( "application/x-www-form-urlencoded" ) === 0 ) {
+ s.data = s.data.replace( r20, "+" );
+ }
+
+ // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
+ if ( s.ifModified ) {
+ if ( jQuery.lastModified[ cacheURL ] ) {
+ jqXHR.setRequestHeader( "If-Modified-Since", jQuery.lastModified[ cacheURL ] );
+ }
+ if ( jQuery.etag[ cacheURL ] ) {
+ jqXHR.setRequestHeader( "If-None-Match", jQuery.etag[ cacheURL ] );
+ }
+ }
+
+ // Set the correct header, if data is being sent
+ if ( s.data && s.hasContent && s.contentType !== false || options.contentType ) {
+ jqXHR.setRequestHeader( "Content-Type", s.contentType );
+ }
+
+ // Set the Accepts header for the server, depending on the dataType
+ jqXHR.setRequestHeader(
+ "Accept",
+ s.dataTypes[ 0 ] && s.accepts[ s.dataTypes[ 0 ] ] ?
+ s.accepts[ s.dataTypes[ 0 ] ] +
+ ( s.dataTypes[ 0 ] !== "*" ? ", " + allTypes + "; q=0.01" : "" ) :
+ s.accepts[ "*" ]
+ );
+
+ // Check for headers option
+ for ( i in s.headers ) {
+ jqXHR.setRequestHeader( i, s.headers[ i ] );
+ }
+
+ // Allow custom headers/mimetypes and early abort
+ if ( s.beforeSend &&
+ ( s.beforeSend.call( callbackContext, jqXHR, s ) === false || completed ) ) {
+
+ // Abort if not done already and return
+ return jqXHR.abort();
+ }
+
+ // Aborting is no longer a cancellation
+ strAbort = "abort";
+
+ // Install callbacks on deferreds
+ completeDeferred.add( s.complete );
+ jqXHR.done( s.success );
+ jqXHR.fail( s.error );
+
+ // Get transport
+ transport = inspectPrefiltersOrTransports( transports, s, options, jqXHR );
+
+ // If no transport, we auto-abort
+ if ( !transport ) {
+ done( -1, "No Transport" );
+ } else {
+ jqXHR.readyState = 1;
+
+ // Send global event
+ if ( fireGlobals ) {
+ globalEventContext.trigger( "ajaxSend", [ jqXHR, s ] );
+ }
+
+ // If request was aborted inside ajaxSend, stop there
+ if ( completed ) {
+ return jqXHR;
+ }
+
+ // Timeout
+ if ( s.async && s.timeout > 0 ) {
+ timeoutTimer = window.setTimeout( function() {
+ jqXHR.abort( "timeout" );
+ }, s.timeout );
+ }
+
+ try {
+ completed = false;
+ transport.send( requestHeaders, done );
+ } catch ( e ) {
+
+ // Rethrow post-completion exceptions
+ if ( completed ) {
+ throw e;
+ }
+
+ // Propagate others as results
+ done( -1, e );
+ }
+ }
+
+ // Callback for when everything is done
+ function done( status, nativeStatusText, responses, headers ) {
+ var isSuccess, success, error, response, modified,
+ statusText = nativeStatusText;
+
+ // Ignore repeat invocations
+ if ( completed ) {
+ return;
+ }
+
+ completed = true;
+
+ // Clear timeout if it exists
+ if ( timeoutTimer ) {
+ window.clearTimeout( timeoutTimer );
+ }
+
+ // Dereference transport for early garbage collection
+ // (no matter how long the jqXHR object will be used)
+ transport = undefined;
+
+ // Cache response headers
+ responseHeadersString = headers || "";
+
+ // Set readyState
+ jqXHR.readyState = status > 0 ? 4 : 0;
+
+ // Determine if successful
+ isSuccess = status >= 200 && status < 300 || status === 304;
+
+ // Get response data
+ if ( responses ) {
+ response = ajaxHandleResponses( s, jqXHR, responses );
+ }
+
+ // Use a noop converter for missing script but not if jsonp
+ if ( !isSuccess &&
+ jQuery.inArray( "script", s.dataTypes ) > -1 &&
+ jQuery.inArray( "json", s.dataTypes ) < 0 ) {
+ s.converters[ "text script" ] = function() {};
+ }
+
+ // Convert no matter what (that way responseXXX fields are always set)
+ response = ajaxConvert( s, response, jqXHR, isSuccess );
+
+ // If successful, handle type chaining
+ if ( isSuccess ) {
+
+ // Set the If-Modified-Since and/or If-None-Match header, if in ifModified mode.
+ if ( s.ifModified ) {
+ modified = jqXHR.getResponseHeader( "Last-Modified" );
+ if ( modified ) {
+ jQuery.lastModified[ cacheURL ] = modified;
+ }
+ modified = jqXHR.getResponseHeader( "etag" );
+ if ( modified ) {
+ jQuery.etag[ cacheURL ] = modified;
+ }
+ }
+
+ // if no content
+ if ( status === 204 || s.type === "HEAD" ) {
+ statusText = "nocontent";
+
+ // if not modified
+ } else if ( status === 304 ) {
+ statusText = "notmodified";
+
+ // If we have data, let's convert it
+ } else {
+ statusText = response.state;
+ success = response.data;
+ error = response.error;
+ isSuccess = !error;
+ }
+ } else {
+
+ // Extract error from statusText and normalize for non-aborts
+ error = statusText;
+ if ( status || !statusText ) {
+ statusText = "error";
+ if ( status < 0 ) {
+ status = 0;
+ }
+ }
+ }
+
+ // Set data for the fake xhr object
+ jqXHR.status = status;
+ jqXHR.statusText = ( nativeStatusText || statusText ) + "";
+
+ // Success/Error
+ if ( isSuccess ) {
+ deferred.resolveWith( callbackContext, [ success, statusText, jqXHR ] );
+ } else {
+ deferred.rejectWith( callbackContext, [ jqXHR, statusText, error ] );
+ }
+
+ // Status-dependent callbacks
+ jqXHR.statusCode( statusCode );
+ statusCode = undefined;
+
+ if ( fireGlobals ) {
+ globalEventContext.trigger( isSuccess ? "ajaxSuccess" : "ajaxError",
+ [ jqXHR, s, isSuccess ? success : error ] );
+ }
+
+ // Complete
+ completeDeferred.fireWith( callbackContext, [ jqXHR, statusText ] );
+
+ if ( fireGlobals ) {
+ globalEventContext.trigger( "ajaxComplete", [ jqXHR, s ] );
+
+ // Handle the global AJAX counter
+ if ( !( --jQuery.active ) ) {
+ jQuery.event.trigger( "ajaxStop" );
+ }
+ }
+ }
+
+ return jqXHR;
+ },
+
+ getJSON: function( url, data, callback ) {
+ return jQuery.get( url, data, callback, "json" );
+ },
+
+ getScript: function( url, callback ) {
+ return jQuery.get( url, undefined, callback, "script" );
+ }
+} );
+
+jQuery.each( [ "get", "post" ], function( _i, method ) {
+ jQuery[ method ] = function( url, data, callback, type ) {
+
+ // Shift arguments if data argument was omitted
+ if ( isFunction( data ) ) {
+ type = type || callback;
+ callback = data;
+ data = undefined;
+ }
+
+ // The url can be an options object (which then must have .url)
+ return jQuery.ajax( jQuery.extend( {
+ url: url,
+ type: method,
+ dataType: type,
+ data: data,
+ success: callback
+ }, jQuery.isPlainObject( url ) && url ) );
+ };
+} );
+
+jQuery.ajaxPrefilter( function( s ) {
+ var i;
+ for ( i in s.headers ) {
+ if ( i.toLowerCase() === "content-type" ) {
+ s.contentType = s.headers[ i ] || "";
+ }
+ }
+} );
+
+
+jQuery._evalUrl = function( url, options, doc ) {
+ return jQuery.ajax( {
+ url: url,
+
+ // Make this explicit, since user can override this through ajaxSetup (#11264)
+ type: "GET",
+ dataType: "script",
+ cache: true,
+ async: false,
+ global: false,
+
+ // Only evaluate the response if it is successful (gh-4126)
+ // dataFilter is not invoked for failure responses, so using it instead
+ // of the default converter is kludgy but it works.
+ converters: {
+ "text script": function() {}
+ },
+ dataFilter: function( response ) {
+ jQuery.globalEval( response, options, doc );
+ }
+ } );
+};
+
+
+jQuery.fn.extend( {
+ wrapAll: function( html ) {
+ var wrap;
+
+ if ( this[ 0 ] ) {
+ if ( isFunction( html ) ) {
+ html = html.call( this[ 0 ] );
+ }
+
+ // The elements to wrap the target around
+ wrap = jQuery( html, this[ 0 ].ownerDocument ).eq( 0 ).clone( true );
+
+ if ( this[ 0 ].parentNode ) {
+ wrap.insertBefore( this[ 0 ] );
+ }
+
+ wrap.map( function() {
+ var elem = this;
+
+ while ( elem.firstElementChild ) {
+ elem = elem.firstElementChild;
+ }
+
+ return elem;
+ } ).append( this );
+ }
+
+ return this;
+ },
+
+ wrapInner: function( html ) {
+ if ( isFunction( html ) ) {
+ return this.each( function( i ) {
+ jQuery( this ).wrapInner( html.call( this, i ) );
+ } );
+ }
+
+ return this.each( function() {
+ var self = jQuery( this ),
+ contents = self.contents();
+
+ if ( contents.length ) {
+ contents.wrapAll( html );
+
+ } else {
+ self.append( html );
+ }
+ } );
+ },
+
+ wrap: function( html ) {
+ var htmlIsFunction = isFunction( html );
+
+ return this.each( function( i ) {
+ jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html );
+ } );
+ },
+
+ unwrap: function( selector ) {
+ this.parent( selector ).not( "body" ).each( function() {
+ jQuery( this ).replaceWith( this.childNodes );
+ } );
+ return this;
+ }
+} );
+
+
+jQuery.expr.pseudos.hidden = function( elem ) {
+ return !jQuery.expr.pseudos.visible( elem );
+};
+jQuery.expr.pseudos.visible = function( elem ) {
+ return !!( elem.offsetWidth || elem.offsetHeight || elem.getClientRects().length );
+};
+
+
+
+
+jQuery.ajaxSettings.xhr = function() {
+ try {
+ return new window.XMLHttpRequest();
+ } catch ( e ) {}
+};
+
+var xhrSuccessStatus = {
+
+ // File protocol always yields status code 0, assume 200
+ 0: 200,
+
+ // Support: IE <=9 only
+ // #1450: sometimes IE returns 1223 when it should be 204
+ 1223: 204
+ },
+ xhrSupported = jQuery.ajaxSettings.xhr();
+
+support.cors = !!xhrSupported && ( "withCredentials" in xhrSupported );
+support.ajax = xhrSupported = !!xhrSupported;
+
+jQuery.ajaxTransport( function( options ) {
+ var callback, errorCallback;
+
+ // Cross domain only allowed if supported through XMLHttpRequest
+ if ( support.cors || xhrSupported && !options.crossDomain ) {
+ return {
+ send: function( headers, complete ) {
+ var i,
+ xhr = options.xhr();
+
+ xhr.open(
+ options.type,
+ options.url,
+ options.async,
+ options.username,
+ options.password
+ );
+
+ // Apply custom fields if provided
+ if ( options.xhrFields ) {
+ for ( i in options.xhrFields ) {
+ xhr[ i ] = options.xhrFields[ i ];
+ }
+ }
+
+ // Override mime type if needed
+ if ( options.mimeType && xhr.overrideMimeType ) {
+ xhr.overrideMimeType( options.mimeType );
+ }
+
+ // X-Requested-With header
+ // For cross-domain requests, seeing as conditions for a preflight are
+ // akin to a jigsaw puzzle, we simply never set it to be sure.
+ // (it can always be set on a per-request basis or even using ajaxSetup)
+ // For same-domain requests, won't change header if already provided.
+ if ( !options.crossDomain && !headers[ "X-Requested-With" ] ) {
+ headers[ "X-Requested-With" ] = "XMLHttpRequest";
+ }
+
+ // Set headers
+ for ( i in headers ) {
+ xhr.setRequestHeader( i, headers[ i ] );
+ }
+
+ // Callback
+ callback = function( type ) {
+ return function() {
+ if ( callback ) {
+ callback = errorCallback = xhr.onload =
+ xhr.onerror = xhr.onabort = xhr.ontimeout =
+ xhr.onreadystatechange = null;
+
+ if ( type === "abort" ) {
+ xhr.abort();
+ } else if ( type === "error" ) {
+
+ // Support: IE <=9 only
+ // On a manual native abort, IE9 throws
+ // errors on any property access that is not readyState
+ if ( typeof xhr.status !== "number" ) {
+ complete( 0, "error" );
+ } else {
+ complete(
+
+ // File: protocol always yields status 0; see #8605, #14207
+ xhr.status,
+ xhr.statusText
+ );
+ }
+ } else {
+ complete(
+ xhrSuccessStatus[ xhr.status ] || xhr.status,
+ xhr.statusText,
+
+ // Support: IE <=9 only
+ // IE9 has no XHR2 but throws on binary (trac-11426)
+ // For XHR2 non-text, let the caller handle it (gh-2498)
+ ( xhr.responseType || "text" ) !== "text" ||
+ typeof xhr.responseText !== "string" ?
+ { binary: xhr.response } :
+ { text: xhr.responseText },
+ xhr.getAllResponseHeaders()
+ );
+ }
+ }
+ };
+ };
+
+ // Listen to events
+ xhr.onload = callback();
+ errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" );
+
+ // Support: IE 9 only
+ // Use onreadystatechange to replace onabort
+ // to handle uncaught aborts
+ if ( xhr.onabort !== undefined ) {
+ xhr.onabort = errorCallback;
+ } else {
+ xhr.onreadystatechange = function() {
+
+ // Check readyState before timeout as it changes
+ if ( xhr.readyState === 4 ) {
+
+ // Allow onerror to be called first,
+ // but that will not handle a native abort
+ // Also, save errorCallback to a variable
+ // as xhr.onerror cannot be accessed
+ window.setTimeout( function() {
+ if ( callback ) {
+ errorCallback();
+ }
+ } );
+ }
+ };
+ }
+
+ // Create the abort callback
+ callback = callback( "abort" );
+
+ try {
+
+ // Do send the request (this may raise an exception)
+ xhr.send( options.hasContent && options.data || null );
+ } catch ( e ) {
+
+ // #14683: Only rethrow if this hasn't been notified as an error yet
+ if ( callback ) {
+ throw e;
+ }
+ }
+ },
+
+ abort: function() {
+ if ( callback ) {
+ callback();
+ }
+ }
+ };
+ }
+} );
+
+
+
+
+// Prevent auto-execution of scripts when no explicit dataType was provided (See gh-2432)
+jQuery.ajaxPrefilter( function( s ) {
+ if ( s.crossDomain ) {
+ s.contents.script = false;
+ }
+} );
+
+// Install script dataType
+jQuery.ajaxSetup( {
+ accepts: {
+ script: "text/javascript, application/javascript, " +
+ "application/ecmascript, application/x-ecmascript"
+ },
+ contents: {
+ script: /\b(?:java|ecma)script\b/
+ },
+ converters: {
+ "text script": function( text ) {
+ jQuery.globalEval( text );
+ return text;
+ }
+ }
+} );
+
+// Handle cache's special case and crossDomain
+jQuery.ajaxPrefilter( "script", function( s ) {
+ if ( s.cache === undefined ) {
+ s.cache = false;
+ }
+ if ( s.crossDomain ) {
+ s.type = "GET";
+ }
+} );
+
+// Bind script tag hack transport
+jQuery.ajaxTransport( "script", function( s ) {
+
+ // This transport only deals with cross domain or forced-by-attrs requests
+ if ( s.crossDomain || s.scriptAttrs ) {
+ var script, callback;
+ return {
+ send: function( _, complete ) {
+ script = jQuery( "
+
+
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+Code Examples
+A number of examples are included in the source distribution of Reticulum.
+You can use these examples to learn how to write your own programs.
+
+Minimal
+The Minimal example demonstrates the bare-minimum setup required to connect to
+a Reticulum network from your program. In about five lines of code, you will
+have the Reticulum Network Stack initialised, and ready to pass traffic in your
+program.
+##########################################################
+# This RNS example demonstrates a minimal setup, that #
+# will start up the Reticulum Network Stack, generate a #
+# new destination, and let the user send an announce. #
+##########################################################
+
+import argparse
+import sys
+import RNS
+
+# Let's define an app name. We'll use this for all
+# destinations we create. Since this basic example
+# is part of a range of example utilities, we'll put
+# them all within the app namespace "example_utilities"
+APP_NAME = "example_utilities"
+
+# This initialisation is executed when the program is started
+def program_setup ( configpath ):
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Randomly create a new identity for our example
+ identity = RNS . Identity ()
+
+ # Using the identity we just created, we create a destination.
+ # Destinations are endpoints in Reticulum, that can be addressed
+ # and communicated with. Destinations can also announce their
+ # existence, which will let the network know they are reachable
+ # and automatically create paths to them, from anywhere else
+ # in the network.
+ destination = RNS . Destination (
+ identity ,
+ RNS . Destination . IN ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "minimalsample"
+ )
+
+ # We configure the destination to automatically prove all
+ # packets addressed to it. By doing this, RNS will automatically
+ # generate a proof for each incoming packet and transmit it
+ # back to the sender of that packet. This will let anyone that
+ # tries to communicate with the destination know whether their
+ # communication was received correctly.
+ destination . set_proof_strategy ( RNS . Destination . PROVE_ALL )
+
+ # Everything's ready!
+ # Let's hand over control to the announce loop
+ announceLoop ( destination )
+
+
+def announceLoop ( destination ):
+ # Let the user know that everything is ready
+ RNS . log (
+ "Minimal example " +
+ RNS . prettyhexrep ( destination . hash ) +
+ " running, hit enter to manually send an announce (Ctrl-C to quit)"
+ )
+
+ # We enter a loop that runs until the users exits.
+ # If the user hits enter, we will announce our server
+ # destination on the network, which will let clients
+ # know how to create messages directed towards it.
+ while True :
+ entered = input ()
+ destination . announce ()
+ RNS . log ( "Sent announce from " + RNS . prettyhexrep ( destination . hash ))
+
+
+##########################################################
+#### Program Startup #####################################
+##########################################################
+
+# This part of the program gets run at startup,
+# and parses input from the user, and then starts
+# the desired program mode.
+if __name__ == "__main__" :
+ try :
+ parser = argparse . ArgumentParser (
+ description = "Minimal example to start Reticulum and create a destination"
+ )
+
+ parser . add_argument (
+ "--config" ,
+ action = "store" ,
+ default = None ,
+ help = "path to alternative Reticulum config directory" ,
+ type = str
+ )
+
+ args = parser . parse_args ()
+
+ if args . config :
+ configarg = args . config
+ else :
+ configarg = None
+
+ program_setup ( configarg )
+
+ except KeyboardInterrupt :
+ print ( "" )
+ sys . exit ( 0 )
+
+
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Minimal.py .
+
+
+Announce
+The Announce example builds upon the previous example by exploring how to
+announce a destination on the network, and how to let your program receive
+notifications about announces from relevant destinations.
+##########################################################
+# This RNS example demonstrates setting up announce #
+# callbacks, which will let an application receive a #
+# notification when an announce relevant for it arrives #
+##########################################################
+
+import argparse
+import random
+import sys
+import RNS
+
+# Let's define an app name. We'll use this for all
+# destinations we create. Since this basic example
+# is part of a range of example utilities, we'll put
+# them all within the app namespace "example_utilities"
+APP_NAME = "example_utilities"
+
+# We initialise two lists of strings to use as app_data
+fruits = [ "Peach" , "Quince" , "Date" , "Tangerine" , "Pomelo" , "Carambola" , "Grape" ]
+noble_gases = [ "Helium" , "Neon" , "Argon" , "Krypton" , "Xenon" , "Radon" , "Oganesson" ]
+
+# This initialisation is executed when the program is started
+def program_setup ( configpath ):
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Randomly create a new identity for our example
+ identity = RNS . Identity ()
+
+ # Using the identity we just created, we create two destinations
+ # in the "example_utilities.announcesample" application space.
+ #
+ # Destinations are endpoints in Reticulum, that can be addressed
+ # and communicated with. Destinations can also announce their
+ # existence, which will let the network know they are reachable
+ # and automatically create paths to them, from anywhere else
+ # in the network.
+ destination_1 = RNS . Destination (
+ identity ,
+ RNS . Destination . IN ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "announcesample" ,
+ "fruits"
+ )
+
+ destination_2 = RNS . Destination (
+ identity ,
+ RNS . Destination . IN ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "announcesample" ,
+ "noble_gases"
+ )
+
+ # We configure the destinations to automatically prove all
+ # packets addressed to it. By doing this, RNS will automatically
+ # generate a proof for each incoming packet and transmit it
+ # back to the sender of that packet. This will let anyone that
+ # tries to communicate with the destination know whether their
+ # communication was received correctly.
+ destination_1 . set_proof_strategy ( RNS . Destination . PROVE_ALL )
+ destination_2 . set_proof_strategy ( RNS . Destination . PROVE_ALL )
+
+ # We create an announce handler and configure it to only ask for
+ # announces from "example_utilities.announcesample.fruits".
+ # Try changing the filter and see what happens.
+ announce_handler = ExampleAnnounceHandler (
+ aspect_filter = "example_utilities.announcesample.fruits"
+ )
+
+ # We register the announce handler with Reticulum
+ RNS . Transport . register_announce_handler ( announce_handler )
+
+ # Everything's ready!
+ # Let's hand over control to the announce loop
+ announceLoop ( destination_1 , destination_2 )
+
+
+def announceLoop ( destination_1 , destination_2 ):
+ # Let the user know that everything is ready
+ RNS . log ( "Announce example running, hit enter to manually send an announce (Ctrl-C to quit)" )
+
+ # We enter a loop that runs until the users exits.
+ # If the user hits enter, we will announce our server
+ # destination on the network, which will let clients
+ # know how to create messages directed towards it.
+ while True :
+ entered = input ()
+
+ # Randomly select a fruit
+ fruit = fruits [ random . randint ( 0 , len ( fruits ) - 1 )]
+
+ # Send the announce including the app data
+ destination_1 . announce ( app_data = fruit . encode ( "utf-8" ))
+ RNS . log (
+ "Sent announce from " +
+ RNS . prettyhexrep ( destination_1 . hash ) +
+ " (" + destination_1 . name + ")"
+ )
+
+ # Randomly select a noble gas
+ noble_gas = noble_gases [ random . randint ( 0 , len ( noble_gases ) - 1 )]
+
+ # Send the announce including the app data
+ destination_2 . announce ( app_data = noble_gas . encode ( "utf-8" ))
+ RNS . log (
+ "Sent announce from " +
+ RNS . prettyhexrep ( destination_2 . hash ) +
+ " (" + destination_2 . name + ")"
+ )
+
+# We will need to define an announce handler class that
+# Reticulum can message when an announce arrives.
+class ExampleAnnounceHandler :
+ # The initialisation method takes the optional
+ # aspect_filter argument. If aspect_filter is set to
+ # None, all announces will be passed to the instance.
+ # If only some announces are wanted, it can be set to
+ # an aspect string.
+ def __init__ ( self , aspect_filter = None ):
+ self . aspect_filter = aspect_filter
+
+ # This method will be called by Reticulums Transport
+ # system when an announce arrives that matches the
+ # configured aspect filter. Filters must be specific,
+ # and cannot use wildcards.
+ def received_announce ( self , destination_hash , announced_identity , app_data ):
+ RNS . log (
+ "Received an announce from " +
+ RNS . prettyhexrep ( destination_hash )
+ )
+
+ if app_data :
+ RNS . log (
+ "The announce contained the following app data: " +
+ app_data . decode ( "utf-8" )
+ )
+
+##########################################################
+#### Program Startup #####################################
+##########################################################
+
+# This part of the program gets run at startup,
+# and parses input from the user, and then starts
+# the desired program mode.
+if __name__ == "__main__" :
+ try :
+ parser = argparse . ArgumentParser (
+ description = "Reticulum example that demonstrates announces and announce handlers"
+ )
+
+ parser . add_argument (
+ "--config" ,
+ action = "store" ,
+ default = None ,
+ help = "path to alternative Reticulum config directory" ,
+ type = str
+ )
+
+ args = parser . parse_args ()
+
+ if args . config :
+ configarg = args . config
+ else :
+ configarg = None
+
+ program_setup ( configarg )
+
+ except KeyboardInterrupt :
+ print ( "" )
+ sys . exit ( 0 )
+
+
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Announce.py .
+
+
+Broadcast
+The Broadcast example explores how to transmit plaintext broadcast messages
+over the network.
+##########################################################
+# This RNS example demonstrates broadcasting unencrypted #
+# information to any listening destinations. #
+##########################################################
+
+import sys
+import argparse
+import RNS
+
+# Let's define an app name. We'll use this for all
+# destinations we create. Since this basic example
+# is part of a range of example utilities, we'll put
+# them all within the app namespace "example_utilities"
+APP_NAME = "example_utilities"
+
+# This initialisation is executed when the program is started
+def program_setup ( configpath , channel = None ):
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # If the user did not select a "channel" we use
+ # a default one called "public_information".
+ # This "channel" is added to the destination name-
+ # space, so the user can select different broadcast
+ # channels.
+ if channel == None :
+ channel = "public_information"
+
+ # We create a PLAIN destination. This is an uncencrypted endpoint
+ # that anyone can listen to and send information to.
+ broadcast_destination = RNS . Destination (
+ None ,
+ RNS . Destination . IN ,
+ RNS . Destination . PLAIN ,
+ APP_NAME ,
+ "broadcast" ,
+ channel
+ )
+
+ # We specify a callback that will get called every time
+ # the destination receives data.
+ broadcast_destination . set_packet_callback ( packet_callback )
+
+ # Everything's ready!
+ # Let's hand over control to the main loop
+ broadcastLoop ( broadcast_destination )
+
+def packet_callback ( data , packet ):
+ # Simply print out the received data
+ print ( "" )
+ print ( "Received data: " + data . decode ( "utf-8" ) + " \r\n > " , end = "" )
+ sys . stdout . flush ()
+
+def broadcastLoop ( destination ):
+ # Let the user know that everything is ready
+ RNS . log (
+ "Broadcast example " +
+ RNS . prettyhexrep ( destination . hash ) +
+ " running, enter text and hit enter to broadcast (Ctrl-C to quit)"
+ )
+
+ # We enter a loop that runs until the users exits.
+ # If the user hits enter, we will send the information
+ # that the user entered into the prompt.
+ while True :
+ print ( "> " , end = "" )
+ entered = input ()
+
+ if entered != "" :
+ data = entered . encode ( "utf-8" )
+ packet = RNS . Packet ( destination , data )
+ packet . send ()
+
+
+
+##########################################################
+#### Program Startup #####################################
+##########################################################
+
+# This part of the program gets run at startup,
+# and parses input from the user, and then starts
+# the program.
+if __name__ == "__main__" :
+ try :
+ parser = argparse . ArgumentParser (
+ description = "Reticulum example demonstrating sending and receiving broadcasts"
+ )
+
+ parser . add_argument (
+ "--config" ,
+ action = "store" ,
+ default = None ,
+ help = "path to alternative Reticulum config directory" ,
+ type = str
+ )
+
+ parser . add_argument (
+ "--channel" ,
+ action = "store" ,
+ default = None ,
+ help = "broadcast channel name" ,
+ type = str
+ )
+
+ args = parser . parse_args ()
+
+ if args . config :
+ configarg = args . config
+ else :
+ configarg = None
+
+ if args . channel :
+ channelarg = args . channel
+ else :
+ channelarg = None
+
+ program_setup ( configarg , channelarg )
+
+ except KeyboardInterrupt :
+ print ( "" )
+ sys . exit ( 0 )
+
+
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Broadcast.py .
+
+
+Echo
+The Echo example demonstrates communication between two destinations using
+the Packet interface.
+##########################################################
+# This RNS example demonstrates a simple client/server #
+# echo utility. A client can send an echo request to the #
+# server, and the server will respond by proving receipt #
+# of the packet. #
+##########################################################
+
+import argparse
+import sys
+import RNS
+
+# Let's define an app name. We'll use this for all
+# destinations we create. Since this echo example
+# is part of a range of example utilities, we'll put
+# them all within the app namespace "example_utilities"
+APP_NAME = "example_utilities"
+
+
+##########################################################
+#### Server Part #########################################
+##########################################################
+
+# This initialisation is executed when the users chooses
+# to run as a server
+def server ( configpath ):
+ global reticulum
+
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Randomly create a new identity for our echo server
+ server_identity = RNS . Identity ()
+
+ # We create a destination that clients can query. We want
+ # to be able to verify echo replies to our clients, so we
+ # create a "single" destination that can receive encrypted
+ # messages. This way the client can send a request and be
+ # certain that no-one else than this destination was able
+ # to read it.
+ echo_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . IN ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "echo" ,
+ "request"
+ )
+
+ # We configure the destination to automatically prove all
+ # packets addressed to it. By doing this, RNS will automatically
+ # generate a proof for each incoming packet and transmit it
+ # back to the sender of that packet.
+ echo_destination . set_proof_strategy ( RNS . Destination . PROVE_ALL )
+
+ # Tell the destination which function in our program to
+ # run when a packet is received. We do this so we can
+ # print a log message when the server receives a request
+ echo_destination . set_packet_callback ( server_callback )
+
+ # Everything's ready!
+ # Let's Wait for client requests or user input
+ announceLoop ( echo_destination )
+
+
+def announceLoop ( destination ):
+ # Let the user know that everything is ready
+ RNS . log (
+ "Echo server " +
+ RNS . prettyhexrep ( destination . hash ) +
+ " running, hit enter to manually send an announce (Ctrl-C to quit)"
+ )
+
+ # We enter a loop that runs until the users exits.
+ # If the user hits enter, we will announce our server
+ # destination on the network, which will let clients
+ # know how to create messages directed towards it.
+ while True :
+ entered = input ()
+ destination . announce ()
+ RNS . log ( "Sent announce from " + RNS . prettyhexrep ( destination . hash ))
+
+
+def server_callback ( message , packet ):
+ global reticulum
+
+ # Tell the user that we received an echo request, and
+ # that we are going to send a reply to the requester.
+ # Sending the proof is handled automatically, since we
+ # set up the destination to prove all incoming packets.
+
+ reception_stats = ""
+ if reticulum . is_connected_to_shared_instance :
+ reception_rssi = reticulum . get_packet_rssi ( packet . packet_hash )
+ reception_snr = reticulum . get_packet_snr ( packet . packet_hash )
+
+ if reception_rssi != None :
+ reception_stats += " [RSSI " + str ( reception_rssi ) + " dBm]"
+
+ if reception_snr != None :
+ reception_stats += " [SNR " + str ( reception_snr ) + " dBm]"
+
+ else :
+ if packet . rssi != None :
+ reception_stats += " [RSSI " + str ( packet . rssi ) + " dBm]"
+
+ if packet . snr != None :
+ reception_stats += " [SNR " + str ( packet . snr ) + " dB]"
+
+ RNS . log ( "Received packet from echo client, proof sent" + reception_stats )
+
+
+##########################################################
+#### Client Part #########################################
+##########################################################
+
+# This initialisation is executed when the users chooses
+# to run as a client
+def client ( destination_hexhash , configpath , timeout = None ):
+ global reticulum
+
+ # We need a binary representation of the destination
+ # hash that was entered on the command line
+ try :
+ dest_len = ( RNS . Reticulum . TRUNCATED_HASHLENGTH // 8 ) * 2
+ if len ( destination_hexhash ) != dest_len :
+ raise ValueError (
+ "Destination length is invalid, must be {hex} hexadecimal characters ( {byte} bytes)." . format ( hex = dest_len , byte = dest_len // 2 )
+ )
+
+ destination_hash = bytes . fromhex ( destination_hexhash )
+ except Exception as e :
+ RNS . log ( "Invalid destination entered. Check your input!" )
+ RNS . log ( str ( e ) + " \n " )
+ sys . exit ( 0 )
+
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # We override the loglevel to provide feedback when
+ # an announce is received
+ if RNS . loglevel < RNS . LOG_INFO :
+ RNS . loglevel = RNS . LOG_INFO
+
+ # Tell the user that the client is ready!
+ RNS . log (
+ "Echo client ready, hit enter to send echo request to " +
+ destination_hexhash +
+ " (Ctrl-C to quit)"
+ )
+
+ # We enter a loop that runs until the user exits.
+ # If the user hits enter, we will try to send an
+ # echo request to the destination specified on the
+ # command line.
+ while True :
+ input ()
+
+ # Let's first check if RNS knows a path to the destination.
+ # If it does, we'll load the server identity and create a packet
+ if RNS . Transport . has_path ( destination_hash ):
+
+ # To address the server, we need to know it's public
+ # key, so we check if Reticulum knows this destination.
+ # This is done by calling the "recall" method of the
+ # Identity module. If the destination is known, it will
+ # return an Identity instance that can be used in
+ # outgoing destinations.
+ server_identity = RNS . Identity . recall ( destination_hash )
+
+ # We got the correct identity instance from the
+ # recall method, so let's create an outgoing
+ # destination. We use the naming convention:
+ # example_utilities.echo.request
+ # This matches the naming we specified in the
+ # server part of the code.
+ request_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . OUT ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "echo" ,
+ "request"
+ )
+
+ # The destination is ready, so let's create a packet.
+ # We set the destination to the request_destination
+ # that was just created, and the only data we add
+ # is a random hash.
+ echo_request = RNS . Packet ( request_destination , RNS . Identity . get_random_hash ())
+
+ # Send the packet! If the packet is successfully
+ # sent, it will return a PacketReceipt instance.
+ packet_receipt = echo_request . send ()
+
+ # If the user specified a timeout, we set this
+ # timeout on the packet receipt, and configure
+ # a callback function, that will get called if
+ # the packet times out.
+ if timeout != None :
+ packet_receipt . set_timeout ( timeout )
+ packet_receipt . set_timeout_callback ( packet_timed_out )
+
+ # We can then set a delivery callback on the receipt.
+ # This will get automatically called when a proof for
+ # this specific packet is received from the destination.
+ packet_receipt . set_delivery_callback ( packet_delivered )
+
+ # Tell the user that the echo request was sent
+ RNS . log ( "Sent echo request to " + RNS . prettyhexrep ( request_destination . hash ))
+ else :
+ # If we do not know this destination, tell the
+ # user to wait for an announce to arrive.
+ RNS . log ( "Destination is not yet known. Requesting path..." )
+ RNS . log ( "Hit enter to manually retry once an announce is received." )
+ RNS . Transport . request_path ( destination_hash )
+
+# This function is called when our reply destination
+# receives a proof packet.
+def packet_delivered ( receipt ):
+ global reticulum
+
+ if receipt . status == RNS . PacketReceipt . DELIVERED :
+ rtt = receipt . get_rtt ()
+ if ( rtt >= 1 ):
+ rtt = round ( rtt , 3 )
+ rttstring = str ( rtt ) + " seconds"
+ else :
+ rtt = round ( rtt * 1000 , 3 )
+ rttstring = str ( rtt ) + " milliseconds"
+
+ reception_stats = ""
+ if reticulum . is_connected_to_shared_instance :
+ reception_rssi = reticulum . get_packet_rssi ( receipt . proof_packet . packet_hash )
+ reception_snr = reticulum . get_packet_snr ( receipt . proof_packet . packet_hash )
+
+ if reception_rssi != None :
+ reception_stats += " [RSSI " + str ( reception_rssi ) + " dBm]"
+
+ if reception_snr != None :
+ reception_stats += " [SNR " + str ( reception_snr ) + " dB]"
+
+ else :
+ if receipt . proof_packet != None :
+ if receipt . proof_packet . rssi != None :
+ reception_stats += " [RSSI " + str ( receipt . proof_packet . rssi ) + " dBm]"
+
+ if receipt . proof_packet . snr != None :
+ reception_stats += " [SNR " + str ( receipt . proof_packet . snr ) + " dB]"
+
+ RNS . log (
+ "Valid reply received from " +
+ RNS . prettyhexrep ( receipt . destination . hash ) +
+ ", round-trip time is " + rttstring +
+ reception_stats
+ )
+
+# This function is called if a packet times out.
+def packet_timed_out ( receipt ):
+ if receipt . status == RNS . PacketReceipt . FAILED :
+ RNS . log ( "Packet " + RNS . prettyhexrep ( receipt . hash ) + " timed out" )
+
+
+##########################################################
+#### Program Startup #####################################
+##########################################################
+
+# This part of the program gets run at startup,
+# and parses input from the user, and then starts
+# the desired program mode.
+if __name__ == "__main__" :
+ try :
+ parser = argparse . ArgumentParser ( description = "Simple echo server and client utility" )
+
+ parser . add_argument (
+ "-s" ,
+ "--server" ,
+ action = "store_true" ,
+ help = "wait for incoming packets from clients"
+ )
+
+ parser . add_argument (
+ "-t" ,
+ "--timeout" ,
+ action = "store" ,
+ metavar = "s" ,
+ default = None ,
+ help = "set a reply timeout in seconds" ,
+ type = float
+ )
+
+ parser . add_argument ( "--config" ,
+ action = "store" ,
+ default = None ,
+ help = "path to alternative Reticulum config directory" ,
+ type = str
+ )
+
+ parser . add_argument (
+ "destination" ,
+ nargs = "?" ,
+ default = None ,
+ help = "hexadecimal hash of the server destination" ,
+ type = str
+ )
+
+ args = parser . parse_args ()
+
+ if args . server :
+ configarg = None
+ if args . config :
+ configarg = args . config
+ server ( configarg )
+ else :
+ if args . config :
+ configarg = args . config
+ else :
+ configarg = None
+
+ if args . timeout :
+ timeoutarg = float ( args . timeout )
+ else :
+ timeoutarg = None
+
+ if ( args . destination == None ):
+ print ( "" )
+ parser . print_help ()
+ print ( "" )
+ else :
+ client ( args . destination , configarg , timeout = timeoutarg )
+ except KeyboardInterrupt :
+ print ( "" )
+ sys . exit ( 0 )
+
+
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Echo.py .
+
+
+Link
+The Link example explores establishing an encrypted link to a remote
+destination, and passing traffic back and forth over the link.
+##########################################################
+# This RNS example demonstrates how to set up a link to #
+# a destination, and pass data back and forth over it. #
+##########################################################
+
+import os
+import sys
+import time
+import argparse
+import RNS
+
+# Let's define an app name. We'll use this for all
+# destinations we create. Since this echo example
+# is part of a range of example utilities, we'll put
+# them all within the app namespace "example_utilities"
+APP_NAME = "example_utilities"
+
+##########################################################
+#### Server Part #########################################
+##########################################################
+
+# A reference to the latest client link that connected
+latest_client_link = None
+
+# This initialisation is executed when the users chooses
+# to run as a server
+def server ( configpath ):
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Randomly create a new identity for our link example
+ server_identity = RNS . Identity ()
+
+ # We create a destination that clients can connect to. We
+ # want clients to create links to this destination, so we
+ # need to create a "single" destination type.
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . IN ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "linkexample"
+ )
+
+ # We configure a function that will get called every time
+ # a new client creates a link to this destination.
+ server_destination . set_link_established_callback ( client_connected )
+
+ # Everything's ready!
+ # Let's Wait for client requests or user input
+ server_loop ( server_destination )
+
+def server_loop ( destination ):
+ # Let the user know that everything is ready
+ RNS . log (
+ "Link example " +
+ RNS . prettyhexrep ( destination . hash ) +
+ " running, waiting for a connection."
+ )
+
+ RNS . log ( "Hit enter to manually send an announce (Ctrl-C to quit)" )
+
+ # We enter a loop that runs until the users exits.
+ # If the user hits enter, we will announce our server
+ # destination on the network, which will let clients
+ # know how to create messages directed towards it.
+ while True :
+ entered = input ()
+ destination . announce ()
+ RNS . log ( "Sent announce from " + RNS . prettyhexrep ( destination . hash ))
+
+# When a client establishes a link to our server
+# destination, this function will be called with
+# a reference to the link.
+def client_connected ( link ):
+ global latest_client_link
+
+ RNS . log ( "Client connected" )
+ link . set_link_closed_callback ( client_disconnected )
+ link . set_packet_callback ( server_packet_received )
+ latest_client_link = link
+
+def client_disconnected ( link ):
+ RNS . log ( "Client disconnected" )
+
+def server_packet_received ( message , packet ):
+ global latest_client_link
+
+ # When data is received over any active link,
+ # it will all be directed to the last client
+ # that connected.
+ text = message . decode ( "utf-8" )
+ RNS . log ( "Received data on the link: " + text )
+
+ reply_text = "I received \" " + text + " \" over the link"
+ reply_data = reply_text . encode ( "utf-8" )
+ RNS . Packet ( latest_client_link , reply_data ) . send ()
+
+
+##########################################################
+#### Client Part #########################################
+##########################################################
+
+# A reference to the server link
+server_link = None
+
+# This initialisation is executed when the users chooses
+# to run as a client
+def client ( destination_hexhash , configpath ):
+ # We need a binary representation of the destination
+ # hash that was entered on the command line
+ try :
+ dest_len = ( RNS . Reticulum . TRUNCATED_HASHLENGTH // 8 ) * 2
+ if len ( destination_hexhash ) != dest_len :
+ raise ValueError (
+ "Destination length is invalid, must be {hex} hexadecimal characters ( {byte} bytes)." . format ( hex = dest_len , byte = dest_len // 2 )
+ )
+
+ destination_hash = bytes . fromhex ( destination_hexhash )
+ except :
+ RNS . log ( "Invalid destination entered. Check your input! \n " )
+ sys . exit ( 0 )
+
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Check if we know a path to the destination
+ if not RNS . Transport . has_path ( destination_hash ):
+ RNS . log ( "Destination is not yet known. Requesting path and waiting for announce to arrive..." )
+ RNS . Transport . request_path ( destination_hash )
+ while not RNS . Transport . has_path ( destination_hash ):
+ time . sleep ( 0.1 )
+
+ # Recall the server identity
+ server_identity = RNS . Identity . recall ( destination_hash )
+
+ # Inform the user that we'll begin connecting
+ RNS . log ( "Establishing link with server..." )
+
+ # When the server identity is known, we set
+ # up a destination
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . OUT ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "linkexample"
+ )
+
+ # And create a link
+ link = RNS . Link ( server_destination )
+
+ # We set a callback that will get executed
+ # every time a packet is received over the
+ # link
+ link . set_packet_callback ( client_packet_received )
+
+ # We'll also set up functions to inform the
+ # user when the link is established or closed
+ link . set_link_established_callback ( link_established )
+ link . set_link_closed_callback ( link_closed )
+
+ # Everything is set up, so let's enter a loop
+ # for the user to interact with the example
+ client_loop ()
+
+def client_loop ():
+ global server_link
+
+ # Wait for the link to become active
+ while not server_link :
+ time . sleep ( 0.1 )
+
+ should_quit = False
+ while not should_quit :
+ try :
+ print ( "> " , end = " " )
+ text = input ()
+
+ # Check if we should quit the example
+ if text == "quit" or text == "q" or text == "exit" :
+ should_quit = True
+ server_link . teardown ()
+
+ # If not, send the entered text over the link
+ if text != "" :
+ data = text . encode ( "utf-8" )
+ if len ( data ) <= RNS . Link . MDU :
+ RNS . Packet ( server_link , data ) . send ()
+ else :
+ RNS . log (
+ "Cannot send this packet, the data size of " +
+ str ( len ( data )) + " bytes exceeds the link packet MDU of " +
+ str ( RNS . Link . MDU ) + " bytes" ,
+ RNS . LOG_ERROR
+ )
+
+ except Exception as e :
+ RNS . log ( "Error while sending data over the link: " + str ( e ))
+ should_quit = True
+ server_link . teardown ()
+
+# This function is called when a link
+# has been established with the server
+def link_established ( link ):
+ # We store a reference to the link
+ # instance for later use
+ global server_link
+ server_link = link
+
+ # Inform the user that the server is
+ # connected
+ RNS . log ( "Link established with server, enter some text to send, or \" quit \" to quit" )
+
+# When a link is closed, we'll inform the
+# user, and exit the program
+def link_closed ( link ):
+ if link . teardown_reason == RNS . Link . TIMEOUT :
+ RNS . log ( "The link timed out, exiting now" )
+ elif link . teardown_reason == RNS . Link . DESTINATION_CLOSED :
+ RNS . log ( "The link was closed by the server, exiting now" )
+ else :
+ RNS . log ( "Link closed, exiting now" )
+
+ time . sleep ( 1.5 )
+ sys . exit ( 0 )
+
+# When a packet is received over the link, we
+# simply print out the data.
+def client_packet_received ( message , packet ):
+ text = message . decode ( "utf-8" )
+ RNS . log ( "Received data on the link: " + text )
+ print ( "> " , end = " " )
+ sys . stdout . flush ()
+
+
+##########################################################
+#### Program Startup #####################################
+##########################################################
+
+# This part of the program runs at startup,
+# and parses input of from the user, and then
+# starts up the desired program mode.
+if __name__ == "__main__" :
+ try :
+ parser = argparse . ArgumentParser ( description = "Simple link example" )
+
+ parser . add_argument (
+ "-s" ,
+ "--server" ,
+ action = "store_true" ,
+ help = "wait for incoming link requests from clients"
+ )
+
+ parser . add_argument (
+ "--config" ,
+ action = "store" ,
+ default = None ,
+ help = "path to alternative Reticulum config directory" ,
+ type = str
+ )
+
+ parser . add_argument (
+ "destination" ,
+ nargs = "?" ,
+ default = None ,
+ help = "hexadecimal hash of the server destination" ,
+ type = str
+ )
+
+ args = parser . parse_args ()
+
+ if args . config :
+ configarg = args . config
+ else :
+ configarg = None
+
+ if args . server :
+ server ( configarg )
+ else :
+ if ( args . destination == None ):
+ print ( "" )
+ parser . print_help ()
+ print ( "" )
+ else :
+ client ( args . destination , configarg )
+
+ except KeyboardInterrupt :
+ print ( "" )
+ sys . exit ( 0 )
+
+
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Link.py .
+
+
+Identification
+The Identify example explores identifying an intiator of a link, once
+the link has been established.
+##########################################################
+# This RNS example demonstrates how to set up a link to #
+# a destination, and identify the initiator to it's peer #
+##########################################################
+
+import os
+import sys
+import time
+import argparse
+import RNS
+
+# Let's define an app name. We'll use this for all
+# destinations we create. Since this echo example
+# is part of a range of example utilities, we'll put
+# them all within the app namespace "example_utilities"
+APP_NAME = "example_utilities"
+
+##########################################################
+#### Server Part #########################################
+##########################################################
+
+# A reference to the latest client link that connected
+latest_client_link = None
+
+# This initialisation is executed when the users chooses
+# to run as a server
+def server ( configpath ):
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Randomly create a new identity for our link example
+ server_identity = RNS . Identity ()
+
+ # We create a destination that clients can connect to. We
+ # want clients to create links to this destination, so we
+ # need to create a "single" destination type.
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . IN ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "identifyexample"
+ )
+
+ # We configure a function that will get called every time
+ # a new client creates a link to this destination.
+ server_destination . set_link_established_callback ( client_connected )
+
+ # Everything's ready!
+ # Let's Wait for client requests or user input
+ server_loop ( server_destination )
+
+def server_loop ( destination ):
+ # Let the user know that everything is ready
+ RNS . log (
+ "Link identification example " +
+ RNS . prettyhexrep ( destination . hash ) +
+ " running, waiting for a connection."
+ )
+
+ RNS . log ( "Hit enter to manually send an announce (Ctrl-C to quit)" )
+
+ # We enter a loop that runs until the users exits.
+ # If the user hits enter, we will announce our server
+ # destination on the network, which will let clients
+ # know how to create messages directed towards it.
+ while True :
+ entered = input ()
+ destination . announce ()
+ RNS . log ( "Sent announce from " + RNS . prettyhexrep ( destination . hash ))
+
+# When a client establishes a link to our server
+# destination, this function will be called with
+# a reference to the link.
+def client_connected ( link ):
+ global latest_client_link
+
+ RNS . log ( "Client connected" )
+ link . set_link_closed_callback ( client_disconnected )
+ link . set_packet_callback ( server_packet_received )
+ link . set_remote_identified_callback ( remote_identified )
+ latest_client_link = link
+
+def client_disconnected ( link ):
+ RNS . log ( "Client disconnected" )
+
+def remote_identified ( link , identity ):
+ RNS . log ( "Remote identified as: " + str ( identity ))
+
+def server_packet_received ( message , packet ):
+ global latest_client_link
+
+ # Get the originating identity for display
+ remote_peer = "unidentified peer"
+ if packet . link . get_remote_identity () != None :
+ remote_peer = str ( packet . link . get_remote_identity ())
+
+ # When data is received over any active link,
+ # it will all be directed to the last client
+ # that connected.
+ text = message . decode ( "utf-8" )
+
+ RNS . log ( "Received data from " + remote_peer + ": " + text )
+
+ reply_text = "I received \" " + text + " \" over the link from " + remote_peer
+ reply_data = reply_text . encode ( "utf-8" )
+ RNS . Packet ( latest_client_link , reply_data ) . send ()
+
+
+##########################################################
+#### Client Part #########################################
+##########################################################
+
+# A reference to the server link
+server_link = None
+
+# A reference to the client identity
+client_identity = None
+
+# This initialisation is executed when the users chooses
+# to run as a client
+def client ( destination_hexhash , configpath ):
+ global client_identity
+ # We need a binary representation of the destination
+ # hash that was entered on the command line
+ try :
+ dest_len = ( RNS . Reticulum . TRUNCATED_HASHLENGTH // 8 ) * 2
+ if len ( destination_hexhash ) != dest_len :
+ raise ValueError (
+ "Destination length is invalid, must be {hex} hexadecimal characters ( {byte} bytes)." . format ( hex = dest_len , byte = dest_len // 2 )
+ )
+
+ destination_hash = bytes . fromhex ( destination_hexhash )
+ except :
+ RNS . log ( "Invalid destination entered. Check your input! \n " )
+ sys . exit ( 0 )
+
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Create a new client identity
+ client_identity = RNS . Identity ()
+ RNS . log (
+ "Client created new identity " +
+ str ( client_identity )
+ )
+
+ # Check if we know a path to the destination
+ if not RNS . Transport . has_path ( destination_hash ):
+ RNS . log ( "Destination is not yet known. Requesting path and waiting for announce to arrive..." )
+ RNS . Transport . request_path ( destination_hash )
+ while not RNS . Transport . has_path ( destination_hash ):
+ time . sleep ( 0.1 )
+
+ # Recall the server identity
+ server_identity = RNS . Identity . recall ( destination_hash )
+
+ # Inform the user that we'll begin connecting
+ RNS . log ( "Establishing link with server..." )
+
+ # When the server identity is known, we set
+ # up a destination
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . OUT ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "identifyexample"
+ )
+
+ # And create a link
+ link = RNS . Link ( server_destination )
+
+ # We set a callback that will get executed
+ # every time a packet is received over the
+ # link
+ link . set_packet_callback ( client_packet_received )
+
+ # We'll also set up functions to inform the
+ # user when the link is established or closed
+ link . set_link_established_callback ( link_established )
+ link . set_link_closed_callback ( link_closed )
+
+ # Everything is set up, so let's enter a loop
+ # for the user to interact with the example
+ client_loop ()
+
+def client_loop ():
+ global server_link
+
+ # Wait for the link to become active
+ while not server_link :
+ time . sleep ( 0.1 )
+
+ should_quit = False
+ while not should_quit :
+ try :
+ print ( "> " , end = " " )
+ text = input ()
+
+ # Check if we should quit the example
+ if text == "quit" or text == "q" or text == "exit" :
+ should_quit = True
+ server_link . teardown ()
+
+ # If not, send the entered text over the link
+ if text != "" :
+ data = text . encode ( "utf-8" )
+ if len ( data ) <= RNS . Link . MDU :
+ RNS . Packet ( server_link , data ) . send ()
+ else :
+ RNS . log (
+ "Cannot send this packet, the data size of " +
+ str ( len ( data )) + " bytes exceeds the link packet MDU of " +
+ str ( RNS . Link . MDU ) + " bytes" ,
+ RNS . LOG_ERROR
+ )
+
+ except Exception as e :
+ RNS . log ( "Error while sending data over the link: " + str ( e ))
+ should_quit = True
+ server_link . teardown ()
+
+# This function is called when a link
+# has been established with the server
+def link_established ( link ):
+ # We store a reference to the link
+ # instance for later use
+ global server_link , client_identity
+ server_link = link
+
+ # Inform the user that the server is
+ # connected
+ RNS . log ( "Link established with server, identifying to remote peer..." )
+
+ link . identify ( client_identity )
+
+# When a link is closed, we'll inform the
+# user, and exit the program
+def link_closed ( link ):
+ if link . teardown_reason == RNS . Link . TIMEOUT :
+ RNS . log ( "The link timed out, exiting now" )
+ elif link . teardown_reason == RNS . Link . DESTINATION_CLOSED :
+ RNS . log ( "The link was closed by the server, exiting now" )
+ else :
+ RNS . log ( "Link closed, exiting now" )
+
+ time . sleep ( 1.5 )
+ sys . exit ( 0 )
+
+# When a packet is received over the link, we
+# simply print out the data.
+def client_packet_received ( message , packet ):
+ text = message . decode ( "utf-8" )
+ RNS . log ( "Received data on the link: " + text )
+ print ( "> " , end = " " )
+ sys . stdout . flush ()
+
+
+##########################################################
+#### Program Startup #####################################
+##########################################################
+
+# This part of the program runs at startup,
+# and parses input of from the user, and then
+# starts up the desired program mode.
+if __name__ == "__main__" :
+ try :
+ parser = argparse . ArgumentParser ( description = "Simple link example" )
+
+ parser . add_argument (
+ "-s" ,
+ "--server" ,
+ action = "store_true" ,
+ help = "wait for incoming link requests from clients"
+ )
+
+ parser . add_argument (
+ "--config" ,
+ action = "store" ,
+ default = None ,
+ help = "path to alternative Reticulum config directory" ,
+ type = str
+ )
+
+ parser . add_argument (
+ "destination" ,
+ nargs = "?" ,
+ default = None ,
+ help = "hexadecimal hash of the server destination" ,
+ type = str
+ )
+
+ args = parser . parse_args ()
+
+ if args . config :
+ configarg = args . config
+ else :
+ configarg = None
+
+ if args . server :
+ server ( configarg )
+ else :
+ if ( args . destination == None ):
+ print ( "" )
+ parser . print_help ()
+ print ( "" )
+ else :
+ client ( args . destination , configarg )
+
+ except KeyboardInterrupt :
+ print ( "" )
+ sys . exit ( 0 )
+
+
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Identify.py .
+
+
+Requests & Responses
+The Request example explores sending requests and receiving responses.
+##########################################################
+# This RNS example demonstrates how to perform requests #
+# and receive responses over a link. #
+##########################################################
+
+import os
+import sys
+import time
+import random
+import argparse
+import RNS
+
+# Let's define an app name. We'll use this for all
+# destinations we create. Since this echo example
+# is part of a range of example utilities, we'll put
+# them all within the app namespace "example_utilities"
+APP_NAME = "example_utilities"
+
+##########################################################
+#### Server Part #########################################
+##########################################################
+
+# A reference to the latest client link that connected
+latest_client_link = None
+
+def random_text_generator ( path , data , request_id , link_id , remote_identity , requested_at ):
+ RNS . log ( "Generating response to request " + RNS . prettyhexrep ( request_id ) + " on link " + RNS . prettyhexrep ( link_id ))
+ texts = [ "They looked up" , "On each full moon" , "Becky was upset" , "I’ll stay away from it" , "The pet shop stocks everything" ]
+ return texts [ random . randint ( 0 , len ( texts ) - 1 )]
+
+# This initialisation is executed when the users chooses
+# to run as a server
+def server ( configpath ):
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Randomly create a new identity for our link example
+ server_identity = RNS . Identity ()
+
+ # We create a destination that clients can connect to. We
+ # want clients to create links to this destination, so we
+ # need to create a "single" destination type.
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . IN ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "requestexample"
+ )
+
+ # We configure a function that will get called every time
+ # a new client creates a link to this destination.
+ server_destination . set_link_established_callback ( client_connected )
+
+ # We register a request handler for handling incoming
+ # requests over any established links.
+ server_destination . register_request_handler (
+ "/random/text" ,
+ response_generator = random_text_generator ,
+ allow = RNS . Destination . ALLOW_ALL
+ )
+
+ # Everything's ready!
+ # Let's Wait for client requests or user input
+ server_loop ( server_destination )
+
+def server_loop ( destination ):
+ # Let the user know that everything is ready
+ RNS . log (
+ "Request example " +
+ RNS . prettyhexrep ( destination . hash ) +
+ " running, waiting for a connection."
+ )
+
+ RNS . log ( "Hit enter to manually send an announce (Ctrl-C to quit)" )
+
+ # We enter a loop that runs until the users exits.
+ # If the user hits enter, we will announce our server
+ # destination on the network, which will let clients
+ # know how to create messages directed towards it.
+ while True :
+ entered = input ()
+ destination . announce ()
+ RNS . log ( "Sent announce from " + RNS . prettyhexrep ( destination . hash ))
+
+# When a client establishes a link to our server
+# destination, this function will be called with
+# a reference to the link.
+def client_connected ( link ):
+ global latest_client_link
+
+ RNS . log ( "Client connected" )
+ link . set_link_closed_callback ( client_disconnected )
+ latest_client_link = link
+
+def client_disconnected ( link ):
+ RNS . log ( "Client disconnected" )
+
+
+##########################################################
+#### Client Part #########################################
+##########################################################
+
+# A reference to the server link
+server_link = None
+
+# This initialisation is executed when the users chooses
+# to run as a client
+def client ( destination_hexhash , configpath ):
+ # We need a binary representation of the destination
+ # hash that was entered on the command line
+ try :
+ dest_len = ( RNS . Reticulum . TRUNCATED_HASHLENGTH // 8 ) * 2
+ if len ( destination_hexhash ) != dest_len :
+ raise ValueError (
+ "Destination length is invalid, must be {hex} hexadecimal characters ( {byte} bytes)." . format ( hex = dest_len , byte = dest_len // 2 )
+ )
+
+ destination_hash = bytes . fromhex ( destination_hexhash )
+ except :
+ RNS . log ( "Invalid destination entered. Check your input! \n " )
+ sys . exit ( 0 )
+
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Check if we know a path to the destination
+ if not RNS . Transport . has_path ( destination_hash ):
+ RNS . log ( "Destination is not yet known. Requesting path and waiting for announce to arrive..." )
+ RNS . Transport . request_path ( destination_hash )
+ while not RNS . Transport . has_path ( destination_hash ):
+ time . sleep ( 0.1 )
+
+ # Recall the server identity
+ server_identity = RNS . Identity . recall ( destination_hash )
+
+ # Inform the user that we'll begin connecting
+ RNS . log ( "Establishing link with server..." )
+
+ # When the server identity is known, we set
+ # up a destination
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . OUT ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "requestexample"
+ )
+
+ # And create a link
+ link = RNS . Link ( server_destination )
+
+ # We'll set up functions to inform the
+ # user when the link is established or closed
+ link . set_link_established_callback ( link_established )
+ link . set_link_closed_callback ( link_closed )
+
+ # Everything is set up, so let's enter a loop
+ # for the user to interact with the example
+ client_loop ()
+
+def client_loop ():
+ global server_link
+
+ # Wait for the link to become active
+ while not server_link :
+ time . sleep ( 0.1 )
+
+ should_quit = False
+ while not should_quit :
+ try :
+ print ( "> " , end = " " )
+ text = input ()
+
+ # Check if we should quit the example
+ if text == "quit" or text == "q" or text == "exit" :
+ should_quit = True
+ server_link . teardown ()
+
+ else :
+ server_link . request (
+ "/random/text" ,
+ data = None ,
+ response_callback = got_response ,
+ failed_callback = request_failed
+ )
+
+
+ except Exception as e :
+ RNS . log ( "Error while sending request over the link: " + str ( e ))
+ should_quit = True
+ server_link . teardown ()
+
+def got_response ( request_receipt ):
+ request_id = request_receipt . request_id
+ response = request_receipt . response
+
+ RNS . log ( "Got response for request " + RNS . prettyhexrep ( request_id ) + ": " + str ( response ))
+
+def request_received ( request_receipt ):
+ RNS . log ( "The request " + RNS . prettyhexrep ( request_receipt . request_id ) + " was received by the remote peer." )
+
+def request_failed ( request_receipt ):
+ RNS . log ( "The request " + RNS . prettyhexrep ( request_receipt . request_id ) + " failed." )
+
+
+# This function is called when a link
+# has been established with the server
+def link_established ( link ):
+ # We store a reference to the link
+ # instance for later use
+ global server_link
+ server_link = link
+
+ # Inform the user that the server is
+ # connected
+ RNS . log ( "Link established with server, hit enter to perform a request, or type in \" quit \" to quit" )
+
+# When a link is closed, we'll inform the
+# user, and exit the program
+def link_closed ( link ):
+ if link . teardown_reason == RNS . Link . TIMEOUT :
+ RNS . log ( "The link timed out, exiting now" )
+ elif link . teardown_reason == RNS . Link . DESTINATION_CLOSED :
+ RNS . log ( "The link was closed by the server, exiting now" )
+ else :
+ RNS . log ( "Link closed, exiting now" )
+
+ time . sleep ( 1.5 )
+ sys . exit ( 0 )
+
+
+##########################################################
+#### Program Startup #####################################
+##########################################################
+
+# This part of the program runs at startup,
+# and parses input of from the user, and then
+# starts up the desired program mode.
+if __name__ == "__main__" :
+ try :
+ parser = argparse . ArgumentParser ( description = "Simple request/response example" )
+
+ parser . add_argument (
+ "-s" ,
+ "--server" ,
+ action = "store_true" ,
+ help = "wait for incoming requests from clients"
+ )
+
+ parser . add_argument (
+ "--config" ,
+ action = "store" ,
+ default = None ,
+ help = "path to alternative Reticulum config directory" ,
+ type = str
+ )
+
+ parser . add_argument (
+ "destination" ,
+ nargs = "?" ,
+ default = None ,
+ help = "hexadecimal hash of the server destination" ,
+ type = str
+ )
+
+ args = parser . parse_args ()
+
+ if args . config :
+ configarg = args . config
+ else :
+ configarg = None
+
+ if args . server :
+ server ( configarg )
+ else :
+ if ( args . destination == None ):
+ print ( "" )
+ parser . print_help ()
+ print ( "" )
+ else :
+ client ( args . destination , configarg )
+
+ except KeyboardInterrupt :
+ print ( "" )
+ sys . exit ( 0 )
+
+
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Request.py .
+
+
+Channel
+The Channel example explores using a Channel Link
+##########################################################
+# This RNS example demonstrates how to set up a link to #
+# a destination, and pass structured messages over it #
+# using a channel. #
+##########################################################
+
+import os
+import sys
+import time
+import argparse
+from datetime import datetime
+
+import RNS
+from RNS.vendor import umsgpack
+
+# Let's define an app name. We'll use this for all
+# destinations we create. Since this echo example
+# is part of a range of example utilities, we'll put
+# them all within the app namespace "example_utilities"
+APP_NAME = "example_utilities"
+
+##########################################################
+#### Shared Objects ######################################
+##########################################################
+
+# Channel data must be structured in a subclass of
+# MessageBase. This ensures that the channel will be able
+# to serialize and deserialize the object and multiplex it
+# with other objects. Both ends of a link will need the
+# same object definitions to be able to communicate over
+# a channel.
+#
+# Note: The objects we wish to use over the channel must
+# be registered with the channel, and each link has a
+# different channel instance. See the client_connected
+# and link_established functions in this example to see
+# how message types are registered.
+
+# Let's make a simple message class called StringMessage
+# that will convey a string with a timestamp.
+
+class StringMessage ( RNS . MessageBase ):
+ # The MSGTYPE class variable needs to be assigned a
+ # 2 byte integer value. This identifier allows the
+ # channel to look up your message's constructor when a
+ # message arrives over the channel.
+ #
+ # MSGTYPE must be unique across all message types we
+ # register with the channel. MSGTYPEs >= 0xf000 are
+ # reserved for the system.
+ MSGTYPE = 0x0101
+
+ # The constructor of our object must be callable with
+ # no arguments. We can have parameters, but they must
+ # have a default assignment.
+ #
+ # This is needed so the channel can create an empty
+ # version of our message into which the incoming
+ # message can be unpacked.
+ def __init__ ( self , data = None ):
+ self . data = data
+ self . timestamp = datetime . now ()
+
+ # Finally, our message needs to implement functions
+ # the channel can call to pack and unpack our message
+ # to/from the raw packet payload. We'll use the
+ # umsgpack package bundled with RNS. We could also use
+ # the struct package bundled with Python if we wanted
+ # more control over the structure of the packed bytes.
+ #
+ # Also note that packed message objects must fit
+ # entirely in one packet. The number of bytes
+ # available for message payloads can be queried from
+ # the channel using the Channel.MDU property. The
+ # channel MDU is slightly less than the link MDU due
+ # to encoding the message header.
+
+ # The pack function encodes the message contents into
+ # a byte stream.
+ def pack ( self ) -> bytes :
+ return umsgpack . packb (( self . data , self . timestamp ))
+
+ # And the unpack function decodes a byte stream into
+ # the message contents.
+ def unpack ( self , raw ):
+ self . data , self . timestamp = umsgpack . unpackb ( raw )
+
+
+##########################################################
+#### Server Part #########################################
+##########################################################
+
+# A reference to the latest client link that connected
+latest_client_link = None
+
+# This initialisation is executed when the users chooses
+# to run as a server
+def server ( configpath ):
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Randomly create a new identity for our link example
+ server_identity = RNS . Identity ()
+
+ # We create a destination that clients can connect to. We
+ # want clients to create links to this destination, so we
+ # need to create a "single" destination type.
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . IN ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "channelexample"
+ )
+
+ # We configure a function that will get called every time
+ # a new client creates a link to this destination.
+ server_destination . set_link_established_callback ( client_connected )
+
+ # Everything's ready!
+ # Let's Wait for client requests or user input
+ server_loop ( server_destination )
+
+def server_loop ( destination ):
+ # Let the user know that everything is ready
+ RNS . log (
+ "Channel example " +
+ RNS . prettyhexrep ( destination . hash ) +
+ " running, waiting for a connection."
+ )
+
+ RNS . log ( "Hit enter to manually send an announce (Ctrl-C to quit)" )
+
+ # We enter a loop that runs until the users exits.
+ # If the user hits enter, we will announce our server
+ # destination on the network, which will let clients
+ # know how to create messages directed towards it.
+ while True :
+ entered = input ()
+ destination . announce ()
+ RNS . log ( "Sent announce from " + RNS . prettyhexrep ( destination . hash ))
+
+# When a client establishes a link to our server
+# destination, this function will be called with
+# a reference to the link.
+def client_connected ( link ):
+ global latest_client_link
+ latest_client_link = link
+
+ RNS . log ( "Client connected" )
+ link . set_link_closed_callback ( client_disconnected )
+
+ # Register message types and add callback to channel
+ channel = link . get_channel ()
+ channel . register_message_type ( StringMessage )
+ channel . add_message_handler ( server_message_received )
+
+def client_disconnected ( link ):
+ RNS . log ( "Client disconnected" )
+
+def server_message_received ( message ):
+ """
+ A message handler
+ @param message: An instance of a subclass of MessageBase
+ @return: True if message was handled
+ """
+ global latest_client_link
+ # When a message is received over any active link,
+ # the replies will all be directed to the last client
+ # that connected.
+
+ # In a message handler, any deserializable message
+ # that arrives over the link's channel will be passed
+ # to all message handlers, unless a preceding handler indicates it
+ # has handled the message.
+ #
+ #
+ if isinstance ( message , StringMessage ):
+ RNS . log ( "Received data on the link: " + message . data + " (message created at " + str ( message . timestamp ) + ")" )
+
+ reply_message = StringMessage ( "I received \" " + message . data + " \" over the link" )
+ latest_client_link . get_channel () . send ( reply_message )
+
+ # Incoming messages are sent to each message
+ # handler added to the channel, in the order they
+ # were added.
+ # If any message handler returns True, the message
+ # is considered handled and any subsequent
+ # handlers are skipped.
+ return True
+
+
+##########################################################
+#### Client Part #########################################
+##########################################################
+
+# A reference to the server link
+server_link = None
+
+# This initialisation is executed when the users chooses
+# to run as a client
+def client ( destination_hexhash , configpath ):
+ # We need a binary representation of the destination
+ # hash that was entered on the command line
+ try :
+ dest_len = ( RNS . Reticulum . TRUNCATED_HASHLENGTH // 8 ) * 2
+ if len ( destination_hexhash ) != dest_len :
+ raise ValueError (
+ "Destination length is invalid, must be {hex} hexadecimal characters ( {byte} bytes)." . format ( hex = dest_len , byte = dest_len // 2 )
+ )
+
+ destination_hash = bytes . fromhex ( destination_hexhash )
+ except :
+ RNS . log ( "Invalid destination entered. Check your input! \n " )
+ sys . exit ( 0 )
+
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Check if we know a path to the destination
+ if not RNS . Transport . has_path ( destination_hash ):
+ RNS . log ( "Destination is not yet known. Requesting path and waiting for announce to arrive..." )
+ RNS . Transport . request_path ( destination_hash )
+ while not RNS . Transport . has_path ( destination_hash ):
+ time . sleep ( 0.1 )
+
+ # Recall the server identity
+ server_identity = RNS . Identity . recall ( destination_hash )
+
+ # Inform the user that we'll begin connecting
+ RNS . log ( "Establishing link with server..." )
+
+ # When the server identity is known, we set
+ # up a destination
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . OUT ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "channelexample"
+ )
+
+ # And create a link
+ link = RNS . Link ( server_destination )
+
+ # We'll also set up functions to inform the
+ # user when the link is established or closed
+ link . set_link_established_callback ( link_established )
+ link . set_link_closed_callback ( link_closed )
+
+ # Everything is set up, so let's enter a loop
+ # for the user to interact with the example
+ client_loop ()
+
+def client_loop ():
+ global server_link
+
+ # Wait for the link to become active
+ while not server_link :
+ time . sleep ( 0.1 )
+
+ should_quit = False
+ while not should_quit :
+ try :
+ print ( "> " , end = " " )
+ text = input ()
+
+ # Check if we should quit the example
+ if text == "quit" or text == "q" or text == "exit" :
+ should_quit = True
+ server_link . teardown ()
+
+ # If not, send the entered text over the link
+ if text != "" :
+ message = StringMessage ( text )
+ packed_size = len ( message . pack ())
+ channel = server_link . get_channel ()
+ if channel . is_ready_to_send ():
+ if packed_size <= channel . mdu :
+ channel . send ( message )
+ else :
+ RNS . log (
+ "Cannot send this packet, the data size of " +
+ str ( packed_size ) + " bytes exceeds the link packet MDU of " +
+ str ( channel . MDU ) + " bytes" ,
+ RNS . LOG_ERROR
+ )
+ else :
+ RNS . log ( "Channel is not ready to send, please wait for " +
+ "pending messages to complete." , RNS . LOG_ERROR )
+
+ except Exception as e :
+ RNS . log ( "Error while sending data over the link: " + str ( e ))
+ should_quit = True
+ server_link . teardown ()
+
+# This function is called when a link
+# has been established with the server
+def link_established ( link ):
+ # We store a reference to the link
+ # instance for later use
+ global server_link
+ server_link = link
+
+ # Register messages and add handler to channel
+ channel = link . get_channel ()
+ channel . register_message_type ( StringMessage )
+ channel . add_message_handler ( client_message_received )
+
+ # Inform the user that the server is
+ # connected
+ RNS . log ( "Link established with server, enter some text to send, or \" quit \" to quit" )
+
+# When a link is closed, we'll inform the
+# user, and exit the program
+def link_closed ( link ):
+ if link . teardown_reason == RNS . Link . TIMEOUT :
+ RNS . log ( "The link timed out, exiting now" )
+ elif link . teardown_reason == RNS . Link . DESTINATION_CLOSED :
+ RNS . log ( "The link was closed by the server, exiting now" )
+ else :
+ RNS . log ( "Link closed, exiting now" )
+
+ time . sleep ( 1.5 )
+ sys . exit ( 0 )
+
+# When a packet is received over the channel, we
+# simply print out the data.
+def client_message_received ( message ):
+ if isinstance ( message , StringMessage ):
+ RNS . log ( "Received data on the link: " + message . data + " (message created at " + str ( message . timestamp ) + ")" )
+ print ( "> " , end = " " )
+ sys . stdout . flush ()
+
+
+##########################################################
+#### Program Startup #####################################
+##########################################################
+
+# This part of the program runs at startup,
+# and parses input of from the user, and then
+# starts up the desired program mode.
+if __name__ == "__main__" :
+ try :
+ parser = argparse . ArgumentParser ( description = "Simple channel example" )
+
+ parser . add_argument (
+ "-s" ,
+ "--server" ,
+ action = "store_true" ,
+ help = "wait for incoming link requests from clients"
+ )
+
+ parser . add_argument (
+ "--config" ,
+ action = "store" ,
+ default = None ,
+ help = "path to alternative Reticulum config directory" ,
+ type = str
+ )
+
+ parser . add_argument (
+ "destination" ,
+ nargs = "?" ,
+ default = None ,
+ help = "hexadecimal hash of the server destination" ,
+ type = str
+ )
+
+ args = parser . parse_args ()
+
+ if args . config :
+ configarg = args . config
+ else :
+ configarg = None
+
+ if args . server :
+ server ( configarg )
+ else :
+ if ( args . destination == None ):
+ print ( "" )
+ parser . print_help ()
+ print ( "" )
+ else :
+ client ( args . destination , configarg )
+
+ except KeyboardInterrupt :
+ print ( "" )
+ sys . exit ( 0 )
+
+
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Channel.py .
+
+
+Buffer
+The Buffer example explores using buffered readers and writers to send
+binary data between peers of a Link
+##########################################################
+# This RNS example demonstrates how to set up a link to #
+# a destination, and pass binary data over it using a #
+# channel buffer. #
+##########################################################
+from __future__ import annotations
+import os
+import sys
+import time
+import argparse
+from datetime import datetime
+
+import RNS
+from RNS.vendor import umsgpack
+
+# Let's define an app name. We'll use this for all
+# destinations we create. Since this echo example
+# is part of a range of example utilities, we'll put
+# them all within the app namespace "example_utilities"
+APP_NAME = "example_utilities"
+
+
+##########################################################
+#### Server Part #########################################
+##########################################################
+
+# A reference to the latest client link that connected
+latest_client_link = None
+
+# A reference to the latest buffer object
+latest_buffer = None
+
+# This initialisation is executed when the users chooses
+# to run as a server
+def server ( configpath ):
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Randomly create a new identity for our example
+ server_identity = RNS . Identity ()
+
+ # We create a destination that clients can connect to. We
+ # want clients to create links to this destination, so we
+ # need to create a "single" destination type.
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . IN ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "bufferexample"
+ )
+
+ # We configure a function that will get called every time
+ # a new client creates a link to this destination.
+ server_destination . set_link_established_callback ( client_connected )
+
+ # Everything's ready!
+ # Let's Wait for client requests or user input
+ server_loop ( server_destination )
+
+def server_loop ( destination ):
+ # Let the user know that everything is ready
+ RNS . log (
+ "Link buffer example " +
+ RNS . prettyhexrep ( destination . hash ) +
+ " running, waiting for a connection."
+ )
+
+ RNS . log ( "Hit enter to manually send an announce (Ctrl-C to quit)" )
+
+ # We enter a loop that runs until the users exits.
+ # If the user hits enter, we will announce our server
+ # destination on the network, which will let clients
+ # know how to create messages directed towards it.
+ while True :
+ entered = input ()
+ destination . announce ()
+ RNS . log ( "Sent announce from " + RNS . prettyhexrep ( destination . hash ))
+
+# When a client establishes a link to our server
+# destination, this function will be called with
+# a reference to the link.
+def client_connected ( link ):
+ global latest_client_link , latest_buffer
+ latest_client_link = link
+
+ RNS . log ( "Client connected" )
+ link . set_link_closed_callback ( client_disconnected )
+
+ # If a new connection is received, the old reader
+ # needs to be disconnected.
+ if latest_buffer :
+ latest_buffer . close ()
+
+
+ # Create buffer objects.
+ # The stream_id parameter to these functions is
+ # a bit like a file descriptor, except that it
+ # is unique to the *receiver*.
+ #
+ # In this example, both the reader and the writer
+ # use stream_id = 0, but there are actually two
+ # separate unidirectional streams flowing in
+ # opposite directions.
+ #
+ channel = link . get_channel ()
+ latest_buffer = RNS . Buffer . create_bidirectional_buffer ( 0 , 0 , channel , server_buffer_ready )
+
+def client_disconnected ( link ):
+ RNS . log ( "Client disconnected" )
+
+def server_buffer_ready ( ready_bytes : int ):
+ """
+ Callback from buffer when buffer has data available
+
+ :param ready_bytes: The number of bytes ready to read
+ """
+ global latest_buffer
+
+ data = latest_buffer . read ( ready_bytes )
+ data = data . decode ( "utf-8" )
+
+ RNS . log ( "Received data over the buffer: " + data )
+
+ reply_message = "I received \" " + data + " \" over the buffer"
+ reply_message = reply_message . encode ( "utf-8" )
+ latest_buffer . write ( reply_message )
+ latest_buffer . flush ()
+
+
+
+
+##########################################################
+#### Client Part #########################################
+##########################################################
+
+# A reference to the server link
+server_link = None
+
+# A reference to the buffer object, needed to share the
+# object from the link connected callback to the client
+# loop.
+buffer = None
+
+# This initialisation is executed when the users chooses
+# to run as a client
+def client ( destination_hexhash , configpath ):
+ # We need a binary representation of the destination
+ # hash that was entered on the command line
+ try :
+ dest_len = ( RNS . Reticulum . TRUNCATED_HASHLENGTH // 8 ) * 2
+ if len ( destination_hexhash ) != dest_len :
+ raise ValueError (
+ "Destination length is invalid, must be {hex} hexadecimal characters ( {byte} bytes)." . format ( hex = dest_len , byte = dest_len // 2 )
+ )
+
+ destination_hash = bytes . fromhex ( destination_hexhash )
+ except :
+ RNS . log ( "Invalid destination entered. Check your input! \n " )
+ sys . exit ( 0 )
+
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Check if we know a path to the destination
+ if not RNS . Transport . has_path ( destination_hash ):
+ RNS . log ( "Destination is not yet known. Requesting path and waiting for announce to arrive..." )
+ RNS . Transport . request_path ( destination_hash )
+ while not RNS . Transport . has_path ( destination_hash ):
+ time . sleep ( 0.1 )
+
+ # Recall the server identity
+ server_identity = RNS . Identity . recall ( destination_hash )
+
+ # Inform the user that we'll begin connecting
+ RNS . log ( "Establishing link with server..." )
+
+ # When the server identity is known, we set
+ # up a destination
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . OUT ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "bufferexample"
+ )
+
+ # And create a link
+ link = RNS . Link ( server_destination )
+
+ # We'll also set up functions to inform the
+ # user when the link is established or closed
+ link . set_link_established_callback ( link_established )
+ link . set_link_closed_callback ( link_closed )
+
+ # Everything is set up, so let's enter a loop
+ # for the user to interact with the example
+ client_loop ()
+
+def client_loop ():
+ global server_link
+
+ # Wait for the link to become active
+ while not server_link :
+ time . sleep ( 0.1 )
+
+ should_quit = False
+ while not should_quit :
+ try :
+ print ( "> " , end = " " )
+ text = input ()
+
+ # Check if we should quit the example
+ if text == "quit" or text == "q" or text == "exit" :
+ should_quit = True
+ server_link . teardown ()
+ else :
+ # Otherwise, encode the text and write it to the buffer.
+ text = text . encode ( "utf-8" )
+ buffer . write ( text )
+ # Flush the buffer to force the data to be sent.
+ buffer . flush ()
+
+
+ except Exception as e :
+ RNS . log ( "Error while sending data over the link buffer: " + str ( e ))
+ should_quit = True
+ server_link . teardown ()
+
+# This function is called when a link
+# has been established with the server
+def link_established ( link ):
+ # We store a reference to the link
+ # instance for later use
+ global server_link , buffer
+ server_link = link
+
+ # Create buffer, see server_client_connected() for
+ # more detail about setting up the buffer.
+ channel = link . get_channel ()
+ buffer = RNS . Buffer . create_bidirectional_buffer ( 0 , 0 , channel , client_buffer_ready )
+
+ # Inform the user that the server is
+ # connected
+ RNS . log ( "Link established with server, enter some text to send, or \" quit \" to quit" )
+
+# When a link is closed, we'll inform the
+# user, and exit the program
+def link_closed ( link ):
+ if link . teardown_reason == RNS . Link . TIMEOUT :
+ RNS . log ( "The link timed out, exiting now" )
+ elif link . teardown_reason == RNS . Link . DESTINATION_CLOSED :
+ RNS . log ( "The link was closed by the server, exiting now" )
+ else :
+ RNS . log ( "Link closed, exiting now" )
+
+ time . sleep ( 1.5 )
+ sys . exit ( 0 )
+
+# When the buffer has new data, read it and write it to the terminal.
+def client_buffer_ready ( ready_bytes : int ):
+ global buffer
+ data = buffer . read ( ready_bytes )
+ RNS . log ( "Received data over the link buffer: " + data . decode ( "utf-8" ))
+ print ( "> " , end = " " )
+ sys . stdout . flush ()
+
+
+##########################################################
+#### Program Startup #####################################
+##########################################################
+
+# This part of the program runs at startup,
+# and parses input of from the user, and then
+# starts up the desired program mode.
+if __name__ == "__main__" :
+ try :
+ parser = argparse . ArgumentParser ( description = "Simple buffer example" )
+
+ parser . add_argument (
+ "-s" ,
+ "--server" ,
+ action = "store_true" ,
+ help = "wait for incoming link requests from clients"
+ )
+
+ parser . add_argument (
+ "--config" ,
+ action = "store" ,
+ default = None ,
+ help = "path to alternative Reticulum config directory" ,
+ type = str
+ )
+
+ parser . add_argument (
+ "destination" ,
+ nargs = "?" ,
+ default = None ,
+ help = "hexadecimal hash of the server destination" ,
+ type = str
+ )
+
+ args = parser . parse_args ()
+
+ if args . config :
+ configarg = args . config
+ else :
+ configarg = None
+
+ if args . server :
+ server ( configarg )
+ else :
+ if ( args . destination == None ):
+ print ( "" )
+ parser . print_help ()
+ print ( "" )
+ else :
+ client ( args . destination , configarg )
+
+ except KeyboardInterrupt :
+ print ( "" )
+ sys . exit ( 0 )
+
+
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Buffer.py .
+
+
+Filetransfer
+The Filetransfer example implements a basic file-server program that
+allow clients to connect and download files. The program uses the Resource
+interface to efficiently pass files of any size over a Reticulum Link
+##########################################################
+# This RNS example demonstrates a simple filetransfer #
+# server and client program. The server will serve a #
+# directory of files, and the clients can list and #
+# download files from the server. #
+# #
+# Please note that using RNS Resources for large file #
+# transfers is not recommended, since compression, #
+# encryption and hashmap sequencing can take a long time #
+# on systems with slow CPUs, which will probably result #
+# in the client timing out before the resource sender #
+# can complete preparing the resource. #
+# #
+# If you need to transfer large files, use the Bundle #
+# class instead, which will automatically slice the data #
+# into chunks suitable for packing as a Resource. #
+##########################################################
+
+import os
+import sys
+import time
+import threading
+import argparse
+import RNS
+import RNS.vendor.umsgpack as umsgpack
+
+# Let's define an app name. We'll use this for all
+# destinations we create. Since this echo example
+# is part of a range of example utilities, we'll put
+# them all within the app namespace "example_utilities"
+APP_NAME = "example_utilities"
+
+# We'll also define a default timeout, in seconds
+APP_TIMEOUT = 45.0
+
+##########################################################
+#### Server Part #########################################
+##########################################################
+
+serve_path = None
+
+# This initialisation is executed when the users chooses
+# to run as a server
+def server ( configpath , path ):
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+ # Randomly create a new identity for our file server
+ server_identity = RNS . Identity ()
+
+ global serve_path
+ serve_path = path
+
+ # We create a destination that clients can connect to. We
+ # want clients to create links to this destination, so we
+ # need to create a "single" destination type.
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . IN ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "filetransfer" ,
+ "server"
+ )
+
+ # We configure a function that will get called every time
+ # a new client creates a link to this destination.
+ server_destination . set_link_established_callback ( client_connected )
+
+ # Everything's ready!
+ # Let's Wait for client requests or user input
+ announceLoop ( server_destination )
+
+def announceLoop ( destination ):
+ # Let the user know that everything is ready
+ RNS . log ( "File server " + RNS . prettyhexrep ( destination . hash ) + " running" )
+ RNS . log ( "Hit enter to manually send an announce (Ctrl-C to quit)" )
+
+ # We enter a loop that runs until the users exits.
+ # If the user hits enter, we will announce our server
+ # destination on the network, which will let clients
+ # know how to create messages directed towards it.
+ while True :
+ entered = input ()
+ destination . announce ()
+ RNS . log ( "Sent announce from " + RNS . prettyhexrep ( destination . hash ))
+
+# Here's a convenience function for listing all files
+# in our served directory
+def list_files ():
+ # We add all entries from the directory that are
+ # actual files, and does not start with "."
+ global serve_path
+ return [ file for file in os . listdir ( serve_path ) if os . path . isfile ( os . path . join ( serve_path , file )) and file [: 1 ] != "." ]
+
+# When a client establishes a link to our server
+# destination, this function will be called with
+# a reference to the link. We then send the client
+# a list of files hosted on the server.
+def client_connected ( link ):
+ # Check if the served directory still exists
+ if os . path . isdir ( serve_path ):
+ RNS . log ( "Client connected, sending file list..." )
+
+ link . set_link_closed_callback ( client_disconnected )
+
+ # We pack a list of files for sending in a packet
+ data = umsgpack . packb ( list_files ())
+
+ # Check the size of the packed data
+ if len ( data ) <= RNS . Link . MDU :
+ # If it fits in one packet, we will just
+ # send it as a single packet over the link.
+ list_packet = RNS . Packet ( link , data )
+ list_receipt = list_packet . send ()
+ list_receipt . set_timeout ( APP_TIMEOUT )
+ list_receipt . set_delivery_callback ( list_delivered )
+ list_receipt . set_timeout_callback ( list_timeout )
+ else :
+ RNS . log ( "Too many files in served directory!" , RNS . LOG_ERROR )
+ RNS . log ( "You should implement a function to split the filelist over multiple packets." , RNS . LOG_ERROR )
+ RNS . log ( "Hint: The client already supports it :)" , RNS . LOG_ERROR )
+
+ # After this, we're just going to keep the link
+ # open until the client requests a file. We'll
+ # configure a function that get's called when
+ # the client sends a packet with a file request.
+ link . set_packet_callback ( client_request )
+ else :
+ RNS . log ( "Client connected, but served path no longer exists!" , RNS . LOG_ERROR )
+ link . teardown ()
+
+def client_disconnected ( link ):
+ RNS . log ( "Client disconnected" )
+
+def client_request ( message , packet ):
+ global serve_path
+
+ try :
+ filename = message . decode ( "utf-8" )
+ except Exception as e :
+ filename = None
+
+ if filename in list_files ():
+ try :
+ # If we have the requested file, we'll
+ # read it and pack it as a resource
+ RNS . log ( "Client requested \" " + filename + " \" " )
+ file = open ( os . path . join ( serve_path , filename ), "rb" )
+
+ file_resource = RNS . Resource (
+ file ,
+ packet . link ,
+ callback = resource_sending_concluded
+ )
+
+ file_resource . filename = filename
+ except Exception as e :
+ # If somethign went wrong, we close
+ # the link
+ RNS . log ( "Error while reading file \" " + filename + " \" " , RNS . LOG_ERROR )
+ packet . link . teardown ()
+ raise e
+ else :
+ # If we don't have it, we close the link
+ RNS . log ( "Client requested an unknown file" )
+ packet . link . teardown ()
+
+# This function is called on the server when a
+# resource transfer concludes.
+def resource_sending_concluded ( resource ):
+ if hasattr ( resource , "filename" ):
+ name = resource . filename
+ else :
+ name = "resource"
+
+ if resource . status == RNS . Resource . COMPLETE :
+ RNS . log ( "Done sending \" " + name + " \" to client" )
+ elif resource . status == RNS . Resource . FAILED :
+ RNS . log ( "Sending \" " + name + " \" to client failed" )
+
+def list_delivered ( receipt ):
+ RNS . log ( "The file list was received by the client" )
+
+def list_timeout ( receipt ):
+ RNS . log ( "Sending list to client timed out, closing this link" )
+ link = receipt . destination
+ link . teardown ()
+
+##########################################################
+#### Client Part #########################################
+##########################################################
+
+# We store a global list of files available on the server
+server_files = []
+
+# A reference to the server link
+server_link = None
+
+# And a reference to the current download
+current_download = None
+current_filename = None
+
+# Variables to store download statistics
+download_started = 0
+download_finished = 0
+download_time = 0
+transfer_size = 0
+file_size = 0
+
+
+# This initialisation is executed when the users chooses
+# to run as a client
+def client ( destination_hexhash , configpath ):
+ # We need a binary representation of the destination
+ # hash that was entered on the command line
+ try :
+ dest_len = ( RNS . Reticulum . TRUNCATED_HASHLENGTH // 8 ) * 2
+ if len ( destination_hexhash ) != dest_len :
+ raise ValueError (
+ "Destination length is invalid, must be {hex} hexadecimal characters ( {byte} bytes)." . format ( hex = dest_len , byte = dest_len // 2 )
+ )
+
+ destination_hash = bytes . fromhex ( destination_hexhash )
+ except :
+ RNS . log ( "Invalid destination entered. Check your input! \n " )
+ sys . exit ( 0 )
+
+ # We must first initialise Reticulum
+ reticulum = RNS . Reticulum ( configpath )
+
+
+ # Check if we know a path to the destination
+ if not RNS . Transport . has_path ( destination_hash ):
+ RNS . log ( "Destination is not yet known. Requesting path and waiting for announce to arrive..." )
+ RNS . Transport . request_path ( destination_hash )
+ while not RNS . Transport . has_path ( destination_hash ):
+ time . sleep ( 0.1 )
+
+ # Recall the server identity
+ server_identity = RNS . Identity . recall ( destination_hash )
+
+ # Inform the user that we'll begin connecting
+ RNS . log ( "Establishing link with server..." )
+
+ # When the server identity is known, we set
+ # up a destination
+ server_destination = RNS . Destination (
+ server_identity ,
+ RNS . Destination . OUT ,
+ RNS . Destination . SINGLE ,
+ APP_NAME ,
+ "filetransfer" ,
+ "server"
+ )
+
+ # We also want to automatically prove incoming packets
+ server_destination . set_proof_strategy ( RNS . Destination . PROVE_ALL )
+
+ # And create a link
+ link = RNS . Link ( server_destination )
+
+ # We expect any normal data packets on the link
+ # to contain a list of served files, so we set
+ # a callback accordingly
+ link . set_packet_callback ( filelist_received )
+
+ # We'll also set up functions to inform the
+ # user when the link is established or closed
+ link . set_link_established_callback ( link_established )
+ link . set_link_closed_callback ( link_closed )
+
+ # And set the link to automatically begin
+ # downloading advertised resources
+ link . set_resource_strategy ( RNS . Link . ACCEPT_ALL )
+ link . set_resource_started_callback ( download_began )
+ link . set_resource_concluded_callback ( download_concluded )
+
+ menu ()
+
+# Requests the specified file from the server
+def download ( filename ):
+ global server_link , menu_mode , current_filename , transfer_size , download_started
+ current_filename = filename
+ download_started = 0
+ transfer_size = 0
+
+ # We just create a packet containing the
+ # requested filename, and send it down the
+ # link. We also specify we don't need a
+ # packet receipt.
+ request_packet = RNS . Packet ( server_link , filename . encode ( "utf-8" ), create_receipt = False )
+ request_packet . send ()
+
+ print ( "" )
+ print (( "Requested \" " + filename + " \" from server, waiting for download to begin..." ))
+ menu_mode = "download_started"
+
+# This function runs a simple menu for the user
+# to select which files to download, or quit
+menu_mode = None
+def menu ():
+ global server_files , server_link
+ # Wait until we have a filelist
+ while len ( server_files ) == 0 :
+ time . sleep ( 0.1 )
+ RNS . log ( "Ready!" )
+ time . sleep ( 0.5 )
+
+ global menu_mode
+ menu_mode = "main"
+ should_quit = False
+ while ( not should_quit ):
+ print_menu ()
+
+ while not menu_mode == "main" :
+ # Wait
+ time . sleep ( 0.25 )
+
+ user_input = input ()
+ if user_input == "q" or user_input == "quit" or user_input == "exit" :
+ should_quit = True
+ print ( "" )
+ else :
+ if user_input in server_files :
+ download ( user_input )
+ else :
+ try :
+ if 0 <= int ( user_input ) < len ( server_files ):
+ download ( server_files [ int ( user_input )])
+ except :
+ pass
+
+ if should_quit :
+ server_link . teardown ()
+
+# Prints out menus or screens for the
+# various states of the client program.
+# It's simple and quite uninteresting.
+# I won't go into detail here. Just
+# strings basically.
+def print_menu ():
+ global menu_mode , download_time , download_started , download_finished , transfer_size , file_size
+
+ if menu_mode == "main" :
+ clear_screen ()
+ print_filelist ()
+ print ( "" )
+ print ( "Select a file to download by entering name or number, or q to quit" )
+ print (( "> " ), end = ' ' )
+ elif menu_mode == "download_started" :
+ download_began = time . time ()
+ while menu_mode == "download_started" :
+ time . sleep ( 0.1 )
+ if time . time () > download_began + APP_TIMEOUT :
+ print ( "The download timed out" )
+ time . sleep ( 1 )
+ server_link . teardown ()
+
+ if menu_mode == "downloading" :
+ print ( "Download started" )
+ print ( "" )
+ while menu_mode == "downloading" :
+ global current_download
+ percent = round ( current_download . get_progress () * 100.0 , 1 )
+ print (( " \r Progress: " + str ( percent ) + " % " ), end = ' ' )
+ sys . stdout . flush ()
+ time . sleep ( 0.1 )
+
+ if menu_mode == "save_error" :
+ print (( " \r Progress: 100.0 %" ), end = ' ' )
+ sys . stdout . flush ()
+ print ( "" )
+ print ( "Could not write downloaded file to disk" )
+ current_download . status = RNS . Resource . FAILED
+ menu_mode = "download_concluded"
+
+ if menu_mode == "download_concluded" :
+ if current_download . status == RNS . Resource . COMPLETE :
+ print (( " \r Progress: 100.0 %" ), end = ' ' )
+ sys . stdout . flush ()
+
+ # Print statistics
+ hours , rem = divmod ( download_time , 3600 )
+ minutes , seconds = divmod ( rem , 60 )
+ timestring = " {:0>2} : {:0>2} : {:05.2f} " . format ( int ( hours ), int ( minutes ), seconds )
+ print ( "" )
+ print ( "" )
+ print ( "--- Statistics -----" )
+ print ( " \t Time taken : " + timestring )
+ print ( " \t File size : " + size_str ( file_size ))
+ print ( " \t Data transferred : " + size_str ( transfer_size ))
+ print ( " \t Effective rate : " + size_str ( file_size / download_time , suffix = 'b' ) + "/s" )
+ print ( " \t Transfer rate : " + size_str ( transfer_size / download_time , suffix = 'b' ) + "/s" )
+ print ( "" )
+ print ( "The download completed! Press enter to return to the menu." )
+ print ( "" )
+ input ()
+
+ else :
+ print ( "" )
+ print ( "The download failed! Press enter to return to the menu." )
+ input ()
+
+ current_download = None
+ menu_mode = "main"
+ print_menu ()
+
+# This function prints out a list of files
+# on the connected server.
+def print_filelist ():
+ global server_files
+ print ( "Files on server:" )
+ for index , file in enumerate ( server_files ):
+ print ( " \t (" + str ( index ) + ") \t " + file )
+
+def filelist_received ( filelist_data , packet ):
+ global server_files , menu_mode
+ try :
+ # Unpack the list and extend our
+ # local list of available files
+ filelist = umsgpack . unpackb ( filelist_data )
+ for file in filelist :
+ if not file in server_files :
+ server_files . append ( file )
+
+ # If the menu is already visible,
+ # we'll update it with what was
+ # just received
+ if menu_mode == "main" :
+ print_menu ()
+ except :
+ RNS . log ( "Invalid file list data received, closing link" )
+ packet . link . teardown ()
+
+# This function is called when a link
+# has been established with the server
+def link_established ( link ):
+ # We store a reference to the link
+ # instance for later use
+ global server_link
+ server_link = link
+
+ # Inform the user that the server is
+ # connected
+ RNS . log ( "Link established with server" )
+ RNS . log ( "Waiting for filelist..." )
+
+ # And set up a small job to check for
+ # a potential timeout in receiving the
+ # file list
+ thread = threading . Thread ( target = filelist_timeout_job , daemon = True )
+ thread . start ()
+
+# This job just sleeps for the specified
+# time, and then checks if the file list
+# was received. If not, the program will
+# exit.
+def filelist_timeout_job ():
+ time . sleep ( APP_TIMEOUT )
+
+ global server_files
+ if len ( server_files ) == 0 :
+ RNS . log ( "Timed out waiting for filelist, exiting" )
+ sys . exit ( 0 )
+
+
+# When a link is closed, we'll inform the
+# user, and exit the program
+def link_closed ( link ):
+ if link . teardown_reason == RNS . Link . TIMEOUT :
+ RNS . log ( "The link timed out, exiting now" )
+ elif link . teardown_reason == RNS . Link . DESTINATION_CLOSED :
+ RNS . log ( "The link was closed by the server, exiting now" )
+ else :
+ RNS . log ( "Link closed, exiting now" )
+
+ time . sleep ( 1.5 )
+ sys . exit ( 0 )
+
+# When RNS detects that the download has
+# started, we'll update our menu state
+# so the user can be shown a progress of
+# the download.
+def download_began ( resource ):
+ global menu_mode , current_download , download_started , transfer_size , file_size
+ current_download = resource
+
+ if download_started == 0 :
+ download_started = time . time ()
+
+ transfer_size += resource . size
+ file_size = resource . total_size
+
+ menu_mode = "downloading"
+
+# When the download concludes, successfully
+# or not, we'll update our menu state and
+# inform the user about how it all went.
+def download_concluded ( resource ):
+ global menu_mode , current_filename , download_started , download_finished , download_time
+ download_finished = time . time ()
+ download_time = download_finished - download_started
+
+ saved_filename = current_filename
+
+ if resource . status == RNS . Resource . COMPLETE :
+ counter = 0
+ while os . path . isfile ( saved_filename ):
+ counter += 1
+ saved_filename = current_filename + "." + str ( counter )
+
+ try :
+ file = open ( saved_filename , "wb" )
+ file . write ( resource . data . read ())
+ file . close ()
+ menu_mode = "download_concluded"
+ except :
+ menu_mode = "save_error"
+ else :
+ menu_mode = "download_concluded"
+
+# A convenience function for printing a human-
+# readable file size
+def size_str ( num , suffix = 'B' ):
+ units = [ '' , 'Ki' , 'Mi' , 'Gi' , 'Ti' , 'Pi' , 'Ei' , 'Zi' ]
+ last_unit = 'Yi'
+
+ if suffix == 'b' :
+ num *= 8
+ units = [ '' , 'K' , 'M' , 'G' , 'T' , 'P' , 'E' , 'Z' ]
+ last_unit = 'Y'
+
+ for unit in units :
+ if abs ( num ) < 1024.0 :
+ return " %3.2f %s%s " % ( num , unit , suffix )
+ num /= 1024.0
+ return " %.2f %s%s " % ( num , last_unit , suffix )
+
+# A convenience function for clearing the screen
+def clear_screen ():
+ os . system ( 'cls' if os . name == 'nt' else 'clear' )
+
+##########################################################
+#### Program Startup #####################################
+##########################################################
+
+# This part of the program runs at startup,
+# and parses input of from the user, and then
+# starts up the desired program mode.
+if __name__ == "__main__" :
+ try :
+ parser = argparse . ArgumentParser (
+ description = "Simple file transfer server and client utility"
+ )
+
+ parser . add_argument (
+ "-s" ,
+ "--serve" ,
+ action = "store" ,
+ metavar = "dir" ,
+ help = "serve a directory of files to clients"
+ )
+
+ parser . add_argument (
+ "--config" ,
+ action = "store" ,
+ default = None ,
+ help = "path to alternative Reticulum config directory" ,
+ type = str
+ )
+
+ parser . add_argument (
+ "destination" ,
+ nargs = "?" ,
+ default = None ,
+ help = "hexadecimal hash of the server destination" ,
+ type = str
+ )
+
+ args = parser . parse_args ()
+
+ if args . config :
+ configarg = args . config
+ else :
+ configarg = None
+
+ if args . serve :
+ if os . path . isdir ( args . serve ):
+ server ( configarg , args . serve )
+ else :
+ RNS . log ( "The specified directory does not exist" )
+ else :
+ if ( args . destination == None ):
+ print ( "" )
+ parser . print_help ()
+ print ( "" )
+ else :
+ client ( args . destination , configarg )
+
+ except KeyboardInterrupt :
+ print ( "" )
+ sys . exit ( 0 )
+
+
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/Filetransfer.py .
+
+
+Custom Interfaces
+The ExampleInterface demonstrates creating custom interfaces for Reticulum.
+Any number of custom interfaces can be loaded and utilised by Reticulum, and
+will be fully on-par with natively included interfaces, including all supported
+interface modes common configuration options
+# This example illustrates creating a custom interface
+# definition, that can be loaded and used by Reticulum at
+# runtime. Any number of custom interfaces can be created
+# and loaded. To use the interface place it in the folder
+# ~/.reticulum/interfaces, and add an interface entry to
+# your Reticulum configuration file similar to this:
+
+# [[Example Custom Interface]]
+# type = ExampleInterface
+# enabled = no
+# mode = gateway
+# port = /dev/ttyUSB0
+# speed = 115200
+# databits = 8
+# parity = none
+# stopbits = 1
+
+from time import sleep
+import sys
+import threading
+import time
+
+# This HDLC helper class is used by the interface
+# to delimit and packetize data over the physical
+# medium - in this case a serial connection.
+class HDLC ():
+ # This example interface packetizes data using
+ # simplified HDLC framing, similar to PPP
+ FLAG = 0x7E
+ ESC = 0x7D
+ ESC_MASK = 0x20
+
+ @staticmethod
+ def escape ( data ):
+ data = data . replace ( bytes ([ HDLC . ESC ]), bytes ([ HDLC . ESC , HDLC . ESC ^ HDLC . ESC_MASK ]))
+ data = data . replace ( bytes ([ HDLC . FLAG ]), bytes ([ HDLC . ESC , HDLC . FLAG ^ HDLC . ESC_MASK ]))
+ return data
+
+# Let's define our custom interface class. It must
+# be a sub-class of the RNS "Interface" class.
+class ExampleInterface ( Interface ):
+ # All interface classes must define a default
+ # IFAC size, used in IFAC setup when the user
+ # has not specified a custom IFAC size. This
+ # option is specified in bytes.
+ DEFAULT_IFAC_SIZE = 8
+
+ # The following properties are local to this
+ # particular interface implementation.
+ owner = None
+ port = None
+ speed = None
+ databits = None
+ parity = None
+ stopbits = None
+ serial = None
+
+ # All Reticulum interfaces must have an __init__
+ # method that takes 2 positional arguments:
+ # The owner RNS Transport instance, and a dict
+ # of configuration values.
+ def __init__ ( self , owner , configuration ):
+
+ # The following lines demonstrate handling
+ # potential dependencies required for the
+ # interface to function correctly.
+ import importlib
+ if importlib . util . find_spec ( 'serial' ) != None :
+ import serial
+ else :
+ RNS . log ( "Using this interface requires a serial communication module to be installed." , RNS . LOG_CRITICAL )
+ RNS . log ( "You can install one with the command: python3 -m pip install pyserial" , RNS . LOG_CRITICAL )
+ RNS . panic ()
+
+ # We start out by initialising the super-class
+ super () . __init__ ()
+
+ # To make sure the configuration data is in the
+ # correct format, we parse it through the following
+ # method on the generic Interface class. This step
+ # is required to ensure compatibility on all the
+ # platforms that Reticulum supports.
+ ifconf = Interface . get_config_obj ( configuration )
+
+ # Read the interface name from the configuration
+ # and set it on our interface instance.
+ name = ifconf [ "name" ]
+ self . name = name
+
+ # We read configuration parameters from the supplied
+ # configuration data, and provide default values in
+ # case any are missing.
+ port = ifconf [ "port" ] if "port" in ifconf else None
+ speed = int ( ifconf [ "speed" ]) if "speed" in ifconf else 9600
+ databits = int ( ifconf [ "databits" ]) if "databits" in ifconf else 8
+ parity = ifconf [ "parity" ] if "parity" in ifconf else "N"
+ stopbits = int ( ifconf [ "stopbits" ]) if "stopbits" in ifconf else 1
+
+ # In case no port is specified, we abort setup by
+ # raising an exception.
+ if port == None :
+ raise ValueError ( f "No port specified for { self } " )
+
+ # All interfaces must supply a hardware MTU value
+ # to the RNS Transport instance. This value should
+ # be the maximum data packet payload size that the
+ # underlying medium is capable of handling in all
+ # cases without any segmentation.
+ self . HW_MTU = 564
+
+ # We initially set the "online" property to false,
+ # since the interface has not actually been fully
+ # initialised and connected yet.
+ self . online = False
+
+ # In this case, we can also set the indicated bit-
+ # rate of the interface to the serial port speed.
+ self . bitrate = speed
+
+ # Configure internal properties on the interface
+ # according to the supplied configuration.
+ self . pyserial = serial
+ self . serial = None
+ self . owner = owner
+ self . port = port
+ self . speed = speed
+ self . databits = databits
+ self . parity = serial . PARITY_NONE
+ self . stopbits = stopbits
+ self . timeout = 100
+
+ if parity . lower () == "e" or parity . lower () == "even" :
+ self . parity = serial . PARITY_EVEN
+
+ if parity . lower () == "o" or parity . lower () == "odd" :
+ self . parity = serial . PARITY_ODD
+
+ # Since all required parameters are now configured,
+ # we will try opening the serial port.
+ try :
+ self . open_port ()
+ except Exception as e :
+ RNS . log ( "Could not open serial port for interface " + str ( self ), RNS . LOG_ERROR )
+ raise e
+
+ # If opening the port succeeded, run any post-open
+ # configuration required.
+ if self . serial . is_open :
+ self . configure_device ()
+ else :
+ raise IOError ( "Could not open serial port" )
+
+ # Open the serial port with supplied configuration
+ # parameters and store a reference to the open port.
+ def open_port ( self ):
+ RNS . log ( "Opening serial port " + self . port + "..." , RNS . LOG_VERBOSE )
+ self . serial = self . pyserial . Serial (
+ port = self . port ,
+ baudrate = self . speed ,
+ bytesize = self . databits ,
+ parity = self . parity ,
+ stopbits = self . stopbits ,
+ xonxoff = False ,
+ rtscts = False ,
+ timeout = 0 ,
+ inter_byte_timeout = None ,
+ write_timeout = None ,
+ dsrdtr = False ,
+ )
+
+ # The only thing required after opening the port
+ # is to wait a small amount of time for the
+ # hardware to initialise and then start a thread
+ # that reads any incoming data from the device.
+ def configure_device ( self ):
+ sleep ( 0.5 )
+ thread = threading . Thread ( target = self . read_loop )
+ thread . daemon = True
+ thread . start ()
+ self . online = True
+ RNS . log ( "Serial port " + self . port + " is now open" , RNS . LOG_VERBOSE )
+
+
+ # This method will be called from our read-loop
+ # whenever a full packet has been received over
+ # the underlying medium.
+ def process_incoming ( self , data ):
+ # Update our received bytes counter
+ self . rxb += len ( data )
+
+ # And send the data packet to the Transport
+ # instance for processing.
+ self . owner . inbound ( data , self )
+
+ # The running Reticulum Transport instance will
+ # call this method on the interface whenever the
+ # interface must transmit a packet.
+ def process_outgoing ( self , data ):
+ if self . online :
+ # First, escape and packetize the data
+ # according to HDLC framing.
+ data = bytes ([ HDLC . FLAG ]) + HDLC . escape ( data ) + bytes ([ HDLC . FLAG ])
+
+ # Then write the framed data to the port
+ written = self . serial . write ( data )
+
+ # Update the transmitted bytes counter
+ # and ensure that all data was written
+ self . txb += len ( data )
+ if written != len ( data ):
+ raise IOError ( "Serial interface only wrote " + str ( written ) + " bytes of " + str ( len ( data )))
+
+ # This read loop runs in a thread and continously
+ # receives bytes from the underlying serial port.
+ # When a full packet has been received, it will
+ # be sent to the process_incoming methed, which
+ # will in turn pass it to the Transport instance.
+ def read_loop ( self ):
+ try :
+ in_frame = False
+ escape = False
+ data_buffer = b ""
+ last_read_ms = int ( time . time () * 1000 )
+
+ while self . serial . is_open :
+ if self . serial . in_waiting :
+ byte = ord ( self . serial . read ( 1 ))
+ last_read_ms = int ( time . time () * 1000 )
+
+ if ( in_frame and byte == HDLC . FLAG ):
+ in_frame = False
+ self . process_incoming ( data_buffer )
+ elif ( byte == HDLC . FLAG ):
+ in_frame = True
+ data_buffer = b ""
+ elif ( in_frame and len ( data_buffer ) < self . HW_MTU ):
+ if ( byte == HDLC . ESC ):
+ escape = True
+ else :
+ if ( escape ):
+ if ( byte == HDLC . FLAG ^ HDLC . ESC_MASK ):
+ byte = HDLC . FLAG
+ if ( byte == HDLC . ESC ^ HDLC . ESC_MASK ):
+ byte = HDLC . ESC
+ escape = False
+ data_buffer = data_buffer + bytes ([ byte ])
+
+ else :
+ time_since_last = int ( time . time () * 1000 ) - last_read_ms
+ if len ( data_buffer ) > 0 and time_since_last > self . timeout :
+ data_buffer = b ""
+ in_frame = False
+ escape = False
+ sleep ( 0.08 )
+
+ except Exception as e :
+ self . online = False
+ RNS . log ( "A serial port error occurred, the contained exception was: " + str ( e ), RNS . LOG_ERROR )
+ RNS . log ( "The interface " + str ( self ) + " experienced an unrecoverable error and is now offline." , RNS . LOG_ERROR )
+
+ if RNS . Reticulum . panic_on_interface_error :
+ RNS . panic ()
+
+ RNS . log ( "Reticulum will attempt to reconnect the interface periodically." , RNS . LOG_ERROR )
+
+ self . online = False
+ self . serial . close ()
+ self . reconnect_port ()
+
+ # This method handles serial port disconnects.
+ def reconnect_port ( self ):
+ while not self . online :
+ try :
+ time . sleep ( 5 )
+ RNS . log ( "Attempting to reconnect serial port " + str ( self . port ) + " for " + str ( self ) + "..." , RNS . LOG_VERBOSE )
+ self . open_port ()
+ if self . serial . is_open :
+ self . configure_device ()
+ except Exception as e :
+ RNS . log ( "Error while reconnecting port, the contained exception was: " + str ( e ), RNS . LOG_ERROR )
+
+ RNS . log ( "Reconnected serial port for " + str ( self ))
+
+ # Signal to Reticulum that this interface should
+ # not perform any ingress limiting.
+ def should_ingress_limit ( self ):
+ return False
+
+ # We must provide a string representation of this
+ # interface, that is used whenever the interface
+ # is printed in logs or external programs.
+ def __str__ ( self ):
+ return "ExampleInterface[" + self . name + "]"
+
+# Finally, register the defined interface class as the
+# target class for Reticulum to use as an interface
+interface_class = ExampleInterface
+
+
This example can also be found at https://github.com/markqvist/Reticulum/blob/master/Examples/ExampleInterface.py .
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
An Explanation of Reticulum for Human Beings - Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+An Explanation of Reticulum for Human Beings
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
Index - Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
Getting Started Fast - Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+Getting Started Fast
+The best way to get started with the Reticulum Network Stack depends on what
+you want to do. This guide will outline sensible starting paths for different
+scenarios.
+
+Standalone Reticulum Installation
+If you simply want to install Reticulum and related utilities on a system,
+the easiest way is via the pip
+
+If you do not already have pip installed, you can install it using the package manager
+of your system with a command like sudo apt install python3-pip sudo pamac install python-pip
+You can also dowload the Reticulum release wheels from GitHub, or other release channels,
+and install them offline using pip
+pip install ./ rns - 0.5.1 - py3 - none - any . whl
+
+
For more detailed installation instructions, please see the
+Platform-Specific Install Notes
+After installation is complete, it might be helpful to refer to the
+Using Reticulum on Your System
+
+Resolving Dependency & Installation Issues
+On some platforms, there may not be binary packages available for all dependencies, and
+pip
+# Debian / Ubuntu / Derivatives
+sudo apt install build - essential
+
+# Arch / Manjaro / Derivatives
+sudo pamac install base - devel
+
+# Fedora
+sudo dnf groupinstall "Development Tools" "Development Libraries"
+
+
With the base development packages installed, pip
+
+
+
+Try Using a Reticulum-based Program
+If you simply want to try using a program built with Reticulum, a few different
+programs exist that allow basic communication and a range of other useful functions,
+even over extremely low-bandwidth Reticulum networks.
+These programs will let you get a feel for how Reticulum works. They have been designed
+to run well over networks based on LoRa or packet radio, but can also be used over fast
+links, such as local WiFi, wired Ethernet, the Internet, or any combination.
+As such, it is easy to get started experimenting, without having to set up any radio
+transceivers or infrastructure just to try it out. Launching the programs on separate
+devices connected to the same WiFi network is enough to get started, and physical
+radio interfaces can then be added later.
+
+Remote Shell
+The rnsh program lets you establish fully interactive
+remote shell sessions over Reticulum. It also allows you to pipe any program to or from a
+remote system, and is similar to how ssh rnsh
+
+
+Nomad Network
+The terminal-based program Nomad Network
+provides a complete encrypted communications suite built with Reticulum. It features
+encrypted messaging (both direct and delayed-delivery for offline users), file sharing,
+and has a built-in text-browser and page server with support for dynamically rendered pages,
+user authentication and more.
+Nomad Network is a user-facing client
+for the messaging and information-sharing protocol
+LXMF , another project built with Reticulum.
+You can install Nomad Network via pip:
+# Install ...
+pip install nomadnet
+
+# ... and run
+nomadnet
+
+
+
Note
+
If this is the very first time you use pip pip PATH
+
+
+Sideband
+If you would rather use a program with a graphical user interface, you can take
+a look at Sideband , which is available for Android,
+Linux, macOS and Windows.
+Sideband allows you to communicate with other people or LXMF-compatible
+systems over Reticulum networks using LoRa, Packet Radio, WiFi, I2P, Encrypted QR
+Paper Messages, or anything else Reticulum supports. It also interoperates with
+the Nomad Network program.
+
+
+MeshChat
+The Reticulum MeshChat application
+is a user-friendly LXMF client for macOS and Windows, that also includes voice call
+functionality, and a range of other interesting functions.
+Reticulum MeshChat is of course also compatible with Sideband and Nomad Network, or
+any other LXMF client.
+
+
+
+Using the Included Utilities
+Reticulum comes with a range of included utilities that make it easier to
+manage your network, check connectivity and make Reticulum available to other
+programs on your system.
+You can use rnsd rnstatus rnpath rnprobe
+To learn more about these utility programs, have a look at the
+Using Reticulum on Your System
+
+
+Creating a Network With Reticulum
+To create a network, you will need to specify one or more interfaces for
+Reticulum to use. This is done in the Reticulum configuration file, which by
+default is located at ~/.reticulum/config rnsd --exampleconfig
+When Reticulum is started for the first time, it will create a default
+configuration file, with one active interface. This default interface uses
+your existing Ethernet and WiFi networks (if any), and only allows you to
+communicate with other Reticulum peers within your local broadcast domains.
+To communicate further, you will have to add one or more interfaces. The default
+configuration includes a number of examples, ranging from using TCP over the
+internet, to LoRa and Packet Radio interfaces.
+With Reticulum, you only need to configure what interfaces you want to communicate
+over. There is no need to configure address spaces, subnets, routing tables,
+or other things you might be used to from other network types.
+Once Reticulum knows which interfaces it should use, it will automatically
+discover topography and configure transport of data to any destinations it
+knows about.
+In situations where you already have an established WiFi or Ethernet network, and
+many devices that want to utilise the same external Reticulum network paths (for example over
+LoRa), it will often be sufficient to let one system act as a Reticulum gateway, by
+adding any external interfaces to the configuration of this system, and then enabling transport on it. Any
+other device on your local WiFi will then be able to connect to this wider Reticulum
+network just using the default (AutoInterface
+Possibly, the examples in the config file are enough to get you started. If
+you want more information, you can read the Building Networks Interfaces
+
+
+Connecting Reticulum Instances Over the Internet
+Reticulum currently offers two interfaces suitable for connecting instances over the Internet: TCP I2P
+The TCPServerInterface I2PInterface
+TCP connections reveal the IP address of both your instance and the server to anyone who can
+inspect the connection. Someone could use this information to determine your location or identity. Adversaries
+inspecting your packets may be able to record packet metadata like time of transmission and packet size.
+Even though Reticulum encrypts traffic, TCP does not, so an adversary may be able to use
+packet inspection to learn that a system is running Reticulum, and what other IP addresses connect to it.
+Hosting a publicly reachable instance over TCP also requires a publicly reachable IP address,
+which most Internet connections don’t offer anymore.
+The I2PInterface Invisible Internet Protocol
+(I2P) . To use this interface, users must also run an I2P daemon in
+parallel to rnsd i2pd .
+By default, I2P will encrypt and mix all traffic sent over the Internet, and
+hide both the sender and receiver Reticulum instance IP addresses. Running an I2P node
+will also relay other I2P user’s encrypted packets, which will use extra
+bandwidth and compute power, but also makes timing attacks and other forms of
+deep-packet-inspection much more difficult.
+I2P also allows users to host globally available Reticulum instances from non-public IP’s and behind firewalls and NAT.
+In general it is recommended to use an I2P node if you want to host a publicly accessible
+instance, while preserving anonymity. If you care more about performance, and a slightly
+easier setup, use TCP.
+
+
+Connect to the Public Testnet
+An experimental public testnet has been made accessible over both I2P and TCP. You can join it
+by adding one of the following interfaces to your .reticulum/config
+# TCP/IP interface to the RNS Amsterdam Hub
+[[ RNS Testnet Amsterdam ]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = amsterdam . connect . reticulum . network
+ target_port = 4965
+
+# TCP/IP interface to the BetweenTheBorders Hub (community-provided)
+[[ RNS Testnet BetweenTheBorders ]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum . betweentheborders . com
+ target_port = 4242
+
+# Interface to Testnet I2P Hub
+[[ RNS Testnet I2P Hub ]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq . b32 . i2p
+
+
Many other Reticulum instances are connecting to this testnet, and you can also join it
+via other entry points if you know them. There is absolutely no control over the network
+topography, usage or what types of instances connect. It will also occasionally be used
+to test various failure scenarios, and there are no availability or service guarantees.
+Expect weird things to happen on this network, as people experiment and try out things.
+It probably goes without saying, but don’t use the testnet entry-points as
+hardcoded or default interfaces in any applications you ship to users . When
+shipping applications, the best practice is to provide your own default
+connectivity solutions, if needed and applicable, or in most cases, simply
+leave it up to the user which networks to connect to, and how.
+
+
+Adding Radio Interfaces
+Once you have Reticulum installed and working, you can add radio interfaces with
+any compatible hardware you have available. Reticulum supports a wide range of radio
+hardware, and if you already have any available, it is very likely that it will
+work with Reticulum. For information on how to configure this, see the
+Interfaces
+If you do not already have transceiver hardware available, you can easily and
+cheaply build an RNode
+To build one yourself requires installing a custom firmware on a supported LoRa
+development board with an auto-install script. Please see the Communications Hardware list of suppliers . For more information on RNode, you can also
+refer to these additional external resources:
+
+If you have communications hardware that is not already supported by any of the
+existing interface types GitHub discussion pages
+and propose adding an interface for the hardware.
+
+
+Creating and Using Custom Interfaces
+While Reticulum includes a flexible and broad range of built-in interfaces, these
+will not cover every conceivable type of communications hardware that Reticulum
+can potentially use to communicate.
+It is therefore possible to easily write your own interface modules, that can be
+loaded at run-time and used on-par with any of the built-in interface types.
+For more information on this subject, and code examples to build on, please see
+the Configuring Interfaces
+
+
+Develop a Program with Reticulum
+If you want to develop programs that use Reticulum, the easiest way to get
+started is to install the latest release of Reticulum via pip:
+
+The above command will install Reticulum and dependencies, and you will be
+ready to import and use RNS in your own programs. The next step will most
+likely be to look at some Example Programs
+The entire Reticulum API is documented in the API Reference
+
+
+Participate in Reticulum Development
+If you want to participate in the development of Reticulum and associated
+utilities, you’ll want to get the latest source from GitHub. In that case,
+don’t use pip, but try this recipe:
+# Install dependencies
+pip install cryptography pyserial
+
+# Clone repository
+git clone https : // github . com / markqvist / Reticulum . git
+
+# Move into Reticulum folder and symlink library to examples folder
+cd Reticulum
+ln - s ../ RNS ./ Examples /
+
+# Run an example
+python Examples / Echo . py - s
+
+# Unless you've manually created a config file, Reticulum will do so now,
+# and immediately exit. Make any necessary changes to the file:
+nano ~/. reticulum / config
+
+# ... and launch the example again.
+python Examples / Echo . py - s
+
+# You can now repeat the process on another computer,
+# and run the same example with -h to get command line options.
+python Examples / Echo . py - h
+
+# Run the example in client mode to "ping" the server.
+# Replace the hash below with the actual destination hash of your server.
+python Examples / Echo . py 174 a64852a75682259ad8b921b8bf416
+
+# Have a look at another example
+python Examples / Filetransfer . py - h
+
+
When you have experimented with the basic examples, it’s time to go read the
+Understanding Reticulum disucssion forum on GitHub ,
+or ask one of the developers or maintainers for a good place to start.
+
+
+Platform-Specific Install Notes
+Some platforms require a slightly different installation procedure, or have
+various quirks that are worth being aware of. These are listed here.
+
+Android
+Reticulum can be used on Android in different ways. The easiest way to get
+started is using an app like Sideband .
+For more control and features, you can use Reticulum and related programs via
+the Termux app , at the time of writing available on
+F-droid .
+Termux is a terminal emulator and Linux environment for Android based devices,
+which includes the ability to use many different programs and libraries,
+including Reticulum.
+To use Reticulum within the Termux environment, you will need to install
+python python-cryptography pkg pip
+From within Termux, execute the following:
+# First, make sure indexes and packages are up to date.
+pkg update
+pkg upgrade
+
+# Then install python and the cryptography library.
+pkg install python python - cryptography
+
+# Make sure pip is up to date, and install the wheel module.
+pip install wheel pip -- upgrade
+
+# Install Reticulum
+pip install rns
+
+
If for some reason the python-cryptography
+# First, make sure indexes and packages are up to date.
+pkg update
+pkg upgrade
+
+# Then install dependencies for the cryptography library.
+pkg install python build - essential openssl libffi rust
+
+# Make sure pip is up to date, and install the wheel module.
+pip install wheel pip -- upgrade
+
+# To allow the installer to build the cryptography module,
+# we need to let it know what platform we are compiling for:
+export CARGO_BUILD_TARGET = "aarch64-linux-android"
+
+# Start the install process for the cryptography module.
+# Depending on your device, this can take several minutes,
+# since the module must be compiled locally on your device.
+pip install cryptography
+
+# If the above installation succeeds, you can now install
+# Reticulum and any related software
+pip install rns
+
+
It is also possible to include Reticulum in apps compiled and distributed as
+Android APKs. A detailed tutorial and example source code will be included
+here at a later point. Until then you can use the Sideband source code as an example and starting point.
+
+
+ARM64
+On some architectures, including ARM64, not all dependencies have precompiled
+binaries. On such systems, you may need to install python3-dev
+# Install Python and development packages
+sudo apt update
+sudo apt install python3 python3 - pip python3 - dev
+
+# Install Reticulum
+python3 - m pip install rns
+
+
With these packages installed, pip
+
+
+Debian Bookworm
+On versions of Debian released after April 2023, it is no longer possible by default
+to use pip pipx
+# Install pipx
+sudo apt install pipx
+
+# Make installed programs available on the command line
+pipx ensurepath
+
+# Install Reticulum
+pipx install rns
+
+
Alternatively, you can restore normal behaviour to pip ~/.config/pip/pip.conf
+
+
For a one-shot installation of Reticulum, without globally enabling the break-system-packages
+
+
+
Note
+
The --break-system-packages pip could in rare
+cases lead to version conflicts, it does not generally pose any problems, especially
+not in the case of installing Reticulum.
+
+
+MacOS
+To install Reticulum on macOS, you will need to have Python and the pip
+Systems running macOS can vary quite widely in whether or not Python is pre-installed,
+and if it is, which version is installed, and whether the pip download and install
+Python manually.
+When Python and pip
+# Install Reticulum and utilities with pip:
+pip3 install rns
+
+# On some versions, you may need to use the
+# flag --break-system-packages to install:
+pip3 install rns -- break - system - packages
+
+
+
Note
+
The --break-system-packages pip could in rare
+cases lead to version conflicts, it does not generally pose any problems, especially
+not in the case of installing Reticulum.
+
Additionally, some version combinations of macOS and Python require you to
+manually add your installed pip PATH environment
+variable, before you can use installed commands in your terminal. Usually, adding
+the following line to your shell init script (for example ~/.zshrc
+
+
Adjust Python version and shell init script location according to your system.
+
+
+OpenWRT
+On OpenWRT systems with sufficient storage and memory, you can install
+Reticulum and related utilities using the opkg package manager and pip .
+
+
Note
+
At the time of releasing this manual, work is underway to create pre-built
+Reticulum packages for OpenWRT, with full configuration, service
+and uci feed-reticulum
+and reticulum-openwrt
+repositories for more information.
+
To install Reticulum on OpenWRT, first log into a command line session, and
+then use the following instructions:
+# Install dependencies
+opkg install python3 python3 - pip python3 - cryptography python3 - pyserial
+
+# Install Reticulum
+pip install rns
+
+# Start rnsd with debug logging enabled
+rnsd - vvv
+
+
+
Note
+
The above instructions have been verified and tested on OpenWRT 21.02 only.
+It is likely that other versions may require slightly altered installation
+commands or package names. You will also need enough free space in your
+overlay FS, and enough free RAM to actually run Reticulum and any related
+programs and utilities.
+
Depending on your device configuration, you may need to adjust firewall rules
+for Reticulum connectivity to and from your device to work. Until proper
+packaging is ready, you will also need to manually create a service or startup
+script to automatically laucnh Reticulum at boot time.
+Please also note that the AutoInterface requires link-local IPv6 addresses
+to be enabled for any Ethernet and WiFi devices you intend to use. If ip a fe80:: AutoInterface
+
+
+Raspberry Pi
+It is currently recommended to use a 64-bit version of the Raspberry Pi OS
+if you want to run Reticulum on Raspberry Pi computers, since 32-bit versions
+don’t always have packages available for some dependencies. If Python and the
+pip package manager is not already installed, do that first, and then
+install Reticulum using pip .
+# Install dependencies
+sudo apt install python3 python3 - pip python3 - cryptography python3 - pyserial
+
+# Install Reticulum
+pip install rns -- break - system - packages
+
+
+
Note
+
The --break-system-packages pip could in rare
+cases lead to version conflicts, it does not generally pose any problems, especially
+not in the case of installing Reticulum.
+
While it is possible to install and run Reticulum on 32-bit Rasperry Pi OSes,
+it will require manually configuring and installing required build dependencies,
+and is not detailed in this manual.
+
+
+RISC-V
+On some architectures, including RISC-V, not all dependencies have precompiled
+binaries. On such systems, you may need to install python3-dev
+# Install Python and development packages
+sudo apt update
+sudo apt install python3 python3 - pip python3 - dev
+
+# Install Reticulum
+python3 - m pip install rns
+
+
With these packages installed, pip
+
+
+Ubuntu Lunar
+On versions of Ubuntu released after April 2023, it is no longer possible by default
+to use pip pipx
+# Install pipx
+sudo apt install pipx
+
+# Make installed programs available on the command line
+pipx ensurepath
+
+# Install Reticulum
+pipx install rns
+
+
Alternatively, you can restore normal behaviour to pip ~/.config/pip/pip.conf
+
+
For a one-shot installation of Reticulum, without globally enabling the break-system-packages
+
+
+
Note
+
The --break-system-packages pip could in rare
+cases lead to version conflicts, it does not generally pose any problems, especially
+not in the case of installing Reticulum.
+
+
+Windows
+On Windows operating systems, the easiest way to install Reticulum is by using the
+pip
+If you don’t already have Python installed, download and install Python .
+At the time of publication of this manual, the recommended version is Python 3.12.7 .
+Important! When asked by the installer, make sure to add the Python program to
+your PATH environment variables. If you don’t do this, you will not be able to
+use the pip rnsd rnstatus
+After installing Python, open the command prompt or Windows Powershell, and type:
+
+You can now use Reticulum and all included utility programs directly from your
+preferred command line interface.
+
+
+
+Pure-Python Reticulum
+
+
Warning
+
If you use the rnspure PyCA/cryptography , it is
+important that you read and understand the Cryptographic Primitives
+
In some rare cases, and on more obscure system types, it is not possible to
+install one or more dependencies. In such situations,
+you can use the rnspure rns pip --no-dependencies rnspure rns rnspure completely identical .
+The only difference is that the rnspure
+No matter how Reticulum is installed and started, it will load external dependencies
+only if they are needed and available . If for example you want to use Reticulum
+on a system that cannot support pyserial rnspure package, but Reticulum will not be able to use serial-based interfaces.
+All other available modules will still be loaded when needed.
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
Communications Hardware - Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+Communications Hardware
+One of the truly valuable aspects of Reticulum is the ability to use it over
+almost any conceivable kind of communications medium. The interface types
+If you already have or operate some kind of communications hardware, there is a
+very good chance that it will work with Reticulum out of the box. In case it does
+not, it is possible to provide the necessary glue with very little effort using
+for example the PipeInterface TCPClientInterface TCP KISS Server
+by simplyequipped .
+While this broad support and flexibility is very useful, an abundance of options
+can sometimes make it difficult to know where to begin, especially when you are
+starting from scratch.
+This chapter will outline a few different sensible starting paths to get
+real-world functional wireless communications up and running with minimal cost
+and effort. Two fundamental devices categories will be covered, RNodes and
+WiFi-based radios . Additionally, other common options will be briefly described.
+Knowing how to employ just a few different types of hardware will make it possible
+to build a wide range of useful networks with little effort.
+
+Combining Hardware Types
+It is useful to combine different link and hardware types when designing and
+building a network. One useful design pattern is to employ high-capacity point-to-point
+links based on WiFi or millimeter-wave radios (with high-gain directional antennas)
+for the network backbone, and using LoRa-based RNodes for covering large areas with
+connectivity for client devices.
+
+
+RNode
+Reliable and general-purpose long-range digital radio transceiver systems are
+commonly either very expensive, difficult to set up and operate, hard to source,
+power-hungry, or all of the above at the same time. In an attempt to alleviate
+this situation, the transceiver system RNode was designed. It is important to
+note that RNode is not one specific device, from one particular vendor, but
+an open plaform that anyone can use to build interoperable digital transceivers
+suited to their needs and particular situations.
+An RNode is a general purpose, interoperable, low-power and long-range, reliable,
+open and flexible radio communications device. Depending on its components, it can
+operate on many different frequency bands, and use many different modulation
+schemes, but most commonly, and for the purposes of this chapter, we will limit
+the discussion to RNodes using LoRa modulation in common ISM bands.
+Avoid Confusion! RNodes can use LoRa as a physical-layer modulation , but it
+does not use, and has nothing to do with the LoRaWAN protocol and standard, commonly
+used for centrally controlled IoT devices. RNodes use raw LoRa modulation , without
+any additional protocol overhead. All high-level protocol functionality is handled
+directly by Reticulum.
+
+Creating RNodes
+RNode has been designed as a system that is easy to replicate across time and
+space. You can put together a functioning transceiver using commonly available
+components, and a few open source software tools. While you can design and build RNodes
+completely from scratch, to your exact desired specifications, this chapter
+will explain the easiest possible approach to creating RNodes: Using common
+LoRa development boards. This approach can be boiled down to two simple steps:
+
+Obtain one or more supported development boards
Install the RNode firmware with the automated installer
+Once the firmware has been installed and provisioned by the install script, it
+is ready to use with any software that supports RNodes, including Reticulum.
+The device can be used with Reticulum by adding an RNodeInterface
+
+
+
+Installation
+Once you have obtained compatible boards, you can install the RNode Firmware
+using the RNode Configuration Utility .
+If you have installed Reticulum on your system, the rnodeconf Python3 pip pip
+
+Once installation has completed, it is time to start installing the firmware on your
+devices. Run rnodeconf
+rnodeconf -- autoinstall
+
+
The utility will guide you through the installation process by asking a series of
+questions about your hardware. Simply follow the guide, and the utility will
+auto-install and configure your devices.
+
+
+Usage with Reticulum
+When the devices have been installed and provisioned, you can use them with Reticulum
+by adding the relevant interface section
+
+
+
+WiFi-based Hardware
+It is possible to use all kinds of both short- and long-range WiFi-based hardware
+with Reticulum. Any kind of hardware that fully supports bridged Ethernet over the
+WiFi interface will work with the AutoInterface
+This means that you can simply configure the physical links of the WiFi based devices,
+and start communicating over them using Reticulum. It is not necessary to enable any IP
+infrastructure such as DHCP servers, DNS or similar, as long as at least Ethernet is
+available, and packets are passed transparently over the physical WiFi-based devices.
+Below is a list of example WiFi (and similar) radios that work well for high capacity
+Reticulum links over long distances:
+
+This list is by no means exhaustive, and only serves as a few examples of radio hardware
+that is relatively cheap while providing long range and high capacity for Reticulum
+networks. As in all other cases, it is also possible for Reticulum to co-exist with IP
+networks running concurrently on such devices.
+
+
+Ethernet-based Hardware
+Reticulum can run over any kind of hardware that can provide a switched Ethernet-based
+medium. This means that anything from a plain Ethernet switch, to fiber-optic systems,
+to data radios with Ethernet interfaces can be used by Reticulum.
+The Ethernet medium does not need to have any IP infrastructure such as DHCP servers
+or routing set up, but in case such infrastructure does exist, Reticulum will simply
+co-exist with.
+To use Reticulum over Ethernet-based mediums, it is generally enough to use the included
+AutoInterface tun tap
+
+
+Serial Lines & Devices
+Using Reticulum over any kind of raw serial line is also possible with the
+SerialInterface
+
+
+Packet Radio Modems
+Any packet radio modem that provides a standard KISS interface over USB, serial or TCP
+can be used with Reticulum. This includes virtual software modems such as
+FreeDV TNC and Dire Wolf .
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+Reticulum Network Stack Manual
+This manual aims to provide you with all the information you need to
+understand Reticulum, build networks or develop programs using it, or
+to participate in the development of Reticulum itself.
+This manual is also available in PDF and EPUB formats.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
Configuring Interfaces - Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+Configuring Interfaces
+Reticulum supports using many kinds of devices as networking interfaces, and
+allows you to mix and match them in any way you choose. The number of distinct
+network topologies you can create with Reticulum is more or less endless, but
+common to them all is that you will need to define one or more interfaces
+for Reticulum to use.
+The following sections describe the interfaces currently available in Reticulum,
+and gives example configurations for the respective interface types.
+For a high-level overview of how networks can be formed over different interface
+types, have a look at the Building Networks
+
+Custom Interfaces
+In addition to the built-in interface types, Reticulum is fully extensible with
+custom, user- or community-supplied interfaces, and creating custom interface
+modules is straightforward. Please see the custom interface
+
+
+Auto Interface
+The AutoInterface does not need any functional IP
+infrastructure like routers or DHCP servers, on your physical network.
+As long as there is at least some sort of switching medium present between peers (a
+wired switch, a hub, a WiFi access point or similar, or simply two devices connected
+directly by Ethernet cable), it will work without any configuration, setup or intermediary devices.
+For AutoInterface
+
+
Note
+
Almost all current Ethernet and WiFi hardware will work without any kind
+of configuration or setup with AutoInterface AutoInterface
+
# This example demonstrates a bare-minimum setup
+# of an Auto Interface. It will allow communica-
+# tion with all other reachable devices on all
+# usable physical ethernet-based devices that
+# are available on the system.
+[[ Default Interface ]]
+ type = AutoInterface
+ enabled = yes
+
+# This example demonstrates an more specifically
+# configured Auto Interface, that only uses spe-
+# cific physical interfaces, and has a number of
+# other configuration options set.
+[[ Default Interface ]]
+ type = AutoInterface
+ enabled = yes
+
+ # You can create multiple isolated Reticulum
+ # networks on the same physical LAN by
+ # specifying different Group IDs.
+ group_id = reticulum
+
+ # You can also choose the multicast address type:
+ # temporary (default, Temporary Multicast Address)
+ # or permanent (Permanent Multicast Address)
+ multicast_address_type = permanent
+
+ # You can also select specifically which
+ # kernel networking devices to use.
+ devices = wlan0 , eth1
+
+ # Or let AutoInterface use all suitable
+ # devices except for a list of ignored ones.
+ ignored_devices = tun0 , eth0
+
+
If you are connected to the Internet with IPv6, and your provider will route
+IPv6 multicast, you can potentially configure the Auto Interface to globally
+autodiscover other Reticulum nodes within your selected Group ID. You can specify
+the discovery scope by setting it to one of link admin site organisation global
+[[ Default Interface ]]
+ type = AutoInterface
+ enabled = yes
+
+ # Configure global discovery
+
+ group_id = custom_network_name
+ discovery_scope = global
+
+ # Other configuration options
+
+ discovery_port = 48555
+ data_port = 49555
+
+
+
+Backbone Interface
+The Backbone interface is a very fast and resource efficient interface type, primarily
+intended for interconnecting Reticulum instances over many different types of mediums.
+It uses a kernel-event I/O backend, and can handle thousands of interfaces and/or clients
+with relatively low system resource utilisation. This interface type is currently only
+supported on Linux and Android .
+
+
Note
+
The Backbone Interface is fully compatible with the TCPServerInterface TCPClientInterface BackboneInterface
+
While the goal is to support all socket types and I/O devices provided by the underlying
+operating system, the initial release only provides support for TCP connections over IPv4
+and IPv6.
+For all types of connections over a BackboneInterface
+
+Listeners
+The following examples illustrates various ways to set up BackboneInterface
+# This example demonstrates a backbone interface
+# that listens for incoming connections on the
+# specified IP address and port number.
+[[ Backbone Listener ]]
+ type = BackboneInterface
+ enabled = yes
+ listen_on = 0.0.0.0
+ port = 4242
+
+# Alternatively you can bind to a specific IP
+[[ Backbone Listener ]]
+ type = BackboneInterface
+ enabled = yes
+ listen_on = 10.0.0.88
+ port = 4242
+
+# Or a specific network device
+[[ Backbone Listener ]]
+ type = BackboneInterface
+ enabled = yes
+ device = eth0
+ port = 4242
+
+
If you are using the interface on a device which has both IPv4 and IPv6 addresses available,
+you can use the prefer_ipv6
+# This example demonstrates a backbone interface
+# listening on the IPv6 address of a specified
+# kernel networking device.
+[[ Backbone Listener ]]
+ type = BackboneInterface
+ enabled = yes
+ prefer_ipv6 = yes
+ device = eth0
+ port = 4242
+
+
To use the BackboneInterface Yggdrasil , you
+can simply specify the Yggdrasil tun
+# This example demonstrates a backbone interface
+# listening for connections over Yggdrasil.
+[[ Yggdrasil Backbone Interface ]]
+ type = BackboneInterface
+ enabled = yes
+ device = tun0
+ port = 4343
+
+
+
+Connecting Remotes
+The following examples illustrates various ways to connect to remote BackboneInterface BackboneInterface TCPServerInterface
+# Here's an example of a backbone interface that
+# connects to a remote listener.
+[[ Backbone Remote ]]
+ type = BackboneInterface
+ enabled = yes
+ remote = amsterdam . connect . reticulum . network
+ target_port = 4251
+
+
To connect to remotes over Yggdrasil , simply
+specify the target Yggdrasil IPv6 address and port, like so:
+[[ Yggdrasil Remote ]]
+ type = BackboneInterface
+ enabled = yes
+ target_host = 201 : 5 d78 : af73 : 5 caf : a4de : a79f : 3278 : 71e5
+ target_port = 4343
+
+
+
+
+TCP Server Interface
+The TCP Server interface is suitable for allowing other peers to connect over
+the Internet or private IPv4 and IPv6 networks. When a TCP server interface has been
+configured, other Reticulum peers can connect to it with a TCP Client interface.
+# This example demonstrates a TCP server interface.
+# It will listen for incoming connections on all IP
+# interfaces on port 4242.
+[[ TCP Server Interface ]]
+ type = TCPServerInterface
+ enabled = yes
+ listen_ip = 0.0.0.0
+ listen_port = 4242
+
+# Alternatively you can bind to a specific IP
+[[ TCP Server Interface ]]
+ type = TCPServerInterface
+ enabled = yes
+ listen_ip = 10.0.0.88
+ listen_port = 4242
+
+# Or a specific network device
+[[ TCP Server Interface ]]
+ type = TCPServerInterface
+ enabled = yes
+ device = eth0
+ listen_port = 4242
+
+
If you are using the interface on a device which has both IPv4 and IPv6 addresses available,
+you can use the prefer_ipv6
+# This example demonstrates a TCP server interface.
+# It will listen for incoming connections on the
+# specified IP address and port number.
+
+[[ TCP Server Interface ]]
+ type = TCPServerInterface
+ enabled = yes
+ prefer_ipv6 = True
+ device = eth0
+ port = 4242
+
+
To use the TCP Server Interface over Yggdrasil , you
+can simply specify the Yggdrasil tun
+[[ Yggdrasil TCP Server Interface ]]
+ type = TCPServerInterface
+ enabled = yes
+ device = tun0
+ listen_port = 4343
+
+
+
Note
+
The TCP interfaces support tunneling over I2P, but to do so reliably,
+you must use the i2p_tunneled option:
+
[[ TCP Server on I2P ]]
+ type = TCPServerInterface
+ enabled = yes
+ listen_ip = 127.0.0.1
+ listen_port = 5001
+ i2p_tunneled = yes
+
+
In almost all cases, it is easier to use the dedicated I2PInterface
+
+
+TCP Client Interface
+To connect to a TCP server interface, you can use the TCP client
+interface. Many TCP Client interfaces from different peers can connect to the
+same TCP Server interface at the same time.
+The TCP interface types can also tolerate intermittency in the IP link layer.
+This means that Reticulum will gracefully handle IP links that go up and down,
+and restore connectivity after a failure, once the other end of a TCP interface reappears.
+# Here's an example of a TCP Client interface. The
+# target_host can be a hostname or an IPv4 or IPv6 address.
+[[ TCP Client Interface ]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 127.0.0.1
+ target_port = 4242
+
+
To use the TCP Client Interface over Yggdrasil , simply
+specify the target Yggdrasil IPv6 address and port, like so:
+[[ Yggdrasil TCP Client Interface ]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 201 : 5 d78 : af73 : 5 caf : a4de : a79f : 3278 : 71e5
+ target_port = 4343
+
+
It is also possible to use this interface type to connect via other programs
+or hardware devices that expose a KISS interface on a TCP port, for example
+software-based soundmodems. To do this, use the kiss_framing
+# Here's an example of a TCP Client interface that connects
+# to a software TNC soundmodem on a KISS over TCP port.
+
+[[ TCP KISS Interface ]]
+ type = TCPClientInterface
+ enabled = yes
+ kiss_framing = True
+ target_host = 127.0.0.1
+ target_port = 8001
+
+
Caution! Only use the KISS framing option when connecting to external devices
+and programs like soundmodems and similar over TCP. When using the
+TCPClientInterface TCPServerInterface kiss_framing
+
+
Note
+
The TCP interfaces support tunneling over I2P, but to do so reliably,
+you must use the i2p_tunneled option:
+
[[ TCP Client over I2P ]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = 127.0.0.1
+ target_port = 5001
+ i2p_tunneled = yes
+
+
+
+UDP Interface
+A UDP interface can be useful for communicating over IP networks, both
+private and the internet. It can also allow broadcast communication
+over IP networks, so it can provide an easy way to enable connectivity
+with all other peers on a local area network.
+
+
Warning
+
Using broadcast UDP traffic has performance implications,
+especially on WiFi. If your goal is simply to enable easy communication
+with all peers in your local Ethernet broadcast domain, the
+Auto Interface
+
# This example enables communication with other
+# local Reticulum peers over UDP.
+
+[[ UDP Interface ]]
+ type = UDPInterface
+ enabled = yes
+
+ listen_ip = 0.0.0.0
+ listen_port = 4242
+ forward_ip = 255.255.255.255
+ forward_port = 4242
+
+ # The above configuration will allow communication
+ # within the local broadcast domains of all local
+ # IP interfaces.
+
+ # Instead of specifying listen_ip, listen_port,
+ # forward_ip and forward_port, you can also bind
+ # to a specific network device like below.
+
+ # device = eth0
+ # port = 4242
+
+ # Assuming the eth0 device has the address
+ # 10.55.0.72/24, the above configuration would
+ # be equivalent to the following manual setup.
+ # Note that we are both listening and forwarding to
+ # the broadcast address of the network segments.
+
+ # listen_ip = 10.55.0.255
+ # listen_port = 4242
+ # forward_ip = 10.55.0.255
+ # forward_port = 4242
+
+ # You can of course also communicate only with
+ # a single IP address
+
+ # listen_ip = 10.55.0.15
+ # listen_port = 4242
+ # forward_ip = 10.55.0.16
+ # forward_port = 4242
+
+
+
+I2P Interface
+The I2P interface lets you connect Reticulum instances over the
+Invisible Internet Protocol . This can be
+especially useful in cases where you want to host a globally reachable
+Reticulum instance, but do not have access to any public IP addresses,
+have a frequently changing IP address, or have firewalls blocking
+inbound traffic.
+Using the I2P interface, you will get a globally reachable, portable
+and persistent I2P address that your Reticulum instance can be reached
+at.
+To use the I2P interface, you must have an I2P router running
+on your system. The easiest way to achieve this is to download and
+install the latest release
+of the i2pd geti2p.net website .
+When an I2P router is running on your system, you can simply add
+an I2P interface to Reticulum:
+[[ I2P ]]
+ type = I2PInterface
+ enabled = yes
+ connectable = yes
+
+
On the first start, Reticulum will generate a new I2P address for the
+interface and start listening for inbound traffic on it. This can take
+a while the first time, especially if your I2P router was also just
+started, and is not yet well-connected to the I2P network. When ready,
+you should see I2P base32 address printed to your log file. You can
+also inspect the status of the interface using the rnstatus
+To connect to other Reticulum instances over I2P, just add a comma-separated
+list of I2P base32 addresses to the peers
+[[ I2P ]]
+ type = I2PInterface
+ enabled = yes
+ connectable = yes
+ peers = 5 urvjicpzi7q3ybztsef4i5ow2aq4soktfj7zedz53s47r54jnqq . b32 . i2p
+
+
It can take anywhere from a few seconds to a few minutes to establish
+I2P connections to the desired peers, so Reticulum handles the process
+in the background, and will output relevant events to the log.
+
+
Note
+
While the I2P interface is the simplest way to use
+Reticulum over I2P, it is also possible to tunnel the TCP server and
+client interfaces over I2P manually. This can be useful in situations
+where more control is needed, but requires manual tunnel setup through
+the I2P daemon configuration.
+
It is important to note that the two methods are interchangably compatible .
+You can use the I2PInterface to connect to a TCPServerInterface that
+was manually tunneled over I2P, for example. This offers a high degree
+of flexibility in network setup, while retaining ease of use in simpler
+use-cases.
+
+
+RNode LoRa Interface
+To use Reticulum over LoRa, the RNode interface
+can be used, and offers full control over LoRa parameters.
+
+
Warning
+
Radio frequency spectrum is a legally controlled resource, and legislation
+varies widely around the world. It is your responsibility to be aware of any
+relevant regulation for your location, and to make decisions accordingly.
+
# Here's an example of how to add a LoRa interface
+# using the RNode LoRa transceiver.
+
+[[ RNode LoRa Interface ]]
+ type = RNodeInterface
+
+ # Enable interface if you want use it!
+ enabled = yes
+
+ # Serial port for the device
+ port = / dev / ttyUSB0
+
+ # It is also possible to use BLE devices
+ # instead of wired serial ports. The
+ # target RNode must be paired with the
+ # host device before connecting. BLE
+ # devices can be connected by name,
+ # BLE MAC address or by any available.
+
+ # Connect to specific device by name
+ # port = ble://RNode 3B87
+
+ # Or by BLE MAC address
+ # port = ble://F4:12:73:29:4E:89
+
+ # Or connect to the first available,
+ # paired device
+ # port = ble://
+
+ # Set frequency to 867.2 MHz
+ frequency = 867200000
+
+ # Set LoRa bandwidth to 125 KHz
+ bandwidth = 125000
+
+ # Set TX power to 7 dBm (5 mW)
+ txpower = 7
+
+ # Select spreading factor 8. Valid
+ # range is 7 through 12, with 7
+ # being the fastest and 12 having
+ # the longest range.
+ spreadingfactor = 8
+
+ # Select coding rate 5. Valid range
+ # is 5 throough 8, with 5 being the
+ # fastest, and 8 the longest range.
+ codingrate = 5
+
+ # You can configure the RNode to send
+ # out identification on the channel with
+ # a set interval by configuring the
+ # following two parameters.
+
+ # id_callsign = MYCALL-0
+ # id_interval = 600
+
+ # For certain homebrew RNode interfaces
+ # with low amounts of RAM, using packet
+ # flow control can be useful. By default
+ # it is disabled.
+
+ # flow_control = False
+
+ # It is possible to limit the airtime
+ # utilisation of an RNode by using the
+ # following two configuration options.
+ # The short-term limit is applied in a
+ # window of approximately 15 seconds,
+ # and the long-term limit is enforced
+ # over a rolling 60 minute window. Both
+ # options are specified in percent.
+
+ # airtime_limit_long = 1.5
+ # airtime_limit_short = 33
+
+
+
+RNode Multi Interface
+For RNodes that support multiple LoRa transceivers, the RNode
+Multi interface can be used to configure sub-interfaces individually.
+
+
Warning
+
Radio frequency spectrum is a legally controlled resource, and legislation
+varies widely around the world. It is your responsibility to be aware of any
+relevant regulation for your location, and to make decisions accordingly.
+
# Here's an example of how to add an RNode Multi interface
+# using the RNode LoRa transceiver.
+
+[[ RNode Multi Interface ]]
+type = RNodeMultiInterface
+
+# Enable interface if you want to use it!
+enabled = yes
+
+# Serial port for the device
+port = / dev / ttyACM0
+
+# You can configure the RNode to send
+# out identification on the channel with
+# a set interval by configuring the
+# following two parameters.
+
+# id_callsign = MYCALL-0
+# id_interval = 600
+
+ # A subinterface
+ [[[ High Datarate ]]]
+ # Subinterfaces can be enabled and disabled in of themselves
+ enabled = yes
+
+ # Set frequency to 2.4GHz
+ frequency = 2400000000
+
+ # Set LoRa bandwidth to 1625 KHz
+ bandwidth = 1625000
+
+ # Set TX power to 0 dBm (0.12 mW)
+ txpower = 0
+
+ # The virtual port, only the manufacturer
+ # or the person who wrote the board config
+ # can tell you what it will be for which
+ # physical hardware interface
+ vport = 1
+
+ # Select spreading factor 5. Valid
+ # range is 5 through 12, with 5
+ # being the fastest and 12 having
+ # the longest range.
+ spreadingfactor = 5
+
+ # Select coding rate 5. Valid range
+ # is 5 throough 8, with 5 being the
+ # fastest, and 8 the longest range.
+ codingrate = 5
+
+ # It is possible to limit the airtime
+ # utilisation of an RNode by using the
+ # following two configuration options.
+ # The short-term limit is applied in a
+ # window of approximately 15 seconds,
+ # and the long-term limit is enforced
+ # over a rolling 60 minute window. Both
+ # options are specified in percent.
+
+ # airtime_limit_long = 100
+ # airtime_limit_short = 100
+
+ [[[ Low Datarate ]]]
+ # Subinterfaces can be enabled and disabled in of themselves
+ enabled = yes
+
+ # Set frequency to 865.6 MHz
+ frequency = 865600000
+
+ # The virtual port, only the manufacturer
+ # or the person who wrote the board config
+ # can tell you what it will be for which
+ # physical hardware interface
+ vport = 0
+
+ # Set LoRa bandwidth to 125 KHz
+ bandwidth = 125000
+
+ # Set TX power to 0 dBm (0.12 mW)
+ txpower = 0
+
+ # Select spreading factor 7. Valid
+ # range is 5 through 12, with 5
+ # being the fastest and 12 having
+ # the longest range.
+ spreadingfactor = 7
+
+ # Select coding rate 5. Valid range
+ # is 5 throough 8, with 5 being the
+ # fastest, and 8 the longest range.
+ codingrate = 5
+
+ # It is possible to limit the airtime
+ # utilisation of an RNode by using the
+ # following two configuration options.
+ # The short-term limit is applied in a
+ # window of approximately 15 seconds,
+ # and the long-term limit is enforced
+ # over a rolling 60 minute window. Both
+ # options are specified in percent.
+
+ # airtime_limit_long = 100
+ # airtime_limit_short = 100
+
+
+
+Serial Interface
+Reticulum can be used over serial ports directly, or over any device with a
+serial port, that will transparently pass data. Useful for communicating
+directly over a wire-pair, or for using devices such as data radios and lasers.
+[[ Serial Interface ]]
+ type = SerialInterface
+ enabled = yes
+
+ # Serial port for the device
+ port = / dev / ttyUSB0
+
+ # Set the serial baud-rate and other
+ # configuration parameters.
+ speed = 115200
+ databits = 8
+ parity = none
+ stopbits = 1
+
+
+
+Pipe Interface
+Using this interface, Reticulum can use any program as an interface via stdin and
+stdout . This can be used to easily create virtual interfaces, or to interface with
+custom hardware or other systems.
+[[ Pipe Interface ]]
+ type = PipeInterface
+ enabled = yes
+
+ # External command to execute
+ command = netcat - l 5757
+
+ # Optional respawn delay, in seconds
+ respawn_delay = 5
+
+
Reticulum will write all packets to stdin of the command stdout for Reticulum packets. If EOF respawn_interval
+
+
+KISS Interface
+With the KISS interface, you can use Reticulum over a variety of packet
+radio modems and TNCs, including OpenModem .
+KISS interfaces can also be configured to periodically send out beacons
+for station identification purposes.
+
+
Warning
+
Radio frequency spectrum is a legally controlled resource, and legislation
+varies widely around the world. It is your responsibility to be aware of any
+relevant regulation for your location, and to make decisions accordingly.
+
[[ Packet Radio KISS Interface ]]
+ type = KISSInterface
+ enabled = yes
+
+ # Serial port for the device
+ port = / dev / ttyUSB1
+
+ # Set the serial baud-rate and other
+ # configuration parameters.
+ speed = 115200
+ databits = 8
+ parity = none
+ stopbits = 1
+
+ # Set the modem preamble.
+ preamble = 150
+
+ # Set the modem TX tail.
+ txtail = 10
+
+ # Configure CDMA parameters. These
+ # settings are reasonable defaults.
+ persistence = 200
+ slottime = 20
+
+ # You can configure the interface to send
+ # out identification on the channel with
+ # a set interval by configuring the
+ # following two parameters. The KISS
+ # interface will only ID if the set
+ # interval has elapsed since it's last
+ # actual transmission. The interval is
+ # configured in seconds.
+ # This option is commented out and not
+ # used by default.
+ # id_callsign = MYCALL-0
+ # id_interval = 600
+
+ # Whether to use KISS flow-control.
+ # This is useful for modems that have
+ # a small internal packet buffer, but
+ # support packet flow control instead.
+ flow_control = false
+
+
+
+AX.25 KISS Interface
+If you’re using Reticulum on amateur radio spectrum, you might want to
+use the AX.25 KISS interface. This way, Reticulum will automatically
+encapsulate it’s traffic in AX.25 and also identify your stations
+transmissions with your callsign and SSID.
+Only do this if you really need to! Reticulum doesn’t need the AX.25
+layer for anything, and it incurs extra overhead on every packet to
+encapsulate in AX.25.
+A more efficient way is to use the plain KISS interface with the
+beaconing functionality described above.
+
+
Warning
+
Radio frequency spectrum is a legally controlled resource, and legislation
+varies widely around the world. It is your responsibility to be aware of any
+relevant regulation for your location, and to make decisions accordingly.
+
[[ Packet Radio AX .25 KISS Interface ]]
+ type = AX25KISSInterface
+
+ # Set the station callsign and SSID
+ callsign = NO1CLL
+ ssid = 0
+
+ # Enable interface if you want use it!
+ enabled = yes
+
+ # Serial port for the device
+ port = / dev / ttyUSB2
+
+ # Set the serial baud-rate and other
+ # configuration parameters.
+ speed = 115200
+ databits = 8
+ parity = none
+ stopbits = 1
+
+ # Set the modem preamble. A 150ms
+ # preamble should be a reasonable
+ # default, but may need to be
+ # increased for radios with slow-
+ # opening squelch and long TX/RX
+ # turnaround
+ preamble = 150
+
+ # Set the modem TX tail. In most
+ # cases this should be kept as low
+ # as possible to not waste airtime.
+ txtail = 10
+
+ # Configure CDMA parameters. These
+ # settings are reasonable defaults.
+ persistence = 200
+ slottime = 20
+
+ # Whether to use KISS flow-control.
+ # This is useful for modems with a
+ # small internal packet buffer.
+ flow_control = false
+
+
+
+Common Interface Options
+A number of general configuration options are available on most interfaces.
+These can be used to control various aspects of interface behaviour.
+
+
+
+
The enabled False enabled True Yes
+
+
The mode
+
+
+The default value is full
In the access_point ap
+
+
+
The outgoing True False No
+
+
The network_name
+
+
The passphrase network_name
+
+
The ifac_size
+
+
The announce_cap 1 100
+
+If an interface exceeds its announce cap, it will queue announces
+for later transmission. Reticulum will always prioritise propagating
+announces from nearby nodes first. This ensures that the local
+topology is prioritised, and that slow networks are not overwhelmed
+by interconnected fast networks.
+
Destinations that are rapidly re-announcing will be down-prioritised
+further. Trying to get “first-in-line” by announce spamming will have
+the exact opposite effect: Getting moved to the back of the queue every
+time a new announce from the excessively announcing destination is received.
+
This means that it is always beneficial to select a balanced
+announce rate, and not announce more often than is actually necesarry
+for your application to function.
+
+
+
The bitrate bitrate bits per second .
+
+
+
+
+Interface Modes
+The optional mode
+Configuring modes on interfaces is not strictly necessary, but can be useful
+when building or connecting to more complex networks. If your Reticulum
+instance is not running a Transport Node, it is rarely useful to configure
+interface modes, and in such cases interfaces should generally be left in
+the default mode.
+
+
+
+
The default mode is full
+
+
The gateway gw gateway gateway
+
+
If you want to allow other nodes to widely resolve paths or connect
+to a network via an interface, it might be useful to put it in this
+mode. By creating a chain of gateway
+
+
Please note! It is the interface facing the clients that
+must be put into gateway boundary
+
+
In the access_point ap gateway
+
+
This mode is useful for creating interfaces that remain
+quiet, until someone actually starts using them. An example
+of this could be a radio interface serving a wide area,
+where users are expected to connect momentarily, use the
+network, and then disappear again.
+
+
The roaming with the vehicle, the external LoRa interface should be
+configured as roaming roaming
+
+
The purpose of the boundary boundary
+
+
+For a table describing the impact of all modes on announce propagation,
+please see the Announce Propagation Rules
+
+
+Announce Rate Control
+The built-in announce control mechanisms and the default announce_cap announce_rate_target announce_rate_grace announce_rate_penalty rate at
+which received announces are re-broadcasted to other interfaces .
+
+
+
+
The announce_rate_target 3600 received on this interface will only be re-transmitted and
+propagated to other interfaces once every hour, no matter how often they
+are received.
+
+
The optional announce_rate_grace
+
+
The optional announce_rate_penalty 7200
+
+
+These mechanisms, in conjunction with the annouce_cap
+Current statistics and information about announce rates can be viewed using the
+rnpath -r
+It is important to note that there is no one right or wrong way to set up announce
+rates. Slower networks will naturally tend towards using less frequent announces to
+conserve bandwidth, while very fast networks can support applications that
+need very frequent announces. Reticulum implements these mechanisms to ensure
+that a large span of network types can seamlessly co-exist and interconnect.
+
+
+New Destination Rate Limiting
+On public interfaces, where anyone may connect and announce new destinations,
+it can be useful to control the rate at which announces for new destinations are
+processed.
+If a large influx of announces for newly created or previously unknown destinations
+occur within a short amount of time, Reticulum will place these announces on hold,
+so that announce traffic for known and previously established destinations can
+continue to be processed without interruptions.
+After the burst subsides, and an additional waiting period has passed, the held
+announces will be released at a slow rate, until the hold queue is cleared. This
+also means, that should a node decide to connect to a public interface, announce
+a large amount of bogus destinations, and then disconnect, these destination will
+never make it into path tables and waste network bandwidth on retransmitted
+announces.
+It’s important to note that the ingress control works at the level of individual
+sub-interfaces . As an example, this means that one client on a TCP Server Interface TCP Server Interface
+By default, Reticulum will handle this automatically, and ingress announce
+control will be enabled on interface where it is sensible to do so. It should
+generally not be neccessary to modify the ingress control configuration,
+but all the parameters are exposed for configuration if needed.
+
+
+
+
The ingress_control True
+
+
The ic_new_time 2*60*60
+
+
The ic_burst_freq_new 3.5
+
+
The ic_burst_freq 12
+
+If an interface exceeds its burst frequency, incoming announces
+for unknown destinations will be temporarily held in a queue, and
+not processed until later.
+
+
+
The ic_max_held_announces 256
+
+
The ic_burst_hold 60
+
+
The ic_burst_penalty 5*60
+
+
The ic_held_release_interval 30
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
Building Networks - Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+Building Networks
+This chapter will provide you with the knowledge needed to build networks with
+Reticulum, which can often be easier than using traditional stacks, since you
+don’t have to worry about coordinating addresses, subnets and routing for an
+entire network that you might not know how will evolve in the future. With
+Reticulum, you can simply add more segments to your network when it becomes
+necessary, and Reticulum will handle the convergence of the entire network
+automatically.
+
+Concepts & Overview
+There are important points that need to be kept in mind when building networks
+with Reticulum:
+
+
+
+
In a Reticulum network, any node can autonomously generate as many addresses
+(called destinations in Reticulum terminology) as it needs, which become
+globally reachable to the rest of the network. There is no central point of
+control over the address space.
+
+
Reticulum was designed to handle both very small, and very large networks.
+While the address space can support billions of endpoints, Reticulum is
+also very useful when just a few devices needs to communicate.
+
+
Low-bandwidth networks, like LoRa and packet radio, can interoperate and
+interconnect with much larger and higher bandwidth networks without issue.
+Reticulum automatically manages the flow of information to and from various
+network segments, and when bandwidth is limited, local traffic is prioritised.
+
+
Reticulum provides sender/initiator anonymity by default. There is no way
+to filter traffic or discriminate it based on the source of the traffic.
+
+
All traffic is encrypted using ephemeral keys generated by an Elliptic Curve
+Diffie-Hellman key exchange on Curve25519. There is no way to inspect traffic
+contents, and no way to prioritise or throttle certain kinds of traffic.
+All transport and routing layers are thus completely agnostic to traffic type,
+and will pass all traffic equally.
+
+
Reticulum can function both with and without infrastructure. When transport
+nodes are available, they can route traffic over multiple hops for other
+nodes, and will function as a distributed cryptographic keystore. When there
+is no transport nodes available, all nodes that are within communication range
+can still communicate.
+
+
Every node can become a transport node, simply by enabling it in it’s
+configuration, but there is no need for every node on the network to be a
+transport node. Letting every node be a transport node will in most cases
+degrade the performance and reliability of the network.
+
+In general terms, if a node is stationary, well-connected and kept running
+most of the time, it is a good candidate to be a transport node. For optimal
+performance, a network should contain the amount of transport nodes that
+provides connectivity to the intended area / topography, and not many more
+than that.
+
+
+
Reticulum is designed to work reliably in open, trustless environments. This
+means you can use it to create open-access networks, where participants can
+join and leave in a free and unorganised manner. This property allows an
+entirely new, and so far, mostly unexplored class of networked applications,
+where networks, and the information flow within them can form and dissolve
+organically.
+
+
You can just as easily create closed networks, since Reticulum allows you to
+add authentication to any interface. This means you can restrict access on
+any interface type, even when using legacy devices, such as modems. You can
+also mix authenticated and open interfaces on the same system. See the
+
Common Interface Options section of the
Interfaces
+chapter of this manual for information on how to set up interface authentication.
+
+
+Reticulum allows you to mix very different kinds of networking mediums into a
+unified mesh, or to keep everything within one medium. You could build a “virtual
+network” running entirely over the Internet, where all nodes communicate over TCP
+and UDP “channels”. You could also build such a network using other already-established
+communications channels as the underlying carrier for Reticulum.
+However, most real-world networks will probably involve either some form of
+wireless or direct hardline communications. To allow Reticulum to communicate
+over any type of medium, you must specify it in the configuration file, by default
+located at ~/.reticulum/config Supported Interfaces
+Any number of interfaces can be configured, and Reticulum will automatically
+decide which are suitable to use in any given situation, depending on where
+traffic needs to flow.
+
+
+Example Scenarios
+This section illustrates a few example scenarios, and how they would, in general
+terms, be planned, implemented and configured.
+
+Interconnected LoRa Sites
+An organisation wants to provide communication and information services to it’s
+members, which are located mainly in three separate areas. Three suitable hill-top
+locations are found, where the organisation can install equipment: Site A, B and C.
+Since the amount of data that needs to be exchanged between users is mainly text-
+based, the bandwidth requirements are low, and LoRa radios are chosen to connect
+users to the network.
+Due to the hill-top locations found, there is radio line-of-sight between site A
+and B, and also between site B and C. Because of this, the organisation does not
+need to use the Internet to interconnect the sites, but purchases four Point-to-Point
+WiFi based radios for interconnecting the sites.
+At each site, a Raspberry Pi is installed to function as a gateway. A LoRa radio
+is connected to the Pi with a USB cable, and the WiFi radio is connected to the
+Ethernet port of the Pi. At site B, two WiFi radios are needed to be able to reach
+both site A and site C, so an extra Ethernet adapter is connected to the Pi in
+this location.
+Once the hardware has been installed, Reticulum is installed on all the Pis, and at
+site A and C, one interface is added for the LoRa radio, as well as one for the WiFi
+radio. At site B, an interface for the LoRa radio, and one interface for each WiFi
+radio is added to the Reticulum configuration file. The transport node option is
+enabled in the configuration of all three gateways.
+The network is now operational, and ready to serve users across all three areas.
+The organisation prepares a LoRa radio that is supplied to the end users, along
+with a Reticulum configuration file, that contains the right parameters for
+communicating with the LoRa radios installed at the gateway sites.
+Once users connect to the network, anyone will be able to communicate with anyone
+else across all three sites.
+
+
+Bridging Over the Internet
+As the organisation grows, several new communities form in places too far away
+from the core network to be reachable over WiFi links. New gateways similar to those
+previously installed are set up for the new communities at the new sites D and E, but
+they are islanded from the core network, and only serve the local users.
+After investigating the options, it is found that it is possible to install an
+Internet connection at site A, and an interface on the Internet connection is
+configured for Reticulum on the Raspberry Pi at site A.
+A member of the organisation at site D, named Dori, is willing to help by sharing
+the Internet connection she already has in her home, and is able to leave a Raspberry
+Pi running. A new Reticulum interface is configured on her Pi, connecting to the newly
+enabled Internet interface on the gateway at site A. Dori is now connected to both
+the nodes at her own local site (through the hill-top LoRa gateway), and all the
+combined users of sites A, B and C. She then enables transport on her node, and
+traffic from site D can now reach everyone at site A, B and C, and vice versa.
+
+
+Growth and Convergence
+As the organisation grows, more gateways are added to keep up with the growing user
+base. Some local gateways even add VHF radios and packet modems to reach outlying users
+and communities that are out of reach for the LoRa radios and WiFi backhauls.
+As more sites, gateways and users are connected, the amount of coordination required
+is kept to a minimum. If one community wants to add connectivity to the next one
+over, it can simply be done without having to involve everyone or coordinate address
+space or routing tables.
+With the added geographical coverage, the operators at site A one day find that
+the original internet bridged interfaces are no longer utilised. The network has
+converged to be completely self-connected, and the sites that were once poorly
+connected outliers are now an integral part of the network.
+
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
API Reference - Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+API Reference
+Communication over Reticulum networks is achieved by using a simple set of classes exposed by the RNS API.
+This chapter lists and explains all classes exposed by the Reticulum Network Stack API, along with their method signatures and usage. It can be used as a reference while writing applications that utilise Reticulum, or it can be read in entirity to gain an understanding of the complete functionality of RNS from a developers perspective.
+
Reticulum
+
+
+class RNS. Reticulum ( configdir = None loglevel = None logdest = None verbosity = None require_shared_instance = False shared_instance_type = None )
+This class is used to initialise access to Reticulum within a
+program. You must create exactly one instance of this class before
+carrying out any other RNS operations, such as creating destinations
+or sending traffic. Every independently executed program must create
+their own instance of the Reticulum class, but Reticulum will
+automatically handle inter-program communication on the same system,
+and expose all connected programs to external interfaces as well.
+As soon as an instance of this class is created, Reticulum will start
+opening and configuring any hardware devices specified in the supplied
+configuration.
+Currently the first running instance must be kept running while other
+local instances are connected, as the first created instance will
+act as a master instance that directly communicates with external
+hardware such as modems, TNCs and radios. If a master instance is
+asked to exit, it will not exit until all client processes have
+terminated (unless killed forcibly).
+If you are running Reticulum on a system with several different
+programs that use RNS starting and terminating at different times,
+it will be advantageous to run a master RNS instance as a daemon for
+other programs to use on demand.
+
+
+MTU = 500
+The MTU that Reticulum adheres to, and will expect other peers to
+adhere to. By default, the MTU is 500 bytes. In custom RNS network
+implementations, it is possible to change this value, but doing so will
+completely break compatibility with all other RNS networks. An identical
+MTU is a prerequisite for peers to communicate in the same network.
+Unless you really know what you are doing, the MTU should be left at
+the default value.
+
+
+
+
+LINK_MTU_DISCOVERY = True
+Whether automatic link MTU discovery is enabled by default in this
+release. Link MTU discovery significantly increases throughput over
+fast links, but requires all intermediary hops to also support it.
+Support for this feature was added in RNS version 0.9.0. This option
+will become enabled by default in the near future. Please update your
+RNS instances.
+
+
+
+
+ANNOUNCE_CAP = 2
+The maximum percentage of interface bandwidth that, at any given time,
+may be used to propagate announces. If an announce was scheduled for
+broadcasting on an interface, but doing so would exceed the allowed
+bandwidth allocation, the announce will be queued for transmission
+when there is bandwidth available.
+Reticulum will always prioritise propagating announces with fewer
+hops, ensuring that distant, large networks with many peers on fast
+links don’t overwhelm the capacity of smaller networks on slower
+mediums. If an announce remains queued for an extended amount of time,
+it will eventually be dropped.
+This value will be applied by default to all created interfaces,
+but it can be configured individually on a per-interface basis. In
+general, the global default setting should not be changed, and any
+alterations should be made on a per-interface basis instead.
+
+
+
+
+MINIMUM_BITRATE = 5
+Minimum bitrate required across a medium for Reticulum to be able
+to successfully establish links. Currently 5 bits per second.
+
+
+
+
+static get_instance ( )
+Return the currently running Reticulum instance
+
+
+
+
+static should_use_implicit_proof ( )
+Returns whether proofs sent are explicit or implicit.
+
+Returns:
+True if the current running configuration specifies to use implicit proofs. False if not.
+
+
+
+
+
+static transport_enabled ( )
+Returns whether Transport is enabled for the running
+instance.
+When Transport is enabled, Reticulum will
+route traffic for other peers, respond to path requests
+and pass announces over the network.
+
+Returns:
+True if Transport is enabled, False if not.
+
+
+
+
+
+static link_mtu_discovery ( )
+Returns whether link MTU discovery is enabled for the running
+instance.
+When link MTU discovery is enabled, Reticulum will
+automatically upgrade link MTUs to the highest supported
+value, increasing transfer speed and efficiency.
+
+Returns:
+True if link MTU discovery is enabled, False if not.
+
+
+
+
+
+static remote_management_enabled ( )
+Returns whether remote management is enabled for the
+running instance.
+When remote management is enabled, authenticated peers
+can remotely query and manage this instance.
+
+Returns:
+True if remote management is enabled, False if not.
+
+
+
+
+
+
Identity
+
+
+class RNS. Identity ( create_keys = True )
+This class is used to manage identities in Reticulum. It provides methods
+for encryption, decryption, signatures and verification, and is the basis
+for all encrypted communication over Reticulum networks.
+
+Parameters:
+create_keys – Specifies whether new encryption and signing keys should be generated.
+
+
+
+CURVE = 'Curve25519'
+The curve used for Elliptic Curve DH key exchanges
+
+
+
+
+KEYSIZE = 512
+X.25519 key size in bits. A complete key is the concatenation of a 256 bit encryption key, and a 256 bit signing key.
+
+
+
+
+RATCHETSIZE = 256
+X.25519 ratchet key size in bits.
+
+
+
+
+RATCHET_EXPIRY = 2592000
+The expiry time for received ratchets in seconds, defaults to 30 days. Reticulum will always use the most recently
+announced ratchet, and remember it for up to RATCHET_EXPIRY
+
+
+
+
+TRUNCATED_HASHLENGTH = 128
+Constant specifying the truncated hash length (in bits) used by Reticulum
+for addressable hashes and other purposes. Non-configurable.
+
+
+
+
+static recall ( target_hash from_identity_hash = False )
+Recall identity for a destination or identity hash. By default, this function
+will return the identity associated with a given destination hash. As an
+example, if you know the lxmf.delivery identity hash , by setting the
+from_identity_hash
+
+Parameters:
+
+
+Returns:
+An RNS.Identity RNS.Destination None if the destination is unknown.
+
+
+
+
+
+static recall_app_data ( destination_hash )
+Recall last heard app_data for a destination hash.
+
+Parameters:
+destination_hash – Destination hash as bytes .
+Returns:
+Bytes containing app_data, or None if the destination is unknown.
+
+
+
+
+
+static full_hash ( data )
+Get a SHA-256 hash of passed data.
+
+Parameters:
+data – Data to be hashed as bytes .
+Returns:
+SHA-256 hash as bytes .
+
+
+
+
+
+static truncated_hash ( data )
+Get a truncated SHA-256 hash of passed data.
+
+Parameters:
+data – Data to be hashed as bytes .
+Returns:
+Truncated SHA-256 hash as bytes .
+
+
+
+
+
+static get_random_hash ( )
+Get a random SHA-256 hash.
+
+Parameters:
+data – Data to be hashed as bytes .
+Returns:
+Truncated SHA-256 hash of random data as bytes .
+
+
+
+
+
+static current_ratchet_id ( destination_hash )
+Get the ID of the currently used ratchet key for a given destination hash
+
+Parameters:
+destination_hash – A destination hash as bytes .
+Returns:
+A ratchet ID as bytes or None .
+
+
+
+
+
+static from_bytes ( prv_bytes )
+Create a new RNS.Identity bytes of private key.
+Can be used to load previously created and saved identities into Reticulum.
+
+Parameters:
+prv_bytes – The bytes of private a saved private key. HAZARD! Never use this to generate a new key by feeding random data in prv_bytes.
+Returns:
+A RNS.Identity None if the bytes data was invalid.
+
+
+
+
+
+static from_file ( path )
+Create a new RNS.Identity
+
+Parameters:
+path – The full path to the saved RNS.Identity
+Returns:
+A RNS.Identity None if the loaded data was invalid.
+
+
+
+
+
+to_file ( path )
+Saves the identity to a file. This will write the private key to disk,
+and anyone with access to this file will be able to decrypt all
+communication for the identity. Be very careful with this method.
+
+Parameters:
+path – The full path specifying where to save the identity.
+Returns:
+True if the file was saved, otherwise False.
+
+
+
+
+
+get_private_key ( )
+
+Returns:
+The private key as bytes
+
+
+
+
+
+get_public_key ( )
+
+Returns:
+The public key as bytes
+
+
+
+
+
+load_private_key ( prv_bytes )
+Load a private key into the instance.
+
+Parameters:
+prv_bytes – The private key as bytes .
+Returns:
+True if the key was loaded, otherwise False.
+
+
+
+
+
+load_public_key ( pub_bytes )
+Load a public key into the instance.
+
+Parameters:
+pub_bytes – The public key as bytes .
+Returns:
+True if the key was loaded, otherwise False.
+
+
+
+
+
+encrypt ( plaintext ratchet = None )
+Encrypts information for the identity.
+
+Parameters:
+plaintext – The plaintext to be encrypted as bytes .
+Returns:
+Ciphertext token as bytes .
+Raises:
+KeyError if the instance does not hold a public key.
+
+
+
+
+
+decrypt ( ciphertext_token ratchets = None enforce_ratchets = False ratchet_id_receiver = None )
+Decrypts information for the identity.
+
+Parameters:
+ciphertext – The ciphertext to be decrypted as bytes .
+Returns:
+Plaintext as bytes , or None if decryption fails.
+Raises:
+KeyError if the instance does not hold a private key.
+
+
+
+
+
+sign ( message )
+Signs information by the identity.
+
+Parameters:
+message – The message to be signed as bytes .
+Returns:
+Signature as bytes .
+Raises:
+KeyError if the instance does not hold a private key.
+
+
+
+
+
+validate ( signature message )
+Validates the signature of a signed message.
+
+Parameters:
+
+
+Returns:
+True if the signature is valid, otherwise False.
+Raises:
+KeyError if the instance does not hold a public key.
+
+
+
+
+
+
Destination
+
+
+class RNS. Destination ( identity direction type app_name * aspects )
+A class used to describe endpoints in a Reticulum Network. Destination
+instances are used both to create outgoing and incoming endpoints. The
+destination type will decide if encryption, and what type, is used in
+communication with the endpoint. A destination can also announce its
+presence on the network, which will distribute necessary keys for
+encrypted communication with it.
+
+Parameters:
+
+identity – An instance of RNS.Identity
direction – RNS.Destination.IN RNS.Destination.OUT
type – RNS.Destination.SINGLE RNS.Destination.GROUP RNS.Destination.PLAIN
app_name – A string specifying the app name.
*aspects – Any non-zero number of string arguments.
+
+
+
+RATCHET_COUNT = 512
+The default number of generated ratchet keys a destination will retain, if it has ratchets enabled.
+
+
+
+
+RATCHET_INTERVAL = 1800
+The minimum interval between rotating ratchet keys, in seconds.
+
+
+
+
+static expand_name ( identity app_name * aspects )
+
+Returns:
+A string containing the full human-readable name of the destination, for an app_name and a number of aspects.
+
+
+
+
+
+static app_and_aspects_from_name ( full_name )
+
+Returns:
+A tuple containing the app name and a list of aspects, for a full-name string.
+
+
+
+
+
+static hash_from_name_and_identity ( full_name identity )
+
+Returns:
+A destination name in adressable hash form, for a full name string and Identity instance.
+
+
+
+
+
+static hash ( identity app_name * aspects )
+
+Returns:
+A destination name in adressable hash form, for an app_name and a number of aspects.
+
+
+
+
+
+announce ( app_data = None path_response = False attached_interface = None tag = None send = True )
+Creates an announce packet for this destination and broadcasts it on all
+relevant interfaces. Application specific data can be added to the announce.
+
+Parameters:
+
+
+
+
+
+
+
+accepts_links ( accepts = None )
+Set or query whether the destination accepts incoming link requests.
+
+Parameters:
+accepts – If True False None
+Returns:
+True False accepts parameter is not provided or None
+
+
+
+
+
+set_link_established_callback ( callback )
+Registers a function to be called when a link has been established to
+this destination.
+
+Parameters:
+callback – A function or method with the signature callback(link) to be called when a new link is established with this destination.
+
+
+
+
+
+set_packet_callback ( callback )
+Registers a function to be called when a packet has been received by
+this destination.
+
+Parameters:
+callback – A function or method with the signature callback(data, packet) to be called when this destination receives a packet.
+
+
+
+
+
+set_proof_requested_callback ( callback )
+Registers a function to be called when a proof has been requested for
+a packet sent to this destination. Allows control over when and if
+proofs should be returned for received packets.
+
+Parameters:
+callback – A function or method to with the signature callback(packet) be called when a packet that requests a proof is received. The callback must return one of True or False. If the callback returns True, a proof will be sent. If it returns False, a proof will not be sent.
+
+
+
+
+
+set_proof_strategy ( proof_strategy )
+Sets the destinations proof strategy.
+
+Parameters:
+proof_strategy – One of RNS.Destination.PROVE_NONE RNS.Destination.PROVE_ALL RNS.Destination.PROVE_APP RNS.Destination.PROVE_APP proof_requested_callback will be called to determine whether a proof should be sent or not.
+
+
+
+
+
+register_request_handler ( path response_generator = None allow = ALLOW_NONE allowed_list = None auto_compress = True )
+Registers a request handler.
+
+Parameters:
+
+path – The path for the request handler to be registered.
response_generator – A function or method with the signature response_generator(path, data, request_id, link_id, remote_identity, requested_at) to be called. Whatever this funcion returns will be sent as a response to the requester. If the function returns None
allow – One of RNS.Destination.ALLOW_NONE RNS.Destination.ALLOW_ALL RNS.Destination.ALLOW_LIST RNS.Destination.ALLOW_LIST
allowed_list – A list of bytes-like RNS.Identity
auto_compress – If True False
+Raises:
+ValueError
+
+
+
+
+
+deregister_request_handler ( path )
+Deregisters a request handler.
+
+Parameters:
+path – The path for the request handler to be deregistered.
+Returns:
+True if the handler was deregistered, otherwise False.
+
+
+
+
+
+enable_ratchets ( ratchets_path )
+Enables ratchets on the destination. When ratchets are enabled, Reticulum will automatically rotate
+the keys used to encrypt packets to this destination, and include the latest ratchet key in announces.
+Enabling ratchets on a destination will provide forward secrecy for packets sent to that destination,
+even when sent outside a Link Link
+Enabling ratchets will have a small impact on announce size, adding 32 bytes to every sent announce.
+
+Parameters:
+ratchets_path – The path to a file to store ratchet data in.
+Returns:
+True if the operation succeeded, otherwise False.
+
+
+
+
+
+enforce_ratchets ( )
+When ratchet enforcement is enabled, this destination will never accept packets that use its
+base Identity key for encryption, but only accept packets encrypted with one of the retained
+ratchet keys.
+
+
+
+
+set_retained_ratchets ( retained_ratchets )
+Sets the number of previously generated ratchet keys this destination will retain,
+and try to use when decrypting incoming packets. Defaults to Destination.RATCHET_COUNT
+
+Parameters:
+retained_ratchets – The number of generated ratchets to retain.
+Returns:
+True if the operation succeeded, False if not.
+
+
+
+
+
+set_ratchet_interval ( interval )
+Sets the minimum interval in seconds between ratchet key rotation.
+Defaults to Destination.RATCHET_INTERVAL
+
+Parameters:
+interval – The minimum interval in seconds.
+Returns:
+True if the operation succeeded, False if not.
+
+
+
+
+
+create_keys ( )
+For a RNS.Destination.GROUP
+
+Raises:
+TypeError
+
+
+
+
+
+get_private_key ( )
+For a RNS.Destination.GROUP
+
+Raises:
+TypeError
+
+
+
+
+
+load_private_key ( key )
+For a RNS.Destination.GROUP
+
+Parameters:
+key – A bytes-like containing the symmetric key.
+Raises:
+TypeError
+
+
+
+
+
+encrypt ( plaintext )
+Encrypts information for RNS.Destination.SINGLE RNS.Destination.GROUP
+
+Parameters:
+plaintext – A bytes-like containing the plaintext to be encrypted.
+Raises:
+ValueError
+
+
+
+
+
+decrypt ( ciphertext )
+Decrypts information for RNS.Destination.SINGLE RNS.Destination.GROUP
+
+Parameters:
+ciphertext – Bytes containing the ciphertext to be decrypted.
+Raises:
+ValueError
+
+
+
+
+
+sign ( message )
+Signs information for RNS.Destination.SINGLE
+
+Parameters:
+message – Bytes containing the message to be signed.
+Returns:
+A bytes-like containing the message signature, or None if the destination could not sign the message.
+
+
+
+
+
+set_default_app_data ( app_data = None )
+Sets the default app_data for the destination. If set, the default
+app_data will be included in every announce sent by the destination,
+unless other app_data is specified in the announce method.
+
+Parameters:
+app_data – A bytes-like containing the default app_data, or a callable returning a bytes-like containing the app_data.
+
+
+
+
+
+clear_default_app_data ( )
+Clears default app_data previously set for the destination.
+
+
+
+
+
Packet
+
+
+class RNS. Packet ( destination data create_receipt = True )
+The Packet class is used to create packet instances that can be sent
+over a Reticulum network. Packets will automatically be encrypted if
+they are addressed to a RNS.Destination.SINGLE RNS.Destination.GROUP RNS.Link
+For RNS.Destination.GROUP
+For RNS.Destination.SINGLE
+For RNS.Link Forward Secrecy .
+
+Parameters:
+
+destination – A RNS.Destination
data – The data payload to be included in the packet as bytes .
create_receipt – Specifies whether a RNS.PacketReceipt
+
+
+
+ENCRYPTED_MDU = 383
+The maximum size of the payload data in a single encrypted packet
+
+
+
+
+PLAIN_MDU = 464
+The maximum size of the payload data in a single unencrypted packet
+
+
+
+
+send ( )
+Sends the packet.
+
+Returns:
+A RNS.PacketReceipt create_receipt was set to True when the packet was instantiated, if not returns None . If the packet could not be sent False is returned.
+
+
+
+
+
+resend ( )
+Re-sends the packet.
+
+Returns:
+A RNS.PacketReceipt create_receipt was set to True when the packet was instantiated, if not returns None . If the packet could not be sent False is returned.
+
+
+
+
+
+
+Returns:
+The physical layer Received Signal Strength Indication if available, otherwise None
+
+
+
+
+
+get_snr ( )
+
+Returns:
+The physical layer Signal-to-Noise Ratio if available, otherwise None
+
+
+
+
+
+get_q ( )
+
+Returns:
+The physical layer Link Quality if available, otherwise None
+
+
+
+
+
+
Packet Receipt
+
+
+class RNS. PacketReceipt
+The PacketReceipt class is used to receive notifications about
+RNS.Packet send() method of a RNS.Packet
+
+
+get_status ( )
+
+Returns:
+The status of the associated RNS.Packet RNS.PacketReceipt.SENT RNS.PacketReceipt.DELIVERED RNS.PacketReceipt.FAILED RNS.PacketReceipt.CULLED
+
+
+
+
+
+get_rtt ( )
+
+Returns:
+The round-trip-time in seconds
+
+
+
+
+
+set_timeout ( timeout )
+Sets a timeout in seconds
+
+Parameters:
+timeout – The timeout in seconds.
+
+
+
+
+
+set_delivery_callback ( callback )
+Sets a function that gets called if a successfull delivery has been proven.
+
+Parameters:
+callback – A callable with the signature callback(packet_receipt)
+
+
+
+
+
+set_timeout_callback ( callback )
+Sets a function that gets called if the delivery times out.
+
+Parameters:
+callback – A callable with the signature callback(packet_receipt)
+
+
+
+
+
+
Link
+
+
+class RNS. Link ( destination established_callback = None closed_callback = None )
+This class is used to establish and manage links to other peers. When a
+link instance is created, Reticulum will attempt to establish verified
+and encrypted connectivity with the specified destination.
+
+Parameters:
+
+destination – A RNS.Destination
established_callback – An optional function or method with the signature callback(link) to be called when the link has been established.
closed_callback – An optional function or method with the signature callback(link) to be called when the link is closed.
+
+
+
+CURVE = 'Curve25519'
+The curve used for Elliptic Curve DH key exchanges
+
+
+
+
+ESTABLISHMENT_TIMEOUT_PER_HOP = 6
+Timeout for link establishment in seconds per hop to destination.
+
+
+
+
+KEEPALIVE_TIMEOUT_FACTOR = 4
+RTT timeout factor used in link timeout calculation.
+
+
+
+
+STALE_GRACE = 5
+Grace period in seconds used in link timeout calculation.
+
+
+
+
+KEEPALIVE = 360
+Default interval for sending keep-alive packets on established links in seconds.
+
+
+
+
+STALE_TIME = 720
+If no traffic or keep-alive packets are received within this period, the
+link will be marked as stale, and a final keep-alive packet will be sent.
+If after this no traffic or keep-alive packets are received within RTT KEEPALIVE_TIMEOUT_FACTOR STALE_GRACE
+
+
+
+
+identify ( identity )
+Identifies the initiator of the link to the remote peer. This can only happen
+once the link has been established, and is carried out over the encrypted link.
+The identity is only revealed to the remote peer, and initiator anonymity is
+thus preserved. This method can be used for authentication.
+
+Parameters:
+identity – An RNS.Identity instance to identify as.
+
+
+
+
+
+request ( path data = None response_callback = None failed_callback = None progress_callback = None timeout = None )
+Sends a request to the remote peer.
+
+Parameters:
+
+path – The request path.
response_callback – An optional function or method with the signature response_callback(request_receipt) to be called when a response is received. See the Request Example
failed_callback – An optional function or method with the signature failed_callback(request_receipt) to be called when a request fails. See the Request Example
progress_callback – An optional function or method with the signature progress_callback(request_receipt) to be called when progress is made receiving the response. Progress can be accessed as a float between 0.0 and 1.0 by the request_receipt.progress property.
timeout – An optional timeout in seconds for the request. If None is supplied it will be calculated based on link RTT.
+Returns:
+A RNS.RequestReceipt False if it was not.
+
+
+
+
+
+track_phy_stats ( track )
+You can enable physical layer statistics on a per-link basis. If this is enabled,
+and the link is running over an interface that supports reporting physical layer
+statistics, you will be able to retrieve stats such as RSSI , SNR and physical
+Link Quality for the link.
+
+Parameters:
+track – Whether or not to keep track of physical layer statistics. Value must be True False
+
+
+
+
+
+
+Returns:
+The physical layer Received Signal Strength Indication if available, otherwise None
+
+
+
+
+
+get_snr ( )
+
+Returns:
+The physical layer Signal-to-Noise Ratio if available, otherwise None
+
+
+
+
+
+get_q ( )
+
+Returns:
+The physical layer Link Quality if available, otherwise None
+
+
+
+
+
+get_establishment_rate ( )
+
+Returns:
+The data transfer rate at which the link establishment procedure ocurred, in bits per second.
+
+
+
+
+
+get_mtu ( )
+
+Returns:
+The MTU of an established link.
+
+
+
+
+
+get_mdu ( )
+
+Returns:
+The packet MDU of an established link.
+
+
+
+
+
+get_expected_rate ( )
+
+Returns:
+The packet expected in-flight data rate of an established link.
+
+
+
+
+
+get_mode ( )
+
+Returns:
+The mode of an established link.
+
+
+
+
+
+get_age ( )
+
+Returns:
+The time in seconds since this link was established.
+
+
+
+
+
+no_inbound_for ( )
+
+Returns:
+The time in seconds since last inbound packet on the link. This includes keepalive packets.
+
+
+
+
+
+no_outbound_for ( )
+
+Returns:
+The time in seconds since last outbound packet on the link. This includes keepalive packets.
+
+
+
+
+
+no_data_for ( )
+
+Returns:
+The time in seconds since payload data traversed the link. This excludes keepalive packets.
+
+
+
+
+
+inactive_for ( )
+
+Returns:
+The time in seconds since activity on the link. This includes keepalive packets.
+
+
+
+
+
+get_remote_identity ( )
+
+Returns:
+The identity of the remote peer, if it is known. Calling this method will not query the remote initiator to reveal its identity. Returns None identify(identity)
+
+
+
+
+
+teardown ( )
+Closes the link and purges encryption keys. New keys will
+be used if a new link to the same destination is established.
+
+
+
+
+get_channel ( )
+Get the Channel
+
+Returns:
+Channel
+
+
+
+
+
+set_link_closed_callback ( callback )
+Registers a function to be called when a link has been
+torn down.
+
+Parameters:
+callback – A function or method with the signature callback(link) to be called.
+
+
+
+
+
+set_packet_callback ( callback )
+Registers a function to be called when a packet has been
+received over this link.
+
+Parameters:
+callback – A function or method with the signature callback(message, packet) to be called.
+
+
+
+
+
+set_resource_callback ( callback )
+Registers a function to be called when a resource has been
+advertised over this link. If the function returns True
+the resource will be accepted. If it returns False it will
+be ignored.
+
+Parameters:
+callback – A function or method with the signature callback(resource) to be called. Please note that only the basic information of the resource is available at this time, such as get_transfer_size() , get_data_size() , get_parts() and is_compressed() .
+
+
+
+
+
+set_resource_started_callback ( callback )
+Registers a function to be called when a resource has begun
+transferring over this link.
+
+Parameters:
+callback – A function or method with the signature callback(resource) to be called.
+
+
+
+
+
+set_resource_concluded_callback ( callback )
+Registers a function to be called when a resource has concluded
+transferring over this link.
+
+Parameters:
+callback – A function or method with the signature callback(resource) to be called.
+
+
+
+
+
+set_remote_identified_callback ( callback )
+Registers a function to be called when an initiating peer has
+identified over this link.
+
+Parameters:
+callback – A function or method with the signature callback(link, identity) to be called.
+
+
+
+
+
+set_resource_strategy ( resource_strategy )
+Sets the resource strategy for the link.
+
+Parameters:
+resource_strategy – One of RNS.Link.ACCEPT_NONE RNS.Link.ACCEPT_ALL RNS.Link.ACCEPT_APP RNS.Link.ACCEPT_APP resource_callback will be called to determine whether the resource should be accepted or not.
+Raises:
+TypeError if the resource strategy is unsupported.
+
+
+
+
+
+
Request Receipt
+
+
+class RNS. RequestReceipt
+An instance of this class is returned by the request RNS.Link
+
+
+get_request_id ( )
+
+Returns:
+The request ID as bytes .
+
+
+
+
+
+get_status ( )
+
+Returns:
+The current status of the request, one of RNS.RequestReceipt.FAILED RNS.RequestReceipt.SENT RNS.RequestReceipt.DELIVERED RNS.RequestReceipt.READY
+
+
+
+
+
+get_progress ( )
+
+Returns:
+The progress of a response being received as a float between 0.0 and 1.0.
+
+
+
+
+
+get_response ( )
+
+Returns:
+The response as bytes if it is ready, otherwise None .
+
+
+
+
+
+get_response_time ( )
+
+Returns:
+The response time of the request in seconds.
+
+
+
+
+
+concluded ( )
+
+Returns:
+True if the associated request has concluded (successfully or with a failure), otherwise False.
+
+
+
+
+
+
Resource
+
+
+class RNS. Resource ( data link advertise = True auto_compress = True callback = None progress_callback = None timeout = None )
+The Resource class allows transferring arbitrary amounts
+of data over a link. It will automatically handle sequencing,
+compression, coordination and checksumming.
+
+Parameters:
+
+data – The data to be transferred. Can be bytes or an open file handle . See the Filetransfer Example
link – The RNS.Link
advertise – Optional. Whether to automatically advertise the resource. Can be True or False .
auto_compress – Optional. Whether to auto-compress the resource. Can be True or False .
callback – An optional callable with the signature callback(resource) . Will be called when the resource transfer concludes.
progress_callback – An optional callable with the signature callback(resource) . Will be called whenever the resource transfer progress is updated.
+
+
+
+advertise ( )
+Advertise the resource. If the other end of the link accepts
+the resource advertisement it will begin transferring.
+
+
+
+
+cancel ( )
+Cancels transferring the resource.
+
+
+
+
+get_progress ( )
+
+Returns:
+The current progress of the resource transfer as a float between 0.0 and 1.0.
+
+
+
+
+
+get_transfer_size ( )
+
+Returns:
+The number of bytes needed to transfer the resource.
+
+
+
+
+
+get_data_size ( )
+
+Returns:
+The total data size of the resource.
+
+
+
+
+
+get_parts ( )
+
+Returns:
+The number of parts the resource will be transferred in.
+
+
+
+
+
+get_segments ( )
+
+Returns:
+The number of segments the resource is divided into.
+
+
+
+
+
+get_hash ( )
+
+Returns:
+The hash of the resource.
+
+
+
+
+
+is_compressed ( )
+
+Returns:
+Whether the resource is compressed.
+
+
+
+
+
+
Channel
+
+
+class RNS.Channel. Channel
+Provides reliable delivery of messages over
+a link.
+Channel Request Resource
+
+
+Continuous Messages can be sent or received as long as
+the Link
+Bi-directional Messages can be sent in either direction on
+the Link
+Size-constrained Messages must be encoded into a single packet.
+
+
+Channel Packet Link
+Channel Link get_channel()
+
+
+register_message_type ( message_class : Type [ MessageBase ] )
+Register a message class for reception over a Channel
+Message classes must extend MessageBase
+
+Parameters:
+message_class – Class to register
+
+
+
+
+
+add_message_handler ( callback : MessageCallbackType )
+Add a handler for incoming messages. A handler
+has the following signature:
+(message: MessageBase) -> bool
+Handlers are processed in the order they are
+added. If any handler returns True, processing
+of the message stops; handlers after the
+returning handler will not be called.
+
+Parameters:
+callback – Function to call
+
+
+
+
+
+remove_message_handler ( callback : MessageCallbackType )
+Remove a handler added with add_message_handler
+
+Parameters:
+callback – handler to remove
+
+
+
+
+
+is_ready_to_send ( ) → bool
+Check if Channel
+
+Returns:
+True if ready
+
+
+
+
+
+send ( message : MessageBase ) → Envelope
+Send a message. If a message send is attempted and
+Channel
+
+Parameters:
+message – an instance of a MessageBase
+
+
+
+
+
+property mdu
+Maximum Data Unit: the number of bytes available
+for a message to consume in a single send. This
+value is adjusted from the Link
+
+Returns:
+number of bytes available
+
+
+
+
+
+
MessageBase
+
+
+class RNS. MessageBase
+Base type for any messages sent or received on a Channel.
+Subclasses must define the two abstract methods as well as
+the MSGTYPE
+
+
+MSGTYPE = None
+Defines a unique identifier for a message class.
+
+
+
+
+
+abstract pack ( ) → bytes
+Create and return the binary representation of the message
+
+Returns:
+binary representation of message
+
+
+
+
+
+abstract unpack ( raw : bytes )
+Populate message from binary representation
+
+Parameters:
+raw – binary representation
+
+
+
+
+
+
Buffer
+
+
+class RNS. Buffer
+Static functions for creating buffered streams that send
+and receive over a Channel
+These functions use BufferedReader BufferedWriter BufferedRWPair RawChannelReader RawChannelWriter
+
+
+static create_reader ( stream_id : int channel : Channel ready_callback : Optional [ Callable [ [ int ] , None ] ] = None ) → BufferedReader
+Create a buffered reader that reads binary data sent
+over a Channel
+Callback signature: (ready_bytes: int) -> None
+For more information on the reader-specific functions
+of this object, see the Python documentation for
+BufferedReader
+
+Parameters:
+
+stream_id – the local stream id to receive from
channel – the channel to receive on
ready_callback – function to call when new data is available
+Returns:
+a BufferedReader object
+
+
+
+
+
+static create_writer ( stream_id : int channel : Channel ) → BufferedWriter
+Create a buffered writer that writes binary data over
+a Channel
+For more information on the writer-specific functions
+of this object, see the Python documentation for
+BufferedWriter
+
+Parameters:
+
+
+Returns:
+a BufferedWriter object
+
+
+
+
+
+static create_bidirectional_buffer ( receive_stream_id : int send_stream_id : int channel : Channel ready_callback : Optional [ Callable [ [ int ] , None ] ] = None ) → BufferedRWPair
+Create a buffered reader/writer pair that reads and
+writes binary data over a Channel
+Callback signature: (ready_bytes: int) -> None
+For more information on the reader-specific functions
+of this object, see the Python documentation for
+BufferedRWPair
+
+Parameters:
+
+receive_stream_id – the local stream id to receive at
send_stream_id – the remote stream id to send to
channel – the channel to send and receive on
ready_callback – function to call when new data is available
+Returns:
+a BufferedRWPair object
+
+
+
+
+
+
RawChannelReader
+
+
+class RNS. RawChannelReader ( stream_id : int channel : Channel )
+An implementation of RawIOBase that receives
+binary stream data sent over a Channel
+
+
+
+
+__init__ ( stream_id : int channel : Channel )
+Create a raw channel reader.
+
+Parameters:
+
+
+
+
+
+
+
+add_ready_callback ( cb : Callable [ [ int ] , None ] )
+Add a function to be called when new data is available.
+The function should have the signature (ready_bytes: int) -> None
+
+Parameters:
+cb – function to call
+
+
+
+
+
+remove_ready_callback ( cb : Callable [ [ int ] , None ] )
+Remove a function added with RNS.RawChannelReader.add_ready_callback()
+
+Parameters:
+cb – function to remove
+
+
+
+
+
+
RawChannelWriter
+
+
+class RNS. RawChannelWriter ( stream_id : int channel : Channel )
+An implementation of RawIOBase that receives
+binary stream data sent over a channel.
+
+
+
+
+__init__ ( stream_id : int channel : Channel )
+Create a raw channel writer.
+
+Parameters:
+
+
+
+
+
+
+
+
Transport
+
+
+class RNS. Transport
+Through static methods of this class you can interact with the
+Transport system of Reticulum.
+
+
+PATHFINDER_M = 128
+Maximum amount of hops that Reticulum will transport a packet.
+
+
+
+
+static register_announce_handler ( handler )
+Registers an announce handler.
+
+Parameters:
+handler – Must be an object with an aspect_filter attribute and a received_announce(destination_hash, announced_identity, app_data)
+or received_announce(destination_hash, announced_identity, app_data, announce_packet_hash) callable. Can optionally have a
+receive_path_responses attribute set to True Announce Example
+
+
+
+
+
+static deregister_announce_handler ( handler )
+Deregisters an announce handler.
+
+Parameters:
+handler – The announce handler to be deregistered.
+
+
+
+
+
+static has_path ( destination_hash )
+
+Parameters:
+destination_hash – A destination hash as bytes .
+Returns:
+True if a path to the destination is known, otherwise False .
+
+
+
+
+
+static hops_to ( destination_hash )
+
+Parameters:
+destination_hash – A destination hash as bytes .
+Returns:
+The number of hops to the specified destination, or RNS.Transport.PATHFINDER_M
+
+
+
+
+
+static next_hop ( destination_hash )
+
+Parameters:
+destination_hash – A destination hash as bytes .
+Returns:
+The destination hash as bytes for the next hop to the specified destination, or None if the next hop is unknown.
+
+
+
+
+
+static next_hop_interface ( destination_hash )
+
+Parameters:
+destination_hash – A destination hash as bytes .
+Returns:
+The interface for the next hop to the specified destination, or None if the interface is unknown.
+
+
+
+
+
+static request_path ( destination_hash on_interface = None tag = None recursive = False )
+Requests a path to the destination from the network. If
+another reachable peer on the network knows a path, it
+will announce it.
+
+Parameters:
+
+destination_hash – A destination hash as bytes .
on_interface – If specified, the path request will only be sent on this interface. In normal use, Reticulum handles this automatically, and this parameter should not be used.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
Search - Reticulum Network Stack 1.0.0 documentation
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+
+
+
Error
+
+ Please activate JavaScript to enable the search functionality.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
Support Reticulum - Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+Support Reticulum
+You can help support the continued development of open, free and private communications
+systems by donating, providing feedback and contributing code and learning resources.
+
+Donations
+Donations are gratefully accepted via the following channels:
+
+
Are certain features in the development roadmap are important to you or your
+organisation? Make them a reality quickly by sponsoring their implementation.
+
+
+Provide Feedback
+All feedback on the usage, functioning and potential dysfunctioning of any and
+all components of the system is very valuable to the continued development and
+improvement of Reticulum.
+Absolutely no automated analytics, telemetry, error
+reporting or statistics is collected and reported by Reticulum under any
+circumstances, so we rely on old-fashioned human feedback.
+
+
+Contribute Code
+Join us on the GitHub repository to
+report issues, suggest functionality and contribute code to Reticulum.
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
Understanding Reticulum - Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+Understanding Reticulum
+This chapter will briefly describe the overall purpose and operating principles of Reticulum.
+It should give you an overview of how the stack works, and an understanding of how to
+develop networked applications using Reticulum.
+This chapter is not an exhaustive source of information on Reticulum, at least not yet. Currently,
+the only complete repository, and final authority on how Reticulum actually functions, is the Python
+reference implementation and API reference. That being said, this chapter is an essential resource in
+understanding how Reticulum works from a high-level perspective, along with the general principles of
+Reticulum, and how to apply them when creating your own networks or software.
+After reading this document, you should be well-equipped to understand how a Reticulum network
+operates, what it can achieve, and how you can use it yourself. If you want to help out with the
+development, this is also the place to start, since it will provide a pretty clear overview of the
+sentiments and the philosophy behind Reticulum, what problems it seeks to solve, and how it
+approaches those solutions.
+
+Motivation
+The primary motivation for designing and implementing Reticulum has been the current lack of
+reliable, functional and secure minimal-infrastructure modes of digital communication. It is my
+belief that it is highly desirable to create a reliable and efficient way to set up long-range digital
+communication networks that can securely allow exchange of information between people and
+machines, with no central point of authority, control, censorship or barrier to entry.
+Almost all of the various networking systems in use today share a common limitation: They
+require large amounts of coordination and centralised trust and power to function. To join such networks, you need approval
+of gatekeepers in control. This need for coordination and trust inevitably leads to an environment of
+central control, where it’s very easy for infrastructure operators or governments to control or alter
+traffic, and censor or persecute unwanted actors. It also makes it completely impossible to freely deploy
+and use networks at will, like one would use other common tools that enhance individual agency and freedom.
+Reticulum aims to require as little coordination and trust as possible. It aims to make secure,
+anonymous and permissionless networking and information exchange a tool that anyone can just pick up and use.
+Since Reticulum is completely medium agnostic, it can be used to build networks on whatever is best
+suited to the situation, or whatever you have available. In some cases, this might be packet radio
+links over VHF frequencies, in other cases it might be a 2.4 GHz
+network using off-the-shelf radios, or it might be using common LoRa development boards.
+At the time of release of this document, the fastest and easiest setup for development and testing is using
+LoRa radio modules with an open source firmware (see the section Reference Setup
+The ultimate aim of Reticulum is to allow anyone to be their own network operator, and to make it
+cheap and easy to cover vast areas with a myriad of independent, interconnectable and autonomous networks.
+Reticulum is not one network , it is a tool to build thousands of networks . Networks without
+kill-switches, surveillance, censorship and control. Networks that can freely interoperate, associate and disassociate
+with each other, and require no central oversight. Networks for human beings. Networks for the people .
+
+
+Goals
+To be as widely usable and efficient to deploy as possible, the following goals have been used to
+guide the design of Reticulum:
+
+
+Fully useable as open source software stack Reticulum must be implemented with, and be able to run using only open source software. This is
+critical to ensuring the availability, security and transparency of the system.
+
+
+Hardware layer agnosticism Reticulum must be fully hardware agnostic, and shall be useable over a wide range of
+physical networking layers, such as data radios, serial lines, modems, handheld transceivers,
+wired Ethernet, WiFi, or anything else that can carry a digital data stream. Hardware made for
+dedicated Reticulum use shall be as cheap as possible and use off-the-shelf components, so
+it can be easily modified and replicated by anyone interested in doing so.
+
+
+Very low bandwidth requirements Reticulum should be able to function reliably over links with a transmission capacity as low
+as 5 bits per second .
+
+
+Encryption by default Reticulum must use strong encryption by default for all communication.
+
+
+Initiator Anonymity It must be possible to communicate over a Reticulum network without revealing any identifying
+information about oneself.
+
+
+Unlicensed use Reticulum shall be functional over physical communication mediums that do not require any
+form of license to use. Reticulum must be designed in a way, so it is usable over ISM radio
+frequency bands, and can provide functional long distance links in such conditions, for example
+by connecting a modem to a PMR or CB radio, or by using LoRa or WiFi modules.
+
+
+Supplied software In addition to the core networking stack and API, that allows a developer to build
+applications with Reticulum, a basic set of Reticulum-based communication tools must be
+implemented and released along with Reticulum itself. These shall serve both as a
+functional, basic communication suite, and as an example and learning resource to others wishing
+to build applications with Reticulum.
+
+
+Ease of use The reference implementation of Reticulum is written in Python, to make it easy to use
+and understand. A programmer with only basic experience should be able to use
+Reticulum to write networked applications.
+
+
+Low cost It shall be as cheap as possible to deploy a communication system based on Reticulum. This
+should be achieved by using cheap off-the-shelf hardware that potential users might already
+own. The cost of setting up a functioning node should be less than $100 even if all parts
+needs to be purchased.
+
+
+
+
+Introduction & Basic Functionality
+Reticulum is a networking stack suited for high-latency, low-bandwidth links. Reticulum is at its
+core a message oriented system. It is suited for both local point-to-point or point-to-multipoint
+scenarios where all nodes are within range of each other, as well as scenarios where packets need
+to be transported over multiple hops in a complex network to reach the recipient.
+Reticulum does away with the idea of addresses and ports known from IP, TCP and UDP. Instead
+Reticulum uses the singular concept of destinations . Any application using Reticulum as its
+networking stack will need to create one or more destinations to receive data, and know the
+destinations it needs to send data to.
+All destinations in Reticulum are _represented_ as a 16 byte hash. This hash is derived from truncating a full
+SHA-256 hash of identifying characteristics of the destination. To users, the destination addresses
+will be displayed as 16 hexadecimal bytes, like this example: <13425ec15b621c1d928589718000d814>
+The truncation size of 16 bytes (128 bits) for destinations has been chosen as a reasonable trade-off
+between address space
+and packet overhead. The address space accommodated by this size can support many billions of
+simultaneously active devices on the same network, while keeping packet overhead low, which is
+essential on low-bandwidth networks. In the very unlikely case that this address space nears
+congestion, a one-line code change can upgrade the Reticulum address space all the way up to 256
+bits, ensuring the Reticulum address space could potentially support galactic-scale networks.
+This is obviously complete and ridiculous over-allocation, and as such, the current 128 bits should
+be sufficient, even far into the future.
+By default Reticulum encrypts all data using elliptic curve cryptography and AES. Any packet sent to a
+destination is encrypted with a per-packet derived key. Reticulum can also set up an encrypted
+channel to a destination, called a Link . Both data sent over Links and single packets offer
+Initiator Anonymity . Links additionally offer Forward Secrecy by default, employing an Elliptic Curve
+Diffie Hellman key exchange on Curve25519 to derive per-link ephemeral keys. Asymmetric, link-less
+packet communication can also provide forward secrecy, with automatic key ratcheting, by enabling
+ratchets on a per-destination basis. The multi-hop transport, coordination, verification and reliability
+layers are fully autonomous and also based on elliptic curve cryptography.
+Reticulum also offers symmetric key encryption for group-oriented communications, as well as
+unencrypted packets for local broadcast purposes.
+Reticulum can connect to a variety of interfaces such as radio modems, data radios and serial ports,
+and offers the possibility to easily tunnel Reticulum traffic over IP links such as the Internet or
+private IP networks.
+
+Destinations
+To receive and send data with the Reticulum stack, an application needs to create one or more
+destinations. Reticulum uses three different basic destination types, and one special:
+
+
+Single The single destination type is the most common type in Reticulum, and should be used for
+most purposes. It is always identified by a unique public key. Any data sent to this
+destination will be encrypted using ephemeral keys derived from an ECDH key exchange, and will
+only be readable by the creator of the destination, who holds the corresponding private key.
+
+
+Plain A plain destination type is unencrypted, and suited for traffic that should be broadcast to a
+number of users, or should be readable by anyone. Traffic to a plain destination is not encrypted.
+Generally, plain destinations can be used for broadcast information intended to be public.
+Plain destinations are only reachable directly, and packets addressed to plain destinations are
+never transported over multiple hops in the network. To be transportable over multiple hops in Reticulum, information
+must be encrypted, since Reticulum uses the per-packet encryption to verify routing paths and
+keep them alive.
+
+
+Group The group special destination type, that defines a symmetrically encrypted virtual destination.
+Data sent to this destination will be encrypted with a symmetric key, and will be readable by
+anyone in possession of the key, but as with the plain destination type, packets to this type
+of destination are not currently transported over multiple hops, although a planned upgrade
+to Reticulum will allow globally reachable group destinations.
+
+
+Link A link is a special destination type, that serves as an abstract channel to a single
+destination, directly connected or over multiple hops. The link also offers reliability and
+more efficient encryption, forward secrecy, initiator anonymity, and as such can be useful even
+when a node is directly reachable. It also offers a more capable API and allows easily carrying
+out requests and responses, large data transfers and more.
+
+
+
+Destination Naming
+Destinations are created and named in an easy to understand dotted notation of aspects , and
+represented on the network as a hash of this value. The hash is a SHA-256 truncated to 128 bits. The
+top level aspect should always be a unique identifier for the application using the destination.
+The next levels of aspects can be defined in any way by the creator of the application.
+Aspects can be as long and as plentiful as required, and a resulting long destination name will not
+impact efficiency, as names are always represented as truncated SHA-256 hashes on the network.
+As an example, a destination for a environmental monitoring application could be made up of the
+application name, a device type and measurement type, like this:
+
+
For the single destination, Reticulum will automatically append the associated public key as a
+destination aspect before hashing. This is done to ensure only the correct destination is reached,
+since anyone can listen to any destination name. Appending the public key ensures that a given
+packet is only directed at the destination that holds the corresponding private key to decrypt the
+packet.
+Take note! There is a very important concept to understand here:
+
+Anyone can use the destination name environmentlogger.remotesensor.temperature
Each destination that does so will still have a unique destination hash, and thus be uniquely
+addressable, because their public keys will differ.
+In actual use of single destination naming, it is advisable not to use any uniquely identifying
+features in aspect naming. Aspect names should be general terms describing what kind of destination
+is represented. The uniquely identifying aspect is always achieved by appending the public key,
+which expands the destination into a uniquely identifiable one. Reticulum does this automatically.
+Any destination on a Reticulum network can be addressed and reached simply by knowing its
+destination hash (and public key, but if the public key is not known, it can be requested from the
+network simply by knowing the destination hash). The use of app names and aspects makes it easy to
+structure Reticulum programs and makes it possible to filter what information and data your program
+receives.
+To recap, the different destination types should be used in the following situations:
+
+
+Single When private communication between two endpoints is needed. Supports multiple hops.
+
+
+Group When private communication between two or more endpoints is needed. Supports multiple hops
+indirectly, but must first be established through a single destination.
+
+
+Plain When plain-text communication is desirable, for example when broadcasting information, or for local discovery purposes.
+
+
+To communicate with a single destination, you need to know its public key. Any method for
+obtaining the public key is valid, but Reticulum includes a simple mechanism for making other
+nodes aware of your destinations public key, called the announce . It is also possible to request
+an unknown public key from the network, as all transport instances serve as a distributed ledger
+of public keys.
+Note that public key information can be shared and verified in other ways than using the
+built-in announce functionality, and that it is therefore not required to use the announce and path request
+functionality to obtain public keys. It is by far the easiest though, and should definitely be used
+if there is not a very good reason for doing it differently.
+
+
+
+Public Key Announcements
+An announce will send a special packet over any relevant interfaces, containing all needed
+information about the destination hash and public key, and can also contain some additional,
+application specific data. The entire packet is signed by the sender to ensure authenticity. It is not
+required to use the announce functionality, but in many cases it will be the simplest way to share
+public keys on the network. The announce mechanism also serves to establish end-to-end connectivity
+to the announced destination, as the announce propagates through the network.
+As an example, an announce in a simple messenger application might contain the following information:
+
+The announcers destination hash
The announcers public key
Application specific data, in this case the users nickname and availability status
A random blob, making each new announce unique
An Ed25519 signature of the above information, verifying authenticity
+With this information, any Reticulum node that receives it will be able to reconstruct an outgoing
+destination to securely communicate with that destination. You might have noticed that there is one
+piece of information lacking to reconstruct full knowledge of the announced destination, and that is
+the aspect names of the destination. These are intentionally left out to save bandwidth, since they
+will be implicit in almost all cases. The receiving application will already know them. If a destination
+name is not entirely implicit, information can be included in the application specific data part that
+will allow the receiver to infer the naming.
+It is important to note that announces will be forwarded throughout the network according to a
+certain pattern. This will be detailed in the section
+The Announce Mechanism in Detail
+In Reticulum, destinations are allowed to move around the network at will. This is very different from
+protocols such as IP, where an address is always expected to stay within the network segment it was assigned in.
+This limitation does not exist in Reticulum, and any destination is completely portable over the entire topography
+of the network, and can even be moved to other Reticulum networks than the one it was created in, and
+still become reachable. To update its reachability, a destination simply needs to send an announce on any
+networks it is part of. After a short while, it will be globally reachable in the network.
+Seeing how single destinations are always tied to a private/public key pair leads us to the next topic.
+
+
+Identities
+In Reticulum, an identity does not necessarily represent a personal identity, but is an abstraction that
+can represent any kind of verifiable entity . This could very well be a person, but it could also be the
+control interface of a machine, a program, robot, computer, sensor or something else entirely. In
+general, any kind of agent that can act, or be acted upon, or store or manipulate information, can be
+represented as an identity. An identity can be used to create any number of destinations.
+A single destination will always have an identity tied to it, but not plain or group
+destinations. Destinations and identities share a multilateral connection. You can create a
+destination, and if it is not connected to an identity upon creation, it will just create a new one to use
+automatically. This may be desirable in some situations, but often you will probably want to create
+the identity first, and then use it to create new destinations.
+As an example, we could use an identity to represent the user of a messaging application.
+Destinations can then be created by this identity to allow communication to reach the user.
+In all cases it is of great importance to store the private keys associated with any
+Reticulum Identity securely and privately, since obtaining access to the identity keys equals
+obtaining access and controlling reachability to any destinations created by that identity.
+
+
+Getting Further
+The above functions and principles form the core of Reticulum, and would suffice to create
+functional networked applications in local clusters, for example over radio links where all interested
+nodes can directly hear each other. But to be truly useful, we need a way to direct traffic over multiple
+hops in the network.
+In the following sections, two concepts that allow this will be introduced, paths and links .
+
+
+
+Reticulum Transport
+The methods of routing used in traditional networks are fundamentally incompatible with the physical medium
+types and circumstances that Reticulum was designed to handle. These mechanisms mostly assume trust at the physical layer,
+and often needs a lot more bandwidth than Reticulum can assume is available. Since Reticulum is designed to
+survive running over open radio spectrum, no such trust can be assumed, and bandwidth is often very limited.
+To overcome such challenges, Reticulum’s Transport system uses asymmetric elliptic curve cryptography to
+implement the concept of paths that allow discovery of how to get information closer to a certain
+destination. It is important to note that no single node in a Reticulum network knows the complete
+path to a destination. Every Transport node participating in a Reticulum network will only
+know the most direct way to get a packet one hop closer to it’s destination.
+
+Node Types
+Currently, Reticulum distinguishes between two types of network nodes. All nodes on a Reticulum network
+are Reticulum Instances , and some are also Transport Nodes . If a system running Reticulum is fixed in
+one place, and is intended to be kept available most of the time, it is a good contender to be a Transport Node .
+Any Reticulum Instance can become a Transport Node by enabling it in the configuration.
+This distinction is made by the user configuring the node, and is used to determine what nodes on the
+network will help forward traffic, and what nodes rely on other nodes for wider connectivity.
+If a node is an Instance it should be given the configuration directive enable_transport = No
+If it is a Transport Node , it should be given the configuration directive enable_transport = Yes
+
+
+The Announce Mechanism in Detail
+When an announce for a destination is transmitted by a Reticulum instance, it will be forwarded by
+any transport node receiving it, but according to some specific rules:
+
+
+
If this exact announce has already been received before, ignore it.
+
+
If not, record into a table which Transport Node the announce was received from, and how many times in
+total it has been retransmitted to get here.
+
+
If the announce has been retransmitted m+1 times, it will not be forwarded any more. By default, m is
+set to 128.
+
+
After a randomised delay, the announce will be retransmitted on all interfaces that have bandwidth
+available for processing announces. By default, the maximum bandwidth allocation for processing
+announces is set at 2%, but can be configured on a per-interface basis.
+
+
If any given interface does not have enough bandwidth available for retransmitting the announce,
+the announce will be assigned a priority inversely proportional to its hop count, and be inserted
+into a queue managed by the interface.
+
+
When the interface has bandwidth available for processing an announce, it will prioritise announces
+for destinations that are closest in terms of hops, thus prioritising reachability and connectivity
+of local nodes, even on slow networks that connect to wider and faster networks.
+
+
After the announce has been re-transmitted, and if no other nodes are heard retransmitting the announce
+with a greater hop count than when it left this node, transmitting it will be retried r times. By default,
+r is set to 1.
+
+
If a newer announce from the same destination arrives, while an identical one is already waiting
+to be transmitted, the newest announce is discarded. If the newest announce contains different
+application specific data, it will replace the old announce.
+
+Once an announce has reached a node in the network, any other node in direct contact with that
+node will be able to reach the destination the announce originated from, simply by sending a packet
+addressed to that destination. Any node with knowledge of the announce will be able to direct the
+packet towards the destination by looking up the next node with the shortest amount of hops to the
+destination.
+According to these rules, an announce will propagate throughout the network in a predictable way,
+and make the announced destination reachable in a short amount of time. Fast networks that have the
+capacity to process many announces can reach full convergence very quickly, even when constantly adding
+new destinations. Slower segments of such networks might take a bit longer to gain full knowledge about
+the wide and fast networks they are connected to, but can still do so over time, while prioritising full
+and quickly converging end-to-end connectivity for their local, slower segments.
+In general, even extremely complex networks, that utilize the maximum 128 hops will converge to full
+end-to-end connectivity in about one minute, given there is enough bandwidth available to process
+the required amount of announces.
+
+
+Reaching the Destination
+In networks with changing topology and trustless connectivity, nodes need a way to establish
+verified connectivity with each other. Since the network is assumed to be trustless, Reticulum
+must provide a way to guarantee that the peer you are communicating with is actually who you
+expect. Reticulum offers two ways to do this.
+For exchanges of small amounts of information, Reticulum offers the Packet API, which works exactly like you would expect - on a per packet level. The following process is employed when sending a packet:
+
+
+
A packet is always created with an associated destination and some payload data. When the packet is sent
+to a single destination type, Reticulum will automatically create an ephemeral encryption key, perform
+an ECDH key exchange with the destination’s public key (or ratchet key, if available), and encrypt the information.
+
+
It is important to note that this key exchange does not require any network traffic. The sender already
+knows the public key of the destination from an earlier received announce , and can thus perform the ECDH
+key exchange locally, before sending the packet.
+
+
The public part of the newly generated ephemeral key-pair is included with the encrypted token, and sent
+along with the encrypted payload data in the packet.
+
+
When the destination receives the packet, it can itself perform an ECDH key exchange and decrypt the
+packet.
+
+
A new ephemeral key is used for every packet sent in this way.
+
+
Once the packet has been received and decrypted by the addressed destination, that destination can opt
+to prove its receipt of the packet. It does this by calculating the SHA-256 hash of the received packet,
+and signing this hash with its Ed25519 signing key. Transport nodes in the network can then direct this
+proof back to the packets origin, where the signature can be verified against the destination’s known
+public signing key.
+
+
In case the packet is addressed to a group destination type, the packet will be encrypted with the
+pre-shared AES-256 key associated with the destination. In case the packet is addressed to a plain
+destination type, the payload data will not be encrypted. Neither of these two destination types can offer
+forward secrecy. In general, it is recommended to always use the single destination type, unless it is
+strictly necessary to use one of the others.
+
+For exchanges of larger amounts of data, or when longer sessions of bidirectional communication is desired, Reticulum offers the Link API. To establish a link , the following process is employed:
+
+
+
First, the node that wishes to establish a link will send out a special packet, that
+traverses the network and locates the desired destination. Along the way, the Transport Nodes that
+forward the packet will take note of this link request .
+
+
Second, if the destination accepts the link request , it will send back a packet that proves the
+authenticity of its identity (and the receipt of the link request) to the initiating node. All
+nodes that initially forwarded the packet will also be able to verify this proof, and thus
+accept the validity of the link throughout the network.
+
+
When the validity of the link has been accepted by forwarding nodes, these nodes will
+remember the link , and it can subsequently be used by referring to a hash representing it.
+
+
As a part of the link request , an Elliptic Curve Diffie-Hellman key exchange takes place, that sets up an
+efficiently encrypted tunnel between the two nodes. As such, this mode of communication is preferred,
+even for situations when nodes can directly communicate, when the amount of data to be exchanged numbers
+in the tens of packets, or whenever the use of the more advanced API functions is desired.
+
+
When a link has been set up, it automatically provides message receipt functionality, through
+the same proof mechanism discussed before, so the sending node can obtain verified confirmation
+that the information reached the intended recipient.
+
+
Once the link has been set up, the initiator can remain anonymous, or choose to authenticate towards
+the destination using a Reticulum Identity. This authentication is happening inside the encrypted
+link, and is only revealed to the verified destination, and no intermediaries.
+
+In a moment, we will discuss the details of how this methodology is
+implemented, but let’s first recap what purposes this methodology serves. We
+first ensure that the node answering our request is actually the one we want to
+communicate with, and not a malicious actor pretending to be so. At the same
+time we establish an efficient encrypted channel. The setup of this is
+relatively cheap in terms of bandwidth, so it can be used just for a short
+exchange, and then recreated as needed, which will also rotate encryption keys.
+The link can also be kept alive for longer periods of time, if this is more
+suitable to the application. The procedure also inserts the link id , a hash
+calculated from the link request packet, into the memory of forwarding nodes,
+which means that the communicating nodes can thereafter reach each other simply
+by referring to this link id .
+The combined bandwidth cost of setting up a link is 3 packets totalling 297 bytes (more info in the
+Binary Packet Format
+
+Link Establishment in Detail
+After exploring the basics of the announce mechanism, finding a path through the network, and an overview
+of the link establishment procedure, this section will go into greater detail about the Reticulum link
+establishment process.
+The link in Reticulum terminology should not be viewed as a direct node-to-node link on the
+physical layer, but as an abstract channel, that can be open for any amount of time, and can span
+an arbitrary number of hops, where information will be exchanged between two nodes.
+
+
+
When a node in the network wants to establish verified connectivity with another node, it
+will randomly generate a new X25519 private/public key pair. It then creates a link request
+packet, and broadcast it.
+
+
It should be noted that the X25519 public/private keypair mentioned above is two separate keypairs:
+An encryption key pair, used for derivation of a shared symmetric key, and a signing key pair, used
+for signing and verifying messages on the link. They are sent together over the wire, and can be
+considered as single public key for simplicity in this explanation.
+
+
The link request is addressed to the destination hash of the desired destination, and
+contains the following data: The newly generated X25519 public key LKi .
+
+
The broadcasted packet will be directed through the network according to the rules laid out
+previously.
+
+
Any node that forwards the link request will store a link id in it’s link table , along with the
+amount of hops the packet had taken when received. The link id is a hash of the entire link
+request packet. If the link request packet is not proven by the addressed destination within some
+set amount of time, the entry will be dropped from the link table again.
+
+
When the destination receives the link request packet, it will decide whether to accept the request.
+If it is accepted, the destination will also generate a new X25519 private/public key pair, and
+perform a Diffie Hellman Key Exchange, deriving a new symmetric key that will be used to encrypt the
+channel, once it has been established.
+
+
A link proof packet is now constructed and transmitted over the network. This packet is
+addressed to the link id of the link . It contains the following data: The newly generated X25519
+public key LKr and an Ed25519 signature of the link id and LKr made by the original signing key of
+the addressed destination.
+
+
By verifying this link proof packet, all nodes that originally transported the link request
+packet to the destination from the originator can now verify that the intended destination received
+the request and accepted it, and that the path they chose for forwarding the request was valid.
+In successfully carrying out this verification, the transporting nodes marks the link as active.
+An abstract bi-directional communication channel has now been established along a path in the network.
+Packets can now be exchanged bi-directionally from either end of the link simply by adressing the
+packets to the link id of the link.
+
+
When the source receives the proof , it will know unequivocally that a verified path has been
+established to the destination. It can now also use the X25519 public key contained in the
+link proof to perform it’s own Diffie Hellman Key Exchange and derive the symmetric key
+that is used to encrypt the channel. Information can now be exchanged reliably and securely.
+
+It’s important to note that this methodology ensures that the source of the request does not need to
+reveal any identifying information about itself. The link initiator remains completely anonymous.
+When using links , Reticulum will automatically verify all data sent over the link, and can also
+automate retransmissions if Resources are used.
+
+
+
+Resources
+For exchanging small amounts of data over a Reticulum network, the Packet
+This is the purpose of the Reticulum Resource Resource can automatically
+handle the reliable transfer of an arbitrary amount of data over an established Link
+Resources
+
+
+
+Reference Setup
+This section will detail a recommended Reference Setup for Reticulum. It is important to
+note that Reticulum is designed to be usable on more or less any computing device, and over more
+or less any medium that allows you to send and receive data, which satisfies some very low
+minimum requirements.
+The communication channel must support at least half-duplex operation, and provide an average
+throughput of 5 bits per second or greater, and supports a physical layer MTU of 500 bytes. The
+Reticulum stack should be able to run on more or less any hardware that can provide a Python 3.x
+runtime environment.
+That being said, this reference setup has been outlined to provide a common platform for anyone
+who wants to help in the development of Reticulum, and for everyone who wants to know a
+recommended setup to get started experimenting. A reference system consists of three parts:
+
+
+An Interface Device Which provides access to the physical medium whereupon the communication
+takes place, for example a radio with an integrated modem. A setup with a separate modem
+connected to a radio would also be an interface device.
+
+
+A Host Device Some sort of computing device that can run the necessary software, communicate with the
+interface device, and provide user interaction.
+
+
+A Software Stack The software implementing the Reticulum protocol and applications using it.
+
+
+The reference setup can be considered a relatively stable platform to develop on, and also to start
+building networks or applications on. While details of the implementation might change at the current stage of
+development, it is the goal to maintain hardware compatibility for as long as entirely possible, and
+the current reference setup has been determined to provide a functional platform for many years
+into the future. The current Reference System Setup is as follows:
+
+
+Interface Device A data radio consisting of a LoRa radio module, and a microcontroller with open source
+firmware, that can connect to host devices via USB. It operates in either the 430, 868 or 900
+MHz frequency bands. More details can be found on the RNode Page .
+
+
+Host Device Any computer device running Linux and Python. A Raspberry Pi with a Debian based OS is
+recommended.
+
+
+Software Stack The most recently released Python Implementation of Reticulum, running on a Debian based
+operating system.
+
+
+To avoid confusion, it is very important to note, that the reference interface device does not
+use the LoRaWAN standard, but uses a custom MAC layer on top of the plain LoRa modulation! As such, you will
+need a plain LoRa radio module connected to an controller with the correct firmware. Full details on how to
+get or make such a device is available on the RNode Page .
+With the current reference setup, it should be possible to get on a Reticulum network for around 100$
+even if you have none of the hardware already, and need to purchase everything.
+This reference setup is of course just a recommendation for getting started easily, and you should
+tailor it to your own specific needs, or whatever hardware you have available.
+
+
+Protocol Specifics
+This chapter will detail protocol specific information that is essential to the implementation of
+Reticulum, but non critical in understanding how the protocol works on a general level. It should be
+treated more as a reference than as essential reading.
+
+Packet Prioritisation
+Currently, Reticulum is completely priority-agnostic regarding general traffic. All traffic is handled
+on a first-come, first-serve basis. Announce re-transmission are handled according to the re-transmission
+times and priorities described earlier in this chapter.
+
+
+Interface Access Codes
+Reticulum can create named virtual networks, and networks that are only accessible by knowing a preshared
+passphrase. The configuration of this is detailed in the Common Interface Options
+An interface with a named virtual network or passphrase authentication enabled will derive a shared Ed25519
+signing identity, and for every outbound packet generate a signature of the entire packet. This signature is
+then inserted into the packet as an Interface Access Code before transmission. Depending on the speed and
+capabilities of the interface, the IFAC can be the full 512-bit Ed25519 signature, or a truncated version.
+Configured IFAC length can be inspected for all interfaces with the rnstatus
+Upon receipt, the interface will check that the signature matches the expected value, and drop the packet if it
+does not. This ensures that only packets sent with the correct naming and/or passphrase parameters are allowed to
+pass onto the network.
+
+
+
+Announce Propagation Rules
+The following table illustrates the rules for automatically propagating announces
+from one interface type to another, for all possible combinations. For the purpose
+of announce propagation, the Full and Gateway modes are identical.
+See the Interface Modes
+
+
+Cryptographic Primitives
+Reticulum uses a simple suite of efficient, strong and well-tested cryptographic
+primitives, with widely available implementations that can be used both on
+general-purpose CPUs and on microcontrollers.
+One of the primary considerations for choosing this particular set of primitives is
+that they can be implemented safely with relatively few pitfalls, on practically
+all current computing platforms.
+The primitives listed here are authoritative . Anything claiming to be Reticulum,
+but not using these exact primitives is not Reticulum, and possibly an
+intentionally compromised or weakened clone. The utilised primitives are:
+
+In the default installation configuration, the X25519 Ed25519 AES-256-CBC OpenSSL (via the PyCA/cryptography
+package). The hashing functions SHA-256 SHA-512 hashlib . The HKDF HMAC Token PKCS7
+
+Reticulum also includes a complete implementation of all necessary primitives in pure Python.
+If OpenSSL & PyCA are not available on the system when Reticulum is started, Reticulum will
+instead use the internal pure-python primitives. A trivial consequence of this is performance,
+with the OpenSSL backend being much faster. The most important consequence however, is the
+potential loss of security by using primitives that has not seen the same amount of scrutiny,
+testing and review as those from OpenSSL.
+
+
Warning
+
If you want to use the internal pure-python primitives, it is highly advisable that you
+have a good understanding of the risks that this pose, and make an informed decision on whether
+those risks are acceptable to you.
+
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
Using Reticulum on Your System - Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+Using Reticulum on Your System
+Reticulum is not installed as a driver or kernel module, as one might expect
+of a networking stack. Instead, Reticulum is distributed as a Python module,
+containing the networking core, and a set of utility and daemon programs.
+This means that no special privileges are required to install or use it. It
+is also very light-weight, and easy to transfer to, and install on new systems.
+When you have Reticulum installed, any program or application that uses Reticulum
+will automatically load and initialise Reticulum when it starts, if it is not
+already running.
+In many cases, this approach is sufficient. When any program needs to use
+Reticulum, it is loaded, initialised, interfaces are brought up, and the
+program can now communicate over any Reticulum networks available. If another
+program starts up and also wants access to the same Reticulum network, the already
+running instance is simply shared. This works for any number of programs running
+concurrently, and is very easy to use, but depending on your use case, there
+are other options.
+
+Configuration & Data
+Reticulum stores all information that it needs to function in a single file-system
+directory. When Reticulum is started, it will look for a valid configuration
+directory in the following places:
+
+/etc/reticulum
~/.config/reticulum
~/.reticulum
+If no existing configuration directory is found, the directory ~/.reticulum
+It is also possible to use completely arbitrary configuration directories by
+specifying the relevant command-line parameters when running Reticulum-based
+programs. You can also run multiple separate Reticulum instances on the same
+physical system, either in isolation from each other, or connected together.
+In most cases, a single physical system will only need to run one Reticulum
+instance. This can either be launched at boot, as a system service, or simply
+be brought up when a program needs it. In either case, any number of programs
+running on the same system will automatically share the same Reticulum instance,
+if the configuration allows for it, which it does by default.
+The entire configuration of Reticulum is found in the ~/.reticulum/config
+# This is the default Reticulum config file.
+# You should probably edit it to include any additional,
+# interfaces and settings you might need.
+
+# Only the most basic options are included in this default
+# configuration. To see a more verbose, and much longer,
+# configuration example, you can run the command:
+# rnsd --exampleconfig
+
+
+[ reticulum ]
+
+# If you enable Transport, your system will route traffic
+# for other peers, pass announces and serve path requests.
+# This should be done for systems that are suited to act
+# as transport nodes, ie. if they are stationary and
+# always-on. This directive is optional and can be removed
+# for brevity.
+
+enable_transport = No
+
+
+# By default, the first program to launch the Reticulum
+# Network Stack will create a shared instance, that other
+# programs can communicate with. Only the shared instance
+# opens all the configured interfaces directly, and other
+# local programs communicate with the shared instance over
+# a local socket. This is completely transparent to the
+# user, and should generally be turned on. This directive
+# is optional and can be removed for brevity.
+
+share_instance = Yes
+
+
+# If you want to run multiple *different* shared instances
+# on the same system, you will need to specify different
+# instance names for each. On platforms supporting domain
+# sockets, this can be done with the instance_name option:
+
+instance_name = default
+
+# Some platforms don't support domain sockets, and if that
+# is the case, you can isolate different instances by
+# specifying a unique set of ports for each:
+
+# shared_instance_port = 37428
+# instance_control_port = 37429
+
+
+# If you want to explicitly use TCP for shared instance
+# communication, instead of domain sockets, this is also
+# possible, by using the following option:
+
+# shared_instance_type = tcp
+
+
+# On systems where running instances may not have access
+# to the same shared Reticulum configuration directory,
+# it is still possible to allow full interactivity for
+# running instances, by manually specifying a shared RPC
+# key. In almost all cases, this option is not needed, but
+# it can be useful on operating systems such as Android.
+# The key must be specified as bytes in hexadecimal.
+
+# rpc_key = e5c032d3ec4e64a6aca9927ba8ab73336780f6d71790
+
+
+# It is possible to allow remote management of Reticulum
+# systems using the various built-in utilities, such as
+# rnstatus and rnpath. You will need to specify one or
+# more Reticulum Identity hashes for authenticating the
+# queries from client programs. For this purpose, you can
+# use existing identity files, or generate new ones with
+# the rnid utility.
+
+# enable_remote_management = yes
+# remote_management_allowed = 9fb6d773498fb3feda407ed8ef2c3229, 2d882c5586e548d79b5af27bca1776dc
+
+
+# You can configure Reticulum to panic and forcibly close
+# if an unrecoverable interface error occurs, such as the
+# hardware device for an interface disappearing. This is
+# an optional directive, and can be left out for brevity.
+# This behaviour is disabled by default.
+
+# panic_on_interface_error = No
+
+
+# When Transport is enabled, it is possible to allow the
+# Transport Instance to respond to probe requests from
+# the rnprobe utility. This can be a useful tool to test
+# connectivity. When this option is enabled, the probe
+# destination will be generated from the Identity of the
+# Transport Instance, and printed to the log at startup.
+# Optional, and disabled by default.
+
+# respond_to_probes = No
+
+
+[ logging ]
+# Valid log levels are 0 through 7:
+# 0: Log only critical information
+# 1: Log errors and lower log levels
+# 2: Log warnings and lower log levels
+# 3: Log notices and lower log levels
+# 4: Log info and lower (this is the default)
+# 5: Verbose logging
+# 6: Debug logging
+# 7: Extreme logging
+
+loglevel = 4
+
+
+# The interfaces section defines the physical and virtual
+# interfaces Reticulum will use to communicate on. This
+# section will contain examples for a variety of interface
+# types. You can modify these or use them as a basis for
+# your own config, or simply remove the unused ones.
+
+[ interfaces ]
+
+ # This interface enables communication with other
+ # link-local Reticulum nodes over UDP. It does not
+ # need any functional IP infrastructure like routers
+ # or DHCP servers, but will require that at least link-
+ # local IPv6 is enabled in your operating system, which
+ # should be enabled by default in almost any OS. See
+ # the Reticulum Manual for more configuration options.
+
+ [[ Default Interface ]]
+ type = AutoInterface
+ interface_enabled = True
+
+
If Reticulum infrastructure already exists locally, you probably don’t need to
+change anything, and you may already be connected to a wider network. If not,
+you will probably need to add relevant interfaces to the configuration, in
+order to communicate with other systems.
+You can generate a much more verbose configuration example by running the command:
+rnsd --exampleconfig
+The output includes examples for most interface types supported
+by Reticulum, along with additional options and configuration parameters.
+It is a good idea to read the comments and explanations in the above default config.
+It will teach you the basic concepts you need to understand to configure your network.
+Once you have done that, take a look at the Interfaces
+
+
+Included Utility Programs
+Reticulum includes a range of useful utilities, both for managing your Reticulum
+networks, and for carrying out common tasks over Reticulum networks, such as
+transferring files to remote systems, and executing commands and programs remotely.
+If you often use Reticulum from several different programs, or simply want
+Reticulum to stay available all the time, for example if you are hosting
+a transport node, you might want to run Reticulum as a separate service that
+other programs, applications and services can utilise.
+
+The rnsd Utility
+It is very easy to run Reticulum as a service. Simply run the included rnsd rnsd
+You can even run multiple instances of rnsd
+Usage Examples
+Run rnsd
+
+
Run rnsd
+
+Generate a verbose and detailed configuration example, with explanations of all the
+various configuration options, and interface configuration examples:
+
+All Command-Line Options
+
+
You can easily add rnsd configuring a service
+
+
+The rnstatus Utility
+Using the rnstatus ifconfig
+Usage Examples
+Run rnstatus
+
+
Filter output to only show some interfaces:
+
+
All Command-Line Options
+
+
+
Note
+
When using -R -i
+
+
+The rnid Utility
+With the rnid
+Using rnid
+Usage Examples
+Generate a new Identity:
+
+
Display Identity key information:
+
+
Encrypt a file for an LXMF user:
+
+
If the Identity for the destination is not already known, you can fetch it from the network by using the -R
+
+
Decrypt a file using the Reticulum Identity it was encrypted for:
+
+
All Command-Line Options
+
+
+
+The rnpath Utility
+With the rnpath
+Usage Examples
+Resolve path to a destination:
+
+
All Command-Line Options
+
+
+
+The rnprobe Utility
+The rnprobe ping
+You can enable a probe-reply destination on Reticulum Transport Instances by
+setting the respond_to_probes
+Usage Examples
+Probe a destination:
+
+
Send a larger probe:
+
+
If the interface that receives the probe replies supports reporting radio
+parameters such as RSSI and SNR , the rnprobe
+
+
All Command-Line Options
+
+
+
+The rncp Utility
+The rncp
+Usage Examples
+Run rncp on the receiving system, specifying which identities are allowed to send files:
+
+
You can also specify allowed identity hashes (one per line) in the file ~/.rncp/allowed_identities
+and simply running the program in listener mode:
+
+From another system, copy a file to the receiving system:
+
+
Or fetch a file from the remote system:
+
+
All Command-Line Options
+
+
+
+The rnx Utility
+The rnx rnsh program.
+Usage Examples
+Run rnx on the listening system, specifying which identities are allowed to execute commands:
+
+
From another system, run a command on the remote:
+
+
Or enter the interactive mode pseudo-shell:
+
+
The default identity file is stored in ~/.reticulum/identities/rnx
+
+
All Command-Line Options
+
+
+
+The rnodeconf Utility
+The rnodeconf RNodes RNodes
+All Command-Line Options
+
+
For more information on how to create your own RNodes, please read the Creating RNodes
+
+
+
+Remote Management
+It is possible to allow remote management of Reticulum
+systems using the various built-in utilities, such as
+rnstatus rnpath enable_remote_management [reticulum]
+The following is a truncated example of enabling remote management
+in the Reticulum configuration file:
+
+
For a complete example configuration, you can run rnsd --exampleconfig
+
+
+Improving System Configuration
+If you are setting up a system for permanent use with Reticulum, there is a
+few system configuration changes that can make this easier to administrate.
+These changes will be detailed here.
+
+Fixed Serial Port Names
+On a Reticulum instance with several serial port based interfaces, it can be
+beneficial to use the fixed device names for the serial ports, instead
+of the dynamically allocated shorthands such as /dev/ttyUSB0 /dev/serial/by-id
+You can use such a device path directly in place of the numbered shorthands.
+Here is an example of a packet radio TNC configured as such:
+
+
Using this methodology avoids potential naming mix-ups where physical devices
+might be plugged and unplugged in different orders, or when device name
+assignment varies from one boot to another.
+
+
+Reticulum as a System Service
+Instead of starting Reticulum manually, you can install rnsd
+
+Systemwide Service
+If you installed Reticulum with pip rnsd systemd rnsd
+
+
You can then create the service file /etc/systemd/system/rnsd.service
+
+
Be sure to replace USERNAMEHERE rnsd
+To manually start rnsd
+
+
If you want to automatically start rnsd
+
+
+
+Userspace Service
+Alternatively you can use a user systemd service instead of a system wide one. This way the whole setup can be done as a regular user.
+Create a user systemd service files ~/.config/systemd/user/rnsd.service
+
+
Replace RNS_BIN_DIR
+Start user service:
+
+
If you want to automatically start rnsd
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
What is Reticulum? - Reticulum Network Stack 1.0.0 documentation
+
+
+ Contents
+
+
+
+
+
+ Expand
+
+
+
+
+ Light mode
+
+
+
+
+ Dark mode
+
+
+
+
+ Auto light/dark mode
+
+
+
+
+
+
+
+
+
+ Hide table of contents sidebar
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Back to top
+
+
+
+
+ Toggle Light / Dark / Auto color theme
+
+
+
+ Toggle table of contents sidebar
+
+
+
+
+What is Reticulum?
+Reticulum is a cryptography-based networking stack for building both local and
+wide-area networks with readily available hardware, that can continue to operate
+under adverse conditions, such as extremely low bandwidth and very high latency.
+Reticulum allows you to build wide-area networks with off-the-shelf tools, and
+offers end-to-end encryption, forward secrecy, autoconfiguring cryptographically
+backed multi-hop transport, efficient addressing, unforgeable packet
+acknowledgements and more.
+From a users perspective, Reticulum allows the creation of applications that
+respect and empower the autonomy and sovereignty of communities and individuals.
+Reticulum enables secure digital communication that cannot be subjected to
+outside control, manipulation or censorship.
+Reticulum enables the construction of both small and potentially planetary-scale
+networks, without any need for hierarchical or bureaucratic structures to control
+or manage them, while ensuring individuals and communities full sovereignty
+over their own network segments.
+Reticulum is a complete networking stack , and does not need IP or higher
+layers, although it is easy to utilise IP (with TCP or UDP) as the underlying
+carrier for Reticulum. It is therefore trivial to tunnel Reticulum over the
+Internet or private IP networks. Reticulum is built directly on cryptographic
+principles, allowing resilience and stable functionality in open and trustless
+networks.
+No kernel modules or drivers are required. Reticulum can run completely in
+userland, and will run on practically any system that runs Python 3. Reticulum
+runs well even on small single-board computers like the Pi Zero.
+
+Current Status
+All core protocol features are implemented and functioning, but additions will probably occur as
+real-world use is explored. The API and wire-format can be considered complete and stable, but
+could change if absolutely warranted.
+
+
+What does Reticulum Offer?
+
+Coordination-less globally unique addressing and identification
Fully self-configuring multi-hop routing over heterogeneous carriers
Flexible scalability over heterogeneous topologies
+
+Reticulum can carry data over any mixture of physical mediums and topologies
Low-bandwidth networks can co-exist and interoperate with large, high-bandwidth networks
+Initiator anonymity, communicate without revealing your identity
+
+Asymmetric X25519 encryption and Ed25519 signatures as a basis for all communication
+
+Forward Secrecy is available for all communication types, both for single packets and over links
Reticulum uses the following format for encrypted tokens:
+
+Ephemeral per-packet and link keys and derived from an ECDH key exchange on Curve25519
AES-256 in CBC mode with PKCS7 padding
HMAC using SHA256 for authentication
IVs are generated through os.urandom()
+Unforgeable packet delivery confirmations
Flexible and extensible interface system
+
+Reticulum includes a large variety of built-in interface types
Ability to load and utilise custom user- or community-supplied interface types
Easily create your own custom interfaces for communicating over anything
+Authentication and virtual network segmentation on all supported interface types
An intuitive and easy-to-use API
+
+Simpler and easier to use than sockets APIs and simpler, but more powerful
Makes building distributed and decentralised applications much simpler
+Reliable and efficient transfer of arbitrary amounts of data
+
+Reticulum can handle a few bytes of data or files of many gigabytes
Sequencing, compression, transfer coordination and checksumming are automatic
The API is very easy to use, and provides transfer progress
+Lightweight, flexible and expandable Request/Response mechanism
Efficient link establishment
+
+Total cost of setting up an encrypted and verified link is only 3 packets, totalling 297 bytes
Low cost of keeping links open at only 0.44 bits per second
+Reliable sequential delivery with Channel and Buffer mechanisms
+
+
+Where can Reticulum be Used?
+Over practically any medium that can support at least a half-duplex channel
+with greater throughput than 5 bits per second, and an MTU of 500 bytes. Data radios,
+modems, LoRa radios, serial lines, AX.25 TNCs, amateur radio digital modes,
+ad-hoc WiFi, free-space optical links and similar systems are all examples
+of the types of interfaces Reticulum was designed for.
+An open-source LoRa-based interface called RNode
+has been designed as an example transceiver that is very suitable for
+Reticulum. It is possible to build it yourself, to transform a common LoRa
+development board into one, or it can be purchased as a complete transceiver
+from various vendors.
+Reticulum can also be encapsulated over existing IP networks, so there’s
+nothing stopping you from using it over wired Ethernet or your local WiFi
+network, where it’ll work just as well. In fact, one of the strengths of
+Reticulum is how easily it allows you to connect different mediums into a
+self-configuring, resilient and encrypted mesh.
+As an example, it’s possible to set up a Raspberry Pi connected to both a
+LoRa radio, a packet radio TNC and a WiFi network. Once the interfaces are
+added, Reticulum will take care of the rest, and any device on the WiFi
+network can communicate with nodes on the LoRa and packet radio sides of the
+network, and vice versa.
+
+
+Interface Types and Devices
+Reticulum implements a range of generalised interface types that covers the communications hardware that Reticulum can run over. If your hardware is not supported, it’s simple to implement an interface class
+
+Any Ethernet device
+
+LoRa using RNode
+
+Packet Radio TNCs, such as OpenModem
+
+Any device with a serial port
The I2P network
TCP over IP networks
UDP over IP networks
Anything you can connect via stdio
+
+Reticulum can use external programs and pipes as interfaces
This can be used to easily hack in virtual interfaces
Or to quickly create interfaces with custom hardware
+
+For a full list and more details, see the Supported Interfaces
+
+
+Caveat Emptor
+Reticulum is an experimental networking stack, and should be considered as
+such. While it has been built with cryptography best-practices very foremost in
+mind, it has not yet been externally security audited, and there could very well be
+privacy-breaking bugs. To be considered secure, Reticulum needs a thorough
+security review by independent cryptographers and security researchers. If you
+want to help out with this, or can help sponsor an audit, please do get in touch.
+
+
+
+
+
+
+
+
+
+
+
+ Copyright © 2023, Mark Qvist
+
+ Generated with
Sphinx and
+
Furo
+
+
+
+
+
+
+
+
Reticulum Network
+
Get Started
+The best way to get started with the Reticulum Network Stack depends on what
+you want to do. For full details and examples, have a look at the Getting Started Fast section of the Reticulum Manual .
+Experimental Software
+Please Know! Reticulum is still in beta. This means, that while it already works very well, and is very stable, there could very well still be critical bugs or flaws in the behaviour, privacy or security of the system as a whole. Use Reticulum if you are comfortable with this, and understand the implications.
+Community & Support
+If you are having trouble, or if something is not working, here are some great places to ask for help:
+
+Installation
+To install Reticulum and related utilities on your system, the easiest way is via pip:
+pip install rns
+You can then start any program that uses Reticulum, or start Reticulum as a system service with the rnsd utility .
+If pip is not available on your system, install the python3 and python3-pip packages for your OS first.
+When first started, Reticulum will create a default configuration file, providing basic connectivity to other Reticulum peers that might be locally reachable. If any of those local peers are Transport Instances, these might connect you to wider networks. The default config file contains a few examples, and references for creating a more complex configuration.
+For more detailed examples on how to expand communication over many mediums such as packet radio or LoRa, serial ports, or over fast IP links and the Internet using the UDP and TCP interfaces, take a look at the Supported Interfaces section of the Reticulum Manual .
+Included Utilities
+Reticulum includes a range of useful utilities for managing your networks, viewing status and information, and other tasks. You can read more about these programs in the Included Utility Programs section of the Reticulum Manual .
+
+The system daemon rnsd for running Reticulum as an always-available service
+An interface status utility called rnstatus, that displays information about interfaces
+The path lookup and management tool rnpath letting you view and modify path tables
+A diagnostics tool called rnprobe for checking connectivity to destinations
+A simple file transfer program called rncp making it easy to copy files to remote systems
+The remote command execution program rnx that let's you run commands and programs and retrieve output from remote systems
+
+All tools, including rnx and rncp, work reliably and well even over very low-bandwidth links like LoRa or Packet Radio.
+Programs Using Reticulum
+If you want to quickly get an idea of what Reticulum can do, take a look at the following resources.
+
+For an off-grid, encrypted and resilient mesh communications platform, see Nomad Network
+The Android, Linux and macOS app Sideband has a graphical interface and focuses on ease of use.
+LXMF is a distributed, delay and disruption tolerant message transfer protocol built on Reticulum
+Dependencies
+The installation of the default rns package requires the dependencies listed below. Almost all systems and distributions have readily available packages for these dependencies, and when the rns package is installed with pip, they will be downloaded and installed as well.
+
+On more unusual systems, and in some rare cases, it might not be possible to install or even compile one or more of the above modules. In such situations, you can use the rnspure package instead, which require no external dependencies for installation. Please note that the contents of the rns and rnspure packages are identical . The only difference is that the rnspure package lists no dependencies required for installation.
+No matter how Reticulum is installed and started, it will load external dependencies only if they are needed and available . If for example you want to use Reticulum on a system that cannot support pyserial , it is perfectly possible to do so using the rnspure package, but Reticulum will not be able to use serial-based interfaces. All other available modules will still be loaded when needed.
+Please Note! If you use the rnspure package to run Reticulum on systems that do not support PyCA/cryptography , it is important that you read and understand the Cryptographic Primitives section of this site.
+Performance
+Reticulum targets a very wide usable performance envelope, but prioritises functionality and performance over low-bandwidth mediums. The goal is to provide a dynamic performance envelope from 250 bits per second, to 1 gigabit per second on normal hardware.
+Currently, the usable performance envelope is approximately 150 bits per second to 40 megabits per second, with physical mediums faster than that not being saturated. Performance beyond the current level is intended for future upgrades, but not highly prioritised until the wire format and API has been locked in.
+Next Topic: Supported Hardware
+
+
diff --git a/docs/start_de.html b/docs/start_de.html
new file mode 100644
index 0000000..65cb583
--- /dev/null
+++ b/docs/start_de.html
@@ -0,0 +1,65 @@
+
+
+
+
+Reticulum Network
+
Los geht's
+Wie Sie am besten mit dem Reticulum Network Stack beginnen, hängt davon ab, was
+Sie durchführen möchten. Ausführliche Informationen und Beispiele finden Sie im Abschnitt Schneller Einstieg des Reticulum-Handbuchs .
+Experimentelle Software
+Bitte beachten Sie! Reticulum befindet sich noch im Beta-Stadium. Das bedeutet, dass es zwar bereits sehr gut funktioniert und sehr stabil ist, es aber durchaus noch kritische Fehler oder Schwachstellen im Verhalten, im Datenschutz oder in der Sicherheit des gesamten Systems geben kann. Verwenden Sie Reticulum nur, wenn Sie damit einverstanden sind und die Auswirkungen verstehen.
+Gemeinschaft & Unterstützung
+Wenn Sie Probleme haben oder etwas nicht funktioniert, finden Sie hier einige gute Stellen, an denen Sie um Hilfe bitten können:
+
+Installation
+Der einfachste Weg, Reticulum und zugehörige Dienstprogramme auf Ihrem System zu installieren, ist über pip:
+pip install rns
+Sie können dann jedes Programm starten, das Reticulum verwendet, oder Reticulum als Systemdienst starten mit [dem Dienstprogramm rnsd] .(manual/using.html#the-rnsd-utility).
+Wenn pip auf Ihrem System nicht verfügbar ist, installieren Sie zuerst die Pakete python3 und python3-pip für Ihr Betriebssystem.
+Beim ersten Start erstellt Reticulum eine Standardkonfigurationsdatei, die eine grundlegende Konnektivität zu anderen Reticulum-Peers herstellt, die lokal erreichbar sein könnten. Wenn es sich bei einem dieser lokalen Peers um eine Transportinstanz handelt, können Sie über diese eine Verbindung zu einem größeren Netzwerk herstellen. Die Standardkonfigurationsdatei enthält einige Beispiele und Referenzen für die Erstellung einer komplexeren Konfiguration.
+Ausführlichere Beispiele für die Erweiterung der Kommunikation über verschiedene Medien wie Packet Radio oder LoRa, serielle Schnittstellen oder über schnelle IP-Verbindungen und das Internet unter Verwendung der UDP- und TCP-Schnittstellen finden Sie im Abschnitt Unterstützte Schnittstellen im Reticulum Handbuch .
+Enthaltene Dienstprogramme
+Reticulum enthält eine Reihe nützlicher Hilfsprogramme zur Verwaltung Ihrer Netzwerke, zur Anzeige von Status und Informationen und für andere Aufgaben. Weitere Informationen zu diesen Programmen finden Sie im Abschnitt Enthaltene Dienstprogramme im Reticulum Handbuch .
+
+Der System-Daemon rnsd für den Betrieb von Reticulum als immer verfügbarer Dienst
+Ein Dienstprogramm für den Schnittstellenstatus namens rnstatus, das Informationen über Schnittstellen anzeigt
+Das Werkzeug rnpath zum Nachschlagen und Verwalten von Pfaden, mit dem Sie Pfad-Tabellen anzeigen und ändern können
+Ein Diagnosewerkzeug namens rnprobe zur Überprüfung der Konnektivität zu Zielen
+Ein einfaches Dateiübertragungsprogramm namens rncp, das das Kopieren von Dateien auf entfernte Systeme erleichtert
+Das Programm rnx zur Ausführung von Fernbefehlen, mit dem Sie Befehle und Programme ausführen und Ausgaben von entfernten Systemen abrufen können
+
+Alle Tools, einschließlich rnx und rncp, arbeiten zuverlässig und gut auch über Verbindungen mit sehr geringer Bandbreite wie LoRa oder Packet Radio.
+Programme welche Reticulum verwenden
+Wenn Sie sich schnell einen Überblick über die Möglichkeiten von Reticulum verschaffen möchten, werfen Sie einen Blick auf die folgenden Ressourcen.
+
+Eine netzunabhängige, verschlüsselte und widerstandsfähige Mesh-Kommunikationsplattform finden Sie unter Nomad Network
+Die Android-, Linux- und macOS-Anwendung Sideband verfügt über eine grafische Oberfläche und legt den Schwerpunkt auf Benutzerfreundlichkeit.
+LXMF ist ein verteiltes, verzögerungs- und unterbrechungstolerantes Nachrichtenübertragungsprotokoll, das auf Reticulum aufbaut.
+Abhängigkeiten
+Die Installation des Standardpakets rns erfordert die unten aufgeführten Abhängigkeiten. Fast alle Systeme und Distributionen haben leicht verfügbare Pakete für diese Abhängigkeiten, und wenn das rns-Paket mit pip installiert wird, werden sie ebenfalls heruntergeladen und installiert.
+
+Auf ungewöhnlicheren Systemen und in einigen seltenen Fällen ist es möglicherweise nicht möglich, eines oder mehrere der oben genannten Module zu installieren oder gar zu kompilieren. In solchen Situationen können Sie stattdessen das Paket rnspure verwenden, das keine externen Abhängigkeiten für die Installation benötigt. Bitte beachten Sie, dass der Inhalt der Pakete rns und rnspure identisch ist. Der einzige Unterschied besteht darin, dass das Paket rnspure keine Abhängigkeiten auflistet, die für die Installation erforderlich sind.
+Unabhängig davon, wie Reticulum installiert und gestartet wird, lädt es externe Abhängigkeiten nur, wenn sie benötigt und verfügbar sind. Wenn Sie Reticulum beispielsweise auf einem System verwenden möchten, das pyserial nicht unterstützt, ist es durchaus möglich, das Paket rnspure zu verwenden, aber Reticulum kann dann keine seriell basierten Schnittstellen nutzen. Alle anderen verfügbaren Module werden bei Bedarf weiterhin geladen.
+Bitte beachten Sie! Wenn Sie das Paket rnspure verwenden, um Reticulum auf Systemen zu betreiben, die PyCA/cryptography nicht unterstützen, ist es wichtig, dass Sie den Abschnitt Kryptographische Primitiven auf dieser Website lesen und verstehen.
+Leistung
+Reticulum zielt auf einen sehr großen nutzbaren Leistungsbereich ab, gibt aber der Funktionalität und Leistung Vorrang auf Medien mit geringer Bandbreite. Ziel ist es, einen dynamischen Leistungsbereich von 250 Bit pro Sekunde bis zu 1 Gigabit pro Sekunde auf normaler Hardware bereitzustellen.
+Derzeit liegt der nutzbare Leistungsbereich bei etwa 150 Bit pro Sekunde bis 40 Megabit pro Sekunde, wobei schnellere physische Medien nicht gesättigt sind. Eine über das derzeitige Niveau hinausgehende Leistung ist für künftige Upgrades vorgesehen, hat aber keine hohe Priorität, solange das Leitungsformat und die API noch nicht festgelegt sind.
+Nächstes Thema: Unterstützte Hardware
+
+
diff --git a/docs/start_es.html b/docs/start_es.html
new file mode 100644
index 0000000..c394560
--- /dev/null
+++ b/docs/start_es.html
@@ -0,0 +1,73 @@
+
+
+
+
+Reticulum Network
+
Empezar
+La mejor manera de empezar a usar el protocolo Reticulum depende de qué
+quieras hacer. Para más detalles y ejemplos, consulte la sección Empezar rapidito del Manual de Reticulum .
+Software experimental
+¡A saber! Reticulum todavía está en fase beta. Esto significa que, aunque ya funciona muy bien y es muy estable, es muy
+posible que todavía haya errores o fallos críticos en el comportamiento, la privacidad o la seguridad del sistema en su conjunto.
+Utilice Reticulum si se siente cómodo con esto y comprende las implicaciones.
+Comunidad y Soporte
+Si estás teniendo algún problema o algo no está funcionando, estos son algunos excelentes lugares para pedir ayuda:
+
+Instalación
+Para instalar reticulum y utilidades relacionadas, la forma más fácil es usando pip:
+pip install rns
+Podes ejecutar entonces cualquier programa que use Reticulum o iniciar Reticulum como un servicio del sistema con la utilidad rnsd .
+Si pip no es disponible en tu sistema, instala primero python3 y python3-pip para tu sistema operativo.
+La primera vez que inicia, Reticulum crea un archivo de configuración por defecto, proporcionando conectividad básica con pares
+de Reticulum que puedan ser localmente ubicables . Si cualquiera de esos pares locales son instancias de transporte, puede que
+te conecten con redes más grandes. El archivo de configuración contiene algunos ejemplos y referencias para crear configuraciones
+más complejas.
+Para ejemplos más detallados sobre cómo expandir la comunicación a más medios, como paquetes de radio o Lora, puertos seriales,
+o a través de enlaces rápidos de IP e Internet utilizando las interfaces UDP y TCP, péguele una mirada a la sección
+Interfaces soportadas del Manual de Reticulum .
+Utilidades Incluidas
+Reticulum incluye una serie de utilidades para gestionar sus redes, ver el estado, la información y otras tareas. Puede leer
+más sobre estos programas en la sección Utilidades Incluidas del Manual de Reticulum .
+
+El servicio/daemon rnsd para correr Reticulum como un servicio siempre disponible.
+Una utilidad de estado de la interfaz llamada rnstatus, para mostrar info sobre interfaces.
+La herramienta de búsqueda y gestión de rutas rnpath le permite ver y modificar tablas de rutas.
+Una herramienta de diagnóstico llamada rnprobe para comprobar la conectividad con los destinos, similar a ping.
+Un sencillo programa de transferencia de archivos llamado rncp que facilita la copia de archivos a sistemas remotos.
+El programa de ejecución remota de comandos rnx que le permite ejecutar comandos, programas y recuperar output de sistemas remotos.
+
+Todas las herramientas, incluidas rnx y rncp, funcionan bien y con fiabilidad incluso en enlaces de muy bajo ancho de banda como LoRa o radio por paquetes.
+Programas que usan Reticulum
+Si quiere rápidamente hacerse una idea de lo que puede hacer Reticulum, peguele una mirada a los siguientes recursos:
+
+Para una plataforma de comunicaciones mesh sin conexión a la red, encriptada y resiliente, consulte Nomad Network .
+La aplicación para Android, Linux y macOS Sideband tiene una interfaz gráfica y se centra en facilidad de uso.
+LXMF es un protocolo de transferencia de mensajes distribuido, tolerante a retrasos e interrupciones y basado en Reticulum.
+Dependencias
+La instalación del paquete rns requiere las dependencias que se enumeran a continuación. Casi todos los sistemas y distribuciones tienen paquetes disponibles para estas dependencias, y cuando se instala el paquete rns con pip, también se descargan e instalan.
+
+En sistemas más inusuales, y en algunos casos raros, puede que no sea posible instalar o incluso compilar uno o más de los módulos anteriores. En tales situaciones, puede utilizar en su lugar el paquete rnspure, que no requiere dependencias externas para su instalación. Tenga en cuenta que el contenido de los paquetes rns y rnspure es idéntico . La única diferencia es que el paquete rnspure no necesita dependencias externas para su instalación.
+Independientemente de cómo se instale e inicie Reticulum, éste cargará las dependencias externas sólo si son necesarias y están disponibles . Si, por ejemplo, desea utilizar Reticulum en un sistema que no admite pyserial , es perfectamente posible hacerlo utilizando el paquete rnspure, pero Reticulum no podrá utilizar interfaces basadas en serial. Todos los demás módulos disponibles seguirán cargándose cuando sea necesario.
+Atenti! Si utiliza el paquete rnspure para ejecutar Reticulum en sistemas que no soportan PyCA/cryptography , es importante que lea y comprenda la sección Primitivas Criptográficas de este sitio.
+Desempeño
+Reticulum busca cubrir un amplio rango de desempeño utilizable pero prioriza la funcionalidad y el desempeño sobre medios de baja capacidad de ancho de banda. El objetivo es ofrecer un entorno de desempeño dinámico que va desde 250 bit por segundo hasta 1 giga bit por segundo en hardware normal.
+Actualmente, el rango de desempeño utilizable está aproximadamente en 150 bit por segundo a 40 mega bits por segundo, mientras que los medios físicos más rápidos no están saturados. El desempeño superior a este nivel se reserva para actualizaciones futuras, pero no es prioritario hasta que los formatos de cable y API hayan sido establecidos.
+Próximo Tema: Hardware soportado
+
+
diff --git a/docs/start_jp.html b/docs/start_jp.html
new file mode 100644
index 0000000..f02bbae
--- /dev/null
+++ b/docs/start_jp.html
@@ -0,0 +1,64 @@
+
+
+
+
+Reticulum Network
+
はじめに
+Reticulum Network Stackを始める最良の方法は、行いたいことによって異なります。詳細や例については、Getting Started Fast セクションをReticulum Manual で確認してください。
+実験的なソフトウェア
+ご注意ください！ Reticulumはまだベータ版です。これは、既に非常にうまく動作していて非常に安定していますが、システム全体の動作、プライバシー、セキュリティにおいて依然として致命的なバグや欠陥がある可能性があります。これを理解し、快適に使用できる場合にReticulumを使用してください。
+コミュニティとサポート
+問題が発生したり、何かがうまく動作しない場合は、助けを求めるための優れた場所がいくつかあります：
+
+インストール
+システムにReticulumおよび関連ユーティリティをインストールする最も簡単な方法は、pipを使用することです：
+pip install rns
+その後、Reticulumを使用するプログラムを開始するか、rnsdユーティリティ を使用してReticulumをシステムサービスとして起動できます。
+システムにpipが利用できない場合は、まずOS用のpython3およびpython3-pipパッケージをインストールしてください。
+最初に起動すると、Reticulumはデフォルトの設定ファイルを作成し、ローカルに到達可能な他のReticulumピアとの基本的な接続性を提供します。これらのローカルピアがTransport Instancesであれば、これらはより広範なネットワークに接続できるかもしれません。デフォルトの設定ファイルにはいくつかの例と、より複雑な構成を作成するための参照が含まれています。
+パケットラジオやLoRa、シリアルポート、UDPおよびTCPインターフェースを使用して高速なIPリンクおよびインターネット経由で通信を拡張する方法についての詳細な例については、Reticulum Manual のSupported Interfaces セクションを参照してください。
+含まれるユーティリティ
+Reticulumには、ネットワークを管理し、ステータスや情報を表示し、その他のタスクを行うためのさまざまな便利なユーティリティが含まれています。これらのプログラムについて詳しくは、Reticulum Manual のIncluded Utility Programs セクションを読んでください。
+
+常に利用可能なサービスとしてReticulumを実行するためのシステムデーモンrnsd
+インターフェイスのステータス情報を表示するrnstatusと呼ばれるユーティリティ
+パステーブルを表示および変更するためのパス検索および管理ツールrnpath
+接続先への接続を確認する診断ツールrnprobe
+ファイルをリモートシステムに簡単にコピーできるようにする単純なファイル転送プログラムrncp
+リモートシステムからコマンドやプログラムを実行し、出力を取得するrnx
+
+これらのツール、rnxおよびrncpを含むすべてのツールは、LoRaやパケットラジオなどの非常に低帯域幅のリンクでも信頼性があり、うまく動作します。
+Reticulumを使用したプログラム
+Reticulumの機能についてすぐに理解したい場合は、以下のリソースをご覧ください。
+
+オフグリッド、暗号化された、強固なメッシュ通信プラットフォームについては、Nomad Network を参照してください。
+Android、Linux、およびmacOSアプリSideband は、グラフィカルなインターフェースを備えており、使いやすさに焦点を当てています。
+LXMF は、Reticulum上に構築された分散型で遅延および障害対応のメッセージ転送プロトコルです。
+依存関係
+デフォルトのrnsパッケージのインストールには、以下にリストされた依存関係が必要です。ほとんどのシステムとディストリビューションはこれらの依存関係のために既に利用可能なパッケージを持っており、pipでrnsパッケージをインストールすると、これらもダウンロードおよびインストールされます。
+
+より一般的でないシステムや一部の稀なケースでは、上記のモジュールの1つ以上をインストールまたはコンパイルすることができないかもしれません。そのような状況では、外部依存関係がインストールに必要ないrnspureパッケージを代わりに使用できます。rnsとrnspureパッケージの内容は同一 です。唯一の違いは、rnspureパッケージがインストールに必要な依存関係をリストしていないことです。
+どのようにReticulumがインストールおよび起動されても、外部依存関係は必要 かつ利用可能 な場合のみ読み込まれます。例えば、pyserial をサポートしないシステムでReticulumを使用したい場合、rnspureパッケージを使用しても問題ありませんが、Reticulumはシリアルベースのインターフェースを使用できません。それ以外の利用可能なモジュールは、必要に応じて引き続き読み込まれます。
+注意！ PyCA/cryptography をサポートしないシステムでrnspureパッケージを使用してReticulumを実行する場合は、このサイトの暗号プリミティブ セクションを読み、理解することが重要です。
+パフォーマンス
+Reticulumは非常に 広範なパフォーマンスエンベロープを対象としていますが、低帯域幅のメディアに対する機能性とパフォーマンスを優先します。目標は、通常のハードウェアで250ビット/秒から1ギガビット/秒までの動的なパフォーマンス範囲を提供することです。
+現在、使用可能なパフォーマンス範囲は約150ビット/秒から40メガビット/秒であり、それ以上の物理メディアは飽和していません。現在のレベルを超えるパフォーマンスは将来のアップグレードのために意図されていますが、ワイヤフォーマットとAPIが確定するまで高い優先度は付けられていません。
+次のトピック：サポートされているハードウェア
+
+
diff --git a/docs/start_nl.html b/docs/start_nl.html
new file mode 100644
index 0000000..d4dfb0d
--- /dev/null
+++ b/docs/start_nl.html
@@ -0,0 +1,64 @@
+
+
+
+
+Reticulum Network
+
Begin
+De beste manier om aan de slag te gaan met de Reticulum Network Stack hangt af van wat jij wilt doen. Voor volledige details en voorbeelden, kijk eens naar de sectie Snel aan de slag van de Reticulum Manual .
+Experimentele software
+Let op! Reticulum is nog steeds in bèta. Dit betekent dat, hoewel het al heel goed werkt en zeer stabiel is, er nog steeds kritieke bugs of tekortkomingen kunnen zijn in het gedrag, de privacy of de veiligheid van het systeem als geheel. Gebruik Reticulum als u zich hier prettig bij voelt en de implicaties begrijpt.
+Hulp van de gemeenschap
+Als u problemen ondervindt of als iets niet werkt, zijn hier enkele goede plaatsen waar u om hulp kunt vragen:
+
+Installatie
+Om Reticulum en gerelateerde hulpprogramma's op uw systeem te installeren, is de eenvoudigste manier via pip:
+pip install rns
+U kunt vervolgens elk programma starten dat Reticulum gebruikt, of Reticulum starten als een systeemservice met [het rnsd-hulpprogramma] (manual/using.html#the-rnsd-utility).
+Als pip niet beschikbaar is op uw systeem, installeer dan eerst de pakketten python3 en python3-pip voor uw besturingssysteem.
+Wanneer Reticulum voor het eerst wordt gestart, zal het een standaardconfiguratiebestand maken, dat basisconnectiviteit biedt met andere Reticulum-peers die mogelijk lokaal bereikbaar zijn. Als een van deze lokale peers een Transport Instantie is, kunnen deze u verbinden met bredere netwerken. Het standaardconfiguratiebestand bevat enkele voorbeelden en referenties voor het maken van een complexere configuratie.
+Voor meer gedetailleerde voorbeelden over hoe u de communicatie kunt uitbreiden via vele media, zoals packet radio of LoRa, seriële poorten, of via snelle IP-verbindingen en internet met behulp van de UDP- en TCP-interfaces, kunt u de [Ondersteunde interfaces] (handleiding/interfaces) raadplegen. .html) sectie van de Reticulum Manual .
+Inbegrepen hulpprogramma's
+Reticulum bevat een reeks handige hulpprogramma's voor het beheren van uw netwerken, het bekijken van status en informatie en andere taken. U kunt meer over deze programma's lezen in het hoofdstuk Included Utility Programs van de Reticulum Manual .
+
+De systeemdaemon rnsd voor het uitvoeren van Reticulum als een altijd beschikbare service
+Een interfacestatushulpprogramma genaamd rnstatus, dat informatie over interfaces weergeeft
+Het hulpmiddel voor het opzoeken en beheren van paden rnpath waarmee u padtabellen kunt bekijken en wijzigen
+Een diagnostisch hulpmiddel genaamd rnprobe voor het controleren van de connectiviteit met bestemmingen
+Een eenvoudig programma voor bestandsoverdracht genaamd rncp, waarmee u eenvoudig bestanden naar externe systemen kunt kopiëren
+Het programma voor het uitvoeren van opdrachten op afstand rnx waarmee u opdrachten en programma's kunt uitvoeren en uitvoer van externe systemen kunt ophalen
+
+Alle tools, inclusief rnx en rncp, werken betrouwbaar en goed, zelfs via verbindingen met een zeer lage bandbreedte, zoals LoRa of Packet Radio.
+Programma's die Reticulum gebruiken
+Als je snel een idee wilt krijgen van wat Reticulum kan doen, bekijk dan de volgende bronnen.
+
+Voor een off-grid, gecodeerd en veerkrachtig mesh-communicatieplatform, zie Nomad Network
+De Android-, Linux- en macOS-app Sideband heeft een grafische interface en is gericht op gebruiksgemak.
+LXMF is een gedistribueerd, vertragings- en verstoringstolerant protocol voor berichtoverdracht, gebouwd op Reticulum
+Afhankelijkheden
+Voor de installatie van het standaard rns-pakket zijn de onderstaande afhankelijkheden vereist. Bijna alle systemen en distributies hebben pakketten beschikbaar voor deze afhankelijkheden, en wanneer het rns-pakket met pip wordt geïnstalleerd, zullen deze ook worden gedownload en geïnstalleerd.
+
+Op meer ongebruikelijke systemen, en in sommige zeldzame gevallen, is het misschien niet mogelijk om een of meer van de bovenstaande modules te installeren of zelfs te compileren. In dergelijke situaties kunt u in plaats daarvan het pakket rnspure gebruiken, waarvoor geen externe afhankelijkheden nodig zijn voor de installatie. Houd er rekening mee dat de inhoud van de pakketten rns en rnspure identiek is. Het enige verschil is dat het rnspure-pakket geen afhankelijkheden vermeldt die vereist zijn voor de installatie.
+Ongeacht hoe Reticulum is geïnstalleerd en gestart, het zal alleen externe afhankelijkheden laden als deze nodig en beschikbaar zijn. Als u bijvoorbeeld Reticulum wilt gebruiken op een systeem dat pyserial niet kan ondersteunen, is het perfect mogelijk om dit te doen met het rnspure-pakket, maar Reticulum zal dan niet in staat zijn om seriële interfaces te gebruiken. Alle andere beschikbare modules worden nog steeds geladen wanneer dat nodig is.
+Let op! Als u het rnspure-pakket gebruikt om Reticulum uit te voeren op systemen die PyCA/cryptography niet ondersteunen, is het belangrijk dat u eerst het Cryptografische Primitieven hoofdstuk van deze site leest en begrijpt.
+Prestatie
+Reticulum streeft naar een zeer breed bruikbaar prestatiebereik, maar geeft prioriteit aan functionaliteit en prestaties boven mediums met een lage bandbreedte. Het doel is om een dynamisch prestatiebereik te bieden van 250 bits per seconde tot 1 gigabit per seconde op normale hardware.
+Momenteel bedraagt het bruikbare prestatiebereik ongeveer 150 bits per seconde tot 40 megabits per seconde, waarbij fysieke media sneller dan dat niet verzadigd zijn. Prestaties boven het huidige niveau zijn bedoeld voor toekomstige upgrades, maar krijgen geen hoge prioriteit totdat het draadformaat en de API zijn vergrendeld.
+Volgend onderwerp: ondersteunde hardware
+
+
diff --git a/docs/start_pl.html b/docs/start_pl.html
new file mode 100644
index 0000000..c4f285a
--- /dev/null
+++ b/docs/start_pl.html
@@ -0,0 +1,65 @@
+
+
+
+
+Reticulum Network
+
Jak zacząć
+Najlepszy sposób na rozpoczęcie pracy z Reticulum Network Stack zależy od tego, co
+co chcesz zrobić. Aby uzyskać pełne szczegóły i przykłady, sprawdź rodział Jak szybko zacząć w Podręczniku Reticulum .
+Eksperymentalne Oprogramowanie
+Proszę Pamiętaj! Reticulum jest wciąż w fazie beta. Oznacza to, że choć działa bardzo dobrze i jest bardzo stabilne, to nadal mogą istnieć krytyczne błędy lub wady w zachowaniu, prywatności lub bezpieczeństwie całego systemu. Używaj Reticulum, jeśli czujesz się z tym komfortowo i rozumiesz konsekwencje.
+Społeczność & Wsparcie
+Jeśli masz problemy lub coś nie działa, oto kilka świetnych miejsc, w których możesz poprosić o pomoc:
+
+Instalacja
+Najprostszym sposobem, żeby zainstalować Reticulum i powiązane narzędzia jest przy wykorzystanie pip:
+pip install rns
+Możesz wtedy uruchomić każdy program, który używa Reticulum, lub uruchomić Reticulum jako usługę systemową za pomocą narzędzia rnsd .
+Jeśli pip nie jest dostępny na twoim systemie, zainstaluj najpierw pakiety python3 i python3-pip dla swojego systemu operacyjnego.
+Przy pierwszym uruchomieniu Reticulum tworzy domyślny plik konfiguracyjny, zapewniający podstawową łączność z innymi serwerami Reticulum, które mogą być osiągalne lokalnie. Jeśli któryś z tych lokalnych peerów jest Instancją Transportową, może on połączyć Ciebie z większymi sieciami. Domyślny plik konfiguracyjny zawiera kilka przykładów oraz referencje do tworzenia bardziej złożonych konfiguracji.
+W celu uzyskania bardziej szczegółowych przykładów dotyczących rozszerzenia komunikacji za pomocą wielu mediów, takich jak packet radio lub LoRa, porty szeregowe lub za pomocą szybkich łączy IP i Internetu przy użyciu interfejsów UDP i TCP, sprawdź sekcję Wspierane Interfejsy w Podręczniku Reticulum .
+Zawarte Narzędzia
+Reticulum zawiera szereg przydatnych narzędzi do zarządzania sieciami, przeglądania stanu i informacji oraz innych zadań. You can read more about these programs in the Możesz przeczytać więcej o tych programach w sekcji Zawarte Programy Użytkowe w Podręczniku Reticulum .
+
+Demon systemowy rnsd do uruchamiania Reticulum jako zawsze dostępnej usługi
+Narzędzie statusu interfejsu o nazwie rnstatus, które wyświetla informacje o interfejsach
+Narzędzie do wyszukiwania i zarządzania ścieżkami rnpath pozwalające na przeglądanie i modyfikowanie tablic ścieżek
+Narzędzie diagnostyczne o nazwie rnprobe do sprawdzania łączności z miejscami docelowymi
+Prosty program do transferu plików o nazwie rncp ułatwiający kopiowanie plików na zdalne systemy
+Program do zdalnego wykonywania poleceń rnx, który pozwala uruchamiać polecenia i programy oraz pobierać dane wyjściowe ze zdalnych systemów
+
+Wszystkie narzędzia, w tym rnx i rncp, działają niezawodnie i dobrze nawet na łączach o bardzo niskiej przepustowości, takich jak LoRa czy Packet Radio.
+Programy Używające Reticulum
+Jeśli chcesz szybko zorientować się, co potrafi Reticulum, zapoznaj się z poniższymi materiałami.
+
+Dla pozasieciowej, szyfrowanej i odpornej platformy komunikacyjnej typu mesh, zobacz Nomad Network
+Aplikacja Sideband na Androida, Linuxa i macOS posiada interfejs graficzny i koncentruje się na łatwości użytkowania.
+LXMF jest rozproszonym, odpornym na opóźnienia i zakłócenia protokołem wysyłania wiadomości zbudowanym na Reticulum
+Zależności
+Instalacja domyślnego pakietu rns wymaga zależności wymienionych poniżej. Prawie wszystkie systemy i dystrybucje mają łatwo dostępne pakiety dla tych zależności, a kiedy pakiet rns jest instalowany z pip, zostaną one pobrane i zainstalowane również.
+
+Na bardziej nietypowych systemach, w niektórych rzadkich przypadkach, może nie być możliwe zainstalowanie lub nawet skompilowanie jednego lub więcej z powyższych modułów. W takich sytuacjach można użyć pakietu rnspure, który nie wymaga zewnętrznych zależności do instalacji. Proszę zauważyć, że zawartość pakietów rns i rnspure jest identyczna . Jedyną różnicą jest to, że pakiet rnspure nie zawiera żadnych zależności wymaganych do instalacji.
+Bez względu na to, jak Reticulum jest zainstalowane i uruchomione, załaduje zewnętrzne zależności tylko wtedy, gdy są one potrzebne i dostępne . Jeśli na przykład chcesz używać Reticulum na systemie, który nie może obsługiwać pyserial , jest to całkowicie możliwe przy użyciu pakietu rnspure, ale Reticulum nie będzie w stanie korzystać z interfejsów opartych na portach szeregowych. Wszystkie inne dostępne moduły będą nadal ładowane w razie potrzeby.
+Uwaga! Jeśli używasz pakietu rnspure do uruchomienia Reticulum na systemach, które nie wspierają PyCA/cryptography , ważne jest, abyś przeczytał i zrozumiał sekcję Prymitywy Kryptograficzne na tej stronie.
+Wydajność
+Reticulum celuje w bardzo szeroki zakres wydajności użytkowej, ale priorytetowo traktuje funkcjonalność i wydajność w stosunku do mediów o niskiej przepustowości. Celem jest zapewnienie dynamicznej wydajności od 250 bitów na sekundę do 1 gigabita na sekundę na normalnym sprzęcie.
+Obecnie użyteczna wydajność wynosi około 150 bitów na sekundę do 40 megabitów na sekundę, z nośnikami fizycznymi szybszymi niż te które nie są nienasycone. Wydajność wykraczająca poza obecny poziom jest przeznaczona do przyszłych aktualizacji, ale nie ma wysokiego priorytetu do czasu zablokowania formatu przewodów i API.
+Następny Temat: Wspierany Hardware
+
+
diff --git a/docs/start_pt-br.html b/docs/start_pt-br.html
new file mode 100644
index 0000000..c4c9e02
--- /dev/null
+++ b/docs/start_pt-br.html
@@ -0,0 +1,64 @@
+
+
+
+
+Reticulum Network
+
Começar
+A melhor forma de começar com o framework Reticulum depende do que você quer fazer. para detalhes completos e exemplos, olhe na seção Começo Rápido do Manual Reticulum .
+Software Experimental
+Atenção! Reticulum ainda está em beta, Isso significa que ele atualmente executa bem, muito estável, mesmo assim ainda pode ter bugs críticos e falhas no funcionamento, privacidade ou a segurança do sistema como um todo.
+Utilize o Reticulum se estiver confortável em relação a isso e entenda suas implicações.
+Comunidade e Ajuda
+Se você estiver com problemas ou se algo não estiver funcionando, aqui estão alguns ótimos lugares para pedir ajuda:
+
+Instalação
+Para instalar o Reticulum e utilitários relacionados no seu sistema, a forma mais fácil é via pip:
+pip install rns
+Feito isto, é possível utilizar qualquer programa que utilize o Reticulum ou inicie o Reticulum como um serviço do sistema com a ferramenta rnsd .
+Se o pip não estiver disponível no seu sistema, instale o python3 ou python3-pip no seu sistema antes.
+Durante a primeira execução, Reticulum irá criar um arquivo de configuração padrão, provendo conexão básica para outros pares Reticulum que podem ser alcançados. Se algum desses pares locais são Instâncias de Transporte, isso poderá te conectar a redes maiores. O arquivo de configuração padrão tem alguns exemplos e referências para criar uma configuração mais complexa.
+Para exemplos mais detalhados de como expandir a comunicação por muitos dispositivos, tais como rádio amador, LoRa, portas seriais, links rápidos de IP ou pela Internet utilizando UDP ou TCP, leia mais na seção de Interfaces Suportadas do Manual Reticulum .
+Ferramentas Incluídas
+Reticulum incluí uma variedade de ferramentas úteis para gerenciar suas redes, como ver estado, informações e outras tarefas. Você pode ler mais sobre essas ferramentas na seção de Utilitários Incluídos do Manual Reticulum .
+
+O serviço de sistema rnsd (daemon) para executar o Reticulum é um serviço sempre disponível.
+Uma ferramenta para interface de estado chamada rnstatus, que mostra informações sobre as interfaces.
+A ferramenta para bloqueio de caminho e gerenciamento rnpath permitindo que você observe e modifique tabelas de caminho.
+Uma ferramenta de diagnóstico chamada rnprobe para checar a conectividade nos destinos.
+Um programa simples de transferência de arquivos chamado rncp tornando fácil de copiar arquivos para sistemas remotos.
+Um programa de comandos remotos rnx que permite você executar comandos e programas para obter dados de sistemas remotos.
+
+Todas as ferramentas, incluindo rnx e rncp, funcionam de forma confiável e bem mesmo sob links de baixa largura de banda como LoRa e rádio amador.
+Programas utilizando Reticulum
+Se você quiser ter uma noção do que o Reticulum é capaz de fazer, veja os seguintes projetos.
+
+Para uma plataforma de comunicação mesh resiliente, isolada da Internet e criptografada, veja a Nomad Network .
+O app Sideband para Android, Linux e MacOSX possuí interface gráfica e foca em facilidade.
+LXMF é um protocolo de transferência de mensagens distribuído, resistente a delays e interrupções, criado no Reticulum.
+Dependências
+A instalação do pacote padrão rns requer as dependências listadas abaixo. Quase todos os sistemas e distribuições tem pacotes disponíveis para estas dependências, quando o pacote rns é instalado via pip, eles serão baixados e instalados em conjunto.
+
+Em alguns sistemas ou em raros casos, pode não ser possível instalar ou até compilar um ou mais dos módulos acima. Em tais situações, você pode utilizar o pacote rnspure no lugar, que não irá pedir dependências externas para instalação. Note que o conteúdo dos pacotes rns e rnspure é idêntico. A única diferença são as listas do pacote rnspure que não requerem dependências para instalação.
+Não importa como o Reticulum é instalado ou iniciado, ele vai carregar as dependências externas apenas caso forem necessárias ou disponíveis. Se por exemplo você quer utilizar o Reticulum em um sistema que não suporta o pyserial , é perfeitamente possível utilizar o pacote rnspure, mas o Reticulum em sistemas que não suportam a PyCA/cryptography , é importante que você leia e entenda a seção de Criptografia neste site.
+Desempenho
+Reticulum possuí um grande potencial de desempenho, mas prioriza a funcionalidade e desempenho em dispositivos de baixa largura de rede. O objetivo é fornecer desempenho dinâmico de 250 bits por segundo para 1 gigabit por segundo em hardware normal.
+Atualmente o desempenho usual é aproximadamente 150 bits por segundo até 40 megabits por segundo, com dispositivos físicos mais rápidos que isso não sendo saturados. O desempenho além do nível atual é esperado para as próximas atualizações, mas não com prioridade alta até que o formato de cabo e API estejam maduros.
+Próxima Página: Hardware Compátivel
+
+
diff --git a/docs/start_tr.html b/docs/start_tr.html
new file mode 100644
index 0000000..d842d2a
--- /dev/null
+++ b/docs/start_tr.html
@@ -0,0 +1,65 @@
+
+
+
+
+Reticulum Network
+
Hoş Geldiniz
+Reticulum Ağı ile başlamanın en iyi yolu, ne yapmak istediğinize bağlıdır. Tam detaylar ve örnekler için Hızlı Başlangıç bölümüne Reticulum Kılavuzu 'nda göz atın.
+Deneysel Yazılım
+Dikkat! Reticulum hala beta aşamasındadır. Şu an çok iyi çalışsa ve çok stabil olsa da, sistemde genel olarak kritik hatalar veya eksiklikler olabilir. Reticulum'u kullanıyorsanız buna rahatlıkla uyum sağlıyorsanız ve sonuçların ne anlama geldiğini anlıyorsanız kullanın.
+Topluluk ve Destek
+Eğer sorun yaşarsanız veya bir şey çalışmıyorsa, yardım istemek için harika yerler şunlar:
+
+Kurulum
+Sisteminize Reticulum'u ve ilgili araçları kurmanın en kolay yolu pip kullanmaktır:
+pip install rns
+Daha sonra Reticulum kullanan herhangi bir programı başlatabilir veya rnsd aracı ile Reticulum'u bir sistem servisi olarak başlatabilirsiniz.
+Eğer sisteminizde pip mevcut değilse, önce işletim sisteminiz için python3 ve python3-pip paketlerini kurun.
+İlk başlatıldığında Reticulum, yerel olarak erişilebilen diğer Reticulum eşlerine temel bağlantı sağlayan varsayılan bir yapılandırma dosyası oluşturacaktır. Bu yerel eşlerin herhangi biri Taşıma Örnekleri ise, sizi daha geniş ağlara bağlayabilirler. Varsayılan yapılandırma dosyası birkaç örnek ve daha karmaşık bir yapılandırma oluşturma referansları içerir.
+Daha ayrıntılı örnekler için paket radyo veya LoRa, seri portlar veya hızlı IP bağlantıları ve UDP ve TCP arabirimlerini kullanarak İnternet üzerinden iletişimi genişletme konusunda Desteklenen Arabirimler bölümüne Reticulum Kılavuzu 'nda göz atın.
+Dahil Edilen Araçlar
+Reticulum, ağlarınızı yönetmek, durum ve bilgi görüntülemek ve diğer görevler için bir dizi kullanışlı araç içerir. Bu programlar hakkında daha fazla bilgiyi Dahil Edilen Yardımcı Programlar bölümünde Reticulum Kılavuzu 'nda bulabilirsiniz.
+
+Reticulum'u her zaman kullanılabilir bir servis olarak çalıştırmak için sistem arka plan uygulaması rnsd
+Arayüz durumu için bilgi gösteren rnstatus adlı bir araç
+Yol tablolarını görüntülemenizi ve değiştirmenizi sağlayan rnpath adlı bir yol arama ve yönetim aracı
+Bağlantıları kontrol etmek için rnprobe adlı bir teşhis aracı
+Uzak sistemlere dosya kopyalamayı kolaylaştıran basit bir dosya transfer programı olan rncp
+Uzak sistemlerden komutları ve programları çalıştırmanıza ve çıktıları almanıza izin veren uzaktan komut yürütme programı rnx
+
+Tüm araçlar, rnx ve rncp dahil, düşük bant genişliği bağlantıları üzerinde bile güvenilir bir şekilde çalışır.
+Reticulum Kullanan Programlar
+Reticulum'un ne yapabileceğine hızlı bir şekilde bir fikir edinmek istiyorsanız, aşağıdaki kaynaklara göz atın.
+
+Off-grid, şifreli ve dayanıklı bir ağ iletişim platformu için Nomad Network
+Android, Linux ve macOS uygulaması Sideband grafik arayüze sahiptir ve kullanım kolaylığına odaklanır.
+LXMF , Reticulum üzerine inşa edilmiş dağıtılmış, gecikmeli ve kesintiye uğramış bir ileti transfer protokolüdür.
+Gereksinimler
+Varsayılan rns paketinin kurulumu aşağıda listelenen gereksinimleri ister. Hemen hemen tüm sistemler ve dağıtımlar, bu bağımlılıklar için gereken hazır paketlere sahiptir ve pip ile rns paketi kurulduğunda indirilip kurulacaktır.
+
+Daha sıra dışı sistemlerde ve bazı nadir durumlarda yukarıdaki modüllerden bir veya daha fazlasını kurmak veya hatta derlemek mümkün olmayabilir. Bu durumlarda rnspure paketini kullanabilirsiniz, bu kurulum için harici bağımlılıklar gerektirmez. Lütfen unutmayın ki rns ve
+rnspure paketlerinin içerikleri aynıdır . Tek fark, rnspure paketinin kurulum için gerekli bağımlılıkları listelememesidir.
+Reticulum nasıl kurulup başlatılırsa başlatsın, dış bağımlılıkları sadece gerektiğinde ve uygunsa yükler. Örneğin, pyserial desteklemeyen bir sistemde Reticulum'u kullanmak istiyorsanız, bunu rnspure paketi kullanarak yapabilirsiniz, ancak Reticulum seri tabanlı arayüzleri kullanamayacaktır. Diğer tüm kullanılabilir modüller, ihtiyaç duyulduğunda yine yüklenecektir.
+Lütfen Dikkat Edin! rnspure paketini PyCA/cryptography 'yi desteklemeyen sistemlerde Reticulum'u çalıştırmak istiyorsanız, bu sitenin Şifreleme Temelleri bölümünü okumanız gerekmektedir.
+Performans
+Reticulum, çok geniş bir kullanılabilir performans aralığına yönelik olup, düşük bant genişliği ortamlarında işlevselliği ve performansı önceliklendirir. Hedef, normal donanımda 250 bit/s'den 1 gigabit/s'ye dinamik bir performans aralığı sağlamaktır.
+Şu anda kullanılabilir performans aralığı yaklaşık olarak 150 bit/s ile 40 megabit/s arasındadır ve bu hızların üzerindeki fiziksel ortamlar doyurulmamaktadır. Mevcut seviyenin ötesinde performans, gelecekteki güncellemeler için ama wire formatı ve API kilitlendikten sonra öncelikli olarak düşünülmüyor.
+Sonraki Konu: Desteklenen Donanım
+
+
diff --git a/docs/start_uk.html b/docs/start_uk.html
new file mode 100644
index 0000000..5e4f858
--- /dev/null
+++ b/docs/start_uk.html
@@ -0,0 +1,64 @@
+
+
+
+
+Reticulum Network
+
Початок роботи
+Найкращий спосіб почати роботу з мережею Reticulum залежить від того, що ви хочете зробити. Для повних деталей та прикладів ознайомтеся з розділом Швидкий старт в Посібнику Reticulum .
+Експериментальне програмне забезпечення
+Будь ласка, майте на увазі! Reticulum все ще в бета-версії. Це означає, що хоча система вже працює дуже добре та є стабільною, можуть бути критичні помилки або недоліки в поведінці, конфіденційності або безпеці системи в цілому. Використовуйте Reticulum, якщо вам комфортно з цим і ви розумієте наслідки.
+Спільнота та підтримка
+Якщо у вас виникли проблеми або щось не працює, ось кілька чудових місць, де можна попросити про допомогу:
+
+Встановлення
+Для встановлення Reticulum та супутніх утиліт на вашу систему найпростішим способом є використання pip:
+pip install rns
+Ви можете запустити будь-яку програму, що використовує Reticulum, або запустити Reticulum як системну службу за допомогою утиліти rnsd .
+Якщо pip недоступний на вашій системі, спочатку встановіть пакети python3 та python3-pip для вашої ОС.
+Під час першого запуску Reticulum створить конфігураційний файл за замовчуванням, який забезпечить базовий зв'язок з іншими одноранговими проєктами Reticulum, які можуть бути доступними локально. Якщо серед них є транспортні екземпляри, вони можуть з'єднати вас з більш широкими мережами. Файл конфігурації містить кілька прикладів та посилань для створення більш складної конфігурації.
+Для більш детальних прикладів того, як розширити зв'язок через різні канали, такі як пакетне радіо або LoRa, послідовні порти, або через швидкі IP-з'єднання та Інтернет, використовуючи інтерфейси UDP та TCP, ознайомтесь із розділом Підтримувані інтерфейси в Посібнику Reticulum .
+Включені утиліти
+Reticulum включає ряд корисних утиліт для керування вашими мережами, перегляду статусу та інформації, а також виконання інших завдань. Більше про ці програми можна дізнатися в розділі Включені утилітні програми в Посібнику Reticulum .
+
+Системний демон rnsd для запуску Reticulum як завжди доступної служби
+Утиліта для перегляду статусу інтерфейсів під назвою rnstatus, яка виводить інформацію про інтерфейси
+Інструмент для перегляду та керування таблицями шляхів rnpath
+Діагностична утиліта під назвою rnprobe для перевірки з'єднання з пунктами призначення
+Простий файл-переносник rncp, який дозволяє легко копіювати файли на віддалені системи
+Утиліта для віддаленого виконання команд rnx, яка дозволяє запускати команди та програми на віддалених системах і отримувати виведення
+
+Усі інструменти, включаючи rnx та rncp, працюють надійно навіть через дуже низькошвидкісні з'єднання, такі як LoRa або пакетне радіо.
+Програми, що використовують Reticulum
+Якщо ви хочете швидко зрозуміти, що може зробити Reticulum, ознайомтесь з наступними ресурсами.
+
+Для оффлайн, зашифрованої та стійкої мережевої платформи, дивіться Nomad Network
+Мобільний додаток для Android, Linux та macOS Sideband має графічний інтерфейс і зосереджений на зручності використання.
+LXMF — це розподілений, стійкий до затримок і переривань протокол передачі повідомлень, побудований на Reticulum.
+Залежності
+Встановлення за замовчуванням пакету rns потребує таких залежностей. Більшість систем та дистрибутивів мають доступні пакети для цих залежностей, і коли пакет rns встановлюється через pip, вони також будуть завантажені та встановлені.
+
+На менш звичайних системах, а також у рідкісних випадках, може бути неможливо встановити або навіть скомпілювати один або кілька з вищезгаданих модулів. У таких ситуаціях ви можете використати пакет rnspure замість цього, який не потребує зовнішніх залежностей для встановлення. Зверніть увагу, що вміст пакетів rns та rnspure ідентичний . Єдина різниця в тому, що пакет rnspure не має списку залежностей, необхідних для встановлення.
+Не залежно від того, як Reticulum було встановлено і запущено, воно завантажить зовнішні залежності тільки якщо вони необхідні і доступні . Якщо, наприклад, ви хочете використовувати Reticulum на системі, яка не підтримує pyserial , це цілком можливо зробити, використовуючи пакет rnspure, але Reticulum не зможе використовувати інтерфейси, що базуються на серійному з'єднанні. Усі інші доступні модулі будуть завантажені, коли це буде потрібно.
+Зверніть увагу! Якщо ви використовуєте пакет rnspure для запуску Reticulum на системах, які не підтримують PyCA/cryptography , важливо, щоб ви прочитали і зрозуміли розділ Криптографічні примітиви на цьому сайті.
+Продуктивність
+Reticulum орієнтовано на дуже широкий діапазон використаної продуктивності, але при цьому надається пріоритет функціональності та продуктивності над низькошвидкісними середовищами. Метою є забезпечення динамічного діапазону продуктивності від 250 біт на секунду до 1 гігабіта на секунду на звичайному обладнанні.
+Наразі використаний діапазон продуктивності становить приблизно від 150 біт на секунду до 40 мегабіт на секунду, при цьому фізичні середовища, що перевищують цей рівень, не насичуються. Продуктивність, що перевищує поточний рівень, планується для майбутніх оновлень, але не є головним пріоритетом, поки не буде зафіксовано формат передачі та API.
+Наступна тема: Підтримуване обладнання
+
+
diff --git a/docs/start_zh-cn.html b/docs/start_zh-cn.html
new file mode 100644
index 0000000..f6287cd
--- /dev/null
+++ b/docs/start_zh-cn.html
@@ -0,0 +1,64 @@
+
+
+
+
+Reticulum Network
+
开始使用
+开始使用 Reticulum 的第一步是看看自己想用它做什么。如果你想了解完整的细节或是参照一些例子，请参阅Reticulum 手册 的快速开始 部分。
+实验性软件
+请注意！ Reticulum 仍旧处于 Beta 测试阶段。虽然它目前已经工作得相当良好而且稳定，但是在系统整体的行为、隐私或安全性上仍旧可能存在致命的漏洞与缺陷。如果你已经了解可能的后果，并且感觉没问题的话，就开始使用吧！
+社区与支持
+如果你遇到了问题，又或是有些东西不工作，以下是一些寻求帮助的好地方：
+
+安装
+安装 Reticulum 及其相关工具最简单的方式是使用 pip：
+pip install rns
+安装完成后，你便可以启动任何依赖 Reticulum 运行的程序，或者是使用 rnsd 工具 将 Reticulum 作为服务运行。
+如果 pip 在你的系统上不可用，请首先安装 python3 与 python3-pip。
+首次启动时，Reticulum 会创建一个默认的配置文件。它会试着连接本地可达的 Reticulum 节点(peer)。如果其中有些节点是”传输节点(Transport Instances)“，它们便可以帮助你连接上更大范围的网络。默认的配置文件提供了几个样例，以及用于创建复杂配置的参考。
+如果想了解更多将通信扩展到各个媒介(如封包无线电，LoRa、串口、基于IP的高速连接、通过UDP/TCP连接互联网等)的细节，请参阅 Reticulum 手册 的受支持的界面 部分。
+附带工具
+Reticulum 附带了用于管理网络、查看状态与信息等用途的一系列工具。欲知详情，请参阅 Reticulum 手册 的附带工具 部分。
+
+用于将 Reticulum 作为服务运行的守护进程(Daemon) rnsd
+用于查看界面信息的工具 rnstatus
+用于查看与更改路径表(Path Tables)的工具 rnpath
+用于检查与目标连接性的诊断工具 rnprobe
+让你可以简单复制文件的文件传输工具 rncp
+运行程序或命令并获取输出的远程命令执行工具 rnx
+
+以上提到的所有工具，包括 rnx 与 rncp，即使是通过带宽极低的链路(如 LoRa 与封包无线电)也能可靠且良好地工作。
+使用 Reticulum 的程序
+如果你想知道 Reticulum 能做什么，可以参考以下链接。
+
+无需基建、加密且可自恢复的网状通讯平台 Nomad Network
+带有图形界面、注重易用性、可在 Android、Linux 与 macOS 使用的 Sideband
+一个分布式、抗延迟、抗干扰、基于 Reticulum 的消息传输协议 LXMF
+
+依赖处理
+rns 包默认条件下的安装需要以下依赖。几乎所有的系统与发行版都有直接可用的软件包。如果是通过 pip 安装，这些依赖会直接被下载安装。
+
+若你使用的是较为罕见的系统，或是有一些特殊情况，上面的依赖不一定总是能安装或是编译成功。这时，你可以使用无需额外依赖的 rnspure 包。请注意 rns 与 rnspure包的内容是完全一致 的。唯一的区别是 rnspure 包没有显式要求需要安装的依赖。
+不论安装 Reticulum 的手段为何，Reticulum 都会在需要 且可用 的情况下加载外部依赖。如果你想在一个不支持 pyserial 的系统上运行 Reticulum，使用 rnspure 包即可。但是此时 Reticulum 将无法使用基于串口的界面。所有其他模块仍旧会在需要时被 Reticulum 载入。
+注意！ 如果你在不支持 PyCA/cryptography 的系统上使用 rnspure 包，请一定确保自己阅读并理解了密码学原语 的相关内容。
+性能
+Reticulum 的可用性能范围非常广 ，但是会优先保证低带宽媒介的可用性与性能。Reticulum 的目标是提供一个 250 bps 到 1 Gbps(普通硬件条件下)的性能区间。
+目前可用的性能区间是 150 bps 到 40 Mbps。更快的连接无法被充分利用。未来，Reticulum 可能会升级性能，但直到有线格式(wire format)和 API 完全稳定之前，性能的提升都不会是优先事项。
+下一个主题: 硬件支持
+
+
diff --git a/source/connect.md b/source/connect.md
index 4be2e70..9154c3a 100644
--- a/source/connect.md
+++ b/source/connect.md
@@ -1,6 +1,8 @@
# Public Testnet
If you just want to get started experimenting without building any physical networks, you are welcome to join the Public Reticulum Testnet. The testnet is just that, an informal network for testing and experimenting. It will be up most of the time, and anyone can join, but it also means that there's no guarantees for service availability.
+**Please note!** For everyday use of Reticulum, such as for messaging and other communications, it is much better to use one or more of the community-provided public entrypoints. Please see the next section for details.
+
The testnet runs the very latest version of Reticulum (often even a short while before it is publicly released). Sometimes experimental versions of Reticulum might be deployed to nodes on the testnet, which means strange behaviour can occur. If none of that scares you, you can join the testnet via either TCP or I2P.
Just add one of the following interfaces to your Reticulum configuration file:
@@ -17,16 +19,25 @@ Just add one of the following interfaces to your Reticulum configuration file:
[[RNS Testnet BetweenTheBorders]]
type = TCPClientInterface
enabled = yes
- target_host = betweentheborders.com
+ target_host = reticulum.betweentheborders.com
target_port = 4242
# Interface to I2P Hub A
[[RNS Testnet I2P Hub A]]
type = I2PInterface
enabled = yes
- peers = mrwqlsioq4hoo2lmeeud7dkfscnm7yxak7dmiyvsrnpfag3z5tsq.b32.i2p
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
```
The testnet also contains a number of [Nomad Network](https://github.com/markqvist/nomadnet) nodes, and [LXMF](https://github.com/markqvist/lxmf) propagation nodes.
+# Community Entrypoints
+A number of publicly available entrypoints to Reticulum networks have been provided by the community. For everyday use, it is recommended to use these instead of the testnet.
+
+You can connect your devices or instances to one or more of these to gain access to any Reticulum networks they are physically connected to.
+
+Ideally, set up a Reticulum Transport Node that your own devices can reach locally, and then connect that transport node to a couple of public entrypoints. This will provide efficient connections and redundancy in case any of them go down.
+
+{PUBLIC_ENTRYPOINTS}
+
Next Topic: Read The Manual
diff --git a/source/connect_de.md b/source/connect_de.md
index 83db56e..0b6bd0a 100644
--- a/source/connect_de.md
+++ b/source/connect_de.md
@@ -18,16 +18,25 @@ Fügen Sie einfach eine der folgenden Schnittstellen in Ihre Reticulum-Konfigura
[[RNS Testnet BetweenTheBorders]]
type = TCPClientInterface
enabled = yes
- target_host = betweentheborders.com
+ target_host = reticulum.betweentheborders.com
target_port = 4242
# Interface to I2P Hub A
[[RNS Testnet I2P Hub A]]
type = I2PInterface
enabled = yes
- peers = mrwqlsioq4hoo2lmeeud7dkfscnm7yxak7dmiyvsrnpfag3z5tsq.b32.i2p
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
```
Das Testnetz enthält auch eine Reihe von [Nomad Network](https://github.com/markqvist/nomadnet)-Knoten und [LXMF](https://github.com/markqvist/lxmf)-Propagationsknoten, Sowie [Sideband](https://github.com/markqvist/Sideband) Peers, welche untereinander erreichbar sind.
+# Community-Einstiegspunkte
+Die Community hat eine Reihe öffentlich verfügbarer Einstiegspunkte zu Reticulum-Netzwerken bereitgestellt. Für den alltäglichen Gebrauch wird empfohlen, diese anstelle des Testnetzes zu verwenden.
+
+Sie können Ihre Geräte oder Instanzen mit einem oder mehreren dieser Punkte verbinden, um Zugriff auf alle Reticulum-Netzwerke zu erhalten, mit denen sie physisch verbunden sind.
+
+Richten Sie im Idealfall einen Reticulum-Transportknoten ein, den Ihre eigenen Geräte lokal erreichen können, und verbinden Sie diesen Transportknoten dann mit einigen öffentlichen Einstiegspunkten. Dies sorgt für effiziente Verbindungen und Redundanz, falls einer von ihnen ausfällt.
+
+{PUBLIC_ENTRYPOINTS}
+
Nächstes Thema: Lesen Sie das Handbuch
diff --git a/source/connect_es.md b/source/connect_es.md
new file mode 100644
index 0000000..d41b6c6
--- /dev/null
+++ b/source/connect_es.md
@@ -0,0 +1,43 @@
+# Testnet pública
+
+Si sólo quiere empezar a experimentar sin construir ninguna red física, le invitamos a unirse a la red pública de pruebas de Reticulum (Testnet).
+La red de pruebas es precisamente eso, una red informal para probar y experimentar. Estará activa la mayor parte del tiempo y cualquiera puede unirse a ella, pero esto también significa que no hay garantías de disponibilidad del servicio.
+
+La red de pruebas ejecuta la ultimísima versión de Reticulum (a menudo incluso un poco antes de su lanzamiento público). A veces pueden desplegarse versiones experimentales de Reticulum en nodos de la red de pruebas, lo que significa que pueden producirse comportamientos extraños. Si nada de esto le asusta, puede unirse a la red de prueba a través de TCP o I2P.
+
+Sólo tiene que añadir una de las siguientes interfaces a su archivo de configuración de Reticulum:
+
+```
+# TCP/IP interfaz al Dublin Hub
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# TCP/IP interfaz al BetweenTheBorders Hub (proporcionado por la comunidad)
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# Interfaz a I2P Hub A
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+```
+
+La red de pruebas también contiene varios nodos de [Nomad Network](https://github.com/markqvist/nomadnet) y nodos de propagación [LXMF](https://github.com/markqvist/lxmf).
+
+# Puntos de entrada de la comunidad
+La comunidad ha proporcionado una serie de puntos de entrada disponibles públicamente a las redes de Reticulum. Para el uso diario, se recomienda utilizar estos en lugar de la red de prueba.
+
+Puede conectar sus dispositivos o instancias a uno o más de estos para obtener acceso a cualquier red de Reticulum a la que estén conectados físicamente.
+
+Lo ideal es configurar un nodo de transporte de Reticulum al que sus propios dispositivos puedan acceder localmente y luego conectar ese nodo de transporte a un par de puntos de entrada públicos. Esto proporcionará conexiones eficientes y redundancia en caso de que alguno de ellos deje de funcionar.
+
+{PUBLIC_ENTRYPOINTS}
+
+Siguiente tema: Leer el manual
diff --git a/source/connect_jp.md b/source/connect_jp.md
new file mode 100644
index 0000000..79ca56d
--- /dev/null
+++ b/source/connect_jp.md
@@ -0,0 +1,41 @@
+# パブリックテストネット
+物理的なネットワークを構築せずに実験を始めたい場合は、パブリックレティキュラムテストネットに参加してください。テストネットはまさにそれであり、テストと実験のための非公式なネットワークです。ほとんどの時間稼働しており、誰でも参加できますが、それは同時にサービスの可用性に対する保証がないことも意味します。
+
+テストネットは最新のレティキュラムのバージョンを実行しており（公開される前の短い期間でもあることがよくあります）、時折実験的なレティキュラムのバージョンがテストネット上のノードに展開されることがあり、それにより奇妙な動作が発生する可能性があります。それでも怖くない場合は、TCPまたはI2Pを使用してテストネットに参加できます。
+
+次のいずれかのインターフェースをReticulumの設定ファイルに追加してください：
+
+```
+# Dublin HubへのTCP/IPインターフェース
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# BetweenTheBorders HubへのTCP/IPインターフェース（コミュニティ提供）
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# I2P Hub Aへのインターフェース
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+```
+
+テストネットには[Nomad Network](https://github.com/markqvist/nomadnet)ノードおよび[LXMF](https://github.com/markqvist/lxmf)伝播ノードも含まれています。
+
+# コミュニティ エントリポイント
+コミュニティによって、Reticulum ネットワークへの公開エントリポイントが多数提供されています。日常的な使用には、テストネットではなくこれらを使用することをお勧めします。
+
+デバイスまたはインスタンスをこれらの 1 つ以上のエントリポイントに接続して、物理的に接続されている Reticulum ネットワークにアクセスできます。
+
+理想的には、自分のデバイスがローカルでアクセスできる Reticulum トランスポート ノードを設定し、そのトランスポート ノードをいくつかのパブリック エントリポイントに接続します。これにより、いずれかのエントリポイントがダウンした場合でも、効率的な接続と冗長性が提供されます。
+
+{PUBLIC_ENTRYPOINTS}
+
+次のトピック：マニュアルを読む
\ No newline at end of file
diff --git a/source/connect_nl.md b/source/connect_nl.md
new file mode 100644
index 0000000..6b33cb4
--- /dev/null
+++ b/source/connect_nl.md
@@ -0,0 +1,41 @@
+# Openbaar Testnet
+Als je gewoon wilt beginnen met experimenteren zonder fysieke netwerken te bouwen, ben je van harte welkom om lid te worden van het Public Reticulum Testnet. Het testnet is precies dat: een informeel netwerk voor testen en experimenteren. Het zal het grootste deel van de tijd actief zijn en iedereen kan meedoen, maar het betekent ook dat er geen garanties zijn voor de beschikbaarheid van de service.
+
+Het testnet draait de allernieuwste versie van Reticulum (vaak zelfs kort voordat deze publiekelijk wordt vrijgegeven). Soms kunnen experimentele versies van Reticulum worden ingezet op knooppunten op het testnet, wat betekent dat er vreemd gedrag kan optreden. Als dit u allemaal niet afschrikt, kunt u zich via TCP of I2P bij het testnet aansluiten.
+
+Voeg gewoon een van de volgende interfaces toe aan uw Reticulum-configuratiebestand:
+
+```
+# TCP/IP interface to the Dublin Hub
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# TCP/IP interface to the BetweenTheBorders Hub (door de gemeenschap geleverd)
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# Interface to I2P Hub A
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+```
+
+Het testnet bevat ook een aantal [Nomad Network](https://github.com/markqvist/nomadnet) knooppunten en [LXMF](https://github.com/markqvist/lxmf) propagatieknooppunten.
+
+# Community Entrypoints
+De community heeft een aantal openbaar beschikbare entrypoints voor Reticulum-netwerken geleverd. Voor dagelijks gebruik is het raadzaam om deze te gebruiken in plaats van het testnet.
+
+U kunt uw apparaten of instanties verbinden met een of meer van deze om toegang te krijgen tot alle Reticulum-netwerken waarmee ze fysiek verbonden zijn.
+
+Idealiter stelt u een Reticulum Transport Node in die uw eigen apparaten lokaal kunnen bereiken en verbindt u die transport node vervolgens met een aantal openbare entrypoints. Dit zorgt voor efficiënte verbindingen en redundantie in het geval dat een van hen uitvalt.
+
+{PUBLIC_ENTRYPOINTS}
+
+Volgend onderwerp: lees de handleiding
diff --git a/source/connect_pl.md b/source/connect_pl.md
index 6c6a6d2..a8b0f45 100644
--- a/source/connect_pl.md
+++ b/source/connect_pl.md
@@ -17,16 +17,25 @@ Dodaj jeden z następujących interfejsów do pliku konfiguracyjnego Reticulum:
[[RNS Testnet BetweenTheBorders]]
type = TCPClientInterface
enabled = yes
- target_host = betweentheborders.com
+ target_host = reticulum.betweentheborders.com
target_port = 4242
# Interface to I2P Hub A
[[RNS Testnet I2P Hub A]]
type = I2PInterface
enabled = yes
- peers = mrwqlsioq4hoo2lmeeud7dkfscnm7yxak7dmiyvsrnpfag3z5tsq.b32.i2p
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
```
Testnet zawiera również liczne węzły [Nomad Network](https://github.com/markqvist/nomadnet), i węzły propagacyjne [LXMF](https://github.com/markqvist/lxmf).
+# Punkty wejścia społeczności
+Społeczność udostępniła szereg publicznie dostępnych punktów wejścia do sieci Reticulum. Do codziennego użytku zaleca się korzystanie z nich zamiast sieci testowej.
+
+Możesz podłączyć swoje urządzenia lub instancje do jednego lub większej liczby z nich, aby uzyskać dostęp do dowolnej sieci Reticulum, do której są fizycznie podłączone.
+
+W idealnym przypadku skonfiguruj węzeł transportowy Reticulum, do którego Twoje własne urządzenia mogą dotrzeć lokalnie, a następnie podłącz ten węzeł transportowy do kilku publicznych punktów wejścia. Zapewni to wydajne połączenia i redundancję w przypadku awarii któregokolwiek z nich.
+
+{PUBLIC_ENTRYPOINTS}
+
Następny Temat: Przeczytaj Podręcznik
diff --git a/source/connect_pt-br.md b/source/connect_pt-br.md
index e97f532..f713037 100644
--- a/source/connect_pt-br.md
+++ b/source/connect_pt-br.md
@@ -18,16 +18,25 @@ Adicione uma das seguintes interfaces no arquivo de configuração do seu Reticu
[[RNS Testnet BetweenTheBorders]]
type = TCPClientInterface
enabled = yes
- target_host = betweentheborders.com
+ target_host = reticulum.betweentheborders.com
target_port = 4242
# Interface para o I2P Hub A
[[RNS Testnet I2P Hub A]]
type = I2PInterface
enabled = yes
- peers = mrwqlsioq4hoo2lmeeud7dkfscnm7yxak7dmiyvsrnpfag3z5tsq.b32.i2p
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
```
A rede de teste também contém o número de nós da [Nomad Network](https://github.com/markqvist/nomadnet) e nós de propagação [LXMF](https://github.com/markqvist/lxmf).
+# Pontos de entrada da comunidade
+Vários pontos de entrada disponíveis publicamente para redes Reticulum foram fornecidos pela comunidade. Para uso diário, é recomendado usar estes em vez da testnet.
+
+Você pode conectar seus dispositivos ou instâncias a um ou mais destes para obter acesso a quaisquer redes Reticulum às quais eles estejam fisicamente conectados.
+
+O ideal é configurar um nó de transporte Reticulum que seus próprios dispositivos possam alcançar localmente e, em seguida, conectar esse nó de transporte a alguns pontos de entrada públicos. Isso fornecerá conexões eficientes e redundância caso algum deles fique inativo.
+
+{PUBLIC_ENTRYPOINTS}
+
Próxima Página: Leia o Manual
diff --git a/source/connect_tr.md b/source/connect_tr.md
new file mode 100644
index 0000000..36f2244
--- /dev/null
+++ b/source/connect_tr.md
@@ -0,0 +1,41 @@
+# Genel Test Ağı
+Eğer fiziksel ağlar oluşturmadan sadece denemelere başlamak istiyorsanız, Genel Reticulum Test Ağı'na katılmaktan hoş geldiniz. Test ağı tam olarak bunun için, test etmek ve denemeler yapmak için gayri resmi bir ağdır. Çoğu zaman aktif olacak ve herkes katılabilir, ancak bu aynı zamanda hizmetin sürekli kullanılabilirliği için garanti olmadığı anlamına gelir.
+
+Test ağı, Reticulum'un en güncel sürümünü çalıştırır (çoğu zaman genel olarak yayınlanmadan kısa bir süre önce). Ara sıra Reticulum'un deneysel sürümleri, test ağındaki düğümlere dağıtılabilir, bu da tuhaf davranışlara neden olabilir. Eğer hiçbiri sizi korkutmuyorsa, test ağına TCP veya I2P aracılığıyla katılabilirsiniz.
+
+Reticulum yapılandırma dosyanıza aşağıdaki arayüzlerden birini ekleyin:
+
+```
+# Dublin Hub için TCP/IP arabirimi
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# BetweenTheBorders Hub için TCP/IP arabirimi (topluluk tarafından sağlanmış)
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# I2P Hub A için arabirim
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+```
+
+Test ayrıca bir dizi [Nomad Network](https://github.com/markqvist/nomadnet) düğümü ve [LXMF](https://github.com/markqvist/lxmf) yayılma düğümü içerir.
+
+# Topluluk Giriş Noktaları
+Topluluk tarafından Reticulum ağlarına bir dizi genel erişime açık giriş noktası sağlanmıştır. Günlük kullanım için, testnet yerine bunları kullanmanız önerilir.
+
+Cihazlarınızı veya örneklerinizi fiziksel olarak bağlı oldukları herhangi bir Reticulum ağına erişim sağlamak için bunlardan birine veya daha fazlasına bağlayabilirsiniz.
+
+İdeal olarak, kendi cihazlarınızın yerel olarak ulaşabileceği bir Reticulum Taşıma Düğümü kurun ve ardından bu taşıma düğümünü birkaç genel giriş noktasına bağlayın. Bu, bunlardan herhangi biri çökerse verimli bağlantılar ve yedeklilik sağlayacaktır.
+
+{PUBLIC_ENTRYPOINTS}
+
+Sonraki Konu: Kılavuzu Okuyun
\ No newline at end of file
diff --git a/source/connect_uk.md b/source/connect_uk.md
new file mode 100644
index 0000000..bf25fcb
--- /dev/null
+++ b/source/connect_uk.md
@@ -0,0 +1,40 @@
+# Публічний Testnet
+Якщо ви просто хочете почати експериментувати без створення фізичних мереж, ви можете приєднатися до публічного тестнету Reticulum. Тестнет саме такий, неформальна мережа для тестування та експериментів. Він буде доступний більшість часу, і кожен може приєднатися, але це також означає, що немає гарантій щодо доступності сервісу.
+
+**Зверніть увагу!** Для повсякденного використання Reticulum, наприклад, для обміну повідомленнями та інших комунікацій, набагато краще використовувати один або кілька з публічних точок входу, наданих спільнотою. Деталі дивіться в наступному розділі.
+
+Тестнет працює на найновішій версії Reticulum (зазвичай навіть до її офіційного випуску). Іноді на тестнеті можуть бути розгорнуті експериментальні версії Reticulum, що може призвести до дивної поведінки. Якщо вас це не лякає, ви можете приєднатися до тестнету через TCP або I2P.
+
+Просто додайте один із наступних інтерфейсів до вашого конфігураційного файлу Reticulum:
+```
+# TCP/IP interface to the Dublin Hub
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# TCP/IP interface to the BetweenTheBorders Hub (community-provided)
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# Interface to I2P Hub A
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+```
+Тестнет також містить кілька вузлів Nomad Network та вузлів поширення LXMF.
+Точки входу спільноти
+
+Спільнота надала кілька публічно доступних точок входу до мереж Reticulum. Для повсякденного використання рекомендується використовувати ці точки замість тестнету.
+
+Ви можете приєднати свої пристрої або інстанси до однієї або кількох таких точок входу, щоб отримати доступ до будь-яких мереж Reticulum, до яких вони фізично підключені.
+
+Ідеально, якщо ви налаштуєте вузол транспорту Reticulum, до якого ваші пристрої зможуть підключатися локально, а потім з’єднаєте цей транспортний вузол з кількома публічними точками входу. Це забезпечить ефективні з’єднання та надійність у випадку, якщо одна з точок входу вийде з ладу.
+
+{PUBLIC_ENTRYPOINTS}
+Наступна тема: Читати мануал
\ No newline at end of file
diff --git a/source/connect_zh-cn.md b/source/connect_zh-cn.md
new file mode 100644
index 0000000..330432e
--- /dev/null
+++ b/source/connect_zh-cn.md
@@ -0,0 +1,44 @@
+# 公共测试网络
+
+如果你只是想立刻上手使用，而不想搭建物理意义上的网络的话，你可以加入公开的 Reticulum 测试网络。这是一个非正式的用于测试与实验的网络。大部分时间它都会在线，所有人都可以加入。同时，“测试”也意味着没有可用性保障。
+
+**请注意！**对于 Reticulum 的日常使用，例如消息传递和其他通信，最好使用社区提供的一个或多个公共入口点。请参阅下一节了解详细信息。
+
+测试网络运行的是最新版的 Reticulum（甚至会在正式发布之前更新）。有时实验版的 Reticulum 会被部署到测试网络的节点之上，这可能会产生奇怪的行为。如果这些都没让你感到害怕，欢迎通过 TCP 或是 I2P 加入测试网络。
+
+你仅需在 Reticulum 的配置文件中加入以下任意一个界面：
+
+```
+# Dublin Hub 的 TCP/IP 界面
+ [[RNS Testnet Dublin]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = dublin.connect.reticulum.network
+ target_port = 4965
+
+# BetweenTheBorders Hub (社区提供) 的 TCP/IP 界面
+ [[RNS Testnet BetweenTheBorders]]
+ type = TCPClientInterface
+ enabled = yes
+ target_host = reticulum.betweentheborders.com
+ target_port = 4242
+
+# I2P Hub A 界面
+ [[RNS Testnet I2P Hub A]]
+ type = I2PInterface
+ enabled = yes
+ peers = g3br23bvx3lq5uddcsjii74xgmn6y5q325ovrkq2zw2wbzbqgbuq.b32.i2p
+```
+
+测试网络中还有几个 [Nomad Network](https://github.com/markqvist/nomadnet) 节点和 [LXMF](https://github.com/markqvist/lxmf) 传播节点（propagation nodes）。
+
+# 社区入口点
+社区提供了许多可公开访问的 Reticulum 网络入口点。对于日常使用，建议使用这些入口点而不是测试网。
+
+您可以将设备或实例连接到其中一个或多个入口点，以访问它们物理连接的任何 Reticulum 网络。
+
+理想情况下，设置一个您自己的设备可以在本地访问的 Reticulum 传输节点，然后将该传输节点连接到几个公共入口点。这将提供有效的连接和冗余，以防其中任何一个出现故障。
+
+{PUBLIC_ENTRYPOINTS}
+
+下一个主题：阅读手册
diff --git a/source/credits.md b/source/credits.md
index a545670..0f7c6a3 100644
--- a/source/credits.md
+++ b/source/credits.md
@@ -18,7 +18,7 @@ A number of other modules and projects are either part of, or used by Reticulum.
The protocol design and reference implementation for Reticulum was carried out between 2014 and 2022 by Mark Qvist.
-The [Python reference implementation of Reticulum](https://github.com/markqvist/reticulum) and this website is licensed under the [MIT License](license.html). Please donate to support the continued development.
+The [Python reference implementation of Reticulum](https://github.com/markqvist/reticulum) and this website is licensed under the [Reticulum License](license.html). Please donate to support the continued development.
----------------
diff --git a/source/credits_de.md b/source/credits_de.md
index c7d1bc3..d46667c 100644
--- a/source/credits_de.md
+++ b/source/credits_de.md
@@ -18,7 +18,7 @@ Eine Reihe anderer Module und Projekte sind entweder Teil von Reticulum oder wer
Das Protokolldesign und die Referenzimplementierung für Reticulum wurden zwischen 2014 und 2022 von Mark Qvist durchgeführt.
-Die [Python Referenzimplementierung von Reticulum](https://github.com/markqvist/reticulum) und diese Website ist lizenziert unter der [MIT License](license.html). Bitte Spenden sie zur Unterstützung der weiteren Entwicklung.
+Die [Python Referenzimplementierung von Reticulum](https://github.com/markqvist/reticulum) und diese Website ist lizenziert unter der [Reticulum License](license.html). Bitte Spenden sie zur Unterstützung der weiteren Entwicklung.
----------------
diff --git a/source/credits_es.md b/source/credits_es.md
new file mode 100644
index 0000000..b16b5b8
--- /dev/null
+++ b/source/credits_es.md
@@ -0,0 +1,28 @@
+# Agradecimientos y créditos
+
+Reticulum sólo puede existir gracias a la montaña de código abierto sobre la que se construyó, a las contribuciones de todos los implicados y a todos los que han apoyado el proyecto a lo largo de los años. A todos los que han ayudado, muchas gracias.
+
+Otros módulos y proyectos forman parte o son utilizados por Reticulum. Nuestro más sincero agradecimiento a los autores y colaboradores de los siguientes proyectos:
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography), *Licencia BSD*
+- [Pure-25519](https://github.com/warner/python-pure25519) por [Brian Warner](https://github.com/warner), *Licencia MIT*
+- [Pysha2](https://github.com/thomdixon/pysha2) por [Thom Dixon](https://github.com/thomdixon), *Licencia MIT*
+- [Python-AES](https://github.com/orgurar/python-aes) por [Or Gur Arie](https://github.com/orgurar), *Licencia MIT*
+- [Curve25519.py](https://gist.github.com/nickovs/cc3c22d15f239a2640c185035c06f8a3#file-curve25519-py) por [Nicko van Someren](https://gist.github.com/nickovs), *Public Domain*
+- [I2Plib](https://github.com/l-n-s/i2plib) por [Viktor Villainov](https://github.com/l-n-s)
+- [PySerial](https://github.com/pyserial/pyserial) por Chris Liechti, *Licencia BSD*
+- [Netifaces](https://github.com/al45tair/netifaces) por [Alastair Houghton](https://github.com/al45tair), *Licencia MIT*
+- [Configobj](https://github.com/DiffSK/configobj) por Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, *Licencia BSD*
+- [Six](https://github.com/benjaminp/six) por [Benjamin Peterson](https://github.com/benjaminp), *Licencia MIT*
+- [Umsgpack.py](https://github.com/vsergeev/u-msgpack-python) por [Ivan A. Sergeev](https://github.com/vsergeev)
+- [Python](https://www.python.org)
+
+El diseño del protocolo y la implementación de referencia para Reticulum se llevaron a cabo entre 2014 y 2022 por Mark Qvist.
+
+La [referencia de la implementación de Reticulum en Python](https://github.com/markqvist/reticulum) y este sitio están licenciados bajo la [Licencia Reticulum](license_es.html). Por favor, dona para apoyar el desarrollo.
+
+----------------
+
+El Protocolo de Reticulum es propiedad compartida de todas las personas,
+
+----------------
diff --git a/source/credits_jp.md b/source/credits_jp.md
new file mode 100644
index 0000000..30d4e7e
--- /dev/null
+++ b/source/credits_jp.md
@@ -0,0 +1,27 @@
+# 謝辞とクレジット
+Reticulumは、その土台となるオープンソースの膨大な作業、関与するすべての人々の貢献、およびこれまでのプロジェクトへのサポートがあるために存在しています。手伝ってくれたすべての方々に心から感謝します。
+
+Reticulumには他にも多くのモジュールやプロジェクトが含まれており、またはそれらを使用しています。以下のプロジェクトの作者と寄与者に心から感謝します：
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography)、*BSDライセンス*
+- [Pure-25519](https://github.com/warner/python-pure25519) by [Brian Warner](https://github.com/warner)、*MITライセンス*
+- [Pysha2](https://github.com/thomdixon/pysha2) by [Thom Dixon](https://github.com/thomdixon)、*MITライセンス*
+- [Python-AES](https://github.com/orgurar/python-aes) by [Or Gur Arie](https://github.com/orgurar)、*MITライセンス*
+- [Curve25519.py](https://gist.github.com/nickovs/cc3c22d15f239a2640c185035c06f8a3#file-curve25519-py) by [Nicko van Someren](https://gist.github.com/nickovs)、*パブリックドメイン*
+- [I2Plib](https://github.com/l-n-s/i2plib) by [Viktor Villainov](https://github.com/l-n-s)
+- [PySerial](https://github.com/pyserial/pyserial) by Chris Liechti、*BSDライセンス*
+- [Netifaces](https://github.com/al45tair/netifaces) by [Alastair Houghton](https://github.com/al45tair)、*MITライセンス*
+- [Configobj](https://github.com/DiffSK/configobj) by Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright、*BSDライセンス*
+- [Six](https://github.com/benjaminp/six) by [Benjamin Peterson](https://github.com/benjaminp)、*MITライセンス*
+- [Umsgpack.py](https://github.com/vsergeev/u-msgpack-python) by [Ivan A. Sergeev](https://github.com/vsergeev)
+- [Python](https://www.python.org)
+
+Reticulumのプロトコルデザインおよびリファレンス実装は、2014年から2022年までMark Qvistによって実施されました。
+
+[ReticulumのPythonリファレンス実装](https://github.com/markqvist/reticulum)およびこのウェブサイトは、[Reticulumライセンス](license.html)の下でライセンスされています。継続的な開発をサポートするために、寄付 をお願いします。
+
+----------------
+
+Reticulumプロトコルはすべての人々の共有財産です。
+
+----------------
\ No newline at end of file
diff --git a/source/credits_nl.md b/source/credits_nl.md
new file mode 100644
index 0000000..09397f0
--- /dev/null
+++ b/source/credits_nl.md
@@ -0,0 +1,27 @@
+# Dankbetuigingen en referenties
+Reticulum kan alleen bestaan dankzij de berg Open Source-werk waarop het is gebouwd, de bijdragen van alle betrokkenen en iedereen die het project door de jaren heen heeft gesteund. Iedereen die geholpen heeft, hartelijk dank.
+
+Een aantal andere modules en projecten maken deel uit van of worden gebruikt door Reticulum. Oprechte dank aan de auteurs en medewerkers van de volgende projecten:
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography), *BSD License*
+- [Pure-25519](https://github.com/warner/python-pure25519) by [Brian Warner](https://github.com/warner), *MIT License*
+- [Pysha2](https://github.com/thomdixon/pysha2) by [Thom Dixon](https://github.com/thomdixon), *MIT License*
+- [Python-AES](https://github.com/orgurar/python-aes) by [Or Gur Arie](https://github.com/orgurar), *MIT License*
+- [Curve25519.py](https://gist.github.com/nickovs/cc3c22d15f239a2640c185035c06f8a3#file-curve25519-py) by [Nicko van Someren](https://gist.github.com/nickovs), *Public Domain*
+- [I2Plib](https://github.com/l-n-s/i2plib) by [Viktor Villainov](https://github.com/l-n-s)
+- [PySerial](https://github.com/pyserial/pyserial) by Chris Liechti, *BSD License*
+- [Netifaces](https://github.com/al45tair/netifaces) by [Alastair Houghton](https://github.com/al45tair), *MIT License*
+- [Configobj](https://github.com/DiffSK/configobj) by Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, *BSD License*
+- [Six](https://github.com/benjaminp/six) by [Benjamin Peterson](https://github.com/benjaminp), *MIT License*
+- [Umsgpack.py](https://github.com/vsergeev/u-msgpack-python) by [Ivan A. Sergeev](https://github.com/vsergeev)
+- [Python](https://www.python.org)
+
+Het protocolontwerp en de referentie-implementatie voor Reticulum werden tussen 2014 en 2022 uitgevoerd door Mark Qvist.
+
+De [Python-referentie-implementatie van Reticulum](https://github.com/markqvist/reticulum) en deze website zijn gelicentieerd onder de [Reticulum License](license.html). Doneer om de voortdurende ontwikkeling te ondersteunen.
+
+----------------
+
+Het Reticulum Protocol is het gedeelde eigendom van alle mensen,
+
+----------------
diff --git a/source/credits_pl.md b/source/credits_pl.md
index e5c71ac..e362ba1 100644
--- a/source/credits_pl.md
+++ b/source/credits_pl.md
@@ -16,9 +16,9 @@ Wiele innych modułów i projektów jest częścią lub jest wykorzystywanych pr
- [Umsgpack.py](https://github.com/vsergeev/u-msgpack-python) przez [Ivan A. Sergeev](https://github.com/vsergeev)
- [Python](https://www.python.org)
-Projekt protokołu i wdrożenie referencyjne dla Reticulum zostało zrealizowane w latach 2014-2022 przez Marka Qvista.
+Projekt protokołu i wdrożenie referencyjne dla Reticulum zostało zrealizowane w latach 2014-2022 przez Mark Qvist.
-[Implementacja referencji dla języka Python](https://github.com/markqvist/reticulum) oraz ta strona są opubliowanie na [Licencji MIT](license.html). Proszę przekaż darowiznę , żeby wesprzeć dalszy rozwój projektu.
+[Implementacja referencji dla języka Python](https://github.com/markqvist/reticulum) oraz ta strona są opubliowanie na [Licencji Reticulum](license.html). Proszę przekaż darowiznę , żeby wesprzeć dalszy rozwój projektu.
----------------
diff --git a/source/credits_pt-br.md b/source/credits_pt-br.md
index d0da83b..7f4fe5d 100644
--- a/source/credits_pt-br.md
+++ b/source/credits_pt-br.md
@@ -18,7 +18,7 @@ Uma lista de outros modelos e projetos são parte disso ou utilizado no Reticulu
O design do protocolo e implementação de referência foram desenvolvidos entre 2014 e 2022 por Mark Qvist.
-A [implementação Python referencial do Reticulum](https://github.com/markqvist/reticulum) e seu site utilizam a [licença MIT](https://reticulum.network/license.html). Por favor considere uma doação para ajudar a continuar o projeto.
+A [implementação Python referencial do Reticulum](https://github.com/markqvist/reticulum) e seu site utilizam a [licença Reticulum](https://reticulum.network/license.html). Por favor considere uma doação para ajudar a continuar o projeto.
----------------
diff --git a/source/credits_tr.md b/source/credits_tr.md
new file mode 100644
index 0000000..c6a842d
--- /dev/null
+++ b/source/credits_tr.md
@@ -0,0 +1,27 @@
+# Teşekkürler & Saygılar
+Reticulum, üzerine inşa edildiği Açık Kaynak çalışmalarının dağının ve yıllar boyunca projeye destek olan herkesin katkıları sayesinde var olabilir. Yardım eden herkese çok teşekkür ederiz.
+
+Reticulum'a ait birçok diğer modül ve proje ya Reticulum'un bir parçasıdır ya da onun tarafından kullanılmaktadır. Aşağıdaki projelerin yazarlarına ve katkıda bulunanlarına içten teşekkürler:
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography), *BSD Lisansı*
+- [Pure-25519](https://github.com/warner/python-pure25519) by [Brian Warner](https://github.com/warner), *MIT Lisansı*
+- [Pysha2](https://github.com/thomdixon/pysha2) by [Thom Dixon](https://github.com/thomdixon), *MIT Lisansı*
+- [Python-AES](https://github.com/orgurar/python-aes) by [Or Gur Arie](https://github.com/orgurar), *MIT Lisansı*
+- [Curve25519.py](https://gist.github.com/nickovs/cc3c22d15f239a2640c185035c06f8a3#file-curve25519-py) by [Nicko van Someren](https://gist.github.com/nickovs), *Genel Kamu Malı*
+- [I2Plib](https://github.com/l-n-s/i2plib) by [Viktor Villainov](https://github.com/l-n-s)
+- [PySerial](https://github.com/pyserial/pyserial) by Chris Liechti, *BSD Lisansı*
+- [Netifaces](https://github.com/al45tair/netifaces) by [Alastair Houghton](https://github.com/al45tair), *MIT Lisansı*
+- [Configobj](https://github.com/DiffSK/configobj) by Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, *BSD Lisansı*
+- [Six](https://github.com/benjaminp/six) by [Benjamin Peterson](https://github.com/benjaminp), *MIT Lisansı*
+- [Umsgpack.py](https://github.com/vsergeev/u-msgpack-python) by [Ivan A. Sergeev](https://github.com/vsergeev)
+- [Python](https://www.python.org)
+
+Reticulum'un protokol tasarımı ve referans uygulaması, 2014 ile 2022 yılları arasında Mark Qvist tarafından gerçekleştirildi.
+
+[Reticulum'un Python referans uygulaması](https://github.com/markqvist/reticulum) ve bu web sitesi [Reticulum Lisansı](license.html) altında lisanslanmıştır. Lütfen devam eden geliştirmeyi desteklemek için bağış yapın.
+
+----------------
+
+Reticulum Protokolü, tüm insanların ortak mülkiyetidir,
+
+----------------
\ No newline at end of file
diff --git a/source/credits_uk.md b/source/credits_uk.md
new file mode 100644
index 0000000..4e2ed19
--- /dev/null
+++ b/source/credits_uk.md
@@ -0,0 +1,27 @@
+# Подяки та кредити
+Reticulum може існувати тільки завдяки великій кількості відкритого програмного забезпечення, на якому він був побудований, внескам всіх, хто брав участь, і всім, хто підтримував проєкт протягом багатьох років. Усім, хто допомагав, велике спасибі.
+
+Чимало інших модулів та проєктів є частинами або використовуються Reticulum. Щира подяка авторам і контриб'юторам наступних проєктів:
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography), *BSD License*
+- [Pure-25519](https://github.com/warner/python-pure25519) від [Brian Warner](https://github.com/warner), *MIT License*
+- [Pysha2](https://github.com/thomdixon/pysha2) від [Thom Dixon](https://github.com/thomdixon), *MIT License*
+- [Python-AES](https://github.com/orgurar/python-aes) від [Or Gur Arie](https://github.com/orgurar), *MIT License*
+- [Curve25519.py](https://gist.github.com/nickovs/cc3c22d15f239a2640c185035c06f8a3#file-curve25519-py) від [Nicko van Someren](https://gist.github.com/nickovs), *Public Domain*
+- [I2Plib](https://github.com/l-n-s/i2plib) від [Viktor Villainov](https://github.com/l-n-s)
+- [PySerial](https://github.com/pyserial/pyserial) від Chris Liechti, *BSD License*
+- [Netifaces](https://github.com/al45tair/netifaces) від [Alastair Houghton](https://github.com/al45tair), *MIT License*
+- [Configobj](https://github.com/DiffSK/configobj) від Michael Foord, Nicola Larosa, Rob Dennis та Eli Courtwright, *BSD License*
+- [Six](https://github.com/benjaminp/six) від [Benjamin Peterson](https://github.com/benjaminp), *MIT License*
+- [Umsgpack.py](https://github.com/vsergeev/u-msgpack-python) від [Ivan A. Sergeev](https://github.com/vsergeev)
+- [Python](https://www.python.org)
+
+Проєктування протоколу та його референс-імплементація для Reticulum здійснювались з 2014 по 2022 рік Mark Qvist.
+
+[Python референс-імплементація Reticulum](https://github.com/markqvist/reticulum) та цей вебсайт ліцензовані за умовами [Reticulum License](license.html). Будь ласка, пожертвуйте , щоб підтримати подальший розвиток.
+
+----------------
+
+Протокол Reticulum є спільною власністю всіх людей,
+
+----------------
diff --git a/source/credits_zh-cn.md b/source/credits_zh-cn.md
new file mode 100644
index 0000000..765027b
--- /dev/null
+++ b/source/credits_zh-cn.md
@@ -0,0 +1,29 @@
+# 致谢与署名
+Reticulum 站在巨人的肩膀上。没有前人移山般的开源工作、多位贡献者的参与以及各位对本项目的支持，Reticulum 就不可能存在。非常感谢每一位帮助过这个项目的人。
+
+Reticulum 用到了一系列模块与项目。在这里，对以下项目的作者与贡献者致以诚挚的感谢。
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography), *BSD License*
+- [Pure-25519](https://github.com/warner/python-pure25519) by [Brian Warner](https://github.com/warner), *MIT License*
+- [Pysha2](https://github.com/thomdixon/pysha2) by [Thom Dixon](https://github.com/thomdixon), *MIT License*
+- [Python-AES](https://github.com/orgurar/python-aes) by [Or Gur Arie](https://github.com/orgurar), *MIT License*
+- [Curve25519.py](https://gist.github.com/nickovs/cc3c22d15f239a2640c185035c06f8a3#file-curve25519-py) by [Nicko van Someren](https://gist.github.com/nickovs), *Public Domain*
+- [I2Plib](https://github.com/l-n-s/i2plib) by [Viktor Villainov](https://github.com/l-n-s)
+- [PySerial](https://github.com/pyserial/pyserial) by Chris Liechti, *BSD License*
+- [Netifaces](https://github.com/al45tair/netifaces) by [Alastair Houghton](https://github.com/al45tair), *MIT License*
+- [Configobj](https://github.com/DiffSK/configobj) by Michael Foord, Nicola Larosa, Rob Dennis & Eli Courtwright, *BSD License*
+- [Six](https://github.com/benjaminp/six) by [Benjamin Peterson](https://github.com/benjaminp), *MIT License*
+- [Umsgpack.py](https://github.com/vsergeev/u-msgpack-python) by [Ivan A. Sergeev](https://github.com/vsergeev)
+- [Python](https://www.python.org)
+
+Reticulum 的协议设计与参考实现是由 Mark Qvist 于 2014-2022 进行的。
+
+Reticulum 的 [Python 参考实现](https://github.com/markqvist/reticulum) 以及这个网站均为 [Reticulum 授权](license.html)。若想支持 Reticulum 的开发，欢迎捐赠 。
+
+----------------
+
+Reticulum 协议是人类的共有财产
+
+----------------
+
+Siguiente tema: Agradecimientos y créditos
diff --git a/source/crypto_jp.md b/source/crypto_jp.md
new file mode 100644
index 0000000..9d8e388
--- /dev/null
+++ b/source/crypto_jp.md
@@ -0,0 +1,25 @@
+# 暗号プリミティブ
+Reticulumは、効率的で強力かつ現代的な暗号プリミティブのシンプルなスイートを使用しています。これらは、一般的な用途のCPUおよびマイクロコントローラーの両方で使用できる広く利用可能な実装を備えています。必要なプリミティブには以下が含まれます：
+
+- 署名用のEd25519
+- ECDH鍵交換用のX22519
+- 鍵導出用のHKDF
+- CBCモードでのAES-256
+- メッセージ認証用のHMAC-SHA256
+- SHA-256
+- SHA-512
+
+デフォルトのインストール構成では、`X25519`、`Ed25519`、および`AES-256-CBC`のプリミティブは[OpenSSL](https://www.openssl.org/)（[PyCA/cryptography](https://github.com/pyca/cryptography)パッケージを介して）によって提供されます。ハッシュ関数`SHA-256`および`SHA-512`は、標準のPython [hashlib](https://docs.python.org/3/library/hashlib.html)によって提供されています。`HKDF`、`HMAC`、`Token`プリミティブ、および`PKCS7`パディング関数は、常に次の内部実装によって提供されます：
+
+- [HKDF.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HKDF.py)
+- [HMAC.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HMAC.py)
+- [Token.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/Token.py)
+- [PKCS7.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/PKCS7.py)
+
+Reticulumには、すべての必要なプリミティブの純粋なPythonによる完全な実装も含まれています。Reticulumが開始されるときにシステムにOpenSSL＆PyCAが利用できない場合、Reticulumは代わりに内部の純粋なPythonプリミティブを使用します。これの取り決めの一因はパフォーマンスであり、OpenSSLバックエンドが非常に速いことです。しかし、最も重要な結果は、OpenSSLと同じくらいの精査、テスト、およびレビューを受けていないプリミティブを使用することによるセキュリティの潜在的な損失です。
+
+内部の純粋なPythonプリミティブを使用したい場合は、このリスクが許容できるかどうかを検討し、よく理解した上で情報を得ることが**強くお勧め**されます。
+
+Reticulumは比較的新しいソフトウェアであり、それに準じて考えるべきです。暗号化のベストプラクティスを非常に重視して構築されていますが、外部からのセキュリティ監査はまだ行われておらず、プライバシーやセキュリティを崩壊させる可能性があります。協力したり、監査をスポンサーしたりしたい場合は、どうぞお知らせください。
+
+次のトピック: 謝辞とクレジット
diff --git a/source/crypto_nl.md b/source/crypto_nl.md
new file mode 100644
index 0000000..8493a33
--- /dev/null
+++ b/source/crypto_nl.md
@@ -0,0 +1,26 @@
+# Cryptografische primitieven
+Reticulum maakt gebruik van een eenvoudige reeks efficiënte, sterke en moderne cryptografische primitieven, met algemeen beschikbare implementaties die zowel op CPU's voor algemene doeleinden als op microcontrollers kunnen worden gebruikt. De noodzakelijke primitieven zijn:
+
+- Ed25519 voor handtekeningen
+- X22519 voor ECDH-sleuteluitwisselingen
+- HKDF voor sleutelafleiding
+- AES-256 in CBC-modus
+- HMAC-SHA256 voor berichtauthenticatie
+- SHA-256
+- SHA-512
+
+In de standaard installatieconfiguratie worden de primitieven `X25519`, `Ed25519` en `AES-256-CBC` geleverd door [OpenSSL](https://www.openssl.org/) (via het [PyCA/cryptography](https://github.com/pyca/cryptography) pakket). De hashfuncties `SHA-256` and `SHA-512` worden geleverd door de standaard Python [hashlib](https://docs.python.org/3/library/hashlib.html). De `HKDF`, `HMAC`, `Token` primitieven en de `PKCS7` opvullingsfunctie worden altijd geleverd door de volgende interne implementaties:
+
+- [HKDF.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HKDF.py)
+- [HMAC.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HMAC.py)
+- [Token.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/Token.py)
+- [PKCS7.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/PKCS7.py)
+
+
+Reticulum bevat ook een volledige implementatie van alle benodigde primitieven in pure Python. Als OpenSSL en PyCA niet beschikbaar zijn op het systeem wanneer Reticulum wordt gestart, zal Reticulum in plaats daarvan de interne pure-python-primitieven gebruiken. Een triviaal gevolg hiervan zijn de prestaties, waarbij de OpenSSL-backend *veel* sneller is. Het belangrijkste gevolg is echter het potentiële verlies aan veiligheid door het gebruik van primitieven die niet dezelfde hoeveelheid onderzoek, testen en beoordeling hebben ondergaan als die van OpenSSL.
+
+Als u de interne pure Python-primitieven wilt gebruiken, is het **zeer aan te raden** dat u een goed inzicht heeft in de risico's die dit met zich meebrengt, en een weloverwogen beslissing neemt of deze risico's voor u acceptabel zijn.
+
+Reticulum is relatief jonge software en moet als zodanig worden beschouwd. Hoewel het is gebouwd met de best practices op het gebied van cryptografie in het achterhoofd, is er geen externe beveiligingsaudit uitgevoerd en kunnen er bugs in zitten die de privacy of de beveiliging schenden. Als u wilt helpen of een audit wilt sponsoren, neem dan contact met ons op.
+
+Volgend onderwerp: dankbetuigingen en referenties
diff --git a/source/crypto_pl.md b/source/crypto_pl.md
index 3a73154..3f34b06 100644
--- a/source/crypto_pl.md
+++ b/source/crypto_pl.md
@@ -4,16 +4,16 @@ Reticulum wykorzystuje prosty zestaw wydajnych, silnych i nowoczesnych prymityw
- Ed25519 dla sygnatur
- X22519 dla wymiany kluczy ECDH
- HKDF dla wyodrębnienia klucza
-- AES-128 w trybie CBC
+- AES-256 w trybie CBC
- HMAC-SHA256 dla uwierzytelnienia wiadomości
- SHA-256
- SHA-512
-W domyślnej konfiguracji instalacji, prymitywy `X25519`, `Ed25519` i `AES-128-CBC` są dostarczone przez [OpenSSL](https://www.openssl.org/) (przez pakiet [PyCA/cryptography](https://github.com/pyca/cryptography)). Funkcja hashu `SHA-256` i `SHA-512` są dostarczone przez standard Pythona [hashlib](https://docs.python.org/3/library/hashlib.html). Prymitywy `HKDF`, `HMAC`, `Fernet` i funkcja padding `PKCS7` są zawsze dostarczane przez następujące wewnętrzne implementacje:
+W domyślnej konfiguracji instalacji, prymitywy `X25519`, `Ed25519` i `AES-256-CBC` są dostarczone przez [OpenSSL](https://www.openssl.org/) (przez pakiet [PyCA/cryptography](https://github.com/pyca/cryptography)). Funkcja hashu `SHA-256` i `SHA-512` są dostarczone przez standard Pythona [hashlib](https://docs.python.org/3/library/hashlib.html). Prymitywy `HKDF`, `HMAC`, `Token` i funkcja padding `PKCS7` są zawsze dostarczane przez następujące wewnętrzne implementacje:
- [HKDF.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HKDF.py)
- [HMAC.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HMAC.py)
-- [Fernet.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/Fernet.py)
+- [Token.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/Token.py)
- [PKCS7.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/PKCS7.py)
diff --git a/source/crypto_pt-br.md b/source/crypto_pt-br.md
index 61fd494..d4b58a7 100644
--- a/source/crypto_pt-br.md
+++ b/source/crypto_pt-br.md
@@ -4,16 +4,16 @@ Reticulum utiliza uma suíte simples de primitivos criptográficos modernos, for
- Ed25519 para assinaturas
- X22519 para trocas de chave ECDH
- HKDF para derivação de chaves
-- AES-128 em modo CBC
+- AES-256 em modo CBC
- HMAC-SHA256 para autenticação de mensagem
- SHA-256
- SHA-512
-Na configuração de instalação padrão, os primitivos `X25519`, `Ed25519` e `AES_128-CBC` são fornecidos pela [OpenSSL](https://www.openssl.org/) (pelo pacote [PyCA/cryptography](https://github.com/pyca/cryptography) ). As funções de hash `SHA-256` e `SHA-512` são fornecidas pela biblioteca Python [hashlib](https://docs.python.org/3/library/hashlib.html). Os primitivos `HKDF`, `HMAC`, `Fernet`, e a função de preenchimento `PKCS7` são sempre fornecidas pelas seguintes implementações internas:
+Na configuração de instalação padrão, os primitivos `X25519`, `Ed25519` e `AES-256-CBC` são fornecidos pela [OpenSSL](https://www.openssl.org/) (pelo pacote [PyCA/cryptography](https://github.com/pyca/cryptography) ). As funções de hash `SHA-256` e `SHA-512` são fornecidas pela biblioteca Python [hashlib](https://docs.python.org/3/library/hashlib.html). Os primitivos `HKDF`, `HMAC`, `Token`, e a função de preenchimento `PKCS7` são sempre fornecidas pelas seguintes implementações internas:
- [HKDF.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HKDF.py)
- [HMAC.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HMAC.py)
-- [Fernet.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/Fernet.py)
+- [Token.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/Token.py)
- [PKCS7.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/PKCS7.py)
diff --git a/source/crypto_tr.md b/source/crypto_tr.md
new file mode 100644
index 0000000..1e6b36b
--- /dev/null
+++ b/source/crypto_tr.md
@@ -0,0 +1,25 @@
+# Şifreleme Temelleri
+Reticulum, genel amaçlı CPU'lerde ve mikrodenetleyicilerde kullanılabilen yaygın olarak bulunan uygulamalara sahip, etkili, güçlü ve modern bir şifreleme temel paketi kullanır. Gerekli temel öğeler şunlardır:
+
+- Dijital İmzalar için Ed25519
+- ECDH anahtar değişimleri için X22519
+- Anahtar oluşturmak için HKDF
+- CBC modunda AES-256
+- Mesaj doğrulama için HMAC-SHA256
+- SHA-256
+- SHA-512
+
+Varsayılan kurulum yapılandırmasında, `X25519`, `Ed25519` ve `AES-256-CBC` temel öğeleri, [OpenSSL](https://www.openssl.org/) (aracılığıyla [PyCA/cryptography](https://github.com/pyca/cryptography) paketi üzerinden) tarafından sağlanır. Karma fonksiyonları `SHA-256` ve `SHA-512`, standart Python [hashlib](https://docs.python.org/3/library/hashlib.html) tarafından sağlanır. `HKDF`, `HMAC`, `Token` temel öğeleri ve `PKCS7` dolgu fonksiyonu her zaman şu içsel uygulamalar tarafından sağlanır:
+
+- [HKDF.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HKDF.py)
+- [HMAC.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HMAC.py)
+- [Token.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/Token.py)
+- [PKCS7.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/PKCS7.py)
+
+Reticulum ayrıca tüm gerekli temel öğelerin saf Python'da tam bir uygulamasını içerir. Reticulum başlatıldığında sistemde OpenSSL ve PyCA kullanılamıyorsa, Reticulum bunun yerine içsel saf Python temel öğelerini kullanacaktır. Bu durumun basit bir sonucu performanstır, çünkü OpenSSL *çok* daha hızlıdır. Ancak, en önemli sonuç, OpenSSL'den daha az inceleme, test ve gözden geçirme görmemiş temellerin kullanılmasıyla güvenlik kaybının potansiyelidir.
+
+Eğer içsel saf Python temel öğelerini kullanmak istiyorsanız, bunun getirdiği riskleri iyi anlamanız ve bu risklerin sizin için kabul edilebilir olup olmadığına dair bilinçli bir karar vermeniz **son derece tavsiye edilir**.
+
+Reticulum nispeten genç bir yazılımdır ve buna göre değerlendirilmelidir. Kriptografi en iyi uygulamaları gözetilerek inşa edilmiş olmasına rağmen, dış güvenlik denetimi yapılmamıştır ve gizlilik veya güvenlik ihlali yapabilecek hatalar olabilir. Yardımcı olmak veya maddi açıdan bir güvenlik denetimi yapılmasını desteklemek istiyorsanız, lütfen iletişime geçin.
+
+Sonraki Konu: Teşekkürler ve Saygılar
\ No newline at end of file
diff --git a/source/crypto_uk.md b/source/crypto_uk.md
new file mode 100644
index 0000000..d34966f
--- /dev/null
+++ b/source/crypto_uk.md
@@ -0,0 +1,25 @@
+# Криптографічні примітиви
+Reticulum використовує простий набір ефективних, надійних і сучасних криптографічних примітивів, з широко доступними імплементаціями, які можна використовувати як на загальновживаних процесорах, так і на мікроконтролерах. Необхідні примітиви:
+
+- Ed25519 для підписів
+- X22519 для ECDH обміну ключами
+- HKDF для виведення ключів
+- AES-256 у режимі CBC
+- HMAC-SHA256 для аутентифікації повідомлень
+- SHA-256
+- SHA-512
+
+У стандартній конфігурації установки примітиви `X25519`, `Ed25519` і `AES-256-CBC` надаються [OpenSSL](https://www.openssl.org/) (через пакет [PyCA/cryptography](https://github.com/pyca/cryptography)). Функції хешування `SHA-256` і `SHA-512` надаються стандартною бібліотекою Python [hashlib](https://docs.python.org/3/library/hashlib.html). Примітиви `HKDF`, `HMAC`, `Token`, а також функція паддінгу `PKCS7` завжди надаються наступними внутрішніми імплементаціями:
+
+- [HKDF.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HKDF.py)
+- [HMAC.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HMAC.py)
+- [Token.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/Token.py)
+- [PKCS7.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/PKCS7.py)
+
+Reticulum також включає повну імплементацію всіх необхідних примітивів на чистому Python. Якщо OpenSSL і PyCA недоступні на системі під час запуску Reticulum, то замість них будуть використані внутрішні чисто-python примітиви. Легким наслідком цього є продуктивність, причому бекенд OpenSSL працює *набагато* швидше. Однак найважливіший наслідок полягає в потенційній втраті безпеки через використання примітивів, які не були піддані такій самій перевірці, тестуванню та огляду, як ті, що надаються OpenSSL.
+
+Якщо ви хочете використовувати внутрішні чисто-python примітиви, **вкрай рекомендується** добре розуміти ризики, які вони несуть, і приймати обґрунтоване рішення щодо того, чи є ці ризики для вас прийнятними.
+
+Reticulum — це відносно молода програма, і її слід розглядати саме як таку. Хоча вона була створена з урахуванням найкращих практик криптографії, вона _не проходила_ зовнішнього аудиту безпеки, і цілком ймовірно, що існують помилки, які можуть зламати конфіденційність або безпеку. Якщо ви хочете допомогти або спонсорувати аудит, будь ласка, зв'яжіться з нами.
+
+Наступна тема: Подяки та кредити
diff --git a/source/crypto_zh-cn.md b/source/crypto_zh-cn.md
new file mode 100644
index 0000000..5ed680e
--- /dev/null
+++ b/source/crypto_zh-cn.md
@@ -0,0 +1,25 @@
+# 密码学原语
+Reticulum 使用了一系列高效、健壮、现代的密码学原语(cryptographic primitives)。它们都有着被广泛使用的现成的实现，且在一般的 CPU 或是微控制器上都可以运行。这些必要的原语是：
+
+- Ed25519 用于签名
+- X22519 用于 ECDH 密钥交换
+- HKDF 用于密钥派生
+- AES-256 CBC 模式
+- HMAC-SHA256 用于消息认证
+- SHA-256
+- SHA-512
+
+在默认安装下，`X25519`、`Ed25519` 和 `AES-256-CBC` 都由 [OpenSSL](https://www.openssl.org/) 提供(通过 [PyCA/cryptography](https://github.com/pyca/cryptography))。散列函数 `SHA-256` 和 `SHA-512` 由 Python 标准库 [hashlib](https://docs.python.org/3/library/hashlib.html) 提供。`HKDF`、`HMAC`、`Token` 原语与 `PKCS7` 填充函数总是由以下内部实现提供：
+
+- [HKDF.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HKDF.py)
+- [HMAC.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/HMAC.py)
+- [Token.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/Token.py)
+- [PKCS7.py](https://github.com/markqvist/Reticulum/blob/master/RNS/Cryptography/PKCS7.py)
+
+Reticulum 还包含了所有所需密码学原语的纯 Python 实现。如果 OpenSSL 和 PyCA 在系统上不可用的话，Reticulum 会使用自带的纯 Python 实现。这时，最明显的影响是速度——OpenSSL作为后端会*快的多*。然而最严重的后果可能是使用这些实现带来的安全性问题，毕竟它们没有经受过与 OpenSSL 同级别的安全审查、测试与评估。
+
+如果你想使用自带的纯 Python 实现，我十分建议你先充分了解可能的风险，并仔细思考这些风险是否适用于你。
+
+Reticulum 目前还十分年轻，这一点必须牢记于心。虽说 Reticulum 的开发尽量遵守了密码学的最佳实践，但它*还没有*受过外部的安全审计，而且很可能会有破坏隐私或是安全性的 Bug。如果你愿意帮忙，或是愿意赞助进行安全审计，欢迎联系开发者。
+
+下一个主题: 致谢与署名
diff --git a/source/docs.md b/source/docs.md
index 65ac44f..73ba8ed 100644
--- a/source/docs.md
+++ b/source/docs.md
@@ -1,6 +1,6 @@
# Read The Manual
You can browse full documentation for Reticulum [on this site](manual/index.html) or [on GitHub Pages](https://markqvist.github.io/Reticulum/manual/).
-You can also [download the Reticulum manual as a PDF](manual/Reticulum%20Manual.pdf)
+You can also [download the Reticulum manual as a PDF](manual/Reticulum%20Manual.pdf) or in [EPUB format](manual/Reticulum%20Manual.epub).
Next Topic: Cryptographic Primitives
diff --git a/source/docs_de.md b/source/docs_de.md
index 31d3dc7..0df1fc9 100644
--- a/source/docs_de.md
+++ b/source/docs_de.md
@@ -1,6 +1,6 @@
# Lesen Sie das Handbuch
Die vollständige Dokumentation zu Reticulum finden Sie hier [Auf dieser Seite](manual/index.html) oder [auf den GitHub Seiten](https://markqvist.github.io/Reticulum/manual/).
-Sie können auch [das Reticulum-Handbuch als PDF herunterladen](manual/Reticulum%20Manual.pdf)
+Sie können auch [das Reticulum-Handbuch als PDF](manual/Reticulum%20Manual.pdf) oder [EPUB](manual/Reticulum%20Manual.epub) herunterladen.
Nächstes Thema: Kryptographische Primitive
diff --git a/source/docs_es.md b/source/docs_es.md
new file mode 100644
index 0000000..8bb9071
--- /dev/null
+++ b/source/docs_es.md
@@ -0,0 +1,9 @@
+# Leer el manual
+
+Puede consultar la documentación completa de Reticulum [en este sitio](manual/index.html) o [en GitHub Pages](https://markqvist.github.io/Reticulum/manual/).
+
+También puede [descargar el manual de Reticulum en formato PDF](manual/Reticulum%20Manual.pdf) o en [formato EPUB](manual/Reticulum%20Manual.epub).
+
+Por el momento sólo está disponible en Inglés.
+
+Ooootro tema: Primitivas criptográficas
diff --git a/source/docs_jp.md b/source/docs_jp.md
new file mode 100644
index 0000000..076ca93
--- /dev/null
+++ b/source/docs_jp.md
@@ -0,0 +1,6 @@
+# マニュアルを読む
+Reticulumの完全なドキュメンテーションは、[このサイト](manual/index.html)または[GitHub Pages](https://markqvist.github.io/Reticulum/manual/)で閲覧できます。
+
+[ReticulumマニュアルをPDFでダウンロード](manual/Reticulum%20Manual.pdf)するか、[EPUB形式](manual/Reticulum%20Manual.epub)で入手することもできます。
+
+次のトピック: 暗号プリミティブ
diff --git a/source/docs_nl.md b/source/docs_nl.md
new file mode 100644
index 0000000..e6fd27f
--- /dev/null
+++ b/source/docs_nl.md
@@ -0,0 +1,6 @@
+# Lees de handleiding
+U kunt door de volledige documentatie voor Reticulum bladeren [op deze site](manual/index.html) of [op GitHub Pages](https://markqvist.github.io/Reticulum/manual/).
+
+U kunt ook [de Reticulum-handleiding downloaden als PDF](manual/Reticulum%20Manual.pdf) of in [EPUB format](manual/Reticulum%20Manual.epub).
+
+Volgend onderwerp: cryptografische primitieven
diff --git a/source/docs_pl.md b/source/docs_pl.md
index 2a2a3d8..0df3c00 100644
--- a/source/docs_pl.md
+++ b/source/docs_pl.md
@@ -1,6 +1,6 @@
# Przeczytaj Podręcznik
Możesz sprawdzić pełną dokumentację Reticulum [na tej stronie](manual/index.html) lub [na stronach GitHub](https://markqvist.github.io/Reticulum/manual/).
-Możesz również [pobrać podręcznik Reticulum jako PDF](manual/Reticulum%20Manual.pdf)
+Możesz również [pobrać podręcznik Reticulum jako PDF](manual/Reticulum%20Manual.pdf) lub [EPUB](manual/Reticulum%20Manual.epub).
Następny Temat: Prymitywy Kryptograficzne
diff --git a/source/docs_pt-br.md b/source/docs_pt-br.md
index 07d0834..444e880 100644
--- a/source/docs_pt-br.md
+++ b/source/docs_pt-br.md
@@ -1,6 +1,6 @@
# Leia o Manual
Você navegar por toda documentação do Reticulum [neste site](https://reticulum.network/manual/index.html) ou no [GitHub Pages](https://markqvist.github.io/Reticulum/manual/).
-Você também pode baixar o [manual do Reticulum como PDF](https://reticulum.network/manual/Reticulum%20Manual.pdf)
+Você também pode baixar o [manual do Reticulum como PDF](https://reticulum.network/manual/Reticulum%20Manual.pdf) ou [EPUB](manual/Reticulum%20Manual.epub).
Próxima Página: Criptografia
diff --git a/source/docs_tr.md b/source/docs_tr.md
new file mode 100644
index 0000000..c94c7e7
--- /dev/null
+++ b/source/docs_tr.md
@@ -0,0 +1,6 @@
+# Kılavuzu Okuyun
+Reticulum için tam belgelendirmeyi bu site üzerinden [inceleyebilirsiniz](manual/index.html) veya [GitHub Pages'te](https://markqvist.github.io/Reticulum/manual/) bulabilirsiniz.
+
+Ayrıca Reticulum kılavuzunu [PDF olarak indirebilirsiniz](manual/Reticulum%20Manual.pdf) veya [EPUB formatında](manual/Reticulum%20Manual.epub).
+
+Sonraki Konu: Şifreleme Temelleri
\ No newline at end of file
diff --git a/source/docs_uk.md b/source/docs_uk.md
new file mode 100644
index 0000000..6f69a87
--- /dev/null
+++ b/source/docs_uk.md
@@ -0,0 +1,7 @@
+# Читайте інструкцію
+Ви можете переглядати повну документацію для Reticulum [на цьому сайті](manual/index.html) або [на GitHub Pages](https://markqvist.github.io/Reticulum/manual/).
+
+Ви також можете [завантажити інструкцію Reticulum у форматі PDF](manual/Reticulum%20Manual.pdf) або в [форматі EPUB](manual/Reticulum%20Manual.epub).
+
+Наступна тема: Криптографічні примітиви
+
diff --git a/source/docs_zh-cn.md b/source/docs_zh-cn.md
new file mode 100644
index 0000000..87f0c80
--- /dev/null
+++ b/source/docs_zh-cn.md
@@ -0,0 +1,6 @@
+# 阅读手册
+你可以在[本站](manual/index.html)或是[GitHub Pages](https://markqvist.github.io/Reticulum/manual/)阅读完整的文档。
+
+此外，你还可以下载[PDF](manual/Reticulum%20Manual.pdf)或是[EPUB](manual/Reticulum%20Manual.epub)格式的文档以供离线查看。
+
+下一个主题: 密码学原语
diff --git a/source/donate.md b/source/donate.md
index 8c95cd5..1c1c870 100644
--- a/source/donate.md
+++ b/source/donate.md
@@ -6,15 +6,18 @@ You can help support the continued development of open, free and private communi
84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
```
`https://liberapay.com/Reticulum/`
+ `https://ko-fi.com/markqvist`
\ No newline at end of file
diff --git a/source/donate_de.md b/source/donate_de.md
index d04fbdd..e71ca13 100644
--- a/source/donate_de.md
+++ b/source/donate_de.md
@@ -1,15 +1,23 @@
## Reticulum Entwicklung unterstützen
Sie können die weitere Entwicklung offener, freier und privater Kommunikationssysteme unterstützen, indem Sie über einen der folgenden Kanäle spenden:
-**Monero**
-```
-84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
-```
-**Ethereum**
-```
-0x81F7B979fEa6134bA9FD5c701b3501A2e61E897a
-```
-**Bitcoin**
-```
-3CPmacGm34qYvR6XWLVEJmi2aNe3PZqUuq
-```
+- Monero`https://liberapay.com/Reticulum/`
+ `https://ko-fi.com/markqvist`
\ No newline at end of file
diff --git a/source/donate_es.md b/source/donate_es.md
new file mode 100644
index 0000000..5ee62a9
--- /dev/null
+++ b/source/donate_es.md
@@ -0,0 +1,23 @@
+## Apoya Reticulum
+Podes contribuir al desarrollo de sistemas de comunicaciones abiertas, libres y privadas haciendo una donación a través de uno de los siguientes canales:
+
+- Monero`https://liberapay.com/Reticulum/`
+ `https://ko-fi.com/markqvist`
\ No newline at end of file
diff --git a/source/donate_jp.md b/source/donate_jp.md
new file mode 100644
index 0000000..1d63289
--- /dev/null
+++ b/source/donate_jp.md
@@ -0,0 +1,23 @@
+## レティクラムのサポート
+あなたは、以下のチャンネルを通じて寄付を行うことで、オープンで無料、かつプライベートな通信システムの継続的な開発をサポートできます：
+
+- Monero`https://liberapay.com/Reticulum/`
+ `https://ko-fi.com/markqvist`
\ No newline at end of file
diff --git a/source/donate_nl.md b/source/donate_nl.md
new file mode 100644
index 0000000..8ec8391
--- /dev/null
+++ b/source/donate_nl.md
@@ -0,0 +1,23 @@
+## Ondersteun Reticulum
+U kunt de voortdurende ontwikkeling van open, vrije en particuliere communicatiesystemen helpen ondersteunen door te doneren via een van de volgende kanalen:
+
+- Monero`https://liberapay.com/Reticulum/`
+ `https://ko-fi.com/markqvist`
\ No newline at end of file
diff --git a/source/donate_pl.md b/source/donate_pl.md
index bd8b253..a701481 100644
--- a/source/donate_pl.md
+++ b/source/donate_pl.md
@@ -6,15 +6,18 @@ Możesz wspomóc dalszy rozwój otwartych, wolnych, prywatnych systemów komunik
84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
```
`https://liberapay.com/Reticulum/`
+ `https://ko-fi.com/markqvist`
\ No newline at end of file
diff --git a/source/donate_pt-br.md b/source/donate_pt-br.md
index 9ff9710..e85dcb9 100644
--- a/source/donate_pt-br.md
+++ b/source/donate_pt-br.md
@@ -6,15 +6,18 @@ Você pode ajudar na continuação do desenvolvimento de sistemas de comunicaç
84FpY1QbxHcgdseePYNmhTHcrgMX4nFfBYtz2GKYToqHVVhJp8Eaw1Z1EedRnKD19b3B8NiLCGVxzKV17UMmmeEsCrPyA5w
```
`https://liberapay.com/Reticulum/`
+ `https://ko-fi.com/markqvist`
\ No newline at end of file
diff --git a/source/donate_tr.md b/source/donate_tr.md
new file mode 100644
index 0000000..5ec36d9
--- /dev/null
+++ b/source/donate_tr.md
@@ -0,0 +1,23 @@
+## Reticulum'u Destekle
+Açık, özgür ve özel iletişim sistemlerinin sürekli gelişimine destek olabilirsiniz, aşağıdaki kanallardan biri aracılığıyla bağış yaparak:
+
+- Monero`https://liberapay.com/Reticulum/`
+ `https://ko-fi.com/markqvist`
\ No newline at end of file
diff --git a/source/donate_uk.md b/source/donate_uk.md
new file mode 100644
index 0000000..00f2ba4
--- /dev/null
+++ b/source/donate_uk.md
@@ -0,0 +1,23 @@
+## Підтримати Reticulum
+Ви можете допомогти підтримати подальший розвиток відкритих, безкоштовних та приватних комунікаційних систем, зробивши донат через один із наступних каналів:
+
+- Monero`https://liberapay.com/Reticulum/`
+ `https://ko-fi.com/markqvist`
\ No newline at end of file
diff --git a/source/donate_zh-cn.md b/source/donate_zh-cn.md
new file mode 100644
index 0000000..cd14084
--- /dev/null
+++ b/source/donate_zh-cn.md
@@ -0,0 +1,23 @@
+## 支持 Reticulum
+你可以通过以下途径来支持这一开放、自由、私密的通信系统的开发。
+
+- Monero`https://liberapay.com/Reticulum/`
+ `https://ko-fi.com/markqvist`
\ No newline at end of file
diff --git a/source/hardware_es.md b/source/hardware_es.md
new file mode 100644
index 0000000..35ef26b
--- /dev/null
+++ b/source/hardware_es.md
@@ -0,0 +1,21 @@
+# Hardware soportado
+Reticulum puede utilizarse en prácticamente cualquier medio que admita al menos un canal semidúplex con un rendimiento de 500 bits por segundo y una MTU de 500 bytes. Radios de datos, módems, radios LoRa, líneas seriales, TNC AX.25, modos digitales de radio-aficionados, dispositivos WiFi y Ethernet, enlaces ópticos de espacio libre y sistemas similares son ejemplos de los tipos de dispositivos físicos que puede utilizar Reticulum. Los tipos de interfaz admitidos incluyen:
+
+- Cualquier dispositivo Ethernet
+- Casi todo el hardware basado en WiFi
+- LoRa utilizando [RNode](https://unsigned.io/rnode/)
+- TNCs de Radio en paquetes (con o sin AX.25)
+- Módems de hardware y software compatibles con KISS
+- Cualquier dispositivo con puerto serial
+- TCP sobre redes IP
+- UDP sobre redes IP
+- Programas externos a través de stdio o pipes
+- Hardware personalizado a través de stdio o pipes
+
+Para obtener información más detallada y una lista completa de los tipos de interfaz compatibles, lea los capítulos [Hardware de comunicaciones](manual/hardware.html) e [Interfaces compatibles](manual/interfaces.html) del manual.
+
+Reticulum también puede encapsularse sobre redes IP existentes, por lo que nada le impide utilizarlo a través de Ethernet por cable, su red WiFi local o Internet, donde funcionará igual de bien. De hecho, uno de los puntos fuertes de Reticulum es la facilidad con la que permite conectar diferentes medios en una malla autoconfigurable, resistente y encriptada, utilizando cualquier mezcla de infraestructura disponible.
+
+Como ejemplo, se puede setear una Raspberry Pi conectada a un dispositivo LoRa, una radio en paquetes TNC y una red WiFi. Cuando las interfaces estén configuradas, Reticulum se hace cargo del resto, y cualquier dispositivo en la red se va a poder comunicar con nodos que estén en LoRa y/o radio en paquetes de la red y viceversa.
+
+Siguiente tema: Testnet publica
diff --git a/source/hardware_jp.md b/source/hardware_jp.md
new file mode 100644
index 0000000..4bad861
--- /dev/null
+++ b/source/hardware_jp.md
@@ -0,0 +1,19 @@
+# サポートされているハードウェア
+Reticulumは、少なくともハーフデュプレックスチャネルとして500ビット/秒のスループット、および500バイトのMTUをサポートできるほぼすべてのメディアで使用できます。データラジオ、モデム、LoRaラジオ、シリアルライン、AX.25 TNC、アマチュアラジオデジタルモード、WiFiおよびEthernetデバイス、フリースペース光通信リンクなど、これらはReticulumが使用できる物理デバイスの例です。サポートされるインターフェースのタイプは以下の通りです。
+
+- 任意のEthernetデバイス
+- ほぼすべてのWiFiベースのハードウェア
+- [RNode](https://unsigned.io/rnode/) を使用したLoRa
+- パケットラジオTNC（AX.25ありまたはなし）
+- KISS互換のハードウェアおよびソフトウェアモデム
+- シリアルポートを持つ任意のデバイス
+- IPネットワーク上のTCP
+- IPネットワーク上のUDP
+- stdioまたはパイプを介した外部プログラム
+- stdioまたはパイプを介したカスタムハードウェア
+
+詳細な情報やサポートされているインターフェースタイプの完全なリストについては、[Communications Hardware](manual/hardware.html) および [Supported Interfaces](manual/interfaces.html) マニュアルの章を参照してください。
+
+Reticulumは既存のIPネットワーク上にカプセル化されるため、有線Ethernet、ローカルWiFiネットワーク、またはインターネットを介しても利用できます。実際、Reticulumの強みの一つは、さまざまな媒体を容易に自己設定、強固で暗号化されたメッシュに接続できるようにすることです。利用可能な基盤の組み合わせを使用して、ラズベリーパイをLoRaラジオ、パケットラジオTNC、およびWiFiネットワークに接続することができます。インターフェースが構成されると、Reticulumが残りの作業を処理し、WiFiネットワーク上の任意のデバイスがネットワークのLoRaおよびパケットラジオ側のノードと双方向に通信できます。
+
+次のトピック: パブリックテストネット
\ No newline at end of file
diff --git a/source/hardware_nl.md b/source/hardware_nl.md
new file mode 100644
index 0000000..c1ae61e
--- /dev/null
+++ b/source/hardware_nl.md
@@ -0,0 +1,21 @@
+# Ondersteunde hardware
+Reticulum kan worden gebruikt via vrijwel elk medium dat ten minste een half-duplex kanaal met een doorvoersnelheid van 500 bits per seconde en een MTU van 500 bytes kan ondersteunen. Dataradio's, modems, LoRa-radio's, seriële lijnen, AX.25 TNC's, digitale amateurradiomodi, WiFi- en Ethernet-apparaten, optische verbindingen in de vrije ruimte en soortgelijke systemen zijn allemaal voorbeelden van de soorten fysieke apparaten die Reticulum kan gebruiken. De ondersteunde interfacetypen zijn onder meer:
+
+- Elke ethernetinterface
+- Bijna alle op WiFi gebaseerde hardware
+- LoRa met behulp van [RNode](https://unsigned.io/rnode/)
+- Packet Radio TNC's (met of zonder AX.25)
+- KISS-compatibele hardware- en softwaremodems
+- Elk apparaat met een seriële poort
+- TCP over IP-netwerken
+- UDP via IP-netwerken
+- Externe programma's via stdio of pipelines
+- Aangepaste hardware via stdio of pijpen
+
+Voor meer gedetailleerde informatie en een volledige lijst met ondersteunde interfacetypen kunt u de hoofdstukken [Communicatiehardware](manual/hardware.html) en [Ondersteunde interfaces](manual/interfaces.html) van de handleiding lezen.
+
+Reticulum kan ook worden ingekapseld over bestaande IP-netwerken, dus niets houdt u tegen om het te gebruiken via bedraad ethernet, uw lokale WiFi-netwerk of internet, waar het net zo goed zal werken. Een van de sterke punten van Reticulum is in feite hoe gemakkelijk u verschillende media kunt verbinden tot een zelfconfigurerend, veerkrachtig en gecodeerd netwerk, met behulp van elke beschikbare mix van beschikbare infrastructuur.
+
+Het is bijvoorbeeld mogelijk om een Raspberry Pi op te zetten die is aangesloten op zowel een LoRa-radio, een packet-radio-TNC als een WiFi-netwerk. Zodra de interfaces zijn geconfigureerd, zorgt Reticulum voor de rest, en elk apparaat op het WiFi-netwerk kan communiceren met knooppunten aan de LoRa- en pakketradiozijde van het netwerk, en vice versa.
+
+Volgend onderwerp: openbaar testnet
diff --git a/source/hardware_tr.md b/source/hardware_tr.md
new file mode 100644
index 0000000..bb95878
--- /dev/null
+++ b/source/hardware_tr.md
@@ -0,0 +1,21 @@
+# Desteklenen Donanım
+Reticulum, en az yarı dubleks bir kanalı ve saniyede 500 bit iletim hızını destekleyebilen neredeyse her ortamda kullanılabilir ve MTU değeri 500 byte olan bir ortamda çalışabilir. Veri radyoları, modemler, LoRa radyoları, seri hatlar, AX.25 TNC'ler, amatör telsiz dijital modları, WiFi ve Ethernet cihazları, serbest uzay optik bağlantılar ve benzeri sistemler, Reticulum'un kullanabileceği fiziksel cihaz türlerine örnek olarak verilebilir. Desteklenen arayüz türleri şunları içerir:
+
+- Herhangi bir Ethernet cihazı
+- Neredeyse tüm WiFi tabanlı donanımlar
+- [RNode](https://unsigned.io/rnode/) kullanılarak LoRa
+- Paket Radyo TNC'leri (AX.25 ile veya olmadan)
+- KISS uyumlu donanım ve yazılım modemleri
+- Bir dizi seri porta sahip herhangi bir cihaz
+- IP ağları üzerinden TCP
+- IP ağları üzerinden UDP
+- stdio veya borular aracılığıyla harici programlar
+- stdio veya borular aracılığıyla özel donanım
+
+Daha fazla bilgi ve desteklenen arayüz türlerinin tam listesi için lütfen [İletişim Donanımı](manual/hardware.html) ve [Desteklenen Arayüzler](manual/interfaces.html) bölümlerini okuyun.
+
+Reticulum ayrıca mevcut IP ağları üzerinde de kapsülleyebilir, bu nedenle onu kablolu Ethernet, yerel WiFi ağınız veya İnternet üzerinden kullanmanıza engel bir şey yok, burada da aynı şekilde çalışacaktır. Aslında, Reticulum'un güçlü yanlarından biri, farklı ortamları kolayca birbirine bağlama yeteneğidir; bu, mevcut altyapının herhangi bir karışımını kullanarak özelleştirilebilir, dayanıklı ve şifreli bir mesh ağı oluşturmanıza izin verir.
+
+Örneğin, bir Raspberry Pi'nin hem bir LoRa radyosuna, bir paket radyo TNC'sine ve bir WiFi ağına bağlı olduğu bir yapı kurmak mümkündür. Arayüzler yapılandırıldığında, Reticulum gerisini halledecek ve WiFi ağındaki herhangi bir cihaz, ağın LoRa ve paket radyo taraflarındaki düğümlerle iletişim kurabilir, ve tam tersi.
+
+Sonraki Konu: Genel Test Ağı
\ No newline at end of file
diff --git a/source/hardware_uk.md b/source/hardware_uk.md
new file mode 100644
index 0000000..c9ac172
--- /dev/null
+++ b/source/hardware_uk.md
@@ -0,0 +1,21 @@
+# Підтримуване обладнання
+Reticulum можна використовувати практично через будь-який медіум, який підтримує хоча б напівдуплексний канал з пропускною здатністю 500 біт на секунду і MTU 500 байт. Прикладом фізичних пристроїв, через які можна використовувати Reticulum, є радіостанції даних, модеми, LoRa радіостанції, серійні лінії, TNC AX.25, цифрові режими аматорського радіо, WiFi та Ethernet пристрої, оптичні лінії вільного простору та подібні системи. Підтримувані типи інтерфейсів включають:
+
+- Будь-який Ethernet пристрій
+- Майже все обладнання на базі WiFi
+- LoRa з використанням [RNode](https://unsigned.io/rnode/)
+- TNC для пакетного радіо (з або без AX.25)
+- Апаратура та програмні модеми сумісні з KISS
+- Будь-який пристрій з серійним портом
+- TCP через IP мережі
+- UDP через IP мережі
+- Зовнішні програми через stdio або канали
+- Користувацьке обладнання через stdio або канали
+
+Для більш детальної інформації та повного списку підтримуваних типів інтерфейсів, будь ласка, ознайомтесь з розділами [Комунікаційне обладнання](manual/hardware.html) та [Підтримувані інтерфейси](manual/interfaces.html) у посібнику.
+
+Reticulum також може бути інкапсульований через існуючі IP мережі, тому немає жодних обмежень у використанні його через дротовий Ethernet, вашу локальну WiFi мережу або Інтернет, де він працюватиме так само добре. Насправді, однією з переваг Reticulum є те, як легко він дозволяє підключати різні медіуми до самоконфігурованої, стійкої та зашифрованої мережі, використовуючи будь-яку доступну суміш доступної інфраструктури.
+
+Наприклад, можна налаштувати Raspberry Pi, підключений до радіо LoRa, TNC для пакетного радіо та WiFi мережі. Після налаштування інтерфейсів, Reticulum подбає про решту, і будь-який пристрій у WiFi мережі зможе спілкуватися з вузлами в мережі LoRa і пакетного радіо, і навпаки.
+
+Наступна тема: Публічний тестнет
diff --git a/source/hardware_zh-cn.md b/source/hardware_zh-cn.md
new file mode 100644
index 0000000..77925fb
--- /dev/null
+++ b/source/hardware_zh-cn.md
@@ -0,0 +1,21 @@
+# 硬件支持
+Reticulum 可以被用于任意一个最低支持 500 bps 吞吐量、具有 500 字节 MTU(最大传输单元)的半双工或全双工信道上。Reticulum 支持各种物理设备：数字无线电、调制解调器、LoRa 无线电、串口线、AX.25 终端节点控制器(TNCs)、业余无线电台的数字模式、WiFi与以太网、自由空间光通信……以下是一个简单列表：
+
+- 任意以太网设备
+- 几乎所有基于 WiFi 的硬件
+- LoRa (使用 [RNode](https://unsigned.io/rnode/))
+- 封包无线电 TNC(带或不带 AX.25 均可)
+- 兼容KISS的硬件或软件调制解调器
+- 任何带串口的设备
+- TCP over IP
+- UDP over IP
+- 外部程序(通过 stdio 或是管道)
+- 自制硬件(通过 stdio 或是管道)
+
+若想了解更多细节或是查看完整的支持列表，请参阅手册的[通信硬件(Communications Hardware)](manual/hardware.html)与[受支持的界面(Supported Interfaces)](manual/interfaces.html)部分。
+
+Reticulum 也可以在现有的 IP 网络之上建立连接，所以你也能在有线以太网，本地无线网或是互联网上使用它。事实上，Reticulum 的一大优势就是允许你混合使用各种基础设施，把不同的传输介质连接成一个自配置、自恢复、强加密的网状网络。
+
+譬如，你可以搭建一个连着 LoRa 无线电、封包无线电 TNC 和 WiFi 的树莓派。在这些硬件都设置好之后，Reticulum 会处理剩下的一切——所有在 WiFi 一侧的设备便可以和无线电一侧的设备自由通信了，反之亦然。
+
+下一个主题: 公共测试网络
diff --git a/source/index_es.md b/source/index_es.md
new file mode 100644
index 0000000..c5f8f93
--- /dev/null
+++ b/source/index_es.md
@@ -0,0 +1,31 @@
+# Reticulum
+
+Reticulum es **la** infraestructura basada en criptografía para construir redes locales y de área amplia (WAN) utilizando hardware fácilmente disponible. Reticulum puede continuar operando incluso en condiciones adversas con latencia muy alta y ancho de banda extremadamente bajo.
+
+ La visión de Reticulum es permitir que cualquiera opere sus propias redes de comunicación soberanas, hacerlo barato y que cubrir vastas áreas con una multitud de redes independientes, interconectables y autónomas sea fácil. Reticulum es Redes Imparables para La Gente.
+
+
+
+Reticulum no es una red. Es una herramienta para construir miles de redes. Redes sin interruptores de apagado, vigilancia, censura y control. Redes que pueden operar libremente entre sí, asociarse y desasociarse entre ellas. Reticulum es Redes para Personas.
+
+
+Desde la perspectiva de un usuario, Reticulum permite crear aplicaciones que respetan y fortalecen la autonomía y soberanía de comunidades e individuos.
+Reticulum ofrece comunicación digital segura que no puede someterse a control externo, manipulación o censura.
+
+Reticulum permite la construcción de redes tanto pequeñas como potencialmente a escala planetaria, sin necesidad de estructuras jerárquicas o burocráticas para controlarlas o administrarlas, mientras garantiza que las personas y comunidades tengan plena soberanía sobre sus propios segmentos de red.
+
+## Características Destacadas
+
+Reticulum resuelve el mismo problema que cualquier infraestructura de redes, es decir, transmitir información de forma fiable de un punto a otro a través de un número indeterminado de intermediarios, pero lo hace de una forma muy diferente a otras tecnologías.
+
+- Reticulum no utiliza direcciones de origen. Ningún paquete transmitido incluye información sobre la dirección, lugar, máquina o persona desde donde se originó.
+- No hay control central sobre el espacio de direcciones en Reticulum. Cada uno puede asignar tantas direcciones como necesite, cuando lo necesite.
+- Reticulum garantiza conexión de extremo a extremo. Las direcciones recién generadas se vuelven globalmente alcanzables en un plazo que va de segundos a solo unos minutos.
+- Las direcciones son *soberanas* y *portátiles*. Una vez creada una dirección, puede ser movida físicamente a otro lugar en la red y seguir siendo alcanzable.
+- Toda la comunicación está cifrada de forma predeterminada con [encriptación potente y moderna](crypto_es.html).
+- Todas las claves de encriptación son efímeras y la comunicación ofrece *secreto hacia adelante* por defecto.
+- Es imposible establecer enlaces sin cifrar en redes Reticulum.
+- Es imposible enviar paquetes sin cifrar a destinos en la red.
+- Los destinos que reciban paquetes sin cifrar, los descartaran como paquetes inválidos.
+
+Siguiente tema: Empezar
diff --git a/source/index_jp.md b/source/index_jp.md
new file mode 100644
index 0000000..8fcae5e
--- /dev/null
+++ b/source/index_jp.md
@@ -0,0 +1,27 @@
+# レティクル
+レティクルは、利用可能なハードウェアを使用してローカルおよび広域ネットワークを構築するための、暗号ベースのネットワーキングスタックです。レティクルは、非常に高いレイテンシと極めて低い帯域幅の逆境条件でも動作を継続することができます。
+
+レティクルのビジョンは、誰もが独自の通信ネットワークを運営し、多くの独立した、相互接続可能で自律的なネットワークで広範囲をカバーすることが安価かつ容易になるようにすることです。レティクルは、人々のための停止できないネットワークです。
+
+
+
+レティクルは *1 つの* ネットワークではありません。それは *数千のネットワーク* を構築するためのツールです。キルスイッチ、監視、検閲、および制御のないネットワーク。これらは自由に相互運用し、結びつき、解結することができるネットワークです。レティクルは、人間のためのネットワークです。
+
+ユーザーの視点から見ると、レティクルはコミュニティと個人の自治および主権を尊重し、強化するアプリケーションの作成を可能にします。レティクルは外部の制御、操作、または検閲を受けることのない安全なデジタルコミュニケーションを提供します。
+
+レティクルは、階層的またはビューロクラティックな構造が必要なく、個人やコミュニティが独自のネットワークセグメントに対して完全な主権を確保しながら、小規模なネットワークから潜在的な地球規模のネットワークまでの構築を可能にします。
+
+## 注目すべき特徴
+レティクルは、他のネットワーキング技術とは非常に異なる方法で、任意の中間者を介してデータを信頼性をもって一点から別の点まで取得するという同じ問題を解決します。
+
+- レティクルはソースアドレスを使用しません。転送されるパケットには、それが発信元のアドレス、場所、マシン、または人物に関する情報が含まれません。
+- レティクルにおいてアドレススペースに対する中央制御はありません。必要なだけ多くのアドレスを割り当てることができ、必要な時にそれを行うことができます。
+- レティクルはエンドツーエンドの接続性を確保します。新しく生成されたアドレスは、数秒から数分でグローバルに到達可能になります。
+- アドレスは *自己主権* かつ *携帯可能* です。アドレスが一度作成されると、物理的にネットワーク内の別の場所に移動し、引き続き到達可能です。
+- すべての通信は、[強力で現代的な暗号化](crypto.html)によってデフォルトで保護されています。
+- すべての暗号鍵は一時的であり、通信はデフォルトで前方秘匿を提供します。
+- レティクルネットワークでは非暗号化のリンクを確立することはできません。
+- レティクルネットワークへの宛先に対して非暗号化のパケットを送信することはできません。
+- 非暗号化のパケットを受信した宛先は、それらを無効として破棄します。
+
+次のトピック: はじめに
\ No newline at end of file
diff --git a/source/index_nl.md b/source/index_nl.md
new file mode 100644
index 0000000..906044c
--- /dev/null
+++ b/source/index_nl.md
@@ -0,0 +1,28 @@
+
+# Reticulum
+Reticulum is de op cryptografie gebaseerde netwerkstack voor het bouwen van lokale en wide-area-netwerken met direct beschikbare hardware. Reticulum kan zelfs onder ongunstige omstandigheden blijven werken met een zeer hoge latentie en extreem lage bandbreedte.
+
+De visie van Reticulum is om iedereen in staat te stellen zijn eigen soevereine communicatienetwerken te exploiteren en het goedkoop en gemakkelijk te maken om grote gebieden te bestrijken met een groot aantal onafhankelijke, onderling verbonden en autonome netwerken. Reticulum is onstuitbare netwerken voor het volk.
+
+
+
+Reticulum is niet *één* netwerk. Het is een hulpmiddel voor het bouwen van *duizenden netwerken*. Netwerken zonder kill-switches, surveillance, censuur en controle. Netwerken die vrij met elkaar kunnen samenwerken, zich kunnen associëren en zich kunnen losmaken. Reticulum is netwerken voor mensen.
+
+Vanuit het perspectief van de gebruiker maakt Reticulum de creatie mogelijk van applicaties die de autonomie en soevereiniteit van gemeenschappen en individuen respecteren en versterken. Reticulum biedt veilige digitale communicatie die niet kan worden onderworpen aan controle, manipulatie of censuur van buitenaf.
+
+Reticulum maakt de constructie mogelijk van zowel kleine als potentieel planetaire netwerken, zonder enige noodzaak voor hiërarchische of beaureucratische structuren om deze te controleren of te beheren, terwijl individuen en gemeenschappen volledige soevereiniteit over hun eigen netwerksegmenten worden gegarandeerd.
+
+## Opmerkelijke kenmerken
+Hoewel Reticulum hetzelfde probleem oplost als elke netwerkstack, namelijk gegevens betrouwbaar van het ene punt naar het andere krijgen via een aantal tussenpersonen, doet het dit op een manier die heel anders is dan andere netwerktechnologieën.
+
+- Reticulum gebruikt geen bronadressen. Geen van de verzonden pakketten bevat informatie over het adres, de plaats, de machine of de persoon waar ze vandaan komen.
+- Er is geen centrale controle over de adresruimte in Reticulum. Iedereen kan zoveel adressen toewijzen als hij nodig heeft, wanneer hij die nodig heeft..
+- Reticulum zorgt voor end-to-end connectiviteit. Nieuw gegenereerde adressen worden binnen enkele seconden tot enkele minuten wereldwijd bereikbaar.
+- Adressen zijn *zelf-soeverein* en *draagbaar*. Zodra een adres is aangemaakt, kan het fysiek naar een andere plek in het netwerk worden verplaatst en bereikbaar blijven.
+- Alle communicatie is standaard beveiligd met [sterke, moderne encryptie](crypto_nl.html).
+- Alle encryptiesleutels zijn kortstondig en communicatie biedt standaard voorwaartse geheimhouding.
+- Het is niet mogelijk om ongecodeerde links tot stand te brengen in Reticulum-netwerken.
+- Het is niet mogelijk om ongecodeerde pakketten naar bestemmingen in het netwerk te verzenden.
+- Bestemmingen die niet-versleutelde pakketten ontvangen, zullen deze als ongeldig verwijderen.
+
+Volgend onderwerp: aan de slag
diff --git a/source/index_tr.md b/source/index_tr.md
new file mode 100644
index 0000000..e6bd757
--- /dev/null
+++ b/source/index_tr.md
@@ -0,0 +1,27 @@
+# Reticulum
+Reticulum, hazır bulunan donanım ile yerel ve geniş alan ağları oluşturmak için kriptografi tabanlı bir ağ yığınıdır. Reticulum, çok yüksek gecikme süresi ve son derece düşük bant genişliği koşullarında bile çalışmaya devam edebilir.
+
+Reticulum'un vizyonu, herkesin kendi bağımsız iletişim ağlarını işletmesine ve bağımsız, birbirine bağlanabilir ve otonom ağları geniş alanlarda uygun maliyetli ve kolay bir şekilde kapsamak için olanak tanımaktır. Reticulum, Özgür Toplum İçin Durdurulamayan Ağlardır.
+
+
+
+Reticulum, *bir* ağ değildir. *Binlerce ağ* oluşturmak için bir araçtır. Anahtarları, gözetleme, sansür ve kontrol olmadan çalışan ağlar. Serbestçe birbirleriyle etkileşime girebilen, ilişkilendirilebilen ve ayrılabilecek ağlar. Reticulum, İnsanlık İçin Vardır.
+
+Kullanıcı perspektifinden bakıldığında, Reticulum toplulukların ve bireylerin özerkliğini ve egemenliğini saygılayan ve güçlendiren uygulamaların oluşturulmasına olanak tanır. Reticulum, dış kontrol, manipülasyon veya sansüre tabi olmayan güvenli dijital iletişim sağlar.
+
+Reticulum, hiyerarşik veya bürokratik yapıların kontrol veya yönetimine ihtiyaç duymadan hem küçük hem de potansiyel olarak gezegen ölçeğinde ağların oluşturulmasını sağlar, bu süreçte bireylere ve topluluklara kendi ağ segmentleri üzerinde tam egemenlik sağlar.
+
+## Dikkat Çeken Özellikler
+Reticulum, herhangi bir ağ yığınının çözdüğü aynı problemleri çözerken, veriyi güvenilir bir şekilde bir noktadan diğerine bir dizi aracı üzerinden iletmek bakımından diğer ağ teknolojilerinden çok farklı bir şekilde yapar.
+
+- Reticulum kaynak adresleri kullanmaz. Gönderilen paketler, bunların kaynaklandığı adres, yer, makine veya kişi hakkında bilgi içermez.
+- Reticulum'da adres alanı üzerinde merkezi kontrol yoktur. İhtiyaç duyulduğunda herkes, ihtiyaçları doğrultusunda istedikleri kadar adresi tahsis edebilir.
+- Reticulum, uçtan uca bağlantıyı sağlar. Yeni oluşturulan adresler, birkaç saniye ila birkaç dakika içinde küresel olarak ulaşılabilir hale gelir.
+- Adresler *bağımsız* ve *taşınabilirdir*. Bir adres oluşturulduktan sonra, fiziksel olarak başka bir yere taşınabilir ve erişilebilirliğini sürdürebilir.
+- Tüm iletişim, [güçlü, modern şifreleme](crypto.html) ile varsayılan olarak güvence altına alınmıştır.
+- Tüm şifreleme anahtarları geçici olup, iletişim varsayılan olarak forward secrecy sunar.
+- Reticulum ağlarında şifresiz bağlantılar kurmak mümkün değildir.
+- Ağın herhangi bir hedefine şifresiz paket göndermek mümkün değildir.
+- Şifresiz paketler alan konumlar, bunları geçersiz olarak görecektir.
+
+Sonraki Konu: Başlangıç
\ No newline at end of file
diff --git a/source/index_uk.md b/source/index_uk.md
new file mode 100644
index 0000000..01c95d0
--- /dev/null
+++ b/source/index_uk.md
@@ -0,0 +1,27 @@
+
+# Reticulum
+Reticulum — це криптографічна мережна структура для створення локальних і широкомасштабних мереж з використанням доступного апаратного забезпечення. Reticulum може продовжувати працювати навіть за несприятливих умов з дуже високою затримкою і надзвичайно низькою пропускною здатністю.
+
+Місія Reticulum — дозволити кожному створювати власні суверенні комунікаційні мережі та зробити їх дешевими й простими для покриття великих територій безліччю незалежних, взаємопідключених і автономних мереж. Reticulum — це мережі, котрі не зупинити для людей.
+
+
+Reticulum — це не одна мережа. Це інструмент для створення тисяч мереж. Мереж без вимикачів, спостереження, цензури й контролю. Мереж, які можуть вільно взаємодіяти, асоціюватися і роз’єднуватися між собою. Reticulum — це мережі для людей.
+
+З погляду користувача, Reticulum дозволяє створювати додатки, які поважають і зміцнюють автономію та суверенітет громад і осіб. Reticulum забезпечує безпечну цифрову комунікацію, яку не можна піддавати зовнішньому контролю, маніпуляціям або цензурі.
+
+Reticulum дозволяє будувати як малі, так і потенційно планетарні мережі без необхідності в ієрархічних або бюрократичних структурах для їх контролю чи управління, при цьому забезпечуючи повний суверенітет осіб і громад над їхніми власними сегментами мережі.
+## Основні характеристики
+
+Хоча Reticulum вирішує ту ж проблему, що й будь-яка інша мережна структура, а саме забезпечити надійний перехід даних з однієї точки в іншу через кілька посередників, він робить це дуже по-іншому порівняно з іншими мережними технологіями.
+
+- Reticulum не використовує адреси джерела. Жоден переданий пакет не містить інформації про адресу, місце, машину чи людину, з якої він надійшов.
+- В Reticulum немає центрального контролю над простором адрес. Кожен може виділяти стільки адрес, скільки йому потрібно, коли вони йому потрібні.
+- Reticulum забезпечує з’єднання від кінця до кінця. Новостворені адреси стають глобально доступними протягом декількох секунд або хвилин.
+- Адреси є самостійними та переносними. Після того, як адреса була створена, її можна фізично перемістити в інше місце в мережі й продовжувати бути доступною.
+- Усі комунікації за замовчуванням захищені сильним, сучасним шифруванням.
+- Усі ключі шифрування є тимчасовими, а комунікація за замовчуванням забезпечує вперед-секретність.
+- У мережах Reticulum неможливо встановити незашифровані з’єднання.
+- Неможливо надсилати незашифровані пакети в будь-які пункти призначення в мережі.
+- Пункти призначення, які отримують незашифровані пакети, відкидатимуть їх як недійсні.
+
+Наступна тема: Розпочати
diff --git a/source/index_zh-cn.md b/source/index_zh-cn.md
new file mode 100644
index 0000000..43dc396
--- /dev/null
+++ b/source/index_zh-cn.md
@@ -0,0 +1,28 @@
+
+# Reticulum
+Reticulum 是一个基于密码学的网络栈。人们可以用现有的硬件设备基于 Reticulum 搭建本地或是广域的网络。Reticulum 就算是在极高延迟与极低带宽的情况下仍旧可以运行。
+
+Reticulum 的愿景是让任何人都能够搭建自己的通讯网络——用独立、互联、自治的网络覆盖广阔地域从未如此简单而廉价。Reticulum 是为了人民的、势不可挡的网络。
+
+
+
+Reticulum 不单单是*一个*网络。它是用来搭建*成千上万*网络的工具——成千上万个没有停止按钮(kill-switches)、没有监控、没有审查与控制，但却能协调运作、有机结合的网络。Reticulum 是为了人类的网络。
+
+在用户看来，Reticulum 可以用来构建尊重社区与个人的自治性和独立性的应用。它提供了无法被外部操纵、篡改或是审查的安全数字通信。
+
+Reticulum 可以用于搭建小型乃至覆盖全星球的网络体系，而无需任何层级或是官僚化的控制管理结构。Reticulum 同时还能保证社区与个人对自己那部分网络的主权。
+
+## 值得注意的特质
+虽然 Reticulum 处理的是任何一个网络栈都在尝试解决的问题，即让数据通过数个中间节点，可靠地从一方传输到另一方，但其处理这一问题的方式与其他网络技术却有着很大差异。
+
+- Reticulum 不使用源地址。数据包中不会包含源地址、发送位置、机器与操作者相关的信息。
+- Reticulum 中没有对于地址空间的中央控制。任何人都可以在需要的时候分配任意多的地址。
+- Reticulum 保证端到端连接性。新生的地址会在数秒到数分钟之内全局可及。
+- 地址是*[自主](https://zh.wikipedia.org/zh-cn/%E8%BA%AB%E4%BB%BD%E8%87%AA%E4%B8%BB%E6%9D%83)*且*便携*的。它们可以在物理上被移动到网络的另一位置并仍旧保持可及。
+- 所有通信都默认由[现代而健壮的加密](crypto_zh-cn.html)保护。
+- 所有的密钥都是临时密钥，且通信自带前向保密。
+- 无法在 Reticulum 网络中建立未加密连接。
+- 无法在 Reticulum 网络中向任何目标发送未加密的数据包。
+- 收到未加密数据包的目标会将其视为无效数据包并丢弃。
+
+下一个主题: 开始使用
diff --git a/source/license.md b/source/license.md
index 13c2388..bb56028 100644
--- a/source/license.md
+++ b/source/license.md
@@ -1,7 +1,7 @@
```
MIT License
-Copyright (c) 2016-2022 Mark Qvist / unsigned.io
+Copyright (c) 2016-2024 Mark Qvist / unsigned.io
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
diff --git a/source/license-de.md b/source/license_de.md
similarity index 95%
rename from source/license-de.md
rename to source/license_de.md
index 70ac57e..1f6dafe 100644
--- a/source/license-de.md
+++ b/source/license_de.md
@@ -1,7 +1,7 @@
```
MIT Lizenz
-Copyright (c) 2016-2022 Mark Qvist / unsigned.io
+Copyright (c) 2016-2024 Mark Qvist / unsigned.io
Hiermit wird jeder Person, die eine Kopie dieser Software und der zugehörigen Dokumentationsdateien (die "Software") erwirbt, die kostenlose Erlaubnis erteilt
dieser Software und der zugehörigen Dokumentationsdateien (die "Software") erhält, das Recht
diff --git a/source/license_es.md b/source/license_es.md
new file mode 100644
index 0000000..d21ef78
--- /dev/null
+++ b/source/license_es.md
@@ -0,0 +1,20 @@
+```
+MIT License
+
+Copyright (c) 2016-2024 Mark Qvist / unsigned.io
+
+Por la presente se concede permiso, libre de cargos, a cualquier persona que obtenga una copia
+de este software y de los archivos de documentación asociados (el "Software"), a utilizar el
+Software sin restricción, incluyendo sin limitación los derechos a usar, copiar, modificar,
+fusionar, publicar, distribuir, sublicenciar, y/o vender copias del Software, y a permitir a
+las personas a las que se les proporcione el Software a hacer lo mismo, sujeto a las siguientes condiciones:
+
+El aviso de copyright anterior y este aviso de permiso se incluirán en todas las copias o partes sustanciales del Software.
+
+EL SOFTWARE SE PROPORCIONA "COMO ESTÁ", SIN GARANTÍA DE NINGÚN TIPO, EXPRESA O IMPLÍCITA,
+INCLUYENDO PERO NO LIMITADO A GARANTÍAS DE COMERCIALIZACIÓN, IDONEIDAD PARA UN PROPÓSITO
+PARTICULAR E INCUMPLIMIENTO. EN NINGÚN CASO LOS AUTORES O PROPIETARIOS DE LOS DERECHOS
+DE AUTOR SERÁN RESPONSABLES DE NINGUNA RECLAMACIÓN, DAÑOS U OTRAS RESPONSABILIDADES, YA
+SEA EN UNA ACCIÓN DE CONTRATO, AGRAVIO O CUALQUIER OTRO MOTIVO, DERIVADAS DE, FUERA DE O
+EN CONEXIÓN CON EL SOFTWARE O SU USO U OTRO TIPO DE ACCIONES EN EL SOFTWARE.
+```
diff --git a/source/license_uk.md b/source/license_uk.md
new file mode 100644
index 0000000..fb7f98c
--- /dev/null
+++ b/source/license_uk.md
@@ -0,0 +1,22 @@
+```
+MIT Ліцензія
+
+Авторські права (c) 2016-2024 Mark Qvist / unsigned.io
+
+Цим надається безкоштовна ліцензія будь-якій особі, яка отримає копію
+цього програмного забезпечення та супутніх документаційних файлів ("Програмне забезпечення"), використовувати
+Програмне забезпечення без обмежень, зокрема, але не обмежуючись правами
+на використання, копіювання, модифікацію, об'єднання, публікацію, розповсюдження, надання ліцензії, і/або продаж
+копій Програмного забезпечення, а також дозволяти особам, яким надається це Програмне забезпечення, робити це, за умови дотримання наступних умов:
+
+Усі копії або суттєві частини цього Програмного забезпечення повинні містити
+вище зазначене повідомлення про авторські права та це повідомлення про дозвіл.
+
+ПРОГРАМНЕ ЗАБЕЗПЕЧЕННЯ НАДАЄТЬСЯ "ЯК Є", БЕЗ ЯКОЇ-НЕБУДЬ ГАРАНТІЇ, ВИРАЖЕНОЇ АБО
+НЕВИРАЖЕНОЇ, ВКЛЮЧАЮЧИ, АЛЕ НЕ ОБМЕЖУЮЧИСЬ, ГАРАНТІЯМИ ПРОДОВЖУВАННЯ,
+ПРИДАТНІСТЬ ДЛЯ ПЕВНОЇ МЕТИ ТА НЕПОРУШЕННЯ ПРАВ. В ЖОДНОМУ ВИПАДКУ
+АВТОРИ АБО ВОЛОДІЛІ РОБОТОМ НЕ НЕСУТЬ ВІДПОВІДАЛЬНІСТЬ ЗА ЯКІ-БУДЬ
+СКАРГИ, ШКОДИ АБО ІНШІ ЗОБОВ'ЯЗАННЯ, ЯК У РАМКАХ ДОГОВОРУ, ДЕЛІКТУ АБО ІНШОГО, ЩО ВИНИКАЮТЬ З,
+АБО У ЗВ'ЯЗКУ З ПРОГРАМНИМ ЗАБЕЗПЕЧЕННЯМ, ЙОГО ВИКОРИСТАННЯМ АБО ІНШИМИ ДІЯМИ У
+ПОРОДЖЕННІ ПРОГРАМНОГО ЗАБЕЗПЕЧЕННЯ.
+```
\ No newline at end of file
diff --git a/source/start.md b/source/start.md
index 5209c88..a3e9c11 100644
--- a/source/start.md
+++ b/source/start.md
@@ -10,7 +10,7 @@ you want to do. For full details and examples, have a look at the [Getting Start
If you are having trouble, or if something is not working, here are some great places to ask for help:
- The [discussion forum](https://github.com/markqvist/Reticulum/discussions) on GitHub
-- The [Reticulum Matrix Channel](element://room/!TRaVWNnQhAbvuiSnEK%3Amatrix.org?via=matrix.org) at `#reticulum:matrix.org`
+- The [Reticulum Matrix Channel](https://matrix.to/#/#reticulum:matrix.org) at `#reticulum:matrix.org`
- The [Reticulum subreddit](https://reddit.com/r/reticulum)
## Installation
@@ -34,7 +34,7 @@ Reticulum includes a range of useful utilities for managing your networks, viewi
- The system daemon `rnsd` for running Reticulum as an always-available service
- An interface status utility called `rnstatus`, that displays information about interfaces
-- The path lookup and and management tool `rnpath` letting you view and modify path tables
+- The path lookup and management tool `rnpath` letting you view and modify path tables
- A diagnostics tool called `rnprobe` for checking connectivity to destinations
- A simple file transfer program called `rncp` making it easy to copy files to remote systems
- The remote command execution program `rnx` that let's you run commands and programs and retrieve output from remote systems
@@ -64,6 +64,6 @@ No matter how Reticulum is installed and started, it will load external dependen
## Performance
Reticulum targets a *very* wide usable performance envelope, but prioritises functionality and performance over low-bandwidth mediums. The goal is to provide a dynamic performance envelope from 250 bits per second, to 1 gigabit per second on normal hardware.
-Currently, the usable performance envelope is approximately 500 bits per second to 20 megabits per second, with physical mediums faster than that not being saturated. Performance beyond the current level is intended for future upgrades, but not highly prioritised until the wire format and API has been locked in.
+Currently, the usable performance envelope is approximately 150 bits per second to 40 megabits per second, with physical mediums faster than that not being saturated. Performance beyond the current level is intended for future upgrades, but not highly prioritised until the wire format and API has been locked in.
Next Topic: Supported Hardware
diff --git a/source/start_de.md b/source/start_de.md
index 20155bb..66a8116 100644
--- a/source/start_de.md
+++ b/source/start_de.md
@@ -1,68 +1,68 @@
-# Los geht's
-Wie Sie am besten mit dem Reticulum Network Stack beginnen, hängt davon ab, was
-Sie durchführen möchten. Ausführliche Informationen und Beispiele finden Sie im Abschnitt [Schneller Einstieg](manual/gettingstartedfast.html) des [Reticulum-Handbuchs](manual/index.html).
-
-## Experimentelle Software
-*Bitte beachten Sie!* Reticulum befindet sich noch im Beta-Stadium. Das bedeutet, dass es zwar bereits sehr gut funktioniert und sehr stabil ist, es aber durchaus noch kritische Fehler oder Schwachstellen im Verhalten, im Datenschutz oder in der Sicherheit des gesamten Systems geben kann. Verwenden Sie Reticulum nur, wenn Sie damit einverstanden sind und die Auswirkungen verstehen.
-
-## Gemeinschaft & Unterstützung
-Wenn Sie Probleme haben oder etwas nicht funktioniert, finden Sie hier einige gute Stellen, an denen Sie um Hilfe bitten können:
-
-- Das [Diskussionsforum](https://github.com/markqvist/Reticulum/discussions) auf GitHub
-- Der [Reticulum-Matrixkanal](element://room/!TRaVWNnQhAbvuiSnEK%3Amatrix.org?via=matrix.org) bei `#reticulum:matrix.org`
-- Der [Reticulum-Subreddit](https://reddit.com/r/reticulum)
-
-## Installation
-Der einfachste Weg, Reticulum und zugehörige Dienstprogramme auf Ihrem System zu installieren, ist über pip:
-
-```bash
-pip install rns
-```
-
-Sie können dann jedes Programm starten, das Reticulum verwendet, oder Reticulum als Systemdienst starten mit [dem Dienstprogramm rnsd] .(manual/using.html#the-rnsd-utility).
-
-Wenn `pip` auf Ihrem System nicht verfügbar ist, installieren Sie zuerst die Pakete `python3` und `python3-pip` für Ihr Betriebssystem.
-
-Beim ersten Start erstellt Reticulum eine Standardkonfigurationsdatei, die eine grundlegende Konnektivität zu anderen Reticulum-Peers herstellt, die lokal erreichbar sein könnten. Wenn es sich bei einem dieser lokalen Peers um eine Transportinstanz handelt, können Sie über diese eine Verbindung zu einem größeren Netzwerk herstellen. Die Standardkonfigurationsdatei enthält einige Beispiele und Referenzen für die Erstellung einer komplexeren Konfiguration.
-
-Ausführlichere Beispiele für die Erweiterung der Kommunikation über verschiedene Medien wie Packet Radio oder LoRa, serielle Schnittstellen oder über schnelle IP-Verbindungen und das Internet unter Verwendung der UDP- und TCP-Schnittstellen finden Sie im Abschnitt [Unterstützte Schnittstellen](manual/interfaces.html) im [Reticulum Handbuch](manual/index.html).
-
-
-## Enthaltene Dienstprogramme
-Reticulum enthält eine Reihe nützlicher Hilfsprogramme zur Verwaltung Ihrer Netzwerke, zur Anzeige von Status und Informationen und für andere Aufgaben. Weitere Informationen zu diesen Programmen finden Sie im Abschnitt [Enthaltene Dienstprogramme](manual/using.html#included-utility-programs) im [Reticulum Handbuch](manual/index.html).
-
-- Der System-Daemon `rnsd` für den Betrieb von Reticulum als immer verfügbarer Dienst
-- Ein Dienstprogramm für den Schnittstellenstatus namens `rnstatus`, das Informationen über Schnittstellen anzeigt
-- Das Werkzeug `rnpath` zum Nachschlagen und Verwalten von Pfaden, mit dem Sie Pfad-Tabellen anzeigen und ändern können
-- Ein Diagnosewerkzeug namens `rnprobe` zur Überprüfung der Konnektivität zu Zielen
-- Ein einfaches Dateiübertragungsprogramm namens `rncp`, das das Kopieren von Dateien auf entfernte Systeme erleichtert
-- Das Programm `rnx` zur Ausführung von Fernbefehlen, mit dem Sie Befehle und Programme ausführen und Ausgaben von entfernten Systemen abrufen können
-
-Alle Tools, einschließlich `rnx` und `rncp`, arbeiten zuverlässig und gut auch über Verbindungen mit sehr geringer Bandbreite wie LoRa oder Packet Radio.
-
-## Programme welche Reticulum verwenden
-Wenn Sie sich schnell einen Überblick über die Möglichkeiten von Reticulum verschaffen möchten, werfen Sie einen Blick auf die folgenden Ressourcen.
-
-- Eine netzunabhängige, verschlüsselte und widerstandsfähige Mesh-Kommunikationsplattform finden Sie unter [Nomad Network](https://github.com/markqvist/NomadNet)
-- Die Android-, Linux- und macOS-Anwendung [Sideband](https://github.com/markqvist/sideband) verfügt über eine grafische Oberfläche und legt den Schwerpunkt auf Benutzerfreundlichkeit.
-- [LXMF](https://github.com/markqvist/lxmf) ist ein verteiltes, verzögerungs- und unterbrechungstolerantes Nachrichtenübertragungsprotokoll, das auf Reticulum aufbaut.
-
-## Abhängigkeiten
-Die Installation des Standardpakets `rns` erfordert die unten aufgeführten Abhängigkeiten. Fast alle Systeme und Distributionen haben leicht verfügbare Pakete für diese Abhängigkeiten, und wenn das `rns`-Paket mit `pip` installiert wird, werden sie ebenfalls heruntergeladen und installiert.
-
-- [PyCA/cryptography](https://github.com/pyca/cryptography)
-- [netifaces](https://github.com/al45tair/netifaces)
-- [pyserial](https://github.com/pyserial/pyserial)
-
-Auf ungewöhnlicheren Systemen und in einigen seltenen Fällen ist es möglicherweise nicht möglich, eines oder mehrere der oben genannten Module zu installieren oder gar zu kompilieren. In solchen Situationen können Sie stattdessen das Paket `rnspure` verwenden, das keine externen Abhängigkeiten für die Installation benötigt. Bitte beachten Sie, dass der Inhalt der Pakete `rns` und `rnspure` *identisch* ist. Der einzige Unterschied besteht darin, dass das Paket `rnspure` keine Abhängigkeiten auflistet, die für die Installation erforderlich sind.
-
-Unabhängig davon, wie Reticulum installiert und gestartet wird, lädt es externe Abhängigkeiten nur, wenn sie *benötigt* und *verfügbar* sind. Wenn Sie Reticulum beispielsweise auf einem System verwenden möchten, das [pyserial](https://github.com/pyserial/pyserial) nicht unterstützt, ist es durchaus möglich, das Paket `rnspure` zu verwenden, aber Reticulum kann dann keine seriell basierten Schnittstellen nutzen. Alle anderen verfügbaren Module werden bei Bedarf weiterhin geladen.
-
-**Bitte beachten Sie!** Wenn Sie das Paket `rnspure` verwenden, um Reticulum auf Systemen zu betreiben, die [PyCA/cryptography](https://github.com/pyca/cryptography) nicht unterstützen, ist es wichtig, dass Sie den Abschnitt [Kryptographische Primitiven](crypto_de.html) auf dieser Website lesen und verstehen.
-
-## Leistung
-Reticulum zielt auf einen *sehr* großen nutzbaren Leistungsbereich ab, gibt aber der Funktionalität und Leistung Vorrang auf Medien mit geringer Bandbreite. Ziel ist es, einen dynamischen Leistungsbereich von 250 Bit pro Sekunde bis zu 1 Gigabit pro Sekunde auf normaler Hardware bereitzustellen.
-
-Derzeit liegt der nutzbare Leistungsbereich bei etwa 500 Bit pro Sekunde bis 20 Megabit pro Sekunde, wobei schnellere physische Medien nicht gesättigt sind. Eine über das derzeitige Niveau hinausgehende Leistung ist für künftige Upgrades vorgesehen, hat aber keine hohe Priorität, solange das Leitungsformat und die API noch nicht festgelegt sind.
-
-Nächstes Thema: Unterstützte Hardware
+# Los geht's
+Wie Sie am besten mit dem Reticulum Network Stack beginnen, hängt davon ab, was
+Sie durchführen möchten. Ausführliche Informationen und Beispiele finden Sie im Abschnitt [Schneller Einstieg](manual/gettingstartedfast.html) des [Reticulum-Handbuchs](manual/index.html).
+
+## Experimentelle Software
+*Bitte beachten Sie!* Reticulum befindet sich noch im Beta-Stadium. Das bedeutet, dass es zwar bereits sehr gut funktioniert und sehr stabil ist, es aber durchaus noch kritische Fehler oder Schwachstellen im Verhalten, im Datenschutz oder in der Sicherheit des gesamten Systems geben kann. Verwenden Sie Reticulum nur, wenn Sie damit einverstanden sind und die Auswirkungen verstehen.
+
+## Gemeinschaft & Unterstützung
+Wenn Sie Probleme haben oder etwas nicht funktioniert, finden Sie hier einige gute Stellen, an denen Sie um Hilfe bitten können:
+
+- Das [Diskussionsforum](https://github.com/markqvist/Reticulum/discussions) auf GitHub
+- Der [Reticulum-Matrixkanal](https://matrix.to/#/#reticulum:matrix.org) bei `#reticulum:matrix.org`
+- Der [Reticulum-Subreddit](https://reddit.com/r/reticulum)
+
+## Installation
+Der einfachste Weg, Reticulum und zugehörige Dienstprogramme auf Ihrem System zu installieren, ist über pip:
+
+```bash
+pip install rns
+```
+
+Sie können dann jedes Programm starten, das Reticulum verwendet, oder Reticulum als Systemdienst starten mit [dem Dienstprogramm rnsd] .(manual/using.html#the-rnsd-utility).
+
+Wenn `pip` auf Ihrem System nicht verfügbar ist, installieren Sie zuerst die Pakete `python3` und `python3-pip` für Ihr Betriebssystem.
+
+Beim ersten Start erstellt Reticulum eine Standardkonfigurationsdatei, die eine grundlegende Konnektivität zu anderen Reticulum-Peers herstellt, die lokal erreichbar sein könnten. Wenn es sich bei einem dieser lokalen Peers um eine Transportinstanz handelt, können Sie über diese eine Verbindung zu einem größeren Netzwerk herstellen. Die Standardkonfigurationsdatei enthält einige Beispiele und Referenzen für die Erstellung einer komplexeren Konfiguration.
+
+Ausführlichere Beispiele für die Erweiterung der Kommunikation über verschiedene Medien wie Packet Radio oder LoRa, serielle Schnittstellen oder über schnelle IP-Verbindungen und das Internet unter Verwendung der UDP- und TCP-Schnittstellen finden Sie im Abschnitt [Unterstützte Schnittstellen](manual/interfaces.html) im [Reticulum Handbuch](manual/index.html).
+
+
+## Enthaltene Dienstprogramme
+Reticulum enthält eine Reihe nützlicher Hilfsprogramme zur Verwaltung Ihrer Netzwerke, zur Anzeige von Status und Informationen und für andere Aufgaben. Weitere Informationen zu diesen Programmen finden Sie im Abschnitt [Enthaltene Dienstprogramme](manual/using.html#included-utility-programs) im [Reticulum Handbuch](manual/index.html).
+
+- Der System-Daemon `rnsd` für den Betrieb von Reticulum als immer verfügbarer Dienst
+- Ein Dienstprogramm für den Schnittstellenstatus namens `rnstatus`, das Informationen über Schnittstellen anzeigt
+- Das Werkzeug `rnpath` zum Nachschlagen und Verwalten von Pfaden, mit dem Sie Pfad-Tabellen anzeigen und ändern können
+- Ein Diagnosewerkzeug namens `rnprobe` zur Überprüfung der Konnektivität zu Zielen
+- Ein einfaches Dateiübertragungsprogramm namens `rncp`, das das Kopieren von Dateien auf entfernte Systeme erleichtert
+- Das Programm `rnx` zur Ausführung von Fernbefehlen, mit dem Sie Befehle und Programme ausführen und Ausgaben von entfernten Systemen abrufen können
+
+Alle Tools, einschließlich `rnx` und `rncp`, arbeiten zuverlässig und gut auch über Verbindungen mit sehr geringer Bandbreite wie LoRa oder Packet Radio.
+
+## Programme welche Reticulum verwenden
+Wenn Sie sich schnell einen Überblick über die Möglichkeiten von Reticulum verschaffen möchten, werfen Sie einen Blick auf die folgenden Ressourcen.
+
+- Eine netzunabhängige, verschlüsselte und widerstandsfähige Mesh-Kommunikationsplattform finden Sie unter [Nomad Network](https://github.com/markqvist/NomadNet)
+- Die Android-, Linux- und macOS-Anwendung [Sideband](https://github.com/markqvist/sideband) verfügt über eine grafische Oberfläche und legt den Schwerpunkt auf Benutzerfreundlichkeit.
+- [LXMF](https://github.com/markqvist/lxmf) ist ein verteiltes, verzögerungs- und unterbrechungstolerantes Nachrichtenübertragungsprotokoll, das auf Reticulum aufbaut.
+
+## Abhängigkeiten
+Die Installation des Standardpakets `rns` erfordert die unten aufgeführten Abhängigkeiten. Fast alle Systeme und Distributionen haben leicht verfügbare Pakete für diese Abhängigkeiten, und wenn das `rns`-Paket mit `pip` installiert wird, werden sie ebenfalls heruntergeladen und installiert.
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography)
+- [netifaces](https://github.com/al45tair/netifaces)
+- [pyserial](https://github.com/pyserial/pyserial)
+
+Auf ungewöhnlicheren Systemen und in einigen seltenen Fällen ist es möglicherweise nicht möglich, eines oder mehrere der oben genannten Module zu installieren oder gar zu kompilieren. In solchen Situationen können Sie stattdessen das Paket `rnspure` verwenden, das keine externen Abhängigkeiten für die Installation benötigt. Bitte beachten Sie, dass der Inhalt der Pakete `rns` und `rnspure` *identisch* ist. Der einzige Unterschied besteht darin, dass das Paket `rnspure` keine Abhängigkeiten auflistet, die für die Installation erforderlich sind.
+
+Unabhängig davon, wie Reticulum installiert und gestartet wird, lädt es externe Abhängigkeiten nur, wenn sie *benötigt* und *verfügbar* sind. Wenn Sie Reticulum beispielsweise auf einem System verwenden möchten, das [pyserial](https://github.com/pyserial/pyserial) nicht unterstützt, ist es durchaus möglich, das Paket `rnspure` zu verwenden, aber Reticulum kann dann keine seriell basierten Schnittstellen nutzen. Alle anderen verfügbaren Module werden bei Bedarf weiterhin geladen.
+
+**Bitte beachten Sie!** Wenn Sie das Paket `rnspure` verwenden, um Reticulum auf Systemen zu betreiben, die [PyCA/cryptography](https://github.com/pyca/cryptography) nicht unterstützen, ist es wichtig, dass Sie den Abschnitt [Kryptographische Primitiven](crypto_de.html) auf dieser Website lesen und verstehen.
+
+## Leistung
+Reticulum zielt auf einen *sehr* großen nutzbaren Leistungsbereich ab, gibt aber der Funktionalität und Leistung Vorrang auf Medien mit geringer Bandbreite. Ziel ist es, einen dynamischen Leistungsbereich von 250 Bit pro Sekunde bis zu 1 Gigabit pro Sekunde auf normaler Hardware bereitzustellen.
+
+Derzeit liegt der nutzbare Leistungsbereich bei etwa 150 Bit pro Sekunde bis 40 Megabit pro Sekunde, wobei schnellere physische Medien nicht gesättigt sind. Eine über das derzeitige Niveau hinausgehende Leistung ist für künftige Upgrades vorgesehen, hat aber keine hohe Priorität, solange das Leitungsformat und die API noch nicht festgelegt sind.
+
+Nächstes Thema: Unterstützte Hardware
diff --git a/source/start_es.md b/source/start_es.md
new file mode 100644
index 0000000..2ce0234
--- /dev/null
+++ b/source/start_es.md
@@ -0,0 +1,79 @@
+# Empezar
+La mejor manera de empezar a usar el protocolo Reticulum depende de qué
+quieras hacer. Para más detalles y ejemplos, consulte la sección [Empezar rapidito](manual/gettingstartedfast.html) del [Manual de Reticulum](manual/index.html).
+
+## Software experimental
+**¡A saber!** Reticulum todavía está en fase beta. Esto significa que, aunque ya funciona muy bien y es muy estable, es muy
+posible que todavía haya errores o fallos críticos en el comportamiento, la privacidad o la seguridad del sistema en su conjunto.
+Utilice Reticulum si se siente cómodo con esto y comprende las implicaciones.
+
+## Comunidad y Soporte
+
+Si estás teniendo algún problema o algo no está funcionando, estos son algunos excelentes lugares para pedir ayuda:
+
+- El [foro de discusión](https://github.com/markqvist/Reticulum/discussions) en Github
+- El [Canal de Reticulum en Matrix](https://matrix.to/#/#reticulum:matrix.org) en `#reticulum:matrix.org`
+- El [Subreddit de Reticulum](https://reddit.com/r/reticulum)
+
+## Instalación
+Para instalar reticulum y utilidades relacionadas, la forma más fácil es usando pip:
+
+```bash
+pip install rns
+```
+
+Podes ejecutar entonces cualquier programa que use Reticulum o iniciar Reticulum como un servicio del sistema con [la utilidad rnsd](manual/using.html#the-rnsd-utility).
+
+Si `pip` no es disponible en tu sistema, instala primero `python3` y `python3-pip` para tu sistema operativo.
+
+La primera vez que inicia, Reticulum crea un archivo de configuración por defecto, proporcionando conectividad básica con pares
+de Reticulum que puedan ser localmente *ubicables*. Si cualquiera de esos pares locales son instancias de transporte, puede que
+te conecten con redes más grandes. El archivo de configuración contiene algunos ejemplos y referencias para crear configuraciones
+más complejas.
+
+Para ejemplos más detallados sobre cómo expandir la comunicación a más medios, como paquetes de radio o Lora, puertos seriales,
+o a través de enlaces rápidos de IP e Internet utilizando las interfaces UDP y TCP, péguele una mirada a la sección
+[Interfaces soportadas](manual/interfaces.html) del [Manual de Reticulum](manual/index.html).
+
+## Utilidades Incluidas
+
+Reticulum incluye una serie de utilidades para gestionar sus redes, ver el estado, la información y otras tareas. Puede leer
+más sobre estos programas en la sección [Utilidades Incluidas](manual/using.html#utilidades-incluidas) del [Manual de Reticulum](manual/index.html).
+
+- El servicio/daemon `rnsd` para correr Reticulum como un servicio siempre disponible.
+- Una utilidad de estado de la interfaz llamada `rnstatus`, para mostrar info sobre interfaces.
+- La herramienta de búsqueda y gestión de rutas `rnpath` le permite ver y modificar tablas de rutas.
+- Una herramienta de diagnóstico llamada `rnprobe` para comprobar la conectividad con los destinos, similar a `ping`.
+- Un sencillo programa de transferencia de archivos llamado `rncp` que facilita la copia de archivos a sistemas remotos.
+- El programa de ejecución remota de comandos `rnx` que le permite ejecutar comandos, programas y recuperar output de sistemas remotos.
+
+Todas las herramientas, incluidas `rnx` y `rncp`, funcionan bien y con fiabilidad incluso en enlaces de muy bajo ancho de banda como LoRa o radio por paquetes.
+
+## Programas que usan Reticulum
+Si quiere rápidamente hacerse una idea de lo que puede hacer Reticulum, peguele una mirada a los siguientes recursos:
+
+- Para una plataforma de comunicaciones *mesh* sin conexión a la red, encriptada y resiliente, consulte [Nomad Network](https://github.com/markqvist/NomadNet).
+- La aplicación para Android, Linux y macOS [Sideband](https://github.com/markqvist/sideband) tiene una interfaz gráfica y se centra en facilidad de uso.
+- [LXMF](https://github.com/markqvist/lxmf) es un protocolo de transferencia de mensajes distribuido, tolerante a retrasos e interrupciones y basado en Reticulum.
+
+## Dependencias
+
+La instalación del paquete `rns` requiere las dependencias que se enumeran a continuación. Casi todos los sistemas y distribuciones tienen paquetes disponibles para estas dependencias, y cuando se instala el paquete `rns` con `pip`, también se descargan e instalan.
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography)
+- [netifaces](https://github.com/al45tair/netifaces)
+- [pyserial](https://github.com/pyserial/pyserial)
+
+En sistemas más inusuales, y en algunos casos raros, puede que no sea posible instalar o incluso compilar uno o más de los módulos anteriores. En tales situaciones, puede utilizar en su lugar el paquete `rnspure`, que no requiere dependencias externas para su instalación. Tenga en cuenta que el contenido de los paquetes `rns` y `rnspure` es *idéntico*. La única diferencia es que el paquete `rnspure` no necesita dependencias externas para su instalación.
+
+Independientemente de cómo se instale e inicie Reticulum, éste cargará las dependencias externas sólo si son *necesarias* y están *disponibles*. Si, por ejemplo, desea utilizar Reticulum en un sistema que no admite [pyserial](https://github.com/pyserial/pyserial), es perfectamente posible hacerlo utilizando el paquete `rnspure`, pero Reticulum no podrá utilizar interfaces basadas en serial. Todos los demás módulos disponibles seguirán cargándose cuando sea necesario.
+
+**Atenti!** Si utiliza el paquete `rnspure` para ejecutar Reticulum en sistemas que no soportan [PyCA/cryptography](https://github.com/pyca/cryptography), es importante que lea y comprenda la sección [Primitivas Criptográficas](crypto_es.html) de este sitio.
+
+## Desempeño
+
+Reticulum busca cubrir un amplio rango de desempeño utilizable pero prioriza la funcionalidad y el desempeño sobre medios de baja capacidad de ancho de banda. El objetivo es ofrecer un entorno de desempeño dinámico que va desde 250 bit por segundo hasta 1 giga bit por segundo en hardware normal.
+
+Actualmente, el rango de desempeño utilizable está aproximadamente en 150 bit por segundo a 40 mega bits por segundo, mientras que los medios físicos más rápidos no están saturados. El desempeño superior a este nivel se reserva para actualizaciones futuras, pero no es prioritario hasta que los formatos de cable y API hayan sido establecidos.
+
+Próximo Tema: Hardware soportado
diff --git a/source/start_jp.md b/source/start_jp.md
new file mode 100644
index 0000000..ef995d2
--- /dev/null
+++ b/source/start_jp.md
@@ -0,0 +1,66 @@
+# はじめに
+Reticulum Network Stackを始める最良の方法は、行いたいことによって異なります。詳細や例については、[Getting Started Fast](manual/gettingstartedfast.html)セクションを[Reticulum Manual](manual/index.html)で確認してください。
+
+## 実験的なソフトウェア
+*ご注意ください！* Reticulumはまだベータ版です。これは、既に非常にうまく動作していて非常に安定していますが、システム全体の動作、プライバシー、セキュリティにおいて依然として致命的なバグや欠陥がある可能性があります。これを理解し、快適に使用できる場合にReticulumを使用してください。
+
+## コミュニティとサポート
+問題が発生したり、何かがうまく動作しない場合は、助けを求めるための優れた場所がいくつかあります：
+
+- GitHubの[discussion forum](https://github.com/markqvist/Reticulum/discussions)
+- [Reticulum Matrix Channel](https://matrix.to/#/#reticulum:matrix.org)の`#reticulum:matrix.org`
+- [Reticulum subreddit](https://reddit.com/r/reticulum)
+
+## インストール
+システムにReticulumおよび関連ユーティリティをインストールする最も簡単な方法は、pipを使用することです：
+
+```bash
+pip install rns
+```
+
+その後、Reticulumを使用するプログラムを開始するか、[rnsdユーティリティ](manual/using.html#the-rnsd-utility)を使用してReticulumをシステムサービスとして起動できます。
+
+システムに`pip`が利用できない場合は、まずOS用の`python3`および`python3-pip`パッケージをインストールしてください。
+
+最初に起動すると、Reticulumはデフォルトの設定ファイルを作成し、ローカルに到達可能な他のReticulumピアとの基本的な接続性を提供します。これらのローカルピアがTransport Instancesであれば、これらはより広範なネットワークに接続できるかもしれません。デフォルトの設定ファイルにはいくつかの例と、より複雑な構成を作成するための参照が含まれています。
+
+パケットラジオやLoRa、シリアルポート、UDPおよびTCPインターフェースを使用して高速なIPリンクおよびインターネット経由で通信を拡張する方法についての詳細な例については、[Reticulum Manual](manual/index.html)の[Supported Interfaces](manual/interfaces.html)セクションを参照してください。
+
+## 含まれるユーティリティ
+Reticulumには、ネットワークを管理し、ステータスや情報を表示し、その他のタスクを行うためのさまざまな便利なユーティリティが含まれています。これらのプログラムについて詳しくは、[Reticulum Manual](manual/index.html)の[Included Utility Programs](manual/using.html#included-utility-programs)セクションを読んでください。
+
+- 常に利用可能なサービスとしてReticulumを実行するためのシステムデーモン`rnsd`
+- インターフェイスのステータス情報を表示する`rnstatus`と呼ばれるユーティリティ
+- パステーブルを表示および変更するためのパス検索および管理ツール`rnpath`
+- 接続先への接続を確認する診断ツール`rnprobe`
+- ファイルをリモートシステムに簡単にコピーできるようにする単純なファイル転送プログラム`rncp`
+- リモートシステムからコマンドやプログラムを実行し、出力を取得する`rnx`
+
+これらのツール、`rnx`および`rncp`を含むすべてのツールは、LoRaやパケットラジオなどの非常に低帯域幅のリンクでも信頼性があり、うまく動作します。
+
+## Reticulumを使用したプログラム
+Reticulumの機能についてすぐに理解したい場合は、以下のリソースをご覧ください。
+
+- オフグリッド、暗号化された、強固なメッシュ通信プラットフォームについては、[Nomad Network](https://github.com/markqvist/NomadNet) を参照してください。
+- Android、Linux、およびmacOSアプリ[Sideband](https://github.com/markqvist/sideband)は、グラフィカルなインターフェースを備えており、使いやすさに焦点を当てています。
+- [LXMF](https://github.com/markqvist/lxmf)は、Reticulum上に構築された分散型で遅延および障害対応のメッセージ転送プロトコルです。
+
+## 依存関係
+デフォルトの`rns`パッケージのインストールには、以下にリストされた依存関係が必要です。ほとんどのシステムとディストリビューションはこれらの依存関係のために既に利用可能なパッケージを持っており、`pip`で`rns`パッケージをインストールすると、これらもダウンロードおよびインストールされます。
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography)
+- [netifaces](https://github.com/al45tair/netifaces)
+- [pyserial](https://github.com/pyserial/pyserial)
+
+より一般的でないシステムや一部の稀なケースでは、上記のモジュールの1つ以上をインストールまたはコンパイルすることができないかもしれません。そのような状況では、外部依存関係がインストールに必要ない`rnspure`パッケージを代わりに使用できます。`rns`と`rnspure`パッケージの内容は*同一*です。唯一の違いは、`rnspure`パッケージがインストールに必要な依存関係をリストしていないことです。
+
+どのようにReticulumがインストールおよび起動されても、外部依存関係は*必要*かつ*利用可能*な場合のみ読み込まれます。例えば、[pyserial](https://github.com/pyserial/pyserial)をサポートしないシステムでReticulumを使用したい場合、`rnspure`パッケージを使用しても問題ありませんが、Reticulumはシリアルベースのインターフェースを使用できません。それ以外の利用可能なモジュールは、必要に応じて引き続き読み込まれます。
+
+**注意！** [PyCA/cryptography](https://github.com/pyca/cryptography)をサポートしないシステムで`rnspure`パッケージを使用してReticulumを実行する場合は、このサイトの[暗号プリミティブ](crypto.html)セクションを読み、理解することが重要です。
+
+## パフォーマンス
+Reticulumは*非常に*広範なパフォーマンスエンベロープを対象としていますが、低帯域幅のメディアに対する機能性とパフォーマンスを優先します。目標は、通常のハードウェアで250ビット/秒から1ギガビット/秒までの動的なパフォーマンス範囲を提供することです。
+
+現在、使用可能なパフォーマンス範囲は約150ビット/秒から40メガビット/秒であり、それ以上の物理メディアは飽和していません。現在のレベルを超えるパフォーマンスは将来のアップグレードのために意図されていますが、ワイヤフォーマットとAPIが確定するまで高い優先度は付けられていません。
+
+次のトピック：サポートされているハードウェア
\ No newline at end of file
diff --git a/source/start_nl.md b/source/start_nl.md
new file mode 100644
index 0000000..4367786
--- /dev/null
+++ b/source/start_nl.md
@@ -0,0 +1,68 @@
+# Begin
+De beste manier om aan de slag te gaan met de Reticulum Network Stack hangt af van wat jij wilt doen. Voor volledige details en voorbeelden, kijk eens naar de sectie [Snel aan de slag](manual/gettingstartedfast.html) van de [Reticulum Manual](manual/index.html).
+
+## Experimentele software
+*Let op!* Reticulum is nog steeds in bèta. Dit betekent dat, hoewel het al heel goed werkt en zeer stabiel is, er nog steeds kritieke bugs of tekortkomingen kunnen zijn in het gedrag, de privacy of de veiligheid van het systeem als geheel. Gebruik Reticulum als u zich hier prettig bij voelt en de implicaties begrijpt.
+
+## Hulp van de gemeenschap
+
+Als u problemen ondervindt of als iets niet werkt, zijn hier enkele goede plaatsen waar u om hulp kunt vragen:
+
+- Het [discussieforum](https://github.com/markqvist/Reticulum/discussions) op GitHub
+- Het [Reticulum Matrix Channel](https://matrix.to/#/#reticulum:matrix.org) op `#reticulum:matrix.org`
+- De [Reticulum-subreddit](https://reddit.com/r/reticulum)
+
+## Installatie
+Om Reticulum en gerelateerde hulpprogramma's op uw systeem te installeren, is de eenvoudigste manier via pip:
+
+``` bash
+pip install rns
+```
+
+U kunt vervolgens elk programma starten dat Reticulum gebruikt, of Reticulum starten als een systeemservice met [het rnsd-hulpprogramma] (manual/using.html#the-rnsd-utility).
+
+Als `pip` niet beschikbaar is op uw systeem, installeer dan eerst de pakketten `python3` en `python3-pip` voor uw besturingssysteem.
+
+Wanneer Reticulum voor het eerst wordt gestart, zal het een standaardconfiguratiebestand maken, dat basisconnectiviteit biedt met andere Reticulum-peers die mogelijk lokaal bereikbaar zijn. Als een van deze lokale peers een Transport Instantie is, kunnen deze u verbinden met bredere netwerken. Het standaardconfiguratiebestand bevat enkele voorbeelden en referenties voor het maken van een complexere configuratie.
+
+Voor meer gedetailleerde voorbeelden over hoe u de communicatie kunt uitbreiden via vele media, zoals packet radio of LoRa, seriële poorten, of via snelle IP-verbindingen en internet met behulp van de UDP- en TCP-interfaces, kunt u de [Ondersteunde interfaces] (handleiding/interfaces) raadplegen. .html) sectie van de [Reticulum Manual](manual/index.html).
+
+
+## Inbegrepen hulpprogramma's
+Reticulum bevat een reeks handige hulpprogramma's voor het beheren van uw netwerken, het bekijken van status en informatie en andere taken. U kunt meer over deze programma's lezen in het hoofdstuk [Included Utility Programs](manual/using.html#included-utility-programs) van de [Reticulum Manual](manual/index.html).
+
+- De systeemdaemon `rnsd` voor het uitvoeren van Reticulum als een altijd beschikbare service
+- Een interfacestatushulpprogramma genaamd `rnstatus`, dat informatie over interfaces weergeeft
+- Het hulpmiddel voor het opzoeken en beheren van paden `rnpath` waarmee u padtabellen kunt bekijken en wijzigen
+- Een diagnostisch hulpmiddel genaamd `rnprobe` voor het controleren van de connectiviteit met bestemmingen
+- Een eenvoudig programma voor bestandsoverdracht genaamd `rncp`, waarmee u eenvoudig bestanden naar externe systemen kunt kopiëren
+- Het programma voor het uitvoeren van opdrachten op afstand `rnx` waarmee u opdrachten en programma's kunt uitvoeren en uitvoer van externe systemen kunt ophalen
+
+Alle tools, inclusief `rnx` en `rncp`, werken betrouwbaar en goed, zelfs via verbindingen met een zeer lage bandbreedte, zoals LoRa of Packet Radio.
+
+## Programma's die Reticulum gebruiken
+Als je snel een idee wilt krijgen van wat Reticulum kan doen, bekijk dan de volgende bronnen.
+
+- Voor een off-grid, gecodeerd en veerkrachtig mesh-communicatieplatform, zie [Nomad Network](https://github.com/markqvist/NomadNet)
+- De Android-, Linux- en macOS-app [Sideband](https://github.com/markqvist/sideband) heeft een grafische interface en is gericht op gebruiksgemak.
+- [LXMF](https://github.com/markqvist/lxmf) is een gedistribueerd, vertragings- en verstoringstolerant protocol voor berichtoverdracht, gebouwd op Reticulum
+
+## Afhankelijkheden
+Voor de installatie van het standaard `rns`-pakket zijn de onderstaande afhankelijkheden vereist. Bijna alle systemen en distributies hebben pakketten beschikbaar voor deze afhankelijkheden, en wanneer het `rns`-pakket met `pip` wordt geïnstalleerd, zullen deze ook worden gedownload en geïnstalleerd.
+
+- [PyCA/cryptografie](https://github.com/pyca/cryptografie)
+- [netifaces](https://github.com/al45tair/netifaces)
+- [pyserial](https://github.com/pyserial/pyserial)
+
+Op meer ongebruikelijke systemen, en in sommige zeldzame gevallen, is het misschien niet mogelijk om een of meer van de bovenstaande modules te installeren of zelfs te compileren. In dergelijke situaties kunt u in plaats daarvan het pakket `rnspure` gebruiken, waarvoor geen externe afhankelijkheden nodig zijn voor de installatie. Houd er rekening mee dat de inhoud van de pakketten `rns` en `rnspure` *identiek* is. Het enige verschil is dat het `rnspure`-pakket geen afhankelijkheden vermeldt die vereist zijn voor de installatie.
+
+Ongeacht hoe Reticulum is geïnstalleerd en gestart, het zal alleen externe afhankelijkheden laden als deze *nodig* en *beschikbaar* zijn. Als u bijvoorbeeld Reticulum wilt gebruiken op een systeem dat [pyserial](https://github.com/pyserial/pyserial) niet kan ondersteunen, is het perfect mogelijk om dit te doen met het `rnspure`-pakket, maar Reticulum zal dan niet in staat zijn om seriële interfaces te gebruiken. Alle andere beschikbare modules worden nog steeds geladen wanneer dat nodig is.
+
+**Let op!** Als u het `rnspure`-pakket gebruikt om Reticulum uit te voeren op systemen die [PyCA/cryptography](https://github.com/pyca/cryptography) niet ondersteunen, is het belangrijk dat u eerst het [Cryptografische Primitieven](crypto_nl.html) hoofdstuk van deze site leest en begrijpt.
+
+## Prestatie
+Reticulum streeft naar een *zeer* breed bruikbaar prestatiebereik, maar geeft prioriteit aan functionaliteit en prestaties boven mediums met een lage bandbreedte. Het doel is om een dynamisch prestatiebereik te bieden van 250 bits per seconde tot 1 gigabit per seconde op normale hardware.
+
+Momenteel bedraagt het bruikbare prestatiebereik ongeveer 150 bits per seconde tot 40 megabits per seconde, waarbij fysieke media sneller dan dat niet verzadigd zijn. Prestaties boven het huidige niveau zijn bedoeld voor toekomstige upgrades, maar krijgen geen hoge prioriteit totdat het draadformaat en de API zijn vergrendeld.
+
+Volgend onderwerp: ondersteunde hardware
diff --git a/source/start_pl.md b/source/start_pl.md
index db0efa8..64bed40 100644
--- a/source/start_pl.md
+++ b/source/start_pl.md
@@ -10,7 +10,7 @@ co chcesz zrobić. Aby uzyskać pełne szczegóły i przykłady, sprawdź rodzia
Jeśli masz problemy lub coś nie działa, oto kilka świetnych miejsc, w których możesz poprosić o pomoc:
- [Forum dyskusyjne](https://github.com/markqvist/Reticulum/discussions) na GitHubie
-- Kanał [Matrix Reticulum](element://room/!TRaVWNnQhAbvuiSnEK%3Amatrix.org?via=matrix.org) pod `#reticulum:matrix.org`
+- Kanał [Matrix Reticulum](https://matrix.to/#/#reticulum:matrix.org) pod `#reticulum:matrix.org`
- [Subreddit Reticulum](https://reddit.com/r/reticulum)
## Instalacja
@@ -64,6 +64,6 @@ Bez względu na to, jak Reticulum jest zainstalowane i uruchomione, załaduje ze
## Wydajność
Reticulum celuje w *bardzo* szeroki zakres wydajności użytkowej, ale priorytetowo traktuje funkcjonalność i wydajność w stosunku do mediów o niskiej przepustowości. Celem jest zapewnienie dynamicznej wydajności od 250 bitów na sekundę do 1 gigabita na sekundę na normalnym sprzęcie.
-Obecnie użyteczna wydajność wynosi około 500 bitów na sekundę do 20 megabitów na sekundę, z nośnikami fizycznymi szybszymi niż te które nie są nienasycone. Wydajność wykraczająca poza obecny poziom jest przeznaczona do przyszłych aktualizacji, ale nie ma wysokiego priorytetu do czasu zablokowania formatu przewodów i API.
+Obecnie użyteczna wydajność wynosi około 150 bitów na sekundę do 40 megabitów na sekundę, z nośnikami fizycznymi szybszymi niż te które nie są nienasycone. Wydajność wykraczająca poza obecny poziom jest przeznaczona do przyszłych aktualizacji, ale nie ma wysokiego priorytetu do czasu zablokowania formatu przewodów i API.
Następny Temat: Wspierany Hardware
diff --git a/source/start_pt-br.md b/source/start_pt-br.md
index 8b5e6eb..4827247 100644
--- a/source/start_pt-br.md
+++ b/source/start_pt-br.md
@@ -12,7 +12,7 @@ Utilize o Reticulum se estiver confortável em relação a isso e entenda suas i
Se você estiver com problemas ou se algo não estiver funcionando, aqui estão alguns ótimos lugares para pedir ajuda:
- O [fórum de discussão](https://github.com/markqvist/Reticulum/discussions) no GitHub
-- O canal da [Matrix do Retículum](element://room/!TRaVWNnQhAbvuiSnEK%3Amatrix.org?via=matrix.org) em `#reticulum:matrix.org`
+- O canal da [Matrix do Retículum](https://matrix.to/#/#reticulum:matrix.org) em `#reticulum:matrix.org`
- O [subreddit Reticulum](https://reddit.com/r/reticulum)
## Instalação
@@ -68,6 +68,6 @@ Não importa como o Reticulum é instalado ou iniciado, ele vai carregar as depe
Reticulum possuí um grande potencial de desempenho, mas prioriza a funcionalidade e desempenho em dispositivos de baixa largura de rede. O objetivo é fornecer desempenho dinâmico de 250 bits por segundo para 1 gigabit por segundo em hardware normal.
-Atualmente o desempenho usual é aproximadamente 500 bits por segundo até 20 megabits por segundo, com dispositivos físicos mais rápidos que isso não sendo saturados. O desempenho além do nível atual é esperado para as próximas atualizações, mas não com prioridade alta até que o formato de cabo e API estejam maduros.
+Atualmente o desempenho usual é aproximadamente 150 bits por segundo até 40 megabits por segundo, com dispositivos físicos mais rápidos que isso não sendo saturados. O desempenho além do nível atual é esperado para as próximas atualizações, mas não com prioridade alta até que o formato de cabo e API estejam maduros.
Próxima Página: Hardware Compátivel
diff --git a/source/start_tr.md b/source/start_tr.md
new file mode 100644
index 0000000..a6e7e3a
--- /dev/null
+++ b/source/start_tr.md
@@ -0,0 +1,68 @@
+# Hoş Geldiniz
+Reticulum Ağı ile başlamanın en iyi yolu, ne yapmak istediğinize bağlıdır. Tam detaylar ve örnekler için [Hızlı Başlangıç](manual/gettingstartedfast.html) bölümüne [Reticulum Kılavuzu](manual/index.html)'nda göz atın.
+
+## Deneysel Yazılım
+*Dikkat!* Reticulum hala beta aşamasındadır. Şu an çok iyi çalışsa ve çok stabil olsa da, sistemde genel olarak kritik hatalar veya eksiklikler olabilir. Reticulum'u kullanıyorsanız buna rahatlıkla uyum sağlıyorsanız ve sonuçların ne anlama geldiğini anlıyorsanız kullanın.
+
+## Topluluk ve Destek
+Eğer sorun yaşarsanız veya bir şey çalışmıyorsa, yardım istemek için harika yerler şunlar:
+
+- [GitHub'daki tartışma forumu](https://github.com/markqvist/Reticulum/discussions)
+- `#reticulum:matrix.org` üzerinden [Reticulum Matrix Kanalı](https://matrix.to/#/#reticulum:matrix.org)
+- [Reticulum subreddit'i](https://reddit.com/r/reticulum)
+
+## Kurulum
+Sisteminize Reticulum'u ve ilgili araçları kurmanın en kolay yolu `pip` kullanmaktır:
+
+```bash
+pip install rns
+```
+
+Daha sonra Reticulum kullanan herhangi bir programı başlatabilir veya [rnsd aracı](manual/using.html#the-rnsd-utility) ile Reticulum'u bir sistem servisi olarak başlatabilirsiniz.
+
+Eğer sisteminizde `pip` mevcut değilse, önce işletim sisteminiz için `python3` ve `python3-pip` paketlerini kurun.
+
+İlk başlatıldığında Reticulum, yerel olarak erişilebilen diğer Reticulum eşlerine temel bağlantı sağlayan varsayılan bir yapılandırma dosyası oluşturacaktır. Bu yerel eşlerin herhangi biri Taşıma Örnekleri ise, sizi daha geniş ağlara bağlayabilirler. Varsayılan yapılandırma dosyası birkaç örnek ve daha karmaşık bir yapılandırma oluşturma referansları içerir.
+
+Daha ayrıntılı örnekler için paket radyo veya LoRa, seri portlar veya hızlı IP bağlantıları ve UDP ve TCP arabirimlerini kullanarak İnternet üzerinden iletişimi genişletme konusunda [Desteklenen Arabirimler](manual/interfaces.html) bölümüne [Reticulum Kılavuzu](manual/index.html)'nda göz atın.
+
+## Dahil Edilen Araçlar
+Reticulum, ağlarınızı yönetmek, durum ve bilgi görüntülemek ve diğer görevler için bir dizi kullanışlı araç içerir. Bu programlar hakkında daha fazla bilgiyi [Dahil Edilen Yardımcı Programlar](manual/using.html#included-utility-programs) bölümünde [Reticulum Kılavuzu](manual/index.html)'nda bulabilirsiniz.
+
+- Reticulum'u her zaman kullanılabilir bir servis olarak çalıştırmak için sistem arka plan uygulaması `rnsd`
+- Arayüz durumu için bilgi gösteren `rnstatus` adlı bir araç
+- Yol tablolarını görüntülemenizi ve değiştirmenizi sağlayan `rnpath` adlı bir yol arama ve yönetim aracı
+- Bağlantıları kontrol etmek için `rnprobe` adlı bir teşhis aracı
+- Uzak sistemlere dosya kopyalamayı kolaylaştıran basit bir dosya transfer programı olan `rncp`
+- Uzak sistemlerden komutları ve programları çalıştırmanıza ve çıktıları almanıza izin veren uzaktan komut yürütme programı `rnx`
+
+Tüm araçlar, `rnx` ve `rncp` dahil, düşük bant genişliği bağlantıları üzerinde bile güvenilir bir şekilde çalışır.
+
+## Reticulum Kullanan Programlar
+Reticulum'un ne yapabileceğine hızlı bir şekilde bir fikir edinmek istiyorsanız, aşağıdaki kaynaklara göz atın.
+
+- Off-grid, şifreli ve dayanıklı bir ağ iletişim platformu için [Nomad Network](https://github.com/markqvist/NomadNet)
+- Android, Linux ve macOS uygulaması [Sideband](https://github.com/markqvist/sideband) grafik arayüze sahiptir ve kullanım kolaylığına odaklanır.
+- [LXMF](https://github.com/markqvist/lxmf), Reticulum üzerine inşa edilmiş dağıtılmış, gecikmeli ve kesintiye uğramış bir ileti transfer protokolüdür.
+
+## Gereksinimler
+Varsayılan `rns` paketinin kurulumu aşağıda listelenen gereksinimleri ister. Hemen hemen tüm sistemler ve dağıtımlar, bu bağımlılıklar için gereken hazır paketlere sahiptir ve `pip` ile `rns` paketi kurulduğunda indirilip kurulacaktır.
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography)
+- [netifaces](https://github.com/al45tair/netifaces)
+- [pyserial](https://github.com/pyserial/pyserial)
+
+Daha sıra dışı sistemlerde ve bazı nadir durumlarda yukarıdaki modüllerden bir veya daha fazlasını kurmak veya hatta derlemek mümkün olmayabilir. Bu durumlarda `rnspure` paketini kullanabilirsiniz, bu kurulum için harici bağımlılıklar gerektirmez. Lütfen unutmayın ki `rns` ve
+
+ `rnspure` paketlerinin içerikleri *aynıdır*. Tek fark, `rnspure` paketinin kurulum için gerekli bağımlılıkları listelememesidir.
+
+Reticulum nasıl kurulup başlatılırsa başlatsın, dış bağımlılıkları sadece *gerektiğinde* ve *uygunsa* yükler. Örneğin, [pyserial](https://github.com/pyserial/pyserial) desteklemeyen bir sistemde Reticulum'u kullanmak istiyorsanız, bunu `rnspure` paketi kullanarak yapabilirsiniz, ancak Reticulum seri tabanlı arayüzleri kullanamayacaktır. Diğer tüm kullanılabilir modüller, ihtiyaç duyulduğunda yine yüklenecektir.
+
+**Lütfen Dikkat Edin!** `rnspure` paketini [PyCA/cryptography](https://github.com/pyca/cryptography)'yi desteklemeyen sistemlerde Reticulum'u çalıştırmak istiyorsanız, bu sitenin [Şifreleme Temelleri](crypto.html) bölümünü okumanız gerekmektedir.
+
+## Performans
+Reticulum, çok geniş bir kullanılabilir performans aralığına yönelik olup, düşük bant genişliği ortamlarında işlevselliği ve performansı önceliklendirir. Hedef, normal donanımda 250 bit/s'den 1 gigabit/s'ye dinamik bir performans aralığı sağlamaktır.
+
+Şu anda kullanılabilir performans aralığı yaklaşık olarak 150 bit/s ile 40 megabit/s arasındadır ve bu hızların üzerindeki fiziksel ortamlar doyurulmamaktadır. Mevcut seviyenin ötesinde performans, gelecekteki güncellemeler için ama wire formatı ve API kilitlendikten sonra öncelikli olarak düşünülmüyor.
+
+Sonraki Konu: Desteklenen Donanım
\ No newline at end of file
diff --git a/source/start_uk.md b/source/start_uk.md
new file mode 100644
index 0000000..8c9aa30
--- /dev/null
+++ b/source/start_uk.md
@@ -0,0 +1,66 @@
+# Початок роботи
+Найкращий спосіб почати роботу з мережею Reticulum залежить від того, що ви хочете зробити. Для повних деталей та прикладів ознайомтеся з розділом [Швидкий старт](manual/gettingstartedfast.html) в [Посібнику Reticulum](manual/index.html).
+
+## Експериментальне програмне забезпечення
+*Будь ласка, майте на увазі!* Reticulum все ще в бета-версії. Це означає, що хоча система вже працює дуже добре та є стабільною, можуть бути критичні помилки або недоліки в поведінці, конфіденційності або безпеці системи в цілому. Використовуйте Reticulum, якщо вам комфортно з цим і ви розумієте наслідки.
+
+## Спільнота та підтримка
+
+Якщо у вас виникли проблеми або щось не працює, ось кілька чудових місць, де можна попросити про допомогу:
+
+- [Форум обговорень](https://github.com/markqvist/Reticulum/discussions) на GitHub
+- [Канал Reticulum у Matrix](https://matrix.to/#/#reticulum:matrix.org) на `#reticulum:matrix.org`
+- [Subreddit Reticulum](https://reddit.com/r/reticulum)
+
+## Встановлення
+Для встановлення Reticulum та супутніх утиліт на вашу систему найпростішим способом є використання pip:
+
+```bash
+pip install rns
+```
+Ви можете запустити будь-яку програму, що використовує Reticulum, або запустити Reticulum як системну службу за допомогою утиліти [rnsd](manual/using.html#the-rnsd-utility).
+
+Якщо `pip` недоступний на вашій системі, спочатку встановіть пакети `python3` та `python3-pip` для вашої ОС.
+
+Під час першого запуску Reticulum створить конфігураційний файл за замовчуванням, який забезпечить базовий зв'язок з іншими одноранговими проєктами Reticulum, які можуть бути доступними локально. Якщо серед них є транспортні екземпляри, вони можуть з'єднати вас з більш широкими мережами. Файл конфігурації містить кілька прикладів та посилань для створення більш складної конфігурації.
+
+Для більш детальних прикладів того, як розширити зв'язок через різні канали, такі як пакетне радіо або LoRa, послідовні порти, або через швидкі IP-з'єднання та Інтернет, використовуючи інтерфейси UDP та TCP, ознайомтесь із розділом [Підтримувані інтерфейси](manual/interfaces.html) в [Посібнику Reticulum](manual/index.html).
+
+## Включені утиліти
+Reticulum включає ряд корисних утиліт для керування вашими мережами, перегляду статусу та інформації, а також виконання інших завдань. Більше про ці програми можна дізнатися в розділі [Включені утилітні програми](manual/using.html#included-utility-programs) в [Посібнику Reticulum](manual/index.html).
+
+- Системний демон `rnsd` для запуску Reticulum як завжди доступної служби
+- Утиліта для перегляду статусу інтерфейсів під назвою `rnstatus`, яка виводить інформацію про інтерфейси
+- Інструмент для перегляду та керування таблицями шляхів `rnpath`
+- Діагностична утиліта під назвою `rnprobe` для перевірки з'єднання з пунктами призначення
+- Простий файл-переносник `rncp`, який дозволяє легко копіювати файли на віддалені системи
+- Утиліта для віддаленого виконання команд `rnx`, яка дозволяє запускати команди та програми на віддалених системах і отримувати виведення
+
+Усі інструменти, включаючи `rnx` та `rncp`, працюють надійно навіть через дуже низькошвидкісні з'єднання, такі як LoRa або пакетне радіо.
+
+## Програми, що використовують Reticulum
+Якщо ви хочете швидко зрозуміти, що може зробити Reticulum, ознайомтесь з наступними ресурсами.
+
+- Для оффлайн, зашифрованої та стійкої мережевої платформи, дивіться [Nomad Network](https://github.com/markqvist/NomadNet)
+- Мобільний додаток для Android, Linux та macOS [Sideband](https://github.com/markqvist/sideband) має графічний інтерфейс і зосереджений на зручності використання.
+- [LXMF](https://github.com/markqvist/lxmf) — це розподілений, стійкий до затримок і переривань протокол передачі повідомлень, побудований на Reticulum.
+
+## Залежності
+Встановлення за замовчуванням пакету `rns` потребує таких залежностей. Більшість систем та дистрибутивів мають доступні пакети для цих залежностей, і коли пакет `rns` встановлюється через `pip`, вони також будуть завантажені та встановлені.
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography)
+- [netifaces](https://github.com/al45tair/netifaces)
+- [pyserial](https://github.com/pyserial/pyserial)
+
+На менш звичайних системах, а також у рідкісних випадках, може бути неможливо встановити або навіть скомпілювати один або кілька з вищезгаданих модулів. У таких ситуаціях ви можете використати пакет `rnspure` замість цього, який не потребує зовнішніх залежностей для встановлення. Зверніть увагу, що вміст пакетів `rns` та `rnspure` *ідентичний*. Єдина різниця в тому, що пакет `rnspure` не має списку залежностей, необхідних для встановлення.
+
+Не залежно від того, як Reticulum було встановлено і запущено, воно завантажить зовнішні залежності тільки якщо вони *необхідні* і *доступні*. Якщо, наприклад, ви хочете використовувати Reticulum на системі, яка не підтримує [pyserial](https://github.com/pyserial/pyserial), це цілком можливо зробити, використовуючи пакет `rnspure`, але Reticulum не зможе використовувати інтерфейси, що базуються на серійному з'єднанні. Усі інші доступні модулі будуть завантажені, коли це буде потрібно.
+
+**Зверніть увагу!** Якщо ви використовуєте пакет `rnspure` для запуску Reticulum на системах, які не підтримують [PyCA/cryptography](https://github.com/pyca/cryptography), важливо, щоб ви прочитали і зрозуміли розділ [Криптографічні примітиви](crypto.html) на цьому сайті.
+
+## Продуктивність
+Reticulum орієнтовано на дуже широкий діапазон використаної продуктивності, але при цьому надається пріоритет функціональності та продуктивності над низькошвидкісними середовищами. Метою є забезпечення динамічного діапазону продуктивності від 250 біт на секунду до 1 гігабіта на секунду на звичайному обладнанні.
+
+Наразі використаний діапазон продуктивності становить приблизно від 150 біт на секунду до 40 мегабіт на секунду, при цьому фізичні середовища, що перевищують цей рівень, не насичуються. Продуктивність, що перевищує поточний рівень, планується для майбутніх оновлень, але не є головним пріоритетом, поки не буде зафіксовано формат передачі та API.
+
+Наступна тема: Підтримуване обладнання
diff --git a/source/start_zh-cn.md b/source/start_zh-cn.md
new file mode 100644
index 0000000..6257ea5
--- /dev/null
+++ b/source/start_zh-cn.md
@@ -0,0 +1,67 @@
+# 开始使用
+开始使用 Reticulum 的第一步是看看自己想用它做什么。如果你想了解完整的细节或是参照一些例子，请参阅[Reticulum 手册](manual/index.html)的[快速开始](manual/gettingstartedfast.html)部分。
+
+## 实验性软件
+*请注意！* Reticulum 仍旧处于 Beta 测试阶段。虽然它目前已经工作得相当良好而且稳定，但是在系统整体的行为、隐私或安全性上仍旧可能存在致命的漏洞与缺陷。如果你已经了解可能的后果，并且感觉没问题的话，就开始使用吧！
+
+## 社区与支持
+
+如果你遇到了问题，又或是有些东西不工作，以下是一些寻求帮助的好地方：
+
+- [Reticulum Github 讨论区](https://github.com/markqvist/Reticulum/discussions)
+- [Reticulum Matrix 群组](https://matrix.to/#/#reticulum:matrix.org)（`#reticulum:matrix.org`）
+- [Reticulum Reddit 讨论版](https://reddit.com/r/reticulum)
+
+## 安装
+安装 Reticulum 及其相关工具最简单的方式是使用 pip：
+
+```bash
+pip install rns
+```
+
+安装完成后，你便可以启动任何依赖 Reticulum 运行的程序，或者是使用 [rnsd 工具](manual/using.html#the-rnsd-utility) 将 Reticulum 作为服务运行。
+
+如果 `pip` 在你的系统上不可用，请首先安装 `python3` 与 `python3-pip`。
+
+首次启动时，Reticulum 会创建一个默认的配置文件。它会试着连接本地可达的 Reticulum 节点(peer)。如果其中有些节点是”传输节点(Transport Instances)“，它们便可以帮助你连接上更大范围的网络。默认的配置文件提供了几个样例，以及用于创建复杂配置的参考。
+
+如果想了解更多将通信扩展到各个媒介(如封包无线电，LoRa、串口、基于IP的高速连接、通过UDP/TCP连接互联网等)的细节，请参阅 [Reticulum 手册](manual/index.html) 的[受支持的界面](manual/interfaces.html)部分。
+
+## 附带工具
+Reticulum 附带了用于管理网络、查看状态与信息等用途的一系列工具。欲知详情，请参阅 [Reticulum 手册](manual/index.html)的[附带工具](manual/using.html#included-utility-programs)部分。
+
+- 用于将 Reticulum 作为服务运行的守护进程(Daemon) `rnsd`
+- 用于查看界面信息的工具 `rnstatus`
+- 用于查看与更改路径表(Path Tables)的工具 `rnpath`
+- 用于检查与目标连接性的诊断工具 `rnprobe`
+- 让你可以简单复制文件的文件传输工具 `rncp`
+- 运行程序或命令并获取输出的远程命令执行工具 `rnx`
+
+以上提到的所有工具，包括 `rnx` 与 `rncp`，即使是通过带宽极低的链路(如 LoRa 与封包无线电)也能可靠且良好地工作。
+
+## 使用 Reticulum 的程序
+如果你想知道 Reticulum 能做什么，可以参考以下链接。
+
+- 无需基建、加密且可自恢复的网状通讯平台 [Nomad Network](https://github.com/markqvist/NomadNet)
+- 带有图形界面、注重易用性、可在 Android、Linux 与 macOS 使用的 [Sideband](https://github.com/markqvist/sideband)
+- 一个分布式、抗延迟、抗干扰、基于 Reticulum 的消息传输协议 [LXMF](https://github.com/markqvist/lxmf)
+
+## 依赖处理
+`rns` 包默认条件下的安装需要以下依赖。几乎所有的系统与发行版都有直接可用的软件包。如果是通过 `pip` 安装，这些依赖会直接被下载安装。
+
+- [PyCA/cryptography](https://github.com/pyca/cryptography)
+- [netifaces](https://github.com/al45tair/netifaces)
+- [pyserial](https://github.com/pyserial/pyserial)
+
+若你使用的是较为罕见的系统，或是有一些特殊情况，上面的依赖不一定总是能安装或是编译成功。这时，你可以使用无需额外依赖的 `rnspure` 包。请注意 `rns` 与 `rnspure`包的内容是*完全一致*的。唯一的区别是 `rnspure` 包没有显式要求需要安装的依赖。
+
+不论安装 Reticulum 的手段为何，Reticulum 都会在*需要*且*可用*的情况下加载外部依赖。如果你想在一个不支持 [pyserial](https://github.com/pyserial/pyserial) 的系统上运行 Reticulum，使用 `rnspure` 包即可。但是此时 Reticulum 将无法使用基于串口的界面。所有其他模块仍旧会在需要时被 Reticulum 载入。
+
+**注意！** 如果你在不支持 [PyCA/cryptography](https://github.com/pyca/cryptography) 的系统上使用 `rnspure` 包，请一定确保自己阅读并理解了[密码学原语](crypto_zh-cn.html)的相关内容。
+
+## 性能
+Reticulum 的可用性能范围*非常广*，但是会优先保证低带宽媒介的可用性与性能。Reticulum 的目标是提供一个 250 bps 到 1 Gbps(普通硬件条件下)的性能区间。
+
+目前可用的性能区间是 150 bps 到 40 Mbps。更快的连接无法被充分利用。未来，Reticulum 可能会升级性能，但直到有线格式(wire format)和 API 完全稳定之前，性能的提升都不会是优先事项。
+
+下一个主题: 硬件支持
