From cb7cf9c3ab32f95733212f83eead181e63ff4653 Mon Sep 17 00:00:00 2001 From: polistern Date: Thu, 2 Dec 2021 09:33:58 +0000 Subject: [PATCH] chore: Added info about bootstrap. Small fixes. --- docs/docs/bote/v5/packet_types.md | 2 +- docs/docs/index.md | 2 +- docs/docs/tutorials/addressbook.md | 3 +- docs/docs/tutorials/bootstrap.md | 50 ++++++++++++++++++++++++++++++ docs/docs/user-guide/install.md | 2 +- docs/mkdocs.yml | 1 + 6 files changed, 56 insertions(+), 4 deletions(-) create mode 100644 docs/docs/tutorials/bootstrap.md diff --git a/docs/docs/bote/v5/packet_types.md b/docs/docs/bote/v5/packet_types.md index 0f0e470..ad71923 100644 --- a/docs/docs/bote/v5/packet_types.md +++ b/docs/docs/bote/v5/packet_types.md @@ -241,7 +241,7 @@ Response to a `Retrieve Request`, `Fetch Request`, `Find Close Peers Request`, o | `4` | Invalid HashCash | | `5` | Not enough HashCash provided | | `6` | No disk space left | -| `7` | Duplicated data | +| `7` | Duplicated data `[VER 5]` | ### 3.2.6 Peer List Request diff --git a/docs/docs/index.md b/docs/docs/index.md index 2ae8cdd..58bb73b 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -3,7 +3,7 @@ pboted (Plus Bote Daemon) - is a standalone C++ implementation of I2P-Bote protocol. I2P-Bote is a server-less encrypted KademliaDHT-based email protocol. -You can find more details it [Bote](devs/bote/v5/version5.md) section. +You can find more details it [Bote](bote/v5/version5.md) section. Interaction with the I2P network occurs through the [SAMv3](https://geti2p.net/ru/docs/api/samv3) interface. Tested with [i2pd](https://github.com/PurpleI2P/i2pd) and [Java I2P](https://github.com/i2p/i2p.i2p). diff --git a/docs/docs/tutorials/addressbook.md b/docs/docs/tutorials/addressbook.md index 82bfe8c..ae3b87c 100644 --- a/docs/docs/tutorials/addressbook.md +++ b/docs/docs/tutorials/addressbook.md @@ -1,6 +1,7 @@ # AddressBook -This feature allows you to use short names when forming letters by third-party applications (currently, when using the SMTP protocol). +This feature allows you to use short names when forming letters by third-party applications (currently, when using the SMTP protocol). +This feature is most useful for sending emails from applications that expect usual email addresses. ## Usage diff --git a/docs/docs/tutorials/bootstrap.md b/docs/docs/tutorials/bootstrap.md new file mode 100644 index 0000000..d8ec51f --- /dev/null +++ b/docs/docs/tutorials/bootstrap.md @@ -0,0 +1,50 @@ +# Bootstrap + +Since **pboted** is a decentralized application, it needs to get information about nodes in the network to get started. +There are 2 possibilities for this: + +- `[bootstrap]` section in config file +- `nodes.txt` file in application directory (usualy `~/.pboted/nodes.txt` or `/var/lib/pboted/nodes.txt`) + +## `[bootstrap]` section + +To use this option, you need in the configuration file: + +- Add `[bootstrap]` section +- Under the section add known nodes addresses for bootstrap +- Start **pboted** + +For example: + +``` +[bootstrap] +## Bootstrap operators; +## Each line should be a I2P destination key in Base64 format. Lines beginning with # are ignored. +# My friend +address = AhG7DrbC~oMeH4r1EMGy4Nc7i5KvXyCXdPLfcTfntFmxoqREwKZi2eGQKuam5PGjNSUfNX5jJP-2fEEqPKevUWCRBtg-zQGJBTeNH6aD2EBNO~JtKsm4EYI0KOUFJFBubYb85xtwYhkDwxKG~t4RHIAVVD6HsfSCKjhrtJiuKnXaClJ77A-A95s7cf3ppy5P5L0w6wRUVUoY4YYui27k9AKKHDklme18ygk4-1VCk~VlEHt-REM0y4glBb7djYoWyf25eqb9i-c3JwiVPzbYsfz0D9Pwf2ilHoGCx76q8tXIElT6dWuXehzK9HC-nvN-TGhlsokiqMs6g7MHte0iHVOcTMMHJuVErWUlDzIp9KCM7BjyVniN-FtCFMa2S9tPAM6V3RyltR8gKCbvgopkDQnfpp6Wu76dGTnxr89k7OehitKGovCIDgWrHlwpVnsZbqSkIV6J-hNOxkt94KE9ggZMGmJPsOHjJkauRazu5qrnzSqlWuZnSrM7UVgP2K30AAAA +# John Doe +address = RRdJMFwElkeEoFzQgCqTl1fN2llsIgbY5Ql3wv4uBqh2VtvKXTZ3~Zj1DzTO~ymCw1IeCLNHvMLL87xHYaRub4hq-Ugw8UQY~gwAnYBlwEyN~pKxl78n5RrvwaoM9puhxOsKPKtVvjvvFsMLrtUC0rm7wtgMbCd0IqNgtU1p3reqejyjpiIA~Ai6~IbWIyHPIn~AlRy2m11UCdzm0XHxCZZbcN~3l8YWTNdHxp9Xdc9qdL-jTn-LZkZG-1BBMcSfnuwtYjdZaZXoXto3HMQWkS3C1Du3O-A90w0RnPlTk1FuZeU~ib5ch1pmkjvkV74kkI-quXgQp0cnxJ8Jei0CWGAvDGYWS0gIpqAKQeU7G2wyHWQyr0FKYHvPpI~-3qU6ZDEu6XZzvA7eKFasf-wx75jh93L8ItBTjZj~XB1bUn~xF-xpzP7iJKSd33lxXyOuyizG0p7ryUfSRTUGsqwFPVrhuN2bQoBAb6RnJKOpi2Co-5MhlE70Y-hbsEb8QTzNAAAA + +``` + +This option will be used only at the very first launch of the application, when file `nodex.txt` has not yet been generated. +If `nodex.txt` file already exists, then these option will be ignored. + + +## `nodes.txt` + +If you want to add nodes to 123 yourself, then just add them, save the file, and start application. + +!!! warning "Warning" + + Do not edit `nodes.txt` file while **pboted** is running as it will be overwritten. + + +``` +# Each line is one Base64-encoded I2P destination. +# Do not edit this file while pbote is running as it will be overwritten. + +jlOVAO2A~gM0qjbQaZQa0~OZYHwBrbc5ohUilIfsRITM1s~RxP6HoV8FKQl~mEM2Q9gPeWFW29xGP1qy-n~-aL70LUVSIba3rTwiQGpb5smvD4zxExCw~yQM0w28LOodu1yZ5xtDVljP0uruRCqZvARbP7bB8uJKJ7NPlmBsai9jIvrZFug-AbPZJKzvKsCbdCvkDivxIFFjJ9273PYogHPN1lkJZp1cPHVuU-wjEJlwVvxZb9dh3oC5m4AGoOY7SRbjbep1lnv4Zq8eEcEoTsDq77EBzwXlOMDOIB4NIW3ZxK8EJKEP-XcnDHZXUKx2R6~wGqsyaJd1uK3Tt-1M5S6AAeMSkNEuKWEdo0ugtuBRbgK9Iej0eVCQA05Y4Ysd7F1B5YJ3OC9JQnodXzhhtJa~ednw7yhOJoyvxWFDWKnA72zactlXksczn9rbxY3xHMtkezWw4lJmg1d-9sTlHEBsRhqVrEvUFdIuYljgX7YcqAWNAjpA8FzLqYijmz~7BQAEAAcAAA== +-Ab-xrc2~XR4sbi2xuGCXESkJg4G9AHLuiVLUcHXL-vL6kBCgVnytZ0rxTcNSaRTEbNZVsa8AfKeBhZp~S5kRqOa2w-OPVY4taa45ZaEdk2nHlRWn2htmzNE4fpB5VXemTHS3x-muKDfEbVf8XGPLFu2RvjlXOLDiuNC3Qa3GeZjbYcjJS-O14gLEZLaytNnU01ng3a8dt8U1EsdYmD4CnKTF-vRixgV5H8Z1KMVeTqxREUJtPYqKKVaW-E8I~JILU6nmn0FZuHPniFLCCoKGA4TbfklYNeoSOC~r4j-YbzwP6jAC9LStHpopy315YPAfF2xXt7f6C~7H47sSE6csum9PTNsBiC3evGETQsFEaJBug1TCcDWaDMcRiOOUuYkIPFdiVirSE91iBLCZX0bwVzS5xdCBQ1g-tiVa-uxCM5U7kvdt~usCU-m6Dl8t6JpHlT~1oXDRJ838K8ajUZRXc-fhOgVTnruWmsiyNWGkTbXu0QHY7F0ijJ9bq87kROPBQAEAAcAAA== + +``` diff --git a/docs/docs/user-guide/install.md b/docs/docs/user-guide/install.md index 74e92d4..74f9fa9 100644 --- a/docs/docs/user-guide/install.md +++ b/docs/docs/user-guide/install.md @@ -2,7 +2,7 @@ ## Building from source -See [developer section documentation](../devs/building/requirements.md) for how to build pboted from source on your OS. +See [developer section documentation](../building/requirements.md) for how to build pboted from source on your OS. ## Ubuntu diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 92aea6e..0b4271b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -15,6 +15,7 @@ nav: - Usage: user-guide/usage.md - FAQ: user-guide/FAQ.md - Tutorials: + - Bootstrap: tutorials/bootstrap.md - AddressBook: tutorials/addressbook.md - SMTP: tutorials/SMTP.md - POP3: tutorials/POP3.md