Tau

Remote sharing of terminal sessions

Declared in: projects/Tau/default.nix

Demo

Implement missing demo

Options

programs.tau-radio
programs.tau-radio.enable

Whether to enable tau-radio.

Type:
boolean
Default:
false
Declared in:
projects/Tau/programs/tau-radio/module.nix
programs.tau-radio.package

The tau-radio package to use.

Type:
package
Default:
pkgs.tau-radio
Declared in:
projects/Tau/programs/tau-radio/module.nix
programs.tau-radio.passwordFile

Path that points to a file that contains the webradio server password.

Type:
null or absolute path
Default:
null
Declared in:
projects/Tau/programs/tau-radio/module.nix
programs.tau-radio.settings

Tau-radio config settings.

Type:
open submodule of (TOML value)
Default:
{ }
Declared in:
projects/Tau/programs/tau-radio/module.nix
programs.tau-radio.settings.audio_interface

Audio interface.

Type:
one of "BlackHole 2ch", "alsa", "jack", "oss", "pcm.sysdefault", "pipewire", "pulse"
Default:
"pipewire"
Declared in:
projects/Tau/programs/tau-radio/module.nix
programs.tau-radio.settings.broadcast_port

Tau-tower broadcast port

Type:
16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
3002
Declared in:
projects/Tau/programs/tau-radio/module.nix
programs.tau-radio.settings.file

Name for OGG file that contains captured audio.

Type:
string
Default:
"tau.ogg"
Declared in:
projects/Tau/programs/tau-radio/module.nix
programs.tau-radio.settings.ip

Tau-tower server IP address

Type:
string
Default:
"127.0.0.1"
Declared in:
projects/Tau/programs/tau-radio/module.nix
programs.tau-radio.settings.port

Tau-tower server port

Type:
16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
3001
Declared in:
projects/Tau/programs/tau-radio/module.nix
programs.tau-radio.settings.username

Webradio server username.

Type:
string
Declared in:
projects/Tau/programs/tau-radio/module.nix
services.tau-tower
services.tau-tower.enable

Whether to enable tau-tower.

Type:
boolean
Default:
false
Declared in:
projects/Tau/services/tau-tower/module.nix
services.tau-tower.package

The tau-tower package to use.

Type:
package
Default:
pkgs.tau-tower
Declared in:
projects/Tau/services/tau-tower/module.nix
services.tau-tower.passwordFile

Path that points to a file that contains the webradio password.

Type:
null or absolute path
Default:
null
Declared in:
projects/Tau/services/tau-tower/module.nix
services.tau-tower.settings

Tau-tower config settings.

Type:
open submodule of (TOML value)
Default:
{ }
Declared in:
projects/Tau/services/tau-tower/module.nix
services.tau-tower.settings.ip

Host IP address.

Type:
string
Default:
"127.0.0.1"
Declared in:
projects/Tau/services/tau-tower/module.nix
services.tau-tower.settings.listen_port

Listen port.

Type:
16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
3001
Declared in:
projects/Tau/services/tau-tower/module.nix
services.tau-tower.settings.mount

Name for OGG file that contains captured audio.

Type:
string
Default:
"tau.ogg"
Declared in:
projects/Tau/services/tau-tower/module.nix
services.tau-tower.settings.mount_port

Broadcast port.

Type:
16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
3002
Declared in:
projects/Tau/services/tau-tower/module.nix
services.tau-tower.settings.username

Webradio username.

Type:
string
Declared in:
projects/Tau/services/tau-tower/module.nix

Examples

Enable tau-radio
{ pkgs, ... }:

{
  programs.tau-radio = {
    enable = true;
    settings = {
      username = "alice";
    };
    # WARN: Don't use this in production as it will copy the file to the
    # Nix store. Instead, provide a string that contains an absolute path
    # to a file that already exists on disk.
    passwordFile = pkgs.writeText "password.txt" "superSecretPassword";
  };
}

Declared in: projects/Tau/programs/tau-radio/examples/basic.nix

Enable tau-tower
{ pkgs, ... }:

{
  services.tau-tower = {
    enable = true;
    settings = {
      username = "alice";
    };
    # WARN: Don't use this in production as it will copy the file to the
    # Nix store. Instead, provide a string that contains an absolute path
    # to a file that already exists on disk.
    passwordFile = pkgs.writeText "password.txt" "superSecretPassword";
  };
}

Declared in: projects/Tau/services/tau-tower/examples/basic.nix

This project is funded by NLnet through these subgrants:

Core
Tau

Related links: