nixos/xray: init service

iopq 96f7444b 0264a930

Changed files
+109
nixos
doc
manual
from_md
release-notes
release-notes
modules
services
networking
+9
nixos/doc/manual/from_md/release-notes/rl-2211.section.xml
···
</listitem>
<listitem>
<para>
<link xlink:href="https://github.com/mozilla-services/syncstorage-rs">syncstorage-rs</link>,
a self-hostable sync server for Firefox. Available as
<link xlink:href="options.html#opt-services.firefox-syncserver.enable">services.firefox-syncserver</link>.
···
</listitem>
<listitem>
<para>
+
[xray] (https://github.com/XTLS/Xray-core), a fully compatible
+
v2ray-core replacement. Features XTLS, which when enabled on
+
server and client, brings UDP FullCone NAT to proxy setups.
+
Available as
+
<link xlink:href="options.html#opt-services.xray.enable">services.xray</link>.
+
</para>
+
</listitem>
+
<listitem>
+
<para>
<link xlink:href="https://github.com/mozilla-services/syncstorage-rs">syncstorage-rs</link>,
a self-hostable sync server for Firefox. Available as
<link xlink:href="options.html#opt-services.firefox-syncserver.enable">services.firefox-syncserver</link>.
+3
nixos/doc/manual/release-notes/rl-2211.section.md
···
## New Services {#sec-release-22.11-new-services}
- [appvm](https://github.com/jollheef/appvm), Nix based app VMs. Available as [virtualisation.appvm](options.html#opt-virtualisation.appvm.enable).
- [syncstorage-rs](https://github.com/mozilla-services/syncstorage-rs), a self-hostable sync server for Firefox. Available as [services.firefox-syncserver](options.html#opt-services.firefox-syncserver.enable).
- [dragonflydb](https://dragonflydb.io/), a modern replacement for Redis and Memcached. Available as [services.dragonflydb](#opt-services.dragonflydb.enable).
···
## New Services {#sec-release-22.11-new-services}
- [appvm](https://github.com/jollheef/appvm), Nix based app VMs. Available as [virtualisation.appvm](options.html#opt-virtualisation.appvm.enable).
+
+
- [xray] (https://github.com/XTLS/Xray-core), a fully compatible v2ray-core replacement. Features XTLS, which when enabled on server and client, brings UDP FullCone NAT to proxy setups. Available as [services.xray](options.html#opt-services.xray.enable).
+
- [syncstorage-rs](https://github.com/mozilla-services/syncstorage-rs), a self-hostable sync server for Firefox. Available as [services.firefox-syncserver](options.html#opt-services.firefox-syncserver.enable).
- [dragonflydb](https://dragonflydb.io/), a modern replacement for Redis and Memcached. Available as [services.dragonflydb](#opt-services.dragonflydb.enable).
+1
nixos/modules/module-list.nix
···
./services/networking/xinetd.nix
./services/networking/xl2tpd.nix
./services/networking/x2goserver.nix
./services/networking/xrdp.nix
./services/networking/yggdrasil.nix
./services/networking/zerobin.nix
···
./services/networking/xinetd.nix
./services/networking/xl2tpd.nix
./services/networking/x2goserver.nix
+
./services/networking/xray.nix
./services/networking/xrdp.nix
./services/networking/yggdrasil.nix
./services/networking/zerobin.nix
+96
nixos/modules/services/networking/xray.nix
···
···
+
{ config, lib, pkgs, ... }:
+
+
with lib;
+
+
{
+
options = {
+
+
services.xray = {
+
enable = mkOption {
+
type = types.bool;
+
default = false;
+
description = lib.mdDoc ''
+
Whether to run xray server.
+
+
Either `settingsFile` or `settings` must be specified.
+
'';
+
};
+
+
package = mkOption {
+
type = types.package;
+
default = pkgs.xray;
+
defaultText = literalExpression "pkgs.xray";
+
description = lib.mdDoc ''
+
Which xray package to use.
+
'';
+
};
+
+
settingsFile = mkOption {
+
type = types.nullOr types.path;
+
default = null;
+
example = "/etc/xray/config.json";
+
description = lib.mdDoc ''
+
The absolute path to the configuration file.
+
+
Either `settingsFile` or `settings` must be specified.
+
+
See <https://www.v2fly.org/en_US/config/overview.html>.
+
'';
+
};
+
+
settings = 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 `settingsFile` or `settings` must be specified.
+
+
See <https://www.v2fly.org/en_US/config/overview.html>.
+
'';
+
};
+
};
+
+
};
+
+
config = let
+
cfg = config.services.xray;
+
settingsFile = if cfg.settingsFile != null
+
then cfg.settingsFile
+
else pkgs.writeTextFile {
+
name = "xray.json";
+
text = builtins.toJSON cfg.settings;
+
checkPhase = ''
+
${cfg.package}/bin/xray -test -config $out
+
'';
+
};
+
+
in mkIf cfg.enable {
+
assertions = [
+
{
+
assertion = (cfg.settingsFile == null) != (cfg.settings == null);
+
message = "Either but not both `settingsFile` and `settings` should be specified for xray.";
+
}
+
];
+
+
systemd.services.xray = {
+
description = "xray Daemon";
+
after = [ "network.target" ];
+
wantedBy = [ "multi-user.target" ];
+
serviceConfig = {
+
DynamicUser = true;
+
ExecStart = "${cfg.package}/bin/xray -config ${settingsFile}";
+
};
+
};
+
};
+
}