From 03d4584562f74de4e7971a22f109a4c6799b4abd Mon Sep 17 00:00:00 2001 From: Darknet Villain Date: Tue, 8 Nov 2016 17:14:53 +0000 Subject: [PATCH] Control i2pd and link to configuration page --- docs/usage.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/docs/usage.md b/docs/usage.md index 9480a556..da09e167 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -10,6 +10,47 @@ i2pd can be used for: and many more. +## Starting, stopping and reloading configuration + +After you have built i2pd from source, just run a binary: + + ./i2pd + +To display all available options: + + ./i2pd --help + +i2pd can be controlled with signals. Process ID by default is written to file `~/.i2pd/i2pd.pid` or `/var/run/i2pd/i2pd.pid`. +You can use `kill` utility to send signals like this: + + kill -TERM $( cat /var/run/i2pd/i2pd.pid ) + +i2pd supports the following signals: + + TERM - Graceful shutdown. i2pd will wait for 10 minutes and stop. Send second TERM signal to shutdown i2pd immediately. + HUP - Reload configuration files. + + +### systemd unit + +Some binary Linux packages have a systemd control unit, so it is possible to managage i2pd with it. + +Start/stop i2pd: + + sudo systemctl i2pd.service start + sudo systemctl i2pd.service stop + +Enable/disable i2pd to be started on bootup: + + sudo systemctl i2pd.service enable + sudo systemctl i2pd.service disable + + +## Configuring i2pd + +See [configuration page](i2pd.readthedocs.io/page/configuration.html). + + ## Browsing and hosting websites ### Browse anonymous websites