Mirrors/i2pd
2
0
Fork 0
mirror of https://github.com/PurpleI2P/i2pd.git synced 2025-01-22 21:37:17 +01:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity

update Config.cpp, links to examples, manpage

Browse source
This commit is contained in:
R4SAS 2018-06-20 05:07:24 +03:00 committed by R4SAS
parent 3cec5235c9
commit dd392941d0
5 changed files with 47 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
contrib/tunnels.conf
View file

@ -30,5 +30,4 @@ keys = irc-keys.dat
#destinationport = 110 #destinationport = 110
#keys = pop3-keys.dat #keys = pop3-keys.dat
# see more examples in /usr/share/doc/i2pd/configuration.md.gz # see more examples at https://i2pd.readthedocs.io/en/latest/user-guide/tunnels/
# or at https://i2pd.readthedocs.io/en/latest/user-guide/tunnels/

5
debian/changelog vendored
View file

@ -1,10 +1,11 @@
i2pd (2.19.0-1) unstable; urgency=low i2pd (2.19.0-pre1) unstable; urgency=low
* updated to version 2.19.0/0.9.35 * updated to version 2.19.0/0.9.35
* update manpage (1) * update manpage (1)
* update docfiles
* fixes in systemd unit (#1089, #1142, #1154, #1155) * fixes in systemd unit (#1089, #1142, #1154, #1155)
-- R4SAS <r4sas@i2pmail.org> Tue, 19 Jun 2018 18:00:00 +0000 -- R4SAS <r4sas@i2pmail.org> Wed, 20 Jun 2018 02:11:00 +0000
i2pd (2.18.0-1) unstable; urgency=low i2pd (2.18.0-1) unstable; urgency=low

2
debian/control vendored
View file

@ -13,7 +13,7 @@ Architecture: any
Pre-Depends: adduser Pre-Depends: adduser
Depends: ${shlibs:Depends}, ${misc:Depends} Depends: ${shlibs:Depends}, ${misc:Depends}
Suggests: tor, privoxy, apparmor Suggests: tor, privoxy, apparmor
Description: A full-featured C++ implementation of I2P client. Description: Full-featured C++ implementation of I2P client.
I2P (Invisible Internet Protocol) is a universal anonymous network layer. All I2P (Invisible Internet Protocol) is a universal anonymous network layer. All
communications over I2P are anonymous and end-to-end encrypted, participants communications over I2P are anonymous and end-to-end encrypted, participants
don't reveal their real IP addresses. don't reveal their real IP addresses.

70
debian/i2pd.1 vendored
View file

@ -1,22 +1,19 @@
.TH I2PD "1" "June 16, 2018" .TH "I2PD" "1" "June 20, 2018"
.SH NAME .SH "NAME"
i2pd \- Load-balanced unspoofable packet switching network i2pd \- Full-featured C++ implementation of I2P client.
.SH "SYNOPSIS"
.SH SYNOPSIS
.B i2pd .B i2pd
[\fIOPTION1\fR] [\fIOPTION2\fR]... [\fIOPTION1\fR] [\fIOPTION2\fR]...
.SH "DESCRIPTION"
.SH DESCRIPTION
i2pd i2pd
is a C++ implementation of the router for the I2P anonymizing network, offering is a C++ implementation of the router for the I2P anonymizing network, offering
a simple layer that identity-sensitive applications can use to securely a simple layer that identity-sensitive applications can use to securely
communicate. All data is wrapped with several layers of encryption, and the communicate. All data is wrapped with several layers of encryption, and the
network is both distributed and dynamic, with no trusted parties. network is both distributed and dynamic, with no trusted parties.
.PP .PP
Any of the configuration options below can be used in the \fBDAEMON_ARGS\fR variable in \fI/etc/default/i2pd\fR. Any of the configuration options below can be used in the \fBDAEMON_ARGS\fR variable in \fI/etc/default/i2pd\fR.
.BR .SH "OPTIONS"
.TP .TP
\fB\-\-help\fR \fB\-\-help\fR
Show available options. Show available options.
@ -43,7 +40,7 @@ Path to logfile (default - autodetect)
Log messages above this level (\fIdebug\fR, \fBinfo\fR, \fIwarn\fR, \fIerror\fR, \fInone\fR) Log messages above this level (\fIdebug\fR, \fBinfo\fR, \fIwarn\fR, \fIerror\fR, \fInone\fR)
.TP .TP
\fB\-\-logclftime\fR \fB\-\-logclftime\fR
Log messages with full CLF-formatted date and time (\fIfalse\fR by default) Log messages with full CLF-formatted date and time (\fIdisabled\fR by default)
.TP .TP
\fB\-\-datadir=\fR \fB\-\-datadir=\fR
Path to storage of i2pd data (RI, keys, peer profiles, ...) Path to storage of i2pd data (RI, keys, peer profiles, ...)
@ -64,25 +61,25 @@ The network interface to bind to for IPv4 connections
The network interface to bind to for IPv6 connections The network interface to bind to for IPv6 connections
.TP .TP
\fB\-\-ipv4\fR \fB\-\-ipv4\fR
Enable communication through ipv6 (\fItrue\fR by default) Enable communication through ipv6 (\fIenabled\fR by default)
.TP .TP
\fB\-\-ipv6\fR \fB\-\-ipv6\fR
Enable communication through ipv6 (\fIfalse\fR by default) Enable communication through ipv6 (\fIdisabled\fR by default)
.TP .TP
\fB\-\-ntcp\fR \fB\-\-ntcp\fR
Enable usage of NTCP transport (\fItrue\fR by default) Enable usage of NTCP transport (\fIenabled\fR by default)
.TP .TP
\fB\-\-ntcpproxy\fR \fB\-\-ntcpproxy=\fR
Set proxy URL for NTCP transport Set proxy URL for NTCP transport
.TP .TP
\fB\-\-ssu\fR \fB\-\-ssu\fR
Enable usage of SSU transport (\fItrue\fR by default) Enable usage of SSU transport (\fIenabled\fR by default)
.TP .TP
\fB\-\-notransit\fR \fB\-\-notransit\fR
Router will not accept transit tunnels at startup (\fIfalse\fR by default) Router will not accept transit tunnels at startup (\fIdisabled\fR by default)
.TP .TP
\fB\-\-floodfill\fR \fB\-\-floodfill\fR
Router will be floodfill (\fIfalse\fR by default) Router will be floodfill (\fIdisabled\fR by default)
.TP .TP
\fB\-\-bandwidth=\fR \fB\-\-bandwidth=\fR
Bandwidth limit: integer in KBps or letter aliases: \fBL (32KBps)\fR, \fIO (256)\fR, \fIP (2048)\fR, \fIX (>9000)\fR Bandwidth limit: integer in KBps or letter aliases: \fBL (32KBps)\fR, \fIO (256)\fR, \fIP (2048)\fR, \fIX (>9000)\fR
@ -91,22 +88,21 @@ Bandwidth limit: integer in KBps or letter aliases: \fBL (32KBps)\fR, \fIO (256)
Limit of transit traffic from max bandwidth in percents. (default: 100) Limit of transit traffic from max bandwidth in percents. (default: 100)
.TP .TP
\fB\-\-daemon\fR \fB\-\-daemon\fR
Router will go to background after start (\fIfalse\fR by default) Router will go to background after start (\fIdisabled\fR by default)
.TP .TP
\fB\-\-service\fR \fB\-\-service\fR
Router will use system folders like \fI/var/lib/i2pd\fR (\fIfalse\fR by default) Router will use system folders like \fI/var/lib/i2pd\fR (\fIdisabled\fR by default)
.TP .TP
\fB\-\-family=\fR \fB\-\-family=\fR
Name of a family, router belongs to. Name of a family, router belongs to.
.PP .PP
See service-specific parameters in example config file \fIcontrib/i2pd.conf\fR Switchs, which enabled by default (like \fB\-\-ssu\fR, \fB\-\-ntcp\fR, etc.), can be disabled in config file.
.RE
.SH FILES See service-specific parameters in example config file \fI/usr/share/doc/i2pd/i2pd.conf.gz\fR
.PP .SH "FILES"
/etc/i2pd/i2pd.conf, /etc/i2pd/tunnels.conf, /etc/default/i2pd /etc/i2pd/i2pd.conf, /etc/i2pd/tunnels.conf, /etc/default/i2pd
.RS 4 .RS 4
i2pd configuration files (when running as a system service) i2pd configuration files (when running as a system service)
.RE .RE
.PP .PP
/var/lib/i2pd/ /var/lib/i2pd/
@ -117,21 +113,15 @@ i2pd profile directory (when running as a system service, see \fB\-\-service\fR
$HOME/.i2pd/ $HOME/.i2pd/
.RS 4 .RS 4
i2pd profile directory (when running as a normal user) i2pd profile directory (when running as a normal user)
.SH SEE ALSO .SH "SEE ALSO"
Documentation at Read the Docs: \m[blue]\fBhttps://i2pd\&.readthedocs\&.io/en/latest/\fR\m[]
.SH "AUTHOR"
This manual page was written by kytv <\m[blue]\fBkillyourtv@i2pmail\&.org\fR\m[]> for the Debian system (but may be used by others).
.RE
Updated by hagen <\m[blue]\fBhagen@i2pmail\&.org\fR\m[]> in 2016.
.RE
Updated by R4SAS <\m[blue]\fBr4sas@i2pmail\&.org\fR\m[]> in 2018.
.PP .PP
Documentation at Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.
.UR https://i2pd.readthedocs.io/en/latest/ .RE
Read the Docs
.UE .
.PP
.SH AUTHOR
This manual page was written by kytv <killyourtv@i2pmail.org> for the Debian system (but may be used by others).
.PP
Updated by hagen <hagen@i2pmail.org> in 2016.
.PP
Updated by R4SAS <r4sas@i2pmail.org> in 2018.
.PP
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation
.BR
On Debian systems, the complete text of the GNU General Public License can be found in \fI/usr/share/common-licenses/GPL\fR On Debian systems, the complete text of the GNU General Public License can be found in \fI/usr/share/common-licenses/GPL\fR

24
libi2pd/Config.cpp
View file

@ -38,31 +38,31 @@ namespace config {
("log", value<std::string>()->default_value(""), "Logs destination: stdout, file, syslog (stdout if not set)") ("log", value<std::string>()->default_value(""), "Logs destination: stdout, file, syslog (stdout if not set)")
("logfile", value<std::string>()->default_value(""), "Path to logfile (stdout if not set, autodetect if daemon)") ("logfile", value<std::string>()->default_value(""), "Path to logfile (stdout if not set, autodetect if daemon)")
("loglevel", value<std::string>()->default_value("info"), "Set the minimal level of log messages (debug, info, warn, error, none)") ("loglevel", value<std::string>()->default_value("info"), "Set the minimal level of log messages (debug, info, warn, error, none)")
("logclftime", value<bool>()->default_value(false), "Write full CLF-formatted date and time to log (default: write only time)") ("logclftime", bool_switch()->default_value(false), "Write full CLF-formatted date and time to log (default: disabled, write only time)")
("family", value<std::string>()->default_value(""), "Specify a family, router belongs to") ("family", value<std::string>()->default_value(""), "Specify a family, router belongs to")
("datadir", value<std::string>()->default_value(""), "Path to storage of i2pd data (RI, keys, peer profiles, ...)") ("datadir", value<std::string>()->default_value(""), "Path to storage of i2pd data (RI, keys, peer profiles, ...)")
("host", value<std::string>()->default_value("0.0.0.0"), "External IP") ("host", value<std::string>()->default_value("0.0.0.0"), "External IP")
("ifname", value<std::string>()->default_value(""), "Network interface to bind to") ("ifname", value<std::string>()->default_value(""), "Network interface to bind to")
("ifname4", value<std::string>()->default_value(""), "Network interface to bind to for ipv4") ("ifname4", value<std::string>()->default_value(""), "Network interface to bind to for ipv4")
("ifname6", value<std::string>()->default_value(""), "Network interface to bind to for ipv6") ("ifname6", value<std::string>()->default_value(""), "Network interface to bind to for ipv6")
("nat", value<bool>()->default_value(true), "Should we assume we are behind NAT?") ("nat", bool_switch()->default_value(true), "Should we assume we are behind NAT? (default: enabled)")
("port", value<uint16_t>()->default_value(0), "Port to listen for incoming connections (default: auto)") ("port", value<uint16_t>()->default_value(0), "Port to listen for incoming connections (default: auto)")
("ipv4", value<bool>()->default_value(true), "Enable communication through ipv4") ("ipv4", bool_switch()->default_value(true), "Enable communication through ipv4 (default: enabled)")
("ipv6", value<bool>()->default_value(false), "Enable communication through ipv6") ("ipv6", bool_switch()->default_value(false), "Enable communication through ipv6 (default: disabled)")
("netid", value<int>()->default_value(I2PD_NET_ID), "Specify NetID. Main I2P is 2") ("netid", value<int>()->default_value(I2PD_NET_ID), "Specify NetID. Main I2P is 2")
("daemon", value<bool>()->default_value(false), "Router will go to background after start") ("daemon", bool_switch()->default_value(false), "Router will go to background after start (default: disabled)")
("service", value<bool>()->default_value(false), "Router will use system folders like '/var/lib/i2pd'") ("service", bool_switch()->default_value(false), "Router will use system folders like '/var/lib/i2pd' (default: disabled)")
("notransit", value<bool>()->default_value(false), "Router will not accept transit tunnels at startup") ("notransit", bool_switch()->default_value(false), "Router will not accept transit tunnels at startup (default: disabled)")
("floodfill", value<bool>()->default_value(false), "Router will be floodfill") ("floodfill", bool_switch()->default_value(false), "Router will be floodfill (default: disabled)")
("bandwidth", value<std::string>()->default_value(""), "Bandwidth limit: integer in KBps or letters: L (32), O (256), P (2048), X (>9000)") ("bandwidth", value<std::string>()->default_value(""), "Bandwidth limit: integer in KBps or letters: L (32), O (256), P (2048), X (>9000)")
("share", value<int>()->default_value(100), "Limit of transit traffic from max bandwidth in percents. (default: 100)") ("share", value<int>()->default_value(100), "Limit of transit traffic from max bandwidth in percents. (default: 100)")
("ntcp", value<bool>()->default_value(true), "Enable NTCP transport") ("ntcp", bool_switch()->default_value(true), "Enable NTCP transport (default: enabled)")
("ssu", value<bool>()->default_value(true), "Enable SSU transport") ("ssu", bool_switch()->default_value(true), "Enable SSU transport (default: enabled)")
("ntcpproxy", value<std::string>()->default_value(""), "Proxy URL for NTCP transport") ("ntcpproxy", value<std::string>()->default_value(""), "Proxy URL for NTCP transport")
("ntcp2", value<bool>()->default_value(false), "Enable NTCP2 (experimental)") ("ntcp2", bool_switch()->default_value(false), "Enable NTCP2 (experimental, default: disabled)")
#ifdef _WIN32 #ifdef _WIN32
("svcctl", value<std::string>()->default_value(""), "Windows service management ('install' or 'remove')") ("svcctl", value<std::string>()->default_value(""), "Windows service management ('install' or 'remove')")
("insomnia", value<bool>()->default_value(false), "Prevent system from sleeping") ("insomnia", bool_switch()->default_value(false), "Prevent system from sleeping (default: disabled)")
("close", value<std::string>()->default_value("ask"), "Action on close: minimize, exit, ask") ("close", value<std::string>()->default_value("ask"), "Action on close: minimize, exit, ask")
#endif #endif
; ;