diff --git a/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml b/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml index 0f768fbe7a89..8af8f1dd6437 100644 --- a/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml +++ b/nixos/doc/manual/from_md/release-notes/rl-2111.section.xml @@ -116,6 +116,13 @@ services.kea. + + + owncast, + self-hosted video live streaming solution. Available at + services.owncast. + + sourcehut, a diff --git a/nixos/doc/manual/release-notes/rl-2111.section.md b/nixos/doc/manual/release-notes/rl-2111.section.md index e169c0a5b8d2..f22a532972be 100644 --- a/nixos/doc/manual/release-notes/rl-2111.section.md +++ b/nixos/doc/manual/release-notes/rl-2111.section.md @@ -39,6 +39,8 @@ In addition to numerous new and upgraded packages, this release has the followin - [Kea](https://www.isc.org/kea/), ISCs 2nd generation DHCP and DDNS server suite. Available at [services.kea](options.html#opt-services.kea). +- [owncast](https://owncast.online/), self-hosted video live streaming solution. Available at [services.owncast](options.html#opt-services.owncast). + - [sourcehut](https://sr.ht), a collection of tools useful for software development. Available as [services.sourcehut](options.html#opt-services.sourcehut.enable). - [ucarp](https://download.pureftpd.org/pub/ucarp/README), an userspace implementation of the Common Address Redundancy Protocol (CARP). Available as [networking.ucarp](options.html#opt-networking.ucarp.enable). diff --git a/nixos/modules/module-list.nix b/nixos/modules/module-list.nix index a7decf889877..a27baa701834 100644 --- a/nixos/modules/module-list.nix +++ b/nixos/modules/module-list.nix @@ -560,6 +560,7 @@ ./services/misc/octoprint.nix ./services/misc/ombi.nix ./services/misc/osrm.nix + ./services/misc/owncast.nix ./services/misc/packagekit.nix ./services/misc/paperless-ng.nix ./services/misc/parsoid.nix diff --git a/nixos/modules/services/misc/owncast.nix b/nixos/modules/services/misc/owncast.nix new file mode 100644 index 000000000000..0852335238fd --- /dev/null +++ b/nixos/modules/services/misc/owncast.nix @@ -0,0 +1,98 @@ +{ lib, pkgs, config, ... }: +with lib; +let cfg = config.services.owncast; +in { + + options.services.owncast = { + + enable = mkEnableOption "owncast"; + + dataDir = mkOption { + type = types.str; + default = "/var/lib/owncast"; + description = '' + The directory where owncast stores its data files. If left as the default value this directory will automatically be created before the owncast server starts, otherwise the sysadmin is responsible for ensuring the directory exists with appropriate ownership and permissions. + ''; + }; + + openFirewall = mkOption { + type = types.bool; + default = false; + description = '' + Open the appropriate ports in the firewall for owncast. + ''; + }; + + user = mkOption { + type = types.str; + default = "owncast"; + description = "User account under which owncast runs."; + }; + + group = mkOption { + type = types.str; + default = "owncast"; + description = "Group under which owncast runs."; + }; + + listen = mkOption { + type = types.str; + default = "127.0.0.1"; + example = "0.0.0.0"; + description = "The IP address to bind the owncast web server to."; + }; + + port = mkOption { + type = types.port; + default = 8080; + description = '' + TCP port where owncast web-gui listens. + ''; + }; + + rtmp-port = mkOption { + type = types.port; + default = 1935; + description = '' + TCP port where owncast rtmp service listens. + ''; + }; + + }; + + config = mkIf cfg.enable { + + systemd.services.owncast = { + description = "A self-hosted live video and web chat server"; + wantedBy = [ "multi-user.target" ]; + + serviceConfig = mkMerge [ + { + User = cfg.user; + Group = cfg.group; + WorkingDirectory = cfg.dataDir; + ExecStart = "${pkgs.owncast}/bin/owncast -webserverport ${toString cfg.port} -rtmpport ${toString cfg.rtmp-port} -webserverip ${cfg.listen}"; + Restart = "on-failure"; + } + (mkIf (cfg.dataDir == "/var/lib/owncast") { + StateDirectory = "owncast"; + }) + ]; + }; + + users.users = mkIf (cfg.user == "owncast") { + owncast = { + isSystemUser = true; + group = cfg.group; + description = "owncast system user"; + }; + }; + + users.groups = mkIf (cfg.group == "owncast") { owncast = { }; }; + + networking.firewall = + mkIf cfg.openFirewall { allowedTCPPorts = [ cfg.rtmp-port ] ++ optional (cfg.listen != "127.0.0.1") cfg.port; }; + + }; + meta = { maintainers = with lib.maintainers; [ MayNiklas ]; }; +} diff --git a/nixos/tests/all-tests.nix b/nixos/tests/all-tests.nix index 66b0f4f258d3..3f19aa397a78 100644 --- a/nixos/tests/all-tests.nix +++ b/nixos/tests/all-tests.nix @@ -327,6 +327,7 @@ in openstack-image-metadata = (handleTestOn ["x86_64-linux"] ./openstack-image.nix {}).metadata or {}; openstack-image-userdata = (handleTestOn ["x86_64-linux"] ./openstack-image.nix {}).userdata or {}; opentabletdriver = handleTest ./opentabletdriver.nix {}; + owncast = handleTest ./owncast.nix {}; image-contents = handleTest ./image-contents.nix {}; orangefs = handleTest ./orangefs.nix {}; os-prober = handleTestOn ["x86_64-linux"] ./os-prober.nix {}; diff --git a/nixos/tests/owncast.nix b/nixos/tests/owncast.nix new file mode 100644 index 000000000000..e54d2cc5dd48 --- /dev/null +++ b/nixos/tests/owncast.nix @@ -0,0 +1,21 @@ +{ system ? builtins.currentSystem, config ? { } +, pkgs ? import ../.. { inherit system config; } }: + +with import (nixpkgs + "/nixos/lib/testing-python.nix") { inherit system; }; +makeTest { + name = "owncast"; + meta = with pkgs.stdenv.lib.maintainers; { maintainers = [ MayNiklas ]; }; + + nodes = { + client = { ... }: { + environment.systemPackages = [ curl ]; + services.owncast = { enable = true; }; + }; + }; + + testScript = '' + start_all() + client.wait_for_unit("owncast.service") + client.succeed("curl localhost:8080/api/status") + ''; +} diff --git a/pkgs/servers/owncast/default.nix b/pkgs/servers/owncast/default.nix new file mode 100644 index 000000000000..7359b8c2bae4 --- /dev/null +++ b/pkgs/servers/owncast/default.nix @@ -0,0 +1,59 @@ +{ lib, buildGoModule, fetchFromGitHub, nixosTests, bash, which, ffmpeg, makeWrapper, coreutils, ... }: + +buildGoModule rec { + + pname = "owncast"; + version = "0.0.8"; + + src = fetchFromGitHub { + owner = "owncast"; + repo = "owncast"; + rev = "v${version}"; + sha256 = "0md4iafa767yxkwh6z8zpcjv9zd79ql2wapx9vzyd973ksvrdaw2"; + }; + + vendorSha256 = "sha256-bH2CWIgpOS974/P98n0R9ebGTJ0YoqPlH8UmxSYNHeM="; + + propagatedBuildInputs = [ ffmpeg ]; + + buildInputs = [ makeWrapper ]; + + preInstall = '' + mkdir -p $out + cp -r $src/{static,webroot} $out + ''; + + postInstall = let + + setupScript = '' + [ ! -d "$PWD/webroot" ] && ( + ${coreutils}/bin/cp --no-preserve=mode -r "${placeholder "out"}/webroot" "$PWD" + ) + + [ ! -d "$PWD/static" ] && ( + ${coreutils}/bin/ln -s "${placeholder "out"}/static" "$PWD" + ) + ''; + in '' + wrapProgram $out/bin/owncast \ + --run '${setupScript}' \ + --prefix PATH : ${lib.makeBinPath [ bash which ffmpeg ]} + ''; + + installCheckPhase = '' + runHook preCheck + $out/bin/owncast --help + runHook postCheck + ''; + + passthru.tests.owncast = nixosTests.testOwncast; + + meta = with lib; { + description = "self-hosted video live streaming solution"; + homepage = "https://owncast.online"; + license = licenses.mit; + platforms = platforms.unix; + maintainers = with maintainers; [ MayNiklas ]; + }; + +} diff --git a/pkgs/top-level/all-packages.nix b/pkgs/top-level/all-packages.nix index 9933bfc4af47..ffec1ea5c52f 100644 --- a/pkgs/top-level/all-packages.nix +++ b/pkgs/top-level/all-packages.nix @@ -7966,6 +7966,8 @@ with pkgs; operator-sdk = callPackage ../development/tools/operator-sdk { }; + owncast = callPackage ../servers/owncast { }; + update-dotdee = with python3Packages; toPythonApplication update-dotdee; update-nix-fetchgit = haskell.lib.justStaticExecutables haskellPackages.update-nix-fetchgit;