From 47508e796978ea3a411b4dcc51ae0610b43c0f21 Mon Sep 17 00:00:00 2001 From: silverpill Date: Fri, 10 Feb 2023 22:07:06 +0000 Subject: [PATCH] Update IPFS guide --- docs/ipfs.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/ipfs.md b/docs/ipfs.md index 5733851..47b6a70 100644 --- a/docs/ipfs.md +++ b/docs/ipfs.md @@ -2,7 +2,7 @@ This guide explains how to run IPFS node in resource-constrained environment (such as cheap VPS or single-board computer). -The recommended IPFS implementation is [go-ipfs](https://github.com/ipfs/go-ipfs), version 0.12 or higher. Normally go-ipfs requires at least 2 GB RAM, but after tweaking it can run on a machine with only 512 MB. +The recommended IPFS implementation is [kubo](https://github.com/ipfs/kubo), version 0.18.1 or higher. Normally **kubo** requires at least 2 GB RAM, but after tweaking it can run on a machine with only 512 MB. ## Configuration profiles @@ -14,24 +14,26 @@ ipfs init --profile server If you're running it on single-board computer, the recommended profile is `lowpower`. -Documentation on configuration profiles: https://github.com/ipfs/go-ipfs/blob/master/docs/config.md#profiles. +Documentation on configuration profiles: https://github.com/ipfs/kubo/blob/master/docs/config.md#profiles ## Configuration options - `Datastore.StorageMax`. Recommended value is `1G`. - `Gateway.NoFetch`. Configures gateway to not fetch files from the network. Recommended value is `true`. -- `RelayService.Enabled`. Enables providing p2p relay service to other peers on the network. Recommended value is `false`. - `Routing.Type`. Should be set to `dht` otherwise the node will not respond to requests from other peers. - `Swarm.ConnMgr.LowWater`. Recommended value is `10`. - `Swarm.ConnMgr.HighWater`. Recommended value is `20`. - `Swarm.ConnMgr.GracePeriod`. Recommended value is `15s`. - `Swarm.DisableBandwidthMetrics`. Disabling bandwidth metrics can slightly improve performance. Recommended value is `true`. +- `Swarm.RelayService.Enabled`. Enables providing p2p relay service to other peers on the network. Recommended value is `false`. +- `Swarm.ResourceMgr.Enabled`. Enables the libp2p Resource Manager. Recommended value is `true`. +- `Swarm.ResourceMgr.MaxMemory`. Recommended value is `150MB`. -Documentation: https://github.com/ipfs/go-ipfs/blob/master/docs/config.md +Documentation: https://github.com/ipfs/kubo/blob/master/docs/config.md ## Systemd service -When go-ipfs starts, its memory usage is around 100 MB and then it slowly increases. To keep memory usage within reasonable bounds the service needs to be restarted regularly. +When **kubo** starts, its memory usage is around 100 MB and then it slowly increases, often beyond the Resource Manager's limit. To keep memory usage within reasonable bounds the service needs to be restarted regularly. This can be achieved by using systemd process supervison features: @@ -44,8 +46,8 @@ ExecStart=/usr/local/bin/ipfs daemon User=ipfs Group=ipfs -# Terminate service every 20 minutes and restart automatically -RuntimeMaxSec=1200 +# Terminate service every 30 minutes and restart automatically +RuntimeMaxSec=1800 Restart=on-failure # Specify the absolute limit on memory usage