Added addressbook section.
polistern
parent
3e5cf0fac4
commit
336b4701a5
|
|
@ -2,6 +2,6 @@
|
|||
|
||||
At the moment, PeerList packets of 5th version have been implemented to support current types of I2P destination.
|
||||
PeerList packets of 4th version are supported, older Java nodes respond but do not send requests due to protocol restrictions at DSA I2P destinations.
|
||||
You can see the implementation details in `docs/techdoc_v5 (draft).txt` file.
|
||||
You can see the implementation details in [this](./packet_types.md) page.
|
||||
|
||||
Proposals for improving the 5th version of the protocol are accepted for consideration.
|
||||
|
|
@ -2,8 +2,9 @@
|
|||
|
||||
In general, for building **pboted** you need several things:
|
||||
|
||||
* compiler with c++17 support (for example: gcc >= 4.8, clang)
|
||||
* compiler with c++17 support (for example: gcc >= 5, clang)
|
||||
* cmake >= 3.7
|
||||
* mimetic >= 0.9.8
|
||||
* boost >= 1.62
|
||||
* openssl library
|
||||
* zlib library (openssl already depends on it)
|
||||
|
|
|
|||
|
|
@ -3,22 +3,10 @@
|
|||
**Supported systems:**
|
||||
|
||||
* GNU/Linux
|
||||
- Debian / Ubuntu (with packaging)
|
||||
- [Debian/Ubuntu](#debian-ubuntu) (with packaging)
|
||||
|
||||
## CMake Options
|
||||
|
||||
|
||||
## Debian/Ubuntu:
|
||||
|
||||
_Tested with Debian 10 and Ubuntu 20.04._
|
||||
|
||||
- Install development libraries and tools:
|
||||
|
||||
```
|
||||
sudo apt install git cmake build-essential zlib1g-dev libssl-dev \
|
||||
libboost-filesystem-dev libboost-system-dev libboost-program-options-dev \
|
||||
libboost-date-time-dev libboost-thread-dev libmimetic-dev
|
||||
```
|
||||
Make sure you have all required dependencies for your system successfully installed.
|
||||
See [this](requirements.md) page for common requirements.
|
||||
|
||||
- Clone repository:
|
||||
|
||||
|
|
@ -32,12 +20,58 @@ git submodule update --init
|
|||
|
||||
```
|
||||
cd build
|
||||
cmake -DCMAKE_BUILD_TYPE=Release
|
||||
make
|
||||
cmake <cmake options> . # see "CMake Options" section below
|
||||
cmake # you may add VERBOSE=1 to cmdline for debugging
|
||||
```
|
||||
|
||||
- Put binary to `/usr/sbin/`
|
||||
|
||||
```
|
||||
sudo mv pboted /usr/sbin/pboted
|
||||
```
|
||||
```
|
||||
|
||||
## CMake Options
|
||||
|
||||
Available CMake options(each option has a form of `-D<key>=<value>`, for more information see `man 1 cmake`):
|
||||
|
||||
* `CMAKE_BUILD_TYPE` build profile (Debug/Release, default: no optimization or debug symbols)
|
||||
* `WITH_STATIC` build static versions of library and i2pd binary (default: OFF)
|
||||
|
||||
Also there is `-L` flag for CMake that could be used to list current cached options:
|
||||
|
||||
```
|
||||
cmake -L
|
||||
```
|
||||
|
||||
## Debian/Ubuntu:
|
||||
|
||||
_Tested with Debian 10 and Ubuntu 20.04._
|
||||
|
||||
You will need a compiler and other tools that could be installed with `build-essential` and `debhelper` packages:
|
||||
|
||||
```
|
||||
sudo apt-get install git cmake build-essential debhelper
|
||||
```
|
||||
|
||||
Also you will need a bunch of development libraries:
|
||||
|
||||
```
|
||||
sudo apt install \
|
||||
libboost-date-time-dev \
|
||||
libboost-filesystem-dev \
|
||||
libboost-program-options-dev \
|
||||
libboost-system-dev \
|
||||
libboost-thread-dev \
|
||||
libmimetic-dev \
|
||||
libssl-dev \
|
||||
zlib1g-dev
|
||||
```
|
||||
|
||||
|
||||
You may also build deb-package with the following:
|
||||
|
||||
```
|
||||
sudo apt-get install fakeroot devscripts dh-apparmor
|
||||
cd pboted
|
||||
debuild --no-tgz-check -us -uc -b
|
||||
```
|
||||
|
|
|
|||
|
|
@ -0,0 +1,27 @@
|
|||
# AddressBook
|
||||
|
||||
This feature allows you to use short names when forming letters by third-party applications (currently, when using the SMTP protocol).
|
||||
|
||||
## Usage
|
||||
|
||||
First you need to fill in file addressbook.txt in pboted data directory (usually it is /var/lib/pboted).
|
||||
For example:
|
||||
|
||||
```
|
||||
# Each line is in the format: <alias>;<name>;<dest>;
|
||||
# alias = for replacement in SMTP (<user>@<domain>)
|
||||
# name = pupblic name of identity
|
||||
# dest = base64 public bote address
|
||||
# The fields are separated by a semicolon character.
|
||||
# Lines starting with a # are ignored.
|
||||
# Do not edit this file while pboted is running as it will be overwritten.
|
||||
|
||||
johnd1@bote.i2p;John Doe 1;24noEIMPvV9CEwrSWQtIsTA7balaZ80ZOGRBAzrsBl5nv9xud~k28d9TQIgXmyyCYtHl8PJASAFDeefSc6EJ81
|
||||
johnd2@example.com;John Doe 2;l0pnj08OwrlWMDZjeuntl~pyI7rrtq2bhcxsYPXlMAo7uI3bOBph5pUAgVT5MWxg8lFPYvT2O6LpPVUHL-Sqdl
|
||||
|
||||
```
|
||||
|
||||
???+ warning ""
|
||||
|
||||
Do not edit this file while pboted is running as it will be overwritten.
|
||||
|
||||
25
mkdocs.yml
25
mkdocs.yml
|
|
@ -3,7 +3,7 @@ site_url: https://pboted.readthedocs.io
|
|||
site_description: pboted documentation
|
||||
site_author: polistern
|
||||
|
||||
repo_url: https://github.com/polistern/pboted_docs
|
||||
repo_url: https://github.com/polistern/pboted
|
||||
|
||||
nav:
|
||||
- Home: index.md
|
||||
|
|
@ -13,6 +13,7 @@ nav:
|
|||
- Configuring: user-guide/configuration.md
|
||||
#- FAQ: user-guide/FAQ.md
|
||||
- Tutorials:
|
||||
- AddressBook: tutorials/addressbook.md
|
||||
- SMTP: tutorials/SMTP.md
|
||||
- POP3: tutorials/POP3.md
|
||||
- Developer Section:
|
||||
|
|
@ -49,3 +50,25 @@ nav:
|
|||
|
||||
copyright: <a href="https://creativecommons.org/licenses/by-sa/4.0/">CC-BY-SA 4.0</a>, Maintained by polistern
|
||||
theme: readthedocs
|
||||
|
||||
markdown_extensions:
|
||||
- admonition
|
||||
- pymdownx.details
|
||||
- pymdownx.superfences
|
||||
|
||||
theme:
|
||||
name: 'material'
|
||||
icon:
|
||||
admonition:
|
||||
note: octicons/tag-16
|
||||
abstract: octicons/checklist-16
|
||||
info: octicons/info-16
|
||||
tip: octicons/squirrel-16
|
||||
success: octicons/check-16
|
||||
question: octicons/question-16
|
||||
warning: octicons/alert-16
|
||||
failure: octicons/x-circle-16
|
||||
danger: octicons/zap-16
|
||||
bug: octicons/bug-16
|
||||
example: octicons/beaker-16
|
||||
quote: octicons/quote-16
|
||||
|
|
|
|||
Loading…
Reference in New Issue