forked from mirrors/nixpkgs
Previously we had three services for different config flavors. This is confusing because only one instance of IPFS can run on a host / port combination at once. So move all into ipfs.service, which contains the configuration specified in services.ipfs. Also remove the env wrapper and just use systemd env configuration.
242 lines
7.2 KiB
Nix
242 lines
7.2 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
with lib;
|
|
let
|
|
cfg = config.services.ipfs;
|
|
|
|
ipfsFlags = toString ([
|
|
(optionalString cfg.autoMount "--mount")
|
|
(optionalString cfg.enableGC "--enable-gc")
|
|
(optionalString (cfg.serviceFdlimit != null) "--manage-fdlimit=false")
|
|
(optionalString (cfg.defaultMode == "offline") "--offline")
|
|
(optionalString (cfg.defaultMode == "norouting") "--routing=none")
|
|
] ++ cfg.extraFlags);
|
|
|
|
in {
|
|
|
|
###### interface
|
|
|
|
options = {
|
|
|
|
services.ipfs = {
|
|
|
|
enable = mkEnableOption "Interplanetary File System (WARNING: may cause severe network degredation)";
|
|
|
|
user = mkOption {
|
|
type = types.str;
|
|
default = "ipfs";
|
|
description = "User under which the IPFS daemon runs";
|
|
};
|
|
|
|
group = mkOption {
|
|
type = types.str;
|
|
default = "ipfs";
|
|
description = "Group under which the IPFS daemon runs";
|
|
};
|
|
|
|
dataDir = mkOption {
|
|
type = types.str;
|
|
default = if versionAtLeast config.system.stateVersion "17.09"
|
|
then "/var/lib/ipfs"
|
|
else "/var/lib/ipfs/.ipfs";
|
|
description = "The data dir for IPFS";
|
|
};
|
|
|
|
defaultMode = mkOption {
|
|
type = types.enum [ "online" "offline" "norouting" ];
|
|
default = "online";
|
|
description = "systemd service that is enabled by default";
|
|
};
|
|
|
|
autoMount = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = "Whether IPFS should try to mount /ipfs and /ipns at startup.";
|
|
};
|
|
|
|
ipfsMountDir = mkOption {
|
|
type = types.str;
|
|
default = "/ipfs";
|
|
description = "Where to mount the IPFS namespace to";
|
|
};
|
|
|
|
ipnsMountDir = mkOption {
|
|
type = types.str;
|
|
default = "/ipns";
|
|
description = "Where to mount the IPNS namespace to";
|
|
};
|
|
|
|
gatewayAddress = mkOption {
|
|
type = types.str;
|
|
default = "/ip4/127.0.0.1/tcp/8080";
|
|
description = "Where the IPFS Gateway can be reached";
|
|
};
|
|
|
|
apiAddress = mkOption {
|
|
type = types.str;
|
|
default = "/ip4/127.0.0.1/tcp/5001";
|
|
description = "Where IPFS exposes its API to";
|
|
};
|
|
|
|
swarmAddress = mkOption {
|
|
type = types.listOf types.str;
|
|
default = [ "/ip4/0.0.0.0/tcp/4001" "/ip6/::/tcp/4001" ];
|
|
description = "Where IPFS listens for incoming p2p connections";
|
|
};
|
|
|
|
enableGC = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = "Whether to enable automatic garbage collection";
|
|
};
|
|
|
|
emptyRepo = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = "If set to true, the repo won't be initialized with help files";
|
|
};
|
|
|
|
extraConfig = mkOption {
|
|
type = types.attrs;
|
|
description = ''
|
|
Attrset of daemon configuration to set using <command>ipfs config</command>, every time the daemon starts.
|
|
These are applied last, so may override configuration set by other options in this module.
|
|
Keep in mind that this configuration is stateful; i.e., unsetting anything in here does not reset the value to the default!
|
|
'';
|
|
default = {};
|
|
example = {
|
|
Datastore.StorageMax = "100GB";
|
|
Discovery.MDNS.Enabled = false;
|
|
Bootstrap = [
|
|
"/ip4/128.199.219.111/tcp/4001/ipfs/QmSoLSafTMBsPKadTEgaXctDQVcqN88CNLHXMkTNwMKPnu"
|
|
"/ip4/162.243.248.213/tcp/4001/ipfs/QmSoLueR4xBeUbY9WZ9xGUUxunbKWcrNFTDAadQJmocnWm"
|
|
];
|
|
Swarm.AddrFilters = null;
|
|
};
|
|
|
|
};
|
|
|
|
extraFlags = mkOption {
|
|
type = types.listOf types.str;
|
|
description = "Extra flags passed to the IPFS daemon";
|
|
default = [];
|
|
};
|
|
|
|
localDiscovery = mkOption {
|
|
type = types.bool;
|
|
description = ''Whether to enable local discovery for the ipfs daemon.
|
|
This will allow ipfs to scan ports on your local network. Some hosting services will ban you if you do this.
|
|
'';
|
|
default = true;
|
|
};
|
|
|
|
serviceFdlimit = mkOption {
|
|
type = types.nullOr types.int;
|
|
default = null;
|
|
description = "The fdlimit for the IPFS systemd unit or <literal>null</literal> to have the daemon attempt to manage it";
|
|
example = 64*1024;
|
|
};
|
|
|
|
};
|
|
};
|
|
|
|
###### implementation
|
|
|
|
config = mkIf cfg.enable {
|
|
environment.systemPackages = [ pkgs.ipfs ];
|
|
environment.variables.IPFS_PATH = cfg.dataDir;
|
|
|
|
programs.fuse = mkIf cfg.autoMount {
|
|
userAllowOther = true;
|
|
};
|
|
|
|
users.users = mkIf (cfg.user == "ipfs") {
|
|
ipfs = {
|
|
group = cfg.group;
|
|
home = cfg.dataDir;
|
|
createHome = false;
|
|
uid = config.ids.uids.ipfs;
|
|
description = "IPFS daemon user";
|
|
packages = [
|
|
pkgs.ipfs-migrator
|
|
];
|
|
};
|
|
};
|
|
|
|
users.groups = mkIf (cfg.group == "ipfs") {
|
|
ipfs.gid = config.ids.gids.ipfs;
|
|
};
|
|
|
|
systemd.tmpfiles.rules = [
|
|
"d '${cfg.dataDir}' - ${cfg.user} ${cfg.group} - -"
|
|
] ++ optionals cfg.autoMount [
|
|
"d '${cfg.ipfsMountDir}' - ${cfg.user} ${cfg.group} - -"
|
|
"d '${cfg.ipnsMountDir}' - ${cfg.user} ${cfg.group} - -"
|
|
];
|
|
|
|
systemd.services.ipfs-init = {
|
|
description = "IPFS Initializer";
|
|
|
|
environment.IPFS_PATH = cfg.dataDir;
|
|
|
|
path = [ pkgs.ipfs ];
|
|
|
|
script = ''
|
|
if [[ ! -f ${cfg.dataDir}/config ]]; then
|
|
ipfs init ${optionalString cfg.emptyRepo "-e"} \
|
|
${optionalString (! cfg.localDiscovery) "--profile=server"}
|
|
else
|
|
${if cfg.localDiscovery
|
|
then "ipfs config profile apply local-discovery"
|
|
else "ipfs config profile apply server"
|
|
}
|
|
fi
|
|
'';
|
|
|
|
serviceConfig = {
|
|
Type = "oneshot";
|
|
RemainAfterExit = true;
|
|
User = cfg.user;
|
|
Group = cfg.group;
|
|
};
|
|
};
|
|
|
|
systemd.services.ipfs = {
|
|
path = [ "/run/wrappers" pkgs.ipfs ];
|
|
environment.IPFS_PATH = cfg.dataDir;
|
|
|
|
wants = [ "ipfs-init.service" ];
|
|
after = [ "ipfs-init.service" ];
|
|
|
|
wantedBy = [ "default.target" ];
|
|
|
|
preStart = optionalString cfg.autoMount ''
|
|
ipfs --local config Mounts.FuseAllowOther --json true
|
|
ipfs --local config Mounts.IPFS ${cfg.ipfsMountDir}
|
|
ipfs --local config Mounts.IPNS ${cfg.ipnsMountDir}
|
|
'' + concatStringsSep "\n" (collect
|
|
isString
|
|
(mapAttrsRecursive
|
|
(path: value:
|
|
# Using heredoc below so that the value is never improperly quoted
|
|
''
|
|
read value <<EOF
|
|
${builtins.toJSON value}
|
|
EOF
|
|
ipfs --local config --json "${concatStringsSep "." path}" "$value"
|
|
'')
|
|
({ Addresses.API = cfg.apiAddress;
|
|
Addresses.Gateway = cfg.gatewayAddress;
|
|
Addresses.Swarm = cfg.swarmAddress;
|
|
} //
|
|
cfg.extraConfig))
|
|
);
|
|
serviceConfig = {
|
|
ExecStart = "${pkgs.ipfs}/bin/ipfs daemon ${ipfsFlags}";
|
|
User = cfg.user;
|
|
Group = cfg.group;
|
|
} // optionalAttrs (cfg.serviceFdlimit != null) { LimitNOFILE = cfg.serviceFdlimit; };
|
|
};
|
|
|
|
};
|
|
}
|