I2PD(1)

📦
version 3.0.0.1 · 4 versions
, in arch rolling, nixos 26.05, nixpkgs unstable, opensuse-leap 16.0

💖 I2PD(1) 💖

okay so bestie, welcome to the i2pd manual page — this is the General Commands Manual and honestly it's giving main character energy for anyone who wants to run an I2P router. let's get into it 🫶

✨ NAME ✨

i2pd — Full-featured C++ implementation of I2P client. that's the whole vibe. no cap. 💅

🎀 SYNOPSIS 🎀

i2pd [OPTION1] [OPTION2]...

🌸 DESCRIPTION 🌸

so i2pd is a C++ implementation of the router for the I2P anonymizing network, and it's literally offering a simple layer that identity-sensitive applications can use to securely communicate. ✨ all data is wrapped with several layers of encryption (yes, several — the girlies love defense in depth), and the network is both distributed and dynamic, with no trusted parties. no trusted parties! periodt. 🫶

any of the configuration options below can be used in the DAEMON_ARGS variable in /etc/default/i2pd. iykyk. 💜

👑 OPTIONS 👑

like, so many options, and we're going through every single one because we don't skip. ever. 💅

  • --help — Show available options. that's it bestie, she just tells you what's available. 🎀
  • --conf= — Config file (default: ~/.i2pd/i2pd.conf or /var/lib/i2pd/i2pd.conf). note: This parameter will be silently ignored if the specified config file does not exist. options specified on the command line take precedence over those in the config file. so if you're confused why your config isn't loading — check the path, babe. 💀
  • --tunconf= — Tunnels config file (default: ~/.i2pd/tunnels.conf or /var/lib/i2pd/tunnels.conf). tunnels need config too, and this is where they live. 🌈
  • --pidfile= — Where to write pidfile (don´t write by default). so by default there's no pidfile at all — you gotta opt in. 🦋
  • --log= — Logs destination: stdout, file, syslog (stdout if not set, file - otherwise, for compatibility). pick your fighter. ✨
  • --logfile= — Path to logfile (default - autodetect). she'll figure it out if you don't tell her. 🎀
  • --loglevel= — Log messages above this level (debug, info, warn, error, none). filter the noise, bestie. 💜
  • --logclftime — Log messages with full CLF-formatted date and time (disabled by default). if you like your timestamps fully formatted, this is for you. 🌸
  • --datadir= — Path to storage of i2pd data (RI, keys, peer profiles, ...). all the important stuff lives here. no cap. 👑
  • --tunnelsdir= — Path to tunnels configuration files (default: ~/.i2pd/tunnels.d or /var/lib/i2pd/tunnels.d). it's the tunnels directory, the tunnels config files live in it. 🦋
  • --host= — The external IP address. that's your host, bestie. 🫶
  • --port= — The port to listen on for incoming connections. pick a port, any port (well, a valid one). 🔥
  • --ifname= — The network interface to bind to. specific interface? this one. ✨
  • --ifname4= — The network interface to bind to for IPv4 connections. v4 girlies get their own interface option. 💅
  • --ifname6= — The network interface to bind to for IPv6 connections. and v6 girlies too. 🌈
  • --ipv4= — Enable communication through ipv4 (enabled by default). it's on by default, she's already slaying. 🎀
  • --ipv6 — Enable communication through ipv6 (disabled by default). off by default, gotta turn her on. 💜
  • --ntcp= — Enable usage of NTCP transport (enabled by default). on by default. ⭐
  • --ntcpproxy= — Set proxy URL for NTCP transport. if you need a proxy for NTCP, here it is. 🦋
  • --ssu= — Enable usage of SSU transport (enabled by default). also on by default. 🌸
  • --notransit — Router will not accept transit tunnels at startup (disabled by default). if you're not about that transit life. disabled by default. 💀
  • --floodfill — Router will be floodfill (disabled by default). floodfill mode is off by default. 👑
  • --bandwidth= — Bandwidth limit: integer in KBps or letter aliases: L (32KBps), O (256), P (2048), X (>9000). so you can do a number or use the cute letter aliases. iykyk. 🔥
  • --share= — Limit of transit traffic from max bandwidth in percents. (default: 100). default is 100. 🫶
  • --daemon — Router will go to background after start (disabled by default). disabled by default — she stays in the foreground unless you tell her otherwise. ✨
  • --service — Router will use system folders like /var/lib/i2pd (disabled by default). disabled by default — no system folders unless you opt in. 💅
  • --family= — Name of a family, router belongs to. yes, routers have families. iconic. 🎀

Switches, which enabled by default (like --ssu, --ntcp, etc.), can be disabled in config file. See service-specific parameters in example config file /usr/share/doc/i2pd/i2pd.conf.gz. 🌸

🦋 FILES 🦋

  • /etc/i2pd/i2pd.conf, /etc/i2pd/tunnels.conf, /etc/default/i2pd — i2pd configuration files (when running as a system service). 💜
  • /var/lib/i2pd/ — i2pd profile directory (when running as a system service, see --service above). 👑
  • $HOME/.i2pd/ — i2pd profile directory (when running as a normal user). 🌈

⭐ SEE ALSO ⭐

Documentation at Read the Docs: https://i2pd.readthedocs.io/en/latest/ — go read the docs bestie, they're right there. 🫶

💜 AUTHOR 💜

This manual page was written by kytv <killyourtv@i2pmail.org> for the Debian system (but may be used by others). Updated by hagen <hagen@i2pmail.org> in 2016. Updated by R4SAS <r4sas@i2pmail.org> in 2018. 💖

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. On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL. 🌸

okay that's the whole manual bestie, no skips no cap. this version is from June 20, 2018 and it's the I2PD(1) page — go run your router and slay. 💅✨🎀🦋💖

📦 where this page comes from