Kubo

`services.kubo.autoMigrate`

Whether Kubo should try to run the fs-repo-migration at startup. Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.autoMount`

Whether Kubo should try to mount /ipfs and /ipns at startup. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.dataDir`

The data dir for Kubo Type: string

Default

if versionAtLeast config.system.stateVersion "17.09"then "/var/lib/ipfs"else "/var/lib/ipfs/.ipfs"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.defaultMode`

systemd service that is enabled by default Type: one of "online", "offline", "norouting"

Default

"online"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.emptyRepo`

If set to false, the repo will be initialized with help files Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.enable`

Whether to enable the Interplanetary File System (WARNING: may cause severe network degradation). NOTE: after enabling this option and rebuilding your system, you need to log out and back in for the IPFS_PATH environment variable to be present in your shell. Until you do that, the CLI tools won't be able to talk to the daemon by default . Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.enableGC`

Whether to enable automatic garbage collection Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.extraFlags`

Extra flags passed to the Kubo daemon Type: list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.group`

Group under which the Kubo daemon runs Type: string

Default

"ipfs"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.localDiscovery`

Whether to enable local discovery for the Kubo daemon. This will allow Kubo to scan ports on your local network. Some hosting services will ban you if you do this.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.package`

The kubo package to use. Type: package

Default

pkgs.kubo

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.serviceFdlimit`

The fdlimit for the Kubo systemd unit or null to have the daemon attempt to manage it Type: null or signed integer

Default

null

Example

65536

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.settings`

Attrset of daemon configuration. See https://github.com/ipfs/kubo/blob/master/docs/config.md for reference. You can't set Identity or Pinning.

Type: JSON value

Default

{ }

Example

{Bootstrap = ["/ip4/128.199.219.111/tcp/4001/ipfs/QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu""/ip4/162.243.248.213/tcp/4001/ipfs/QmSoLueR4xBeUbY9WZ9xGUUxunbKWcrNFTDAadQJmocnWm"];Datastore = {StorageMax = "100GB";};Discovery = {MDNS = {Enabled = false;};};Swarm = {AddrFilters = null;};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.settings.Addresses.API`

Multiaddr or array of multiaddrs describing the address to serve the local HTTP API on. In addition to the multiaddrs listed here, the daemon will also listen on a Unix domain socket. To allow the ipfs CLI tools to communicate with the daemon over that socket, add your user to the correct group, e.g. users.users.alice.extraGroups = [ config.services.kubo.group ];

Type: string or list of string

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.settings.Addresses.Gateway`

Where the IPFS Gateway can be reached Type: string or list of string

Default

"/ip4/127.0.0.1/tcp/8080"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix

`services.kubo.settings.Addresses.Swarm`

Where Kubo listens for incoming p2p connections Type: list of string

Default

["/ip4/0.0.0.0/tcp/4001""/ip6/::/tcp/4001""/ip4/0.0.0.0/udp/4001/quic-v1""/ip4/0.0.0.0/udp/4001/quic-v1/webtransport""/ip6/::/udp/4001/quic-v1""/ip6/::/udp/4001/quic-v1/webtransport"]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/network-filesystems/kubo.nix