i2pd documentation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

79 lines
2.3 KiB

8 years ago
Running i2pd
============
Starting, stopping and reloading configuration
----------------------------------------------
This chapter explains how to start and manage the i2pd daemon under \*nix operation systems.
8 years ago
After you have built i2pd from source, just run the binary:
8 years ago
./i2pd
To display all available options:
./i2pd --help
i2pd can be controlled with signals. The process ID by is written to the file `~/.i2pd/i2pd.pid` or
`/var/run/i2pd/i2pd.pid` by default. You can use `kill` utility to send signals like this:
8 years ago
kill -INT $( cat /var/run/i2pd/i2pd.pid )
i2pd supports the following signals:
* INT - Graceful shutdown. i2pd will wait for up to 10 minutes and stop. Send a second INT signal to shutdown i2pd immediately.
8 years ago
* HUP - Reload configuration files.
### systemd unit
Some i2pd packages come with a systemd control unit, and for those that use systemd, it is possible to manage i2pd with it.
8 years ago
To start/stop i2pd:
8 years ago
sudo systemctl start i2pd.service
sudo systemctl stop i2pd.service --no-block
The stop command initiates a graceful shutdown process, i2pd stops after finishing to route transit tunnels (maximum 10 minutes).
8 years ago
To enable/disable autostart of i2pd upon bootup:
8 years ago
sudo systemctl enable i2pd.service
sudo systemctl disable i2pd.service
Recommended way to run i2pd built from source
---------------------------------------------
The following commands display the recommended way to run i2pd built from source, without a package manager. Installing i2pd this
way will ensure all i2pd-related files are stored at `$HOME/dist`.
8 years ago
mkdir $HOME/dist
cp i2pd $HOME/dist
cp -R contrib/certificates $HOME/dist
cp contrib/i2pd.conf $HOME/dist
8 years ago
cd $HOME/dist
ulimit -n 4096 # only on Linux, increasing open file limit
Then, to run i2pd, simply travel to the installation directory and type:
8 years ago
./i2pd --datadir .
Overriding systemd service parameters
-----
For overriding systemd service defaults create `/etc/systemd/system/i2pd.service.d/override.conf` file and place overriden options. Don't forget use option section.
```
mkdir -p /etc/systemd/system/i2pd.service.d/
touch /etc/systemd/system/i2pd.service.d/override.conf
```
Example content with enabled coredump and increased `nofile` limit
```
[Service]
LimitNOFILE=16386
LimitCORE=infinity
```