PeerTube

A decentralised streaming video platform

Declared in: projects/PeerTube/default.nix

1. Install Nix
   Debian

   Bash

   $ apt install --yes curl git jq nix

   Ubuntu

   Bash

   $ apt install --yes curl git jq nix

   Arch

   Bash

   $ pacman --sync --refresh --noconfirm curl git jq nix

2. Download a configuration file

   # default.nix
   {
     ngipkgs ? import (fetchTarball "https://github.com/ngi-nix/ngipkgs/tarball/main") { },
   }:
   ngipkgs.demo-vm (
     {
       config,
       pkgs,
       ...
     }:
     {
       services.peertube = {
         enable = true;
   
         # Configure locally-running instances of redis server & database.
         database.createLocally = true;
         redis.createLocally = true;
   
         # Where we're running
         localDomain = "localhost";
         listenWeb = 9000;
   
         # Example settings, adjust as desired
         settings = {
           listen.hostname = "0.0.0.0";
           instance.name = "My Lovely PeerTube Instance";
           # Enable livestreaming
           live.enabled = true;
         };
   
         plugins = {
           enable = true;
           plugins = with pkgs; [
             peertube-theme-dark
             peertube-plugin-video-annotation
             peertube-plugin-livechat
           ];
         };
   
         # Do *NOT* use this in production, follow the docs and properly generate a secret here! i.e. using the output of:
         # openssl rand -hex 32
         # https://docs.joinpeertube.org/install/any-os#peertube-configuration
         secrets.secretsFile = pkgs.writeText "secrets.txt" "secrets";
   
         # Set the initial password of the root user to a fixed value. Make sure to change the password afterwards!
         serviceEnvironmentFile = "/etc/peertube-envvars";
       };
       environment.etc."peertube-envvars".text = ''
         PT_INITIAL_ROOT_PASSWORD=changeme
       '';
   
       networking.firewall.allowedTCPPorts = [
         config.services.peertube.listenWeb
         # Livestreaming port
         1935
       ];
     }
   )
   

   Download
3. Enable binary substituters

   Bash

   $ export NIX_CONFIG='substituters = https://cache.nixos.org/ https://ngi.cachix.org/
   trusted-public-keys = cache.nixos.org-1:6NCHdD59X431o0gWypbMrAURkbJ16ZPMQFGspcDShjY= ngi.cachix.org-1:n+CAL72ROC3qQuLxIHpV+Tw5t42WhXmMhprAGkRSrOw='

4. Build and run a virtual machine
   Debian Sid/Trixie

   Bash

   $ nix-build ./default.nix && ./result

   Ubuntu 25.04 and newer

   Bash

   $ nix-build ./default.nix && ./result

   Ubuntu 24.04/24.10

   Bash

   $ rev=$(nix-instantiate --eval --attr sources.nixpkgs.rev https://github.com/ngi-nix/ngipkgs/archive/master.tar.gz | jq --raw-output)

   $ nix-shell -I nixpkgs=https://github.com/NixOS/nixpkgs/archive/$rev.tar.gz --packages nix --run "nix-build ./default.nix && ./result"

   Arch

   Bash

   $ nix-build ./default.nix && ./result

5. Usage Instructions

   1. The web UI is available at http://localhost:9000/.

   2. You can log in with:

      • username: root
      • password: changeme

{
  programs.peertube-cli.enable = true;
}

{
  services.peertube-runner = {
    enable = true;
    instancesToRegister = {
      # All instances must be registered here. They can't be registered using the CLI.
      # personal = {
      #   url = "https://mypeertubeinstance.com";
      #   # See how to generate registration tokens at https://docs.joinpeertube.org/admin/remote-runners#manage-remote-runners.
      #   registrationTokenFile = "/run/secrets/my-peertube-instance-registration-token";
      #   runnerName = "Main";
      # };
    };
  };
}

{
  config,
  pkgs,
  ...
}:
{
  services.peertube = {
    enable = true;

    # Configure locally-running instances of redis server & database.
    database.createLocally = true;
    redis.createLocally = true;

    # Where we're running
    localDomain = "localhost";
    listenWeb = 9000;

    # Example settings, adjust as desired
    settings = {
      listen.hostname = "0.0.0.0";
      instance.name = "My Lovely PeerTube Instance";
      # Enable livestreaming
      live.enabled = true;
    };

    plugins = {
      enable = true;
      plugins = with pkgs; [
        peertube-theme-dark
        peertube-plugin-video-annotation
        peertube-plugin-livechat
      ];
    };

    # Do *NOT* use this in production, follow the docs and properly generate a secret here! i.e. using the output of:
    # openssl rand -hex 32
    # https://docs.joinpeertube.org/install/any-os#peertube-configuration
    secrets.secretsFile = pkgs.writeText "secrets.txt" "secrets";

    # Set the initial password of the root user to a fixed value. Make sure to change the password afterwards!
    serviceEnvironmentFile = "/etc/peertube-envvars";
  };
  environment.etc."peertube-envvars".text = ''
    PT_INITIAL_ROOT_PASSWORD=changeme
  '';

  networking.firewall.allowedTCPPorts = [
    config.services.peertube.listenWeb
    # Livestreaming port
    1935
  ];
}

This project is funded by NLnet through these subgrants:

Entrust

Peertube-Transcode

Peertube-Livechat

PeerTube-mobile

Review

PeerTube

PeerTubeSearch

PeerTubeDesktop

Related links:

• Documentation
• Website