nixpkgs/nixos/modules/services/networking/v2ray.nix
h7x4 0a37316d6c
treewide: use mkPackageOption
This commit replaces a lot of usages of `mkOption` with the package
type, to be `mkPackageOption`, in order to reduce the amount of code.
2023-11-27 01:28:36 +01:00

91 lines
2.2 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
{
options = {
services.v2ray = {
enable = mkOption {
type = types.bool;
default = false;
description = lib.mdDoc ''
Whether to run v2ray server.
Either `configFile` or `config` must be specified.
'';
};
package = mkPackageOption pkgs "v2ray" { };
configFile = mkOption {
type = types.nullOr types.str;
default = null;
example = "/etc/v2ray/config.json";
description = lib.mdDoc ''
The absolute path to the configuration file.
Either `configFile` or `config` must be specified.
See <https://www.v2fly.org/en_US/v5/config/overview.html>.
'';
};
config = mkOption {
type = types.nullOr (types.attrsOf types.unspecified);
default = null;
example = {
inbounds = [{
port = 1080;
listen = "127.0.0.1";
protocol = "http";
}];
outbounds = [{
protocol = "freedom";
}];
};
description = lib.mdDoc ''
The configuration object.
Either `configFile` or `config` must be specified.
See <https://www.v2fly.org/en_US/v5/config/overview.html>.
'';
};
};
};
config = let
cfg = config.services.v2ray;
configFile = if cfg.configFile != null
then cfg.configFile
else pkgs.writeTextFile {
name = "v2ray.json";
text = builtins.toJSON cfg.config;
checkPhase = ''
${cfg.package}/bin/v2ray test -c $out
'';
};
in mkIf cfg.enable {
assertions = [
{
assertion = (cfg.configFile == null) != (cfg.config == null);
message = "Either but not both `configFile` and `config` should be specified for v2ray.";
}
];
environment.etc."v2ray/config.json".source = configFile;
systemd.packages = [ cfg.package ];
systemd.services.v2ray = {
restartTriggers = [ config.environment.etc."v2ray/config.json".source ];
# Workaround: https://github.com/NixOS/nixpkgs/issues/81138
wantedBy = [ "multi-user.target" ];
};
};
}