mirror of
https://github.com/ipfs/kubo.git
synced 2026-02-21 10:27:46 +08:00
6df07bd5a6
the --config-file global flag was defined but not properly used by most commands. this fixes the flag to work consistently, allowing config to be stored separately from the repo. useful for Kubernetes deployments where config comes from a ConfigMap and data lives on a PersistentVolume. changes: - fsrepo: add InitWithUserConfig/OpenWithUserConfig that respect custom config paths - fsrepo: fix InitWithUserConfig to create version/datastore_spec even when config file already exists (pre-populated from ConfigMap) - commands: update all commands that open repo to use the new functions - daemon: add CONFIGURATION FILE MANAGEMENT section to help text explaining difference between --init-config (one-time copy) and --config-file (persistent external path) - init: clarify that default-config template preserves Identity
90 lines
2.6 KiB
Go
90 lines
2.6 KiB
Go
package cmdutils
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
cmds "github.com/ipfs/go-ipfs-cmds"
|
|
|
|
"github.com/ipfs/boxo/path"
|
|
"github.com/ipfs/go-cid"
|
|
coreiface "github.com/ipfs/kubo/core/coreiface"
|
|
)
|
|
|
|
const (
|
|
AllowBigBlockOptionName = "allow-big-block"
|
|
SoftBlockLimit = 1024 * 1024 // https://github.com/ipfs/kubo/issues/7421#issuecomment-910833499
|
|
MaxPinNameBytes = 255 // Maximum number of bytes allowed for a pin name
|
|
|
|
// ConfigFileOption is the name of the global --config-file option
|
|
ConfigFileOption = "config-file"
|
|
)
|
|
|
|
var AllowBigBlockOption cmds.Option
|
|
|
|
func init() {
|
|
AllowBigBlockOption = cmds.BoolOption(AllowBigBlockOptionName, "Disable block size check and allow creation of blocks bigger than 1MiB. WARNING: such blocks won't be transferable over the standard bitswap.").WithDefault(false)
|
|
}
|
|
|
|
func CheckCIDSize(req *cmds.Request, c cid.Cid, dagAPI coreiface.APIDagService) error {
|
|
n, err := dagAPI.Get(req.Context, c)
|
|
if err != nil {
|
|
return fmt.Errorf("CheckCIDSize: getting dag: %w", err)
|
|
}
|
|
|
|
nodeSize, err := n.Size()
|
|
if err != nil {
|
|
return fmt.Errorf("CheckCIDSize: getting node size: %w", err)
|
|
}
|
|
|
|
return CheckBlockSize(req, nodeSize)
|
|
}
|
|
|
|
func CheckBlockSize(req *cmds.Request, size uint64) error {
|
|
allowAnyBlockSize, _ := req.Options[AllowBigBlockOptionName].(bool)
|
|
if allowAnyBlockSize {
|
|
return nil
|
|
}
|
|
|
|
// We do not allow producing blocks bigger than 1 MiB to avoid errors
|
|
// when transmitting them over BitSwap. The 1 MiB constant is an
|
|
// unenforced and undeclared rule of thumb hard-coded here.
|
|
if size > SoftBlockLimit {
|
|
return fmt.Errorf("produced block is over 1MiB: big blocks can't be exchanged with other peers. consider using UnixFS for automatic chunking of bigger files, or pass --allow-big-block to override")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// ValidatePinName validates that a pin name does not exceed the maximum allowed byte length.
|
|
// Returns an error if the name exceeds MaxPinNameBytes (255 bytes).
|
|
func ValidatePinName(name string) error {
|
|
if name == "" {
|
|
// Empty names are allowed
|
|
return nil
|
|
}
|
|
|
|
nameBytes := len([]byte(name))
|
|
if nameBytes > MaxPinNameBytes {
|
|
return fmt.Errorf("pin name is %d bytes (max %d bytes)", nameBytes, MaxPinNameBytes)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// PathOrCidPath returns a path.Path built from the argument. It keeps the old
|
|
// behaviour by building a path from a CID string.
|
|
func PathOrCidPath(str string) (path.Path, error) {
|
|
p, err := path.NewPath(str)
|
|
if err == nil {
|
|
return p, nil
|
|
}
|
|
|
|
// Save the original error before attempting fallback
|
|
originalErr := err
|
|
|
|
if p, err := path.NewPath("/ipfs/" + str); err == nil {
|
|
return p, nil
|
|
}
|
|
|
|
// Send back original err.
|
|
return nil, originalErr
|
|
}
|