diff options
| -rw-r--r-- | instance-options.nix | 251 | ||||
| -rw-r--r-- | workadventure.nix | 164 |
2 files changed, 415 insertions, 0 deletions
diff --git a/instance-options.nix b/instance-options.nix new file mode 100644 index 0000000..f0f3649 --- /dev/null +++ b/instance-options.nix @@ -0,0 +1,251 @@ +# Configuration options specific to a single workadventure instance. + +{ lib, pkgs, config, ... }: + +with lib; +with pkgs; +{ + options = rec { + + settings = {}; + + + backend = { + enable = mkOption { + default = true; + type = types.bool; + }; + + httpPort = mkOption { + default = 8081; + type = types.ints.u16; + description = "The TCP port the backend will bind to for http"; + }; + + grpcPort = mkOption { + default = 50051; + type = types.ints.u16; + description = "The TCP port the backend will bind to for grpc"; + }; + + package = mkOption { + default = workadventure.back; + defaultText = "third_party.workadventure-nix.back"; + type = types.package; + description = "Backend package to use"; + }; + }; + + pusher = { + enable = mkOption { + default = true; + type = types.bool; + }; + + port = mkOption { + default = 8080; + type = types.ints.u16; + description = "The TCP port the pusher will bind to"; + }; + + package = mkOption { + default = workadventure.pusher; + defaultText = "third_party.workadventure-nix.pusher"; + type = types.package; + description = "Pusher package to use"; + }; + }; + + frontend = { + package = mkOption { + default = workadventure.front; + defaultText = "third_party.workadventure-nix.front"; + type = types.package; + description = "Front package to use"; + }; + + debugMode = mkOption { + default = false; + description = "Whether or not to run the frontend in debug mode"; + type = types.bool; + }; + + startRoomUrl = mkOption { + default = "/_/global/localhost/maps/Floor0/floor0.json"; + description = "The workadventure map url that users join by default"; + type = types.str; + }; + + resolution = mkOption { + default = 2; + description = "resolution of workadventure"; + type = types.int; + }; + + zoomLevel = mkOption { + default = 1; + description = "The default zoom level of maps"; + type = types.int; + }; + + positionDelay = mkOption { + default = 200; + description = "Delay in milliseconds between sending position events"; + type = types.int; + }; + + maxExtrapolationTime = mkOption { + default = 100; + description = "Maximum time period in which movements of other players are extrapolated"; + type = types.int; + }; + + + urls = { + api = mkOption { + default = "/pusher"; + type = types.str; + description = "The base url for the api, from the browser's point of view"; + }; + + uploader = mkOption { + default = "/uploader"; + type = types.str; + description = "The base url for the uploader, from the browser's point of view"; + }; + + admin = mkOption { + default = "/pusher/admin"; + type = types.str; + description = "The base url for the admin, from the browser's point of view"; + }; + + maps = mkOption { + default = "/maps"; + type = types.str; + description = "The base url for serving maps, from the browser's point of view"; + }; + }; + }; + + commonConfig = { + secretKey = mkOption { + default = "THECODINGMACHINE_SECRET_KEY"; + type = types.str; + }; + + minimumDistance = mkOption { + default = 64; + type = types.int; + }; + + groupRadius = mkOption { + default = 48; + type = types.int; + }; + + allowArtillery = mkOption { + default = false; + type = types.bool; + }; + + maxUsersPerRoom = mkOption { + default = 600; + type = types.int; + }; + + cpuOverheatThreshold = mkOption { + default = 80; + type = types.int; + }; + + socketIdleTime = mkOption { + default = 30; + type = types.int; + }; + + webrtc = { + stun = { + url = mkOption { + default = "stun:stun.l.google.com:19302"; + description = "The STUN server to use for peer connections"; + type = types.str; + }; + }; + turn = { + url = mkOption { + default = "turn:coturn.workadventure.localhost:3478"; + description = "The TURN server to use for peer connections"; + type = types.str; + }; + user = mkOption { + default = "workadventure"; + description = "Username for TURN authentication"; + type = types.str; # TODO: also allow no user + }; + password = mkOption { + default = "workadventure"; + description = "Password for TURN authentication"; + type = types.str; + }; + }; + }; + + jitsi = { + url = mkOption { + default = "meet.jit.si"; + description = "Jitsi instance to use for conference rooms"; + type = types.str; + }; + privateMode = mkOption { + default = false; + description = "Jitsi private mode"; + type = types.bool; + }; + iss = mkOption { + default = ""; + type = types.str; + }; + secretKey = mkOption { + default = ""; + type = types.str; + }; + }; + }; + + + nginx = { + enable = mkOption { + default = true; + type = types.bool; + description = "enable nginx as proxy, and for serving maps"; + }; + + default = mkOption { + default = false; + type = types.bool; + description = "Whether this instance will be the default one served by nginx"; + }; + + domain = mkOption { + default = "localhost"; + type = types.str; + description = "The domain name to serve workadenture services under."; + }; + + maps = { + serve = mkOption { + default = true; + type = types.bool; + description = "Whether to serve maps through nginx."; + }; + path = mkOption { + default = workadventure.maps.outPath + "/workadventuremaps/"; + defaultText = "third_party.workadventure-nix.maps"; + type = types.path; + description = "Maps package to use"; + }; + }; + }; + }; +} diff --git a/workadventure.nix b/workadventure.nix new file mode 100644 index 0000000..49227aa --- /dev/null +++ b/workadventure.nix @@ -0,0 +1,164 @@ +# Workadventure NixOS module. + +{ config, lib, pkgs, ... }: + +with lib; + +let + instances = config.services.workadventure; + + urls = instanceConfig: if instanceConfig.nginx.domain != null then { + api = instanceConfig.nginx.domain + instanceConfig.frontend.urls.api; + uploader = instanceConfig.nginx.domain + instanceConfig.frontend.urls.uploader; + admin = instanceConfig.nginx.domain + instanceConfig.frontend.urls.admin; + maps = instanceConfig.nginx.domain + instanceConfig.frontend.urls.maps; + } else instanceConfig.urls; + + envCommonConfig = instanceConfig: with instanceConfig; { + SECRET_KEY = commonConfig.secretKey; + MINIMUM_DISTANCE = toString commonConfig.minimumDistance; + GROUP_RADIUS = toString commonConfig.groupRadius; + ALLOW_ARTILLERY = if commonConfig.allowArtillery then "true" else "false"; + MAX_USERS_PER_ROOM = toString commonConfig.maxUsersPerRoom; + CPU_OVERHEAT_THRESHOLD = toString commonConfig.cpuOverheatThreshold; + JITSI_URL = commonConfig.jitsi.url; + JITSI_ISS = commonConfig.jitsi.iss; + SECRET_JITSI_KEY = commonConfig.jitsi.secretKey; + SOCKET_IDLE_TIME = toString commonConfig.socketIdleTime; + }; + + servicesBack = mapAttrs' (instanceName: instanceConfig: { + name = "wa-back-${instanceName}"; + value = mkIf instanceConfig.backend.enable { + description = "WorkAdventure backend ${instanceName}"; + wantedBy = [ "multi-user.target" ]; + after = [ "network.target" ]; + # Hack to get node-grpc-precompiled to work on NixOS by adding getconf to + # $PATH. + # + # It uses node-pre-gyp which attempts to select the right native module + # via npmjs.com/package/detect-libc, which says 'yep, it's glibc' as long + # as `getconf GNU_LIBC_VERSION` returns something sensible. This happens + # during the build process (as stdenv.mkDerivation has enough of a glibc + # dev env to make it work) but doesn't happen on production deployments + # in which the environment is much more limited. This is regardless of + # actual glibc ABI presence wrt. to /nix/store vs. /usr/lib64 paths. + # + # This should be fixed in workadventure-nix. + path = [ + pkgs.getconf + ]; + environment = { + HTTP_PORT = toString instanceConfig.backend.httpPort; + GRPC_PORT = toString instanceConfig.backend.grpcPort; + } // envCommonConfig instanceConfig; + serviceConfig = { + User = "workadventure-backend"; + Group = "workadventure-backend"; + DynamicUser = true; # Note: this implies a lot of other security features. + ExecStart = "${instanceConfig.backend.package}/bin/workadventureback"; + Restart = "always"; + RestartSec = "10s"; + }; + }; + } + ) instances; + + servicesPusher = mapAttrs' (instanceName: instanceConfig: + { + name = "wa-pusher-${instanceName}"; + value = mkIf instanceConfig.pusher.enable { + description = "WorkAdventure pusher ${instanceName}"; + wantedBy = [ "multi-user.target" ]; + after = [ "network.target" ]; + + path = [ + pkgs.getconf + ]; + environment = { + PUSHER_HTTP_PORT = toString instanceConfig.pusher.port; + API_URL = "localhost:${toString instanceConfig.backend.grpcPort}"; + } // envCommonConfig instanceConfig; + serviceConfig = { + User = "workadventure-pusher"; + Group = "workadventure-pusher"; + DynamicUser = true; + ExecStart = "${instanceConfig.pusher.package}/bin/workadventurepusher"; + Restart = "always"; + RestartSec = "10s"; + }; + }; + } + ) instances; + + frontPackage = mapAttrs (instanceName: instanceConfig: + let fc = instanceConfig.frontend; + cc = instanceConfig.commonConfig; + in + fc.package.override { + environment = { + DEBUG_MODE = if fc.debugMode then "true" else "false"; # toString bool behaves weird + START_ROOM_URL = fc.startRoomUrl; + STUN_SERVER = cc.webrtc.stun.url; + TURN_SERVER = cc.webrtc.turn.url; + TURN_USER = cc.webrtc.turn.user; + TURN_PASSWORD = cc.webrtc.turn.password; + JITSI_URL = cc.jitsi.url; + JITSI_PRIVATE_MODE = if cc.jitsi.privateMode then "true" else "false"; + + API_URL = (urls instanceConfig).api; + UPDLOADER_URL = (urls instanceConfig).uploader; + ADMIN_URL = (urls instanceConfig).admin; + MAPS_URL = (urls instanceConfig).maps; + + RESOLUTION = fc.resolution; + ZOOM_LEVEL = fc.zoomLevel; + POSITION_DELAY = fc.positionDelay; + MAX_EXTRAPOLATION_TIME = fc.maxExtrapolationTime; + }; + } + ) instances; + + virtualHosts = mapAttrs (instanceName: instanceConfig: + mkIf instanceConfig.nginx.enable { + default = instanceConfig.nginx.default; + serverName = instanceConfig.nginx.domain; + root = frontPackage.${instanceName} + "/dist"; + locations = { + "/_/" = { + tryFiles = "/index.html =404"; + }; + + "/pusher/" = { + #proxyPass = "http://10.233.3.1:9000"; + proxyPass = "http://localhost:${toString instanceConfig.pusher.port}/"; + proxyWebsockets = true; + }; + + "/maps/" = mkIf instanceConfig.nginx.maps.serve { + alias = instanceConfig.nginx.maps.path; + }; + }; + } + ) instances; +in + { + options = { + services.workadventure = mkOption { + type = types.attrsOf (types.submodule (import ./instance-options.nix { + inherit config lib pkgs; + })); + default = {}; + description = "Declarative WorkAdventure instance config"; + }; + }; + + config = { + systemd.services = servicesBack // servicesPusher; + services.nginx = mkIf (virtualHosts != {}) { + inherit virtualHosts; + enable = mkDefault true; + }; + nixpkgs.overlays = [ (import ./overlay.nix) ]; + }; + } |