1157 lines
35 KiB
HTML
1157 lines
35 KiB
HTML
<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><style>body {
|
||
max-width: 980px;
|
||
border: 1px solid #ddd;
|
||
outline: 1300px solid #fff;
|
||
margin: 16px auto;
|
||
}
|
||
|
||
body .markdown-body
|
||
{
|
||
padding: 45px;
|
||
}
|
||
|
||
@font-face {
|
||
font-family: fontawesome-mini;
|
||
src: url(data:font/woff;charset=utf-8;base64,d09GRgABAAAAABE0AA8AAAAAHWwAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABHU1VCAAABWAAAADsAAABUIIslek9TLzIAAAGUAAAAQwAAAFY3d1HZY21hcAAAAdgAAACqAAACOvWLi0FjdnQgAAAChAAAABMAAAAgBtX/BGZwZ20AAAKYAAAFkAAAC3CKkZBZZ2FzcAAACCgAAAAIAAAACAAAABBnbHlmAAAIMAAABdQAAAjkYT9TNWhlYWQAAA4EAAAAMwAAADYQ6WvNaGhlYQAADjgAAAAfAAAAJAc6A1pobXR4AAAOWAAAACAAAAA0Kmz/7mxvY2EAAA54AAAAHAAAABwQPBJubWF4cAAADpQAAAAgAAAAIAEHC/NuYW1lAAAOtAAAAYQAAALxhQT4h3Bvc3QAABA4AAAAfgAAAMS3SYh9cHJlcAAAELgAAAB6AAAAhuVBK7x4nGNgZGBg4GIwYLBjYHJx8wlh4MtJLMljkGJgYYAAkDwymzEnMz2RgQPGA8qxgGkOIGaDiAIAJjsFSAB4nGNgZHZmnMDAysDAVMW0h4GBoQdCMz5gMGRkAooysDIzYAUBaa4pDA4Pwz+yMwf9z2KIYg5imAYUZgTJAQDcoQvQAHic7ZHNDYJAFIRnBXf94cDRIiyCKkCpwFCPJ092RcKNDoYKcN4+EmMPvpdvk539zQyAPYBCXEUJhBcCrJ5SQ9YLnLJe4qF5rdb+uWPDngNHTkta101pNyWa8lMhn6xx2dqUnW4q9YOIhAOOeueMSgsR/6ry+P7O5s6xVNg4chBsHUuFnWNJ8uZYwrw7chrsHXkODo7cB0dHOYCTY8kv0VE2WJKD6gOlWjsxAAB4nGNgQAMSEMgc9D8LhAESbAPdAHicrVZpd9NGFB15SZyELCULLWphxMRpsEYmbMGACUGyYyBdnK2VoIsUO+m+8Ynf4F/zZNpz6Dd+Wu8bLySQtOdwmpOjd+fN1czbZRJaktgL65GUmy/F1NYmjew8CemGTctRfCg7eyFlisnfBVEQrZbatx2HREQiULWusEQQ+x5ZmmR86FFGy7akV03KLT3pLlvjQb1V334aOsqxO6GkZjN0aD2yJVUYVaJIpj1S0qZlqPorSSu8v8LMV81QwohOImm8GcbQSN4bZ7TKaDW24yiKbLLcKFIkmuFBFHmU1RLn5IoJDMoHzZDyyqcR5cP8iKzYo5xWsEu20/y+L3mndzk/sV9vUbbkQB/Ijuzg7HQlX4RbW2HctJPtKFQRdtd3QmzZ7FT/Zo/ymkYDtysyvdCMYKl8hRArP6HM/iFZLZxP+ZJHo1qykRNB62VO7Es+gdbjiClxzRhZ0N3RCRHU/ZIzDPaYPh788d4plgsTAngcy3pHJZwIEylhczRJ2jByYCVliyqp9a6YOOV1WsRbwn7t2tGXzmjjUHdiPFsPHVs5UcnxaFKnmUyd2knNoykNopR0JnjMrwMoP6JJXm1jNYmVR9M4ZsaERCICLdxLU0EsO7GkKQTNoxm9uRumuXYtWqTJA/Xco/f05la4udNT2g70s0Z/VqdiOtgL0+lp5C/xadrlIkXp+ukZfkziQdYCMpEtNsOUgwdv/Q7Sy9eWHIXXBtju7fMrqH3WRPCkAfsb0B5P1SkJTIWYVYhWQGKta1mWydWsFqnI1HdDmla+rNMEinIcF8e+jHH9XzMzlpgSvt+J07MjLj1z7UsI0xx8m3U9mtepxXIBcWZ5TqdZlu/rNMfyA53mWZ7X6QhLW6ejLD/UaYHlRzodY3lBC5p038GQizDkAg6QMISlA0NYXoIhLBUMYbkIQ1gWYQjLJRjC8mMYwnIZhrC8rGXV1FNJ49qZWAZsQmBijh65zEXlaiq5VEK7aFRqQ54SbpVUFM+qf2WgXjzyhjmwFkiXyJpfMc6Vj0bl+NYVLW8aO1fAsepvH472OfFS1ouFPwX/1dZUJb1izcOTq/Abhp5sJ6o2qXh0TZfPVT26/l9UVFgL9BtIhVgoyrJscGcihI86nYZqoJVDzGzMPLTrdcuan8P9NzFCFlD9+DcUGgvcg05ZSVnt4KzV19uy3DuDcjgTLEkxN/P6VvgiI7PSfpFZyp6PfB5wBYxKZdhqA60VvNknMQ+Z3iTPBHFbUTZI2tjOBIkNHPOAefOdBCZh6qoN5E7hhg34BWFuwXknXKJ6oyyH7kXs8yik/Fun4kT2qGiMwLPZG2Gv70LKb3EMJDT5pX4MVBWhqRg1FdA0Um6oBl/G2bptQsYO9CMqdsOyrOLDxxb3lZJtGYR8pIjVo6Of1l6iTqrcfmYUl++dvgXBIDUxf3vfdHGQyrtayTJHbQNTtxqVU9eaQ+NVh+rmUfW94+wTOWuabronHnpf06rbwcVcLLD2bQ7SUiYX1PVhhQ2iy8WlUOplNEnvuAcYFhjQ71CKjf+r+th8nitVhdFxJN9O1LfR52AM/A/Yf0f1A9D3Y+hyDS7P95oTn2704WyZrqIX66foNzBrrblZugbc0HQD4iFHrY64yg18pwZxeqS5HOkh4GPdFeIBwCaAxeAT3bWM5lMAo/mMOT7A58xh0GQOgy3mMNhmzhrADnMY7DKHwR5zGHzBnHWAL5nDIGQOg4g5DJ4wJwB4yhwGXzGHwdfMYfANc+4DfMscBjFzGCTMYbCv6dYwzC1e0F2gtkFVoANTT1jcw+JQU2XI/o4Xhv29Qcz+wSCm/qjp9pD6Ey8M9WeDmPqLQUz9VdOdIfU3Xhjq7wYx9Q+DmPpMvxjLZQa/jHyXCgeUXWw+5++J9w/bxUC5AAEAAf//AA94nIVVX2hbZRQ/5/t7893s5ja9f7ouzdZ0TTqz3bRJmogbWya6bG6Cq0VbSV2ddIJjFtfIQHEig80Hda8yUN/0YQz8AyriiyD+xQd92R4HCnaCb3samnpumrpsCsLlfPf7zvedc37nL3CAtc/5W/wQZGA3tOBSY/g+TMjHmwzEoM1Q8+ZjRZY4oJhmBw5/YB6Za0yC5AkhlwA1A1yCBIBOwCII0Cj0U8BAMdUCzq05sKwkP7SlUY6fcJk4Fb/RyE79/6P5hjM/F4aZiXBoeMgzcqQ4Xi1hPqfDLG5FT+lchCVU3lYMyvuwhl1mqndQL0RsuloLywHtthLXI06OblTrhfWVnpSJ5+mwu/JdbtuN3IAnkW0LLMcRwaC7ktrlzridM6kVdyf9uO1UNBByI7JhwtG2sEwab07ORBeilWhqavJCqV0qzZTOl/7ZXQ5TbTcdcFelyGhhRDAQpdqp1FEX3w3cFTc1k9pJQkmm4ySCbSikxRP2QOfN+0tHS5MrpQuTU1Mk5nw0E5Xa0WvrOwDyGax9yB9ma6DAg82wHc43SAGTI4GjBWebOePAERFE8/AHaQpZASSTy8A4WwZiLQMQ82mFKATO0ILicRAoDm9p5P99E5b/fXG+kQYY3TYUuqmERWYoT0u/GNYL2q/4WB3LaVS+VynXsVYIcWw6DkCh3nX1D+VzlYN4LClF5yexSQos8exqZ3KVP+wtrC54u4Nznq6cq+xpMpUUnZ8FUYzE86ud0g28NOIv3Gj5/rmA3ABs7S/ywzFuQ4qyd6QxfNtiQIaEgp3w/entQg4Vcbqa16M5FfpeUB8t1+qeg7mI7cUyOe79wOk86gSxkVec4KPTX69++5x68Yubn5/F+w52z7u08sJX7fZXv8ekT/d2mILJxq6sn+SC6qEJknzLJCxyZEKwWVqYmAPBxBE/9DLeZiWHu7lcr/VytrCRuHojncNuTt9h46tmacmYisnSamdN2bZptcsmSysdVsy1PrOvOzF3xN64Rb937t/og9KHxYdcjIUqFAmIAHGHNzlns+RTPgeUYAQm9DwpNxfxbhhBHPaw3/gfTcXO2L+eJVIx5nsyGkvm9X4/f+bGkH45G0PaSjcMXTjcZyTvi3UdHoCDjQd3IDUVsgwYmUoJK/gp4JJxeRI0MKHZIkgynyIBqBTOUs6rOVCojvjZ4mCQz49ZMlMcp8QoYk6NoBfsxnJtsBohpa8iGJS+ZH7gU7NxME6cmF+t7cO9vB8d3jTWSct0ycW9ranXmolNDwmVkNnxe+8JtoztwS5rKJ0xWS95tQ/1zMYzg69MzUZnNtl1ofNbsml/OJm6f9wjRjpnu2o4MzHzn77IQkRd+1DjwMQ2pqSjGMMhyjrgTbBAKksuUm0iU7hI0aN2wOKOq7WYBSH0HGihj/jkiPxAfmwsEbfYrjMG+j3ij932Db/LV7I/xruNrhnroxjR9HRMb2nTvO0ZXOoHPk8H2ZhDPx93qcE/53sH5np/dkIP7zzhTVKdR/BAY/9ElkkR+A6lJGsqpJ4oQcTxpvBT3Kn58VkaJjgHyPEIws57xkaHh9KuVpDEpJZeMbZ5w/zBHi5NMQ4r5VphsFqID7TyB9eR4pX216c3AHxpdAwoqU9qg0ZJ6yVLKmMSz1iG2z27ifx18NkY0LPx1W/wCc2l5LrznrIsiKsqbmB78A9wIGx4tI8rjihVHJyY9pgMirenVq0yWg7Iw7eogG7ZgYM3qR9959A/fZkg6MnD/exlkmc+jWV4SB15XUR+eqC6l6ZmgPtN9z5JMfik05OV8ljylunJ4J+wA/FUaQSSKotsYsCWqaPBidBLcxkWx7XKFRIb45TGaEhjlF9uUVPqXOtcIwsXbBvfoZXIyRYFdkfnqjExH98xpnPczqzjX/uNdO1Y17Wpi5+6Ts8BXtjVFasp9KZ1mOiNbH65c5w6HgmyF2jFCZywM8mWjRc7T5Pmt0lRy7Y71+jYbpGyvwG4sH0XeJxjYGRgYADiwBB/53h+m68M3MwvgCIM1z5N/g6j///9v5H5BbMnkMvBwAQSBQCIcA9gAHicY2BkYGAO+p8FJF/8//v/F/MLBqAICuAFALYQB5kAeJxjfsHAwLwAiCNB+P9fbJjJmoGBMRUo/wKCAfO2EnQAAAAAANoBXgGcAgICVALaA1IDvAPkBAYEPARyAAEAAAANAF0ABAAAAAAAAgAUACQAcwAAAG4LcAAAAAB4nHWRzWrCQBSFT+pPqUIXLXTTzayKUohGKIibCoLuhbrrYtTRxCYZmYyKyz5Fd32HvlDfoO/QkziIFJtw9bvnnpl7ZwLgBt/wcHieGAf2UGd24Atcou+4RH3kuEweO66QXx1XyaHjGh6ROa7jFp/cwStfMVvhy7GHO+/e8QWuvcBxifqz4zL5xXGF/Oa4Sn53XMPE+3Bcx4P3M9DrvYmWoRWNQVN02kFXTPdCU4pSGQu5saE2meiLhU6timPtz3SSs9ypTCdqrJabWJoT5QQnymSRTkXgt0/UkUqVkVbN807ZdtmxdiEWRidi6HqItdErNbN+aO2612qd9sYAGmvsYRBhyUu0EGhQbfK/gzYCdElTOgSdB1eEFBIxFYkNV4RFJWPeZyyYpVQVHTHZx4y/yVGX2LGWFZri51TccUOn5B7nPefVCSPvGhVVwUl9znveO2KkhV8Wk82PZ8qwZf8OVcu1+fSmWCMw/HMOwXvKaysqM+p+cVuWag8tvv+c+xdd+4+teJxtjUEOwiAURJla24KliQfhUA2g/Sl+CKXx+loNrpzVezOLEY34Ron/0WhwQoszOvQYIKFwwQiNSbSBeO2SZ0tBP4j3zVjKNng32ZmtD1VVXCuOiw/pJ8S3WOU6l+K5UOTaDC4+2TjKMtN9KQf1ezLx/Sg/00FCvABHhjDjAAB4nGPw3sFwIihiIyNjX+QGxp0cDBwMyQUbGVidNjEwMmiBGJu5mBg5ICw+BjCLzWkX0wGgNCeQze60i8EBwmZmcNmowtgRGLHBoSNiI3OKy0Y1EG8XRwMDI4tDR3JIBEhJJBBs5mFi5NHawfi/dQNL70YmBhcADHYj9AAA) format('woff');
|
||
}
|
||
|
||
.markdown-body {
|
||
font-family: sans-serif;
|
||
-ms-text-size-adjust: 100%;
|
||
-webkit-text-size-adjust: 100%;
|
||
color: #333333;
|
||
overflow: hidden;
|
||
font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif;
|
||
font-size: 16px;
|
||
line-height: 1.6;
|
||
word-wrap: break-word;
|
||
}
|
||
|
||
.markdown-body a {
|
||
background: transparent;
|
||
}
|
||
|
||
.markdown-body a:active,
|
||
.markdown-body a:hover {
|
||
outline: 0;
|
||
}
|
||
|
||
.markdown-body b,
|
||
.markdown-body strong {
|
||
font-weight: bold;
|
||
}
|
||
|
||
.markdown-body mark {
|
||
background: #ff0;
|
||
color: #000;
|
||
font-style: italic;
|
||
font-weight: bold;
|
||
}
|
||
|
||
.markdown-body sub,
|
||
.markdown-body sup {
|
||
font-size: 75%;
|
||
line-height: 0;
|
||
position: relative;
|
||
vertical-align: baseline;
|
||
}
|
||
.markdown-body sup {
|
||
top: -0.5em;
|
||
}
|
||
.markdown-body sub {
|
||
bottom: -0.25em;
|
||
}
|
||
|
||
.markdown-body h1 {
|
||
font-size: 2em;
|
||
margin: 0.67em 0;
|
||
}
|
||
|
||
.markdown-body img {
|
||
border: 0;
|
||
}
|
||
|
||
.markdown-body hr {
|
||
-moz-box-sizing: content-box;
|
||
box-sizing: content-box;
|
||
height: 0;
|
||
}
|
||
|
||
.markdown-body pre {
|
||
overflow: auto;
|
||
}
|
||
|
||
.markdown-body code,
|
||
.markdown-body kbd,
|
||
.markdown-body pre,
|
||
.markdown-body samp {
|
||
font-family: monospace, monospace;
|
||
font-size: 1em;
|
||
}
|
||
|
||
.markdown-body input {
|
||
color: inherit;
|
||
font: inherit;
|
||
margin: 0;
|
||
}
|
||
|
||
.markdown-body html input[disabled] {
|
||
cursor: default;
|
||
}
|
||
|
||
.markdown-body input {
|
||
line-height: normal;
|
||
}
|
||
|
||
.markdown-body input[type="checkbox"] {
|
||
box-sizing: border-box;
|
||
padding: 0;
|
||
}
|
||
|
||
.markdown-body table {
|
||
border-collapse: collapse;
|
||
border-spacing: 0;
|
||
}
|
||
|
||
.markdown-body td,
|
||
.markdown-body th {
|
||
padding: 0;
|
||
}
|
||
|
||
.markdown-body .codehilitetable {
|
||
border: 0;
|
||
border-spacing: 0;
|
||
}
|
||
|
||
.markdown-body .codehilitetable tr {
|
||
border: 0;
|
||
}
|
||
|
||
.markdown-body .codehilitetable pre,
|
||
.markdown-body .codehilitetable div.codehilite {
|
||
margin: 0;
|
||
}
|
||
|
||
.markdown-body .linenos,
|
||
.markdown-body .code,
|
||
.markdown-body .codehilitetable td {
|
||
border: 0;
|
||
padding: 0;
|
||
}
|
||
|
||
.markdown-body td:not(.linenos) .linenodiv {
|
||
padding: 0 !important;
|
||
}
|
||
|
||
.markdown-body .code {
|
||
width: 100%;
|
||
}
|
||
|
||
.markdown-body .linenos div pre,
|
||
.markdown-body .linenodiv pre,
|
||
.markdown-body .linenodiv {
|
||
border: 0;
|
||
-webkit-border-radius: 0;
|
||
-moz-border-radius: 0;
|
||
border-radius: 0;
|
||
-webkit-border-top-left-radius: 3px;
|
||
-webkit-border-bottom-left-radius: 3px;
|
||
-moz-border-radius-topleft: 3px;
|
||
-moz-border-radius-bottomleft: 3px;
|
||
border-top-left-radius: 3px;
|
||
border-bottom-left-radius: 3px;
|
||
}
|
||
|
||
.markdown-body .code div pre,
|
||
.markdown-body .code div {
|
||
border: 0;
|
||
-webkit-border-radius: 0;
|
||
-moz-border-radius: 0;
|
||
border-radius: 0;
|
||
-webkit-border-top-right-radius: 3px;
|
||
-webkit-border-bottom-right-radius: 3px;
|
||
-moz-border-radius-topright: 3px;
|
||
-moz-border-radius-bottomright: 3px;
|
||
border-top-right-radius: 3px;
|
||
border-bottom-right-radius: 3px;
|
||
}
|
||
|
||
.markdown-body * {
|
||
-moz-box-sizing: border-box;
|
||
box-sizing: border-box;
|
||
}
|
||
|
||
.markdown-body input {
|
||
font: 13px Helvetica, arial, freesans, clean, sans-serif, "Segoe UI Emoji", "Segoe UI Symbol";
|
||
line-height: 1.4;
|
||
}
|
||
|
||
.markdown-body a {
|
||
color: #4183c4;
|
||
text-decoration: none;
|
||
}
|
||
|
||
.markdown-body a:hover,
|
||
.markdown-body a:focus,
|
||
.markdown-body a:active {
|
||
text-decoration: underline;
|
||
}
|
||
|
||
.markdown-body hr {
|
||
height: 0;
|
||
margin: 15px 0;
|
||
overflow: hidden;
|
||
background: transparent;
|
||
border: 0;
|
||
border-bottom: 1px solid #ddd;
|
||
}
|
||
|
||
.markdown-body hr:before,
|
||
.markdown-body hr:after {
|
||
display: table;
|
||
content: " ";
|
||
}
|
||
|
||
.markdown-body hr:after {
|
||
clear: both;
|
||
}
|
||
|
||
.markdown-body h1,
|
||
.markdown-body h2,
|
||
.markdown-body h3,
|
||
.markdown-body h4,
|
||
.markdown-body h5,
|
||
.markdown-body h6 {
|
||
margin-top: 15px;
|
||
margin-bottom: 15px;
|
||
line-height: 1.1;
|
||
}
|
||
|
||
.markdown-body h1 {
|
||
font-size: 30px;
|
||
}
|
||
|
||
.markdown-body h2 {
|
||
font-size: 21px;
|
||
}
|
||
|
||
.markdown-body h3 {
|
||
font-size: 16px;
|
||
}
|
||
|
||
.markdown-body h4 {
|
||
font-size: 14px;
|
||
}
|
||
|
||
.markdown-body h5 {
|
||
font-size: 12px;
|
||
}
|
||
|
||
.markdown-body h6 {
|
||
font-size: 11px;
|
||
}
|
||
|
||
.markdown-body blockquote {
|
||
margin: 0;
|
||
}
|
||
|
||
.markdown-body ul,
|
||
.markdown-body ol {
|
||
padding: 0;
|
||
margin-top: 0;
|
||
margin-bottom: 0;
|
||
}
|
||
|
||
.markdown-body ol ol,
|
||
.markdown-body ul ol {
|
||
list-style-type: lower-roman;
|
||
}
|
||
|
||
.markdown-body ul ul ol,
|
||
.markdown-body ul ol ol,
|
||
.markdown-body ol ul ol,
|
||
.markdown-body ol ol ol {
|
||
list-style-type: lower-alpha;
|
||
}
|
||
|
||
.markdown-body dd {
|
||
margin-left: 0;
|
||
}
|
||
|
||
.markdown-body code,
|
||
.markdown-body pre,
|
||
.markdown-body samp {
|
||
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
||
font-size: 12px;
|
||
}
|
||
|
||
.markdown-body pre {
|
||
margin-top: 0;
|
||
margin-bottom: 0;
|
||
}
|
||
|
||
.markdown-body kbd {
|
||
background-color: #e7e7e7;
|
||
background-image: -moz-linear-gradient(#fefefe, #e7e7e7);
|
||
background-image: -webkit-linear-gradient(#fefefe, #e7e7e7);
|
||
background-image: linear-gradient(#fefefe, #e7e7e7);
|
||
background-repeat: repeat-x;
|
||
border-radius: 2px;
|
||
border: 1px solid #cfcfcf;
|
||
color: #000;
|
||
padding: 3px 5px;
|
||
line-height: 10px;
|
||
font: 11px Consolas, "Liberation Mono", Menlo, Courier, monospace;
|
||
display: inline-block;
|
||
}
|
||
|
||
.markdown-body>*:first-child {
|
||
margin-top: 0 !important;
|
||
}
|
||
|
||
.markdown-body>*:last-child {
|
||
margin-bottom: 0 !important;
|
||
}
|
||
|
||
.markdown-body .headerlink {
|
||
font: normal 400 16px fontawesome-mini;
|
||
vertical-align: middle;
|
||
margin-left: -16px;
|
||
float: left;
|
||
display: inline-block;
|
||
text-decoration: none;
|
||
opacity: 0;
|
||
color: #333;
|
||
}
|
||
|
||
.markdown-body .headerlink:focus {
|
||
outline: none;
|
||
}
|
||
|
||
.markdown-body h1 .headerlink {
|
||
margin-top: 0.8rem;
|
||
}
|
||
|
||
.markdown-body h2 .headerlink,
|
||
.markdown-body h3 .headerlink {
|
||
margin-top: 0.6rem;
|
||
}
|
||
|
||
.markdown-body h4 .headerlink {
|
||
margin-top: 0.2rem;
|
||
}
|
||
|
||
.markdown-body h5 .headerlink,
|
||
.markdown-body h6 .headerlink {
|
||
margin-top: 0;
|
||
}
|
||
|
||
.markdown-body .headerlink:hover,
|
||
.markdown-body h1:hover .headerlink,
|
||
.markdown-body h2:hover .headerlink,
|
||
.markdown-body h3:hover .headerlink,
|
||
.markdown-body h4:hover .headerlink,
|
||
.markdown-body h5:hover .headerlink,
|
||
.markdown-body h6:hover .headerlink {
|
||
opacity: 1;
|
||
text-decoration: none;
|
||
}
|
||
|
||
.markdown-body h1 {
|
||
padding-bottom: 0.3em;
|
||
font-size: 2.25em;
|
||
line-height: 1.2;
|
||
border-bottom: 1px solid #eee;
|
||
}
|
||
|
||
.markdown-body h2 {
|
||
padding-bottom: 0.3em;
|
||
font-size: 1.75em;
|
||
line-height: 1.225;
|
||
border-bottom: 1px solid #eee;
|
||
}
|
||
|
||
.markdown-body h3 {
|
||
font-size: 1.5em;
|
||
line-height: 1.43;
|
||
}
|
||
|
||
.markdown-body h4 {
|
||
font-size: 1.25em;
|
||
}
|
||
|
||
.markdown-body h5 {
|
||
font-size: 1em;
|
||
}
|
||
|
||
.markdown-body h6 {
|
||
font-size: 1em;
|
||
color: #777;
|
||
}
|
||
|
||
.markdown-body p,
|
||
.markdown-body blockquote,
|
||
.markdown-body ul,
|
||
.markdown-body ol,
|
||
.markdown-body dl,
|
||
.markdown-body table,
|
||
.markdown-body pre,
|
||
.markdown-body .admonition {
|
||
margin-top: 0;
|
||
margin-bottom: 16px;
|
||
}
|
||
|
||
.markdown-body hr {
|
||
height: 4px;
|
||
padding: 0;
|
||
margin: 16px 0;
|
||
background-color: #e7e7e7;
|
||
border: 0 none;
|
||
}
|
||
|
||
.markdown-body ul,
|
||
.markdown-body ol {
|
||
padding-left: 2em;
|
||
}
|
||
|
||
.markdown-body ul ul,
|
||
.markdown-body ul ol,
|
||
.markdown-body ol ol,
|
||
.markdown-body ol ul {
|
||
margin-top: 0;
|
||
margin-bottom: 0;
|
||
}
|
||
|
||
.markdown-body li>p {
|
||
margin-top: 16px;
|
||
}
|
||
|
||
.markdown-body dl {
|
||
padding: 0;
|
||
}
|
||
|
||
.markdown-body dl dt {
|
||
padding: 0;
|
||
margin-top: 16px;
|
||
font-size: 1em;
|
||
font-style: italic;
|
||
font-weight: bold;
|
||
}
|
||
|
||
.markdown-body dl dd {
|
||
padding: 0 16px;
|
||
margin-bottom: 16px;
|
||
}
|
||
|
||
.markdown-body blockquote {
|
||
padding: 0 15px;
|
||
color: #777;
|
||
border-left: 4px solid #ddd;
|
||
}
|
||
|
||
.markdown-body blockquote>:first-child {
|
||
margin-top: 0;
|
||
}
|
||
|
||
.markdown-body blockquote>:last-child {
|
||
margin-bottom: 0;
|
||
}
|
||
|
||
.markdown-body table {
|
||
display: block;
|
||
width: 100%;
|
||
overflow: auto;
|
||
word-break: normal;
|
||
word-break: keep-all;
|
||
}
|
||
|
||
.markdown-body table th {
|
||
font-weight: bold;
|
||
}
|
||
|
||
.markdown-body table th,
|
||
.markdown-body table td {
|
||
padding: 6px 13px;
|
||
border: 1px solid #ddd;
|
||
}
|
||
|
||
.markdown-body table tr {
|
||
background-color: #fff;
|
||
border-top: 1px solid #ccc;
|
||
}
|
||
|
||
.markdown-body table tr:nth-child(2n) {
|
||
background-color: #f8f8f8;
|
||
}
|
||
|
||
.markdown-body img {
|
||
max-width: 100%;
|
||
-moz-box-sizing: border-box;
|
||
box-sizing: border-box;
|
||
}
|
||
|
||
.markdown-body code,
|
||
.markdown-body samp {
|
||
padding: 0;
|
||
padding-top: 0.2em;
|
||
padding-bottom: 0.2em;
|
||
margin: 0;
|
||
font-size: 85%;
|
||
background-color: rgba(0,0,0,0.04);
|
||
border-radius: 3px;
|
||
}
|
||
|
||
.markdown-body code:before,
|
||
.markdown-body code:after {
|
||
letter-spacing: -0.2em;
|
||
content: "\00a0";
|
||
}
|
||
|
||
.markdown-body pre>code {
|
||
padding: 0;
|
||
margin: 0;
|
||
font-size: 100%;
|
||
word-break: normal;
|
||
white-space: pre;
|
||
background: transparent;
|
||
border: 0;
|
||
}
|
||
|
||
.markdown-body .codehilite {
|
||
margin-bottom: 16px;
|
||
}
|
||
|
||
.markdown-body .codehilite pre,
|
||
.markdown-body pre {
|
||
padding: 16px;
|
||
overflow: auto;
|
||
font-size: 85%;
|
||
line-height: 1.45;
|
||
background-color: #f7f7f7;
|
||
border-radius: 3px;
|
||
}
|
||
|
||
.markdown-body .codehilite pre {
|
||
margin-bottom: 0;
|
||
word-break: normal;
|
||
}
|
||
|
||
.markdown-body pre {
|
||
word-wrap: normal;
|
||
}
|
||
|
||
.markdown-body pre code {
|
||
display: inline;
|
||
max-width: initial;
|
||
padding: 0;
|
||
margin: 0;
|
||
overflow: initial;
|
||
line-height: inherit;
|
||
word-wrap: normal;
|
||
background-color: transparent;
|
||
border: 0;
|
||
}
|
||
|
||
.markdown-body pre code:before,
|
||
.markdown-body pre code:after {
|
||
content: normal;
|
||
}
|
||
|
||
/* Admonition */
|
||
.markdown-body .admonition {
|
||
-webkit-border-radius: 3px;
|
||
-moz-border-radius: 3px;
|
||
position: relative;
|
||
border-radius: 3px;
|
||
border: 1px solid #e0e0e0;
|
||
border-left: 6px solid #333;
|
||
padding: 10px 10px 10px 30px;
|
||
}
|
||
|
||
.markdown-body .admonition table {
|
||
color: #333;
|
||
}
|
||
|
||
.markdown-body .admonition p {
|
||
padding: 0;
|
||
}
|
||
|
||
.markdown-body .admonition-title {
|
||
font-weight: bold;
|
||
margin: 0;
|
||
}
|
||
|
||
.markdown-body .admonition>.admonition-title {
|
||
color: #333;
|
||
}
|
||
|
||
.markdown-body .attention>.admonition-title {
|
||
color: #a6d796;
|
||
}
|
||
|
||
.markdown-body .caution>.admonition-title {
|
||
color: #d7a796;
|
||
}
|
||
|
||
.markdown-body .hint>.admonition-title {
|
||
color: #96c6d7;
|
||
}
|
||
|
||
.markdown-body .danger>.admonition-title {
|
||
color: #c25f77;
|
||
}
|
||
|
||
.markdown-body .question>.admonition-title {
|
||
color: #96a6d7;
|
||
}
|
||
|
||
.markdown-body .note>.admonition-title {
|
||
color: #d7c896;
|
||
}
|
||
|
||
.markdown-body .admonition:before,
|
||
.markdown-body .attention:before,
|
||
.markdown-body .caution:before,
|
||
.markdown-body .hint:before,
|
||
.markdown-body .danger:before,
|
||
.markdown-body .question:before,
|
||
.markdown-body .note:before {
|
||
font: normal normal 16px fontawesome-mini;
|
||
-moz-osx-font-smoothing: grayscale;
|
||
-webkit-user-select: none;
|
||
-moz-user-select: none;
|
||
-ms-user-select: none;
|
||
user-select: none;
|
||
line-height: 1.5;
|
||
color: #333;
|
||
position: absolute;
|
||
left: 0;
|
||
top: 0;
|
||
padding-top: 10px;
|
||
padding-left: 10px;
|
||
}
|
||
|
||
.markdown-body .admonition:before {
|
||
content: "\f056\00a0";
|
||
color: 333;
|
||
}
|
||
|
||
.markdown-body .attention:before {
|
||
content: "\f058\00a0";
|
||
color: #a6d796;
|
||
}
|
||
|
||
.markdown-body .caution:before {
|
||
content: "\f06a\00a0";
|
||
color: #d7a796;
|
||
}
|
||
|
||
.markdown-body .hint:before {
|
||
content: "\f05a\00a0";
|
||
color: #96c6d7;
|
||
}
|
||
|
||
.markdown-body .danger:before {
|
||
content: "\f057\00a0";
|
||
color: #c25f77;
|
||
}
|
||
|
||
.markdown-body .question:before {
|
||
content: "\f059\00a0";
|
||
color: #96a6d7;
|
||
}
|
||
|
||
.markdown-body .note:before {
|
||
content: "\f040\00a0";
|
||
color: #d7c896;
|
||
}
|
||
|
||
.markdown-body .admonition::after {
|
||
content: normal;
|
||
}
|
||
|
||
.markdown-body .attention {
|
||
border-left: 6px solid #a6d796;
|
||
}
|
||
|
||
.markdown-body .caution {
|
||
border-left: 6px solid #d7a796;
|
||
}
|
||
|
||
.markdown-body .hint {
|
||
border-left: 6px solid #96c6d7;
|
||
}
|
||
|
||
.markdown-body .danger {
|
||
border-left: 6px solid #c25f77;
|
||
}
|
||
|
||
.markdown-body .question {
|
||
border-left: 6px solid #96a6d7;
|
||
}
|
||
|
||
.markdown-body .note {
|
||
border-left: 6px solid #d7c896;
|
||
}
|
||
|
||
.markdown-body .admonition>*:first-child {
|
||
margin-top: 0 !important;
|
||
}
|
||
|
||
.markdown-body .admonition>*:last-child {
|
||
margin-bottom: 0 !important;
|
||
}
|
||
|
||
/* progress bar*/
|
||
.markdown-body .progress {
|
||
display: block;
|
||
width: 300px;
|
||
margin: 10px 0;
|
||
height: 24px;
|
||
-webkit-border-radius: 3px;
|
||
-moz-border-radius: 3px;
|
||
border-radius: 3px;
|
||
background-color: #ededed;
|
||
position: relative;
|
||
box-shadow: inset -1px 1px 3px rgba(0, 0, 0, .1);
|
||
}
|
||
|
||
.markdown-body .progress-label {
|
||
position: absolute;
|
||
text-align: center;
|
||
font-weight: bold;
|
||
width: 100%; margin: 0;
|
||
line-height: 24px;
|
||
color: #333;
|
||
text-shadow: 1px 1px 0 #fefefe, -1px -1px 0 #fefefe, -1px 1px 0 #fefefe, 1px -1px 0 #fefefe, 0 1px 0 #fefefe, 0 -1px 0 #fefefe, 1px 0 0 #fefefe, -1px 0 0 #fefefe, 1px 1px 2px #000;
|
||
-webkit-font-smoothing: antialiased !important;
|
||
white-space: nowrap;
|
||
overflow: hidden;
|
||
}
|
||
|
||
.markdown-body .progress-bar {
|
||
height: 24px;
|
||
float: left;
|
||
-webkit-border-radius: 3px;
|
||
-moz-border-radius: 3px;
|
||
border-radius: 3px;
|
||
background-color: #96c6d7;
|
||
box-shadow: inset 0 1px 0 rgba(255, 255, 255, .5), inset 0 -1px 0 rgba(0, 0, 0, .1);
|
||
background-size: 30px 30px;
|
||
background-image: -webkit-linear-gradient(
|
||
135deg, rgba(255, 255, 255, .4) 27%,
|
||
transparent 27%,
|
||
transparent 52%, rgba(255, 255, 255, .4) 52%,
|
||
rgba(255, 255, 255, .4) 77%,
|
||
transparent 77%, transparent
|
||
);
|
||
background-image: -moz-linear-gradient(
|
||
135deg,
|
||
rgba(255, 255, 255, .4) 27%, transparent 27%,
|
||
transparent 52%, rgba(255, 255, 255, .4) 52%,
|
||
rgba(255, 255, 255, .4) 77%, transparent 77%,
|
||
transparent
|
||
);
|
||
background-image: -ms-linear-gradient(
|
||
135deg,
|
||
rgba(255, 255, 255, .4) 27%, transparent 27%,
|
||
transparent 52%, rgba(255, 255, 255, .4) 52%,
|
||
rgba(255, 255, 255, .4) 77%, transparent 77%,
|
||
transparent
|
||
);
|
||
background-image: -o-linear-gradient(
|
||
135deg,
|
||
rgba(255, 255, 255, .4) 27%, transparent 27%,
|
||
transparent 52%, rgba(255, 255, 255, .4) 52%,
|
||
rgba(255, 255, 255, .4) 77%, transparent 77%,
|
||
transparent
|
||
);
|
||
background-image: linear-gradient(
|
||
135deg,
|
||
rgba(255, 255, 255, .4) 27%, transparent 27%,
|
||
transparent 52%, rgba(255, 255, 255, .4) 52%,
|
||
rgba(255, 255, 255, .4) 77%, transparent 77%,
|
||
transparent
|
||
);
|
||
}
|
||
|
||
.markdown-body .progress-100plus .progress-bar {
|
||
background-color: #a6d796;
|
||
}
|
||
|
||
.markdown-body .progress-80plus .progress-bar {
|
||
background-color: #c6d796;
|
||
}
|
||
|
||
.markdown-body .progress-60plus .progress-bar {
|
||
background-color: #d7c896;
|
||
}
|
||
|
||
.markdown-body .progress-40plus .progress-bar {
|
||
background-color: #d7a796;
|
||
}
|
||
|
||
.markdown-body .progress-20plus .progress-bar {
|
||
background-color: #d796a6;
|
||
}
|
||
|
||
.markdown-body .progress-0plus .progress-bar {
|
||
background-color: #c25f77;
|
||
}
|
||
|
||
.markdown-body .candystripe-animate .progress-bar{
|
||
-webkit-animation: animate-stripes 3s linear infinite;
|
||
-moz-animation: animate-stripes 3s linear infinite;
|
||
animation: animate-stripes 3s linear infinite;
|
||
}
|
||
|
||
@-webkit-keyframes animate-stripes {
|
||
0% {
|
||
background-position: 0 0;
|
||
}
|
||
|
||
100% {
|
||
background-position: 60px 0;
|
||
}
|
||
}
|
||
|
||
@-moz-keyframes animate-stripes {
|
||
0% {
|
||
background-position: 0 0;
|
||
}
|
||
|
||
100% {
|
||
background-position: 60px 0;
|
||
}
|
||
}
|
||
|
||
@keyframes animate-stripes {
|
||
0% {
|
||
background-position: 0 0;
|
||
}
|
||
|
||
100% {
|
||
background-position: 60px 0;
|
||
}
|
||
}
|
||
|
||
.markdown-body .gloss .progress-bar {
|
||
box-shadow:
|
||
inset 0 4px 12px rgba(255, 255, 255, .7),
|
||
inset 0 -12px 0 rgba(0, 0, 0, .05);
|
||
}
|
||
|
||
/* MultiMarkdown Critic Blocks */
|
||
.markdown-body .critic_mark {
|
||
background: #ff0;
|
||
}
|
||
|
||
.markdown-body .critic_delete {
|
||
color: #c82829;
|
||
text-decoration: line-through;
|
||
}
|
||
|
||
.markdown-body .critic_insert {
|
||
color: #718c00 ;
|
||
text-decoration: underline;
|
||
}
|
||
|
||
.markdown-body .critic_comment {
|
||
color: #8e908c;
|
||
font-style: italic;
|
||
}
|
||
|
||
.markdown-body .headeranchor {
|
||
font: normal normal 16px fontawesome-mini;
|
||
line-height: 1;
|
||
display: inline-block;
|
||
text-decoration: none;
|
||
-webkit-font-smoothing: antialiased;
|
||
-moz-osx-font-smoothing: grayscale;
|
||
-webkit-user-select: none;
|
||
-moz-user-select: none;
|
||
-ms-user-select: none;
|
||
user-select: none;
|
||
}
|
||
|
||
.headeranchor:before {
|
||
content: '\e157';
|
||
}
|
||
|
||
.markdown-body .task-list-item {
|
||
list-style-type: none;
|
||
}
|
||
|
||
.markdown-body .task-list-item+.task-list-item {
|
||
margin-top: 3px;
|
||
}
|
||
|
||
.markdown-body .task-list-item input {
|
||
margin: 0 4px 0.25em -20px;
|
||
vertical-align: middle;
|
||
}
|
||
|
||
/* Media */
|
||
@media only screen and (min-width: 480px) {
|
||
.markdown-body {
|
||
font-size:14px;
|
||
}
|
||
}
|
||
|
||
@media only screen and (min-width: 768px) {
|
||
.markdown-body {
|
||
font-size:16px;
|
||
}
|
||
}
|
||
|
||
@media print {
|
||
.markdown-body * {
|
||
background: transparent !important;
|
||
color: black !important;
|
||
filter:none !important;
|
||
-ms-filter: none !important;
|
||
}
|
||
|
||
.markdown-body {
|
||
font-size:12pt;
|
||
max-width:100%;
|
||
outline:none;
|
||
border: 0;
|
||
}
|
||
|
||
.markdown-body a,
|
||
.markdown-body a:visited {
|
||
text-decoration: underline;
|
||
}
|
||
|
||
.markdown-body .headeranchor-link {
|
||
display: none;
|
||
}
|
||
|
||
.markdown-body a[href]:after {
|
||
content: " (" attr(href) ")";
|
||
}
|
||
|
||
.markdown-body abbr[title]:after {
|
||
content: " (" attr(title) ")";
|
||
}
|
||
|
||
.markdown-body .ir a:after,
|
||
.markdown-body a[href^="javascript:"]:after,
|
||
.markdown-body a[href^="#"]:after {
|
||
content: "";
|
||
}
|
||
|
||
.markdown-body pre {
|
||
white-space: pre;
|
||
white-space: pre-wrap;
|
||
word-wrap: break-word;
|
||
}
|
||
|
||
.markdown-body pre,
|
||
.markdown-body blockquote {
|
||
border: 1px solid #999;
|
||
padding-right: 1em;
|
||
page-break-inside: avoid;
|
||
}
|
||
|
||
.markdown-body .progress,
|
||
.markdown-body .progress-bar {
|
||
-moz-box-shadow: none;
|
||
-webkit-box-shadow: none;
|
||
box-shadow: none;
|
||
}
|
||
|
||
.markdown-body .progress {
|
||
border: 1px solid #ddd;
|
||
}
|
||
|
||
.markdown-body .progress-bar {
|
||
height: 22px;
|
||
border-right: 1px solid #ddd;
|
||
}
|
||
|
||
.markdown-body tr,
|
||
.markdown-body img {
|
||
page-break-inside: avoid;
|
||
}
|
||
|
||
.markdown-body img {
|
||
max-width: 100% !important;
|
||
}
|
||
|
||
.markdown-body p,
|
||
.markdown-body h2,
|
||
.markdown-body h3 {
|
||
orphans: 3;
|
||
widows: 3;
|
||
}
|
||
|
||
.markdown-body h2,
|
||
.markdown-body h3 {
|
||
page-break-after: avoid;
|
||
}
|
||
}
|
||
</style><style>/*GitHub*/
|
||
.codehilite {background-color:#fff;color:#333333;}
|
||
.codehilite .hll {background-color:#ffffcc;}
|
||
.codehilite .c{color:#999988;font-style:italic}
|
||
.codehilite .err{color:#a61717;background-color:#e3d2d2}
|
||
.codehilite .k{font-weight:bold}
|
||
.codehilite .o{font-weight:bold}
|
||
.codehilite .cm{color:#999988;font-style:italic}
|
||
.codehilite .cp{color:#999999;font-weight:bold}
|
||
.codehilite .c1{color:#999988;font-style:italic}
|
||
.codehilite .cs{color:#999999;font-weight:bold;font-style:italic}
|
||
.codehilite .gd{color:#000000;background-color:#ffdddd}
|
||
.codehilite .ge{font-style:italic}
|
||
.codehilite .gr{color:#aa0000}
|
||
.codehilite .gh{color:#999999}
|
||
.codehilite .gi{color:#000000;background-color:#ddffdd}
|
||
.codehilite .go{color:#888888}
|
||
.codehilite .gp{color:#555555}
|
||
.codehilite .gs{font-weight:bold}
|
||
.codehilite .gu{color:#800080;font-weight:bold}
|
||
.codehilite .gt{color:#aa0000}
|
||
.codehilite .kc{font-weight:bold}
|
||
.codehilite .kd{font-weight:bold}
|
||
.codehilite .kn{font-weight:bold}
|
||
.codehilite .kp{font-weight:bold}
|
||
.codehilite .kr{font-weight:bold}
|
||
.codehilite .kt{color:#445588;font-weight:bold}
|
||
.codehilite .m{color:#009999}
|
||
.codehilite .s{color:#dd1144}
|
||
.codehilite .n{color:#333333}
|
||
.codehilite .na{color:teal}
|
||
.codehilite .nb{color:#0086b3}
|
||
.codehilite .nc{color:#445588;font-weight:bold}
|
||
.codehilite .no{color:teal}
|
||
.codehilite .ni{color:purple}
|
||
.codehilite .ne{color:#990000;font-weight:bold}
|
||
.codehilite .nf{color:#990000;font-weight:bold}
|
||
.codehilite .nn{color:#555555}
|
||
.codehilite .nt{color:navy}
|
||
.codehilite .nv{color:teal}
|
||
.codehilite .ow{font-weight:bold}
|
||
.codehilite .w{color:#bbbbbb}
|
||
.codehilite .mf{color:#009999}
|
||
.codehilite .mh{color:#009999}
|
||
.codehilite .mi{color:#009999}
|
||
.codehilite .mo{color:#009999}
|
||
.codehilite .sb{color:#dd1144}
|
||
.codehilite .sc{color:#dd1144}
|
||
.codehilite .sd{color:#dd1144}
|
||
.codehilite .s2{color:#dd1144}
|
||
.codehilite .se{color:#dd1144}
|
||
.codehilite .sh{color:#dd1144}
|
||
.codehilite .si{color:#dd1144}
|
||
.codehilite .sx{color:#dd1144}
|
||
.codehilite .sr{color:#009926}
|
||
.codehilite .s1{color:#dd1144}
|
||
.codehilite .ss{color:#990073}
|
||
.codehilite .bp{color:#999999}
|
||
.codehilite .vc{color:teal}
|
||
.codehilite .vg{color:teal}
|
||
.codehilite .vi{color:teal}
|
||
.codehilite .il{color:#009999}
|
||
.codehilite .gc{color:#999;background-color:#EAF2F5}
|
||
</style><title>README</title></head><body><article class="markdown-body"><h1 id="reticulum-network-stack">Reticulum Network Stack α<a class="headerlink" href="#reticulum-network-stack" title="Permanent link"></a></h1>
|
||
<p>Reticulum is a cryptography-based networking stack for high-latency, wide-area networks built on readily available hardware. Reticulum allows you to build very wide-area networks with off-the-shelf tools, and offers end-to-end encryption, autoconfiguring cryptographically backed multi-hop transport, efficient addressing, unforgeable packet acknowledgements and more.</p>
|
||
<p>Reticulum is a complete networking stack, and does not use IP or higher layers, although it is easy to utilise IP (with TCP or UDP) as the underlying carrier for Reticulum.</p>
|
||
<p>Having no dependencies on traditional networking stacks free up overhead that has been utilised to implement a networking stack built directly on cryptographic principles, allowing resilience and stable functionality in open and trustless networks.</p>
|
||
<p>No kernel modules or drivers are required. Reticulum runs completely in userland, and can run on practically any system that runs Python 3.</p>
|
||
<p>For more info, see <a href="https://unsigned.io/projects/reticulum/">unsigned.io/projects/reticulum</a></p>
|
||
<h2 id="notable-features">Notable Features<a class="headerlink" href="#notable-features" title="Permanent link"></a></h2>
|
||
<ul>
|
||
<li>Coordination-less globally unique adressing and identification</li>
|
||
<li>Fully self-configuring multi-hop routing</li>
|
||
<li>Asymmetric RSA encryption and signatures as basis for all communication</li>
|
||
<li>Perfect Forward Secrecy on links with ephemereal Elliptic Curve Diffie-Hellman keys (on the SECP256R1 curve)</li>
|
||
<li>Reticulum uses the <a href="https://github.com/fernet/spec/blob/master/Spec.md">Fernet</a> specification for encryption on links and to group destinations<ul>
|
||
<li>AES-128 in CBC mode with PKCS7 padding</li>
|
||
<li>HMAC using SHA256 for authentication</li>
|
||
<li>IVs are generated through os.urandom()</li>
|
||
</ul>
|
||
</li>
|
||
<li>Unforgeable packet delivery confirmations</li>
|
||
<li>A variety of supported interface types</li>
|
||
<li>Efficient and easy resource transfers</li>
|
||
<li>An intuitive and easy-to-use API</li>
|
||
</ul>
|
||
<h2 id="where-can-reticulum-be-used">Where can Reticulum be used?<a class="headerlink" href="#where-can-reticulum-be-used" title="Permanent link"></a></h2>
|
||
<p>On practically any hardware that can support at least a half-duplex channel with 1.000 bits per second throughput, and an MTU of 500 bytes. Data radios, modems, LoRa radios, serial lines, AX.25 TNCs, amateur radio digital modes, free-space optical links and similar systems are all examples of the types of interfaces Reticulum was designed for.</p>
|
||
<p>An open-source LoRa-based interface called <a href="https://unsigned.io/projects/rnode/">RNode</a> has been designed specifically for use with Reticulum. It is possible to build yourself, or can be purchased as a complete transceiver that just needs a USB connection to the host.</p>
|
||
<p>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.</p>
|
||
<p>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.</p>
|
||
<h2 id="current-status">Current Status<a class="headerlink" href="#current-status" title="Permanent link"></a></h2>
|
||
<p>Consider Reticulum experimental at this stage. Most features are implemented and working, but at this point the protocol may still change significantly, and is made publicly available for development collaboration, previewing and testing.</p>
|
||
<p>An API- and wireformat-stable alpha release is coming in the near future. Until then expect things to change unexpectedly if something warrants it.</p>
|
||
<h2 id="supported-interface-types-and-devices">Supported interface types and devices<a class="headerlink" href="#supported-interface-types-and-devices" title="Permanent link"></a></h2>
|
||
<p>Reticulum implements a range of generalised interface types that covers most of the communications hardware that Reticulum can run over. If your hardware is not supported, it’s relatively simple to implement an interface class. Currently, the following interfaces are supported:</p>
|
||
<ul>
|
||
<li>Any ethernet device</li>
|
||
<li>LoRa using <a href="https://unsigned.io/projects/rnode/">RNode</a></li>
|
||
<li>Packet Radio TNCs (with or without AX.25)</li>
|
||
<li>Any device with a serial port</li>
|
||
<li>TCP over IP networks</li>
|
||
<li>UDP over IP networks</li>
|
||
</ul>
|
||
<h2 id="what-is-currently-being-worked-on">What is currently being worked on?<a class="headerlink" href="#what-is-currently-being-worked-on" title="Permanent link"></a></h2>
|
||
<ul>
|
||
<li>Delay/disruption tolerance</li>
|
||
<li>API documentation</li>
|
||
<li>Useful example programs and utilities</li>
|
||
<li>A generic message transfer protocol built on Reticulum, see <a href="https://github.com/markqvist/lxmf">LXMF</a></li>
|
||
<li>A few useful-in-the-real-world apps built with Reticulum</li>
|
||
</ul>
|
||
<h2 id="can-i-use-reticulum-on-amateur-radio-spectrum">Can I use Reticulum on amateur radio spectrum?<a class="headerlink" href="#can-i-use-reticulum-on-amateur-radio-spectrum" title="Permanent link"></a></h2>
|
||
<p>Some countries still ban the use of encryption when operating under an amateur radio license. Reticulum offers several encryptionless modes, while still using cryptographic principles for station verification, link establishment, data integrity verification, acknowledgements and routing. It is therefore perfectly possible to include Reticulum in amateur radio use, even if your country bans encryption.</p>
|
||
<h2 id="dependencies">Dependencies:<a class="headerlink" href="#dependencies" title="Permanent link"></a></h2>
|
||
<ul>
|
||
<li>Python 3</li>
|
||
<li>cryptography.io</li>
|
||
<li>pyserial</li>
|
||
</ul>
|
||
<h2 id="how-do-i-get-started">How do I get started?<a class="headerlink" href="#how-do-i-get-started" title="Permanent link"></a></h2>
|
||
<p>Full documentation and tutorials are coming with the stable alpha release. Until then, you are mostly on your own. If you want to experiment already, you could take a look in the “Examples” folder, for some well-documented example programs. The default configuration file created by Reticulum on the first run is also worth reading. Be sure to also read the <a href="http://unsigned.io/wp-content/uploads/2018/04/Reticulum_Overview_v0.4.pdf">Reticulum Overview Document</a>.</p>
|
||
<p>If you just need Reticulum as a dependency for another application, the easiest way is probably via pip:</p>
|
||
<div class="codehilite"><pre>pip3 install rns
|
||
</pre></div>
|
||
|
||
<p>For development, you might want to get the latest source from GitHub. In that case, don’t use pip, but try this recipe:</p>
|
||
<div class="codehilite"><pre><span class="c1"># Install dependencies</span>
|
||
pip3 install cryptography pyserial
|
||
|
||
<span class="c1"># Clone repository</span>
|
||
git clone https://github.com/markqvist/Reticulum.git
|
||
|
||
<span class="c1"># Move into Reticulum folder and symlink library to examples folder</span>
|
||
<span class="nb">cd </span>Reticulum
|
||
ln -s ../RNS ./Examples/
|
||
|
||
<span class="c1"># Run an example</span>
|
||
python3 Examples/Echo.py -s
|
||
|
||
<span class="c1"># Unless you've manually created a config file, Reticulum will do so now,</span>
|
||
<span class="c1"># and immediately exit. Make any necessary changes to the file:</span>
|
||
nano ~/.reticulum/config
|
||
|
||
<span class="c1"># ... and launch the example again.</span>
|
||
python3 Examples/Echo.py -s
|
||
|
||
<span class="c1"># You can now repeat the process on another computer,</span>
|
||
<span class="c1"># and run the same example with -h to get command line options.</span>
|
||
python3 Examples/Echo.py -h
|
||
|
||
<span class="c1"># Run the example in client mode to "ping" the server.</span>
|
||
<span class="c1"># Replace the hash below with the actual destination hash of your server.</span>
|
||
python3 Examples/Echo.py 3e12fc71692f8ec47bc5
|
||
|
||
<span class="c1"># Have a look at another example</span>
|
||
python3 Examples/Filetransfer.py -h
|
||
</pre></div>
|
||
|
||
<p>The default config file contains examples for using Reticulum with LoRa transceivers (specifically <a href="https://unsigned.io/projects/rnode/">RNode</a>), packet radio TNCs/modems and UDP. By default a UDP interface is already enabled in the default config, which will enable Reticulum communication in your local ethernet broadcast domain.</p>
|
||
<p>You can use the examples in the config file to expand communication over other mediums such as packet radio or LoRa, or over fast IP links using the UDP interface. I’ll add in-depth tutorials and explanations on these topics later. For now, the included examples will hopefully be enough to get started.</p>
|
||
<h2 id="caveat-emptor">Caveat Emptor<a class="headerlink" href="#caveat-emptor" title="Permanent link"></a></h2>
|
||
<p>Reticulum is alpha software, and should be considered experimental. While it has been built with cryptography best-practices very foremost in mind, it <em>has not</em> been externally security audited, and there could very well be privacy-breaking bugs. If you want to help out, or help sponsor an audit, please do get in touch.</p></article></body></html> |