https://github.com/pedorich-n/playit-nixos-module

NixOS module for https://playit.gg/ agent
https://github.com/pedorich-n/playit-nixos-module

nixos nixos-module playit-gg

Last synced: about 1 month ago
JSON representation

NixOS module for https://playit.gg/ agent

• Host: GitHub
• URL: https://github.com/pedorich-n/playit-nixos-module
• Owner: pedorich-n
• Created: 2023-10-26T05:42:19.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-01T23:52:32.000Z (9 months ago)
• Last Synced: 2024-04-02T00:38:41.289Z (9 months ago)
• Topics: nixos, nixos-module, playit-gg
• Language: Nix
• Homepage:
• Size: 64.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NixOS module for Playit Agent

This NixOS module provides two things:

- packaged [playit-agent](https://github.com/playit-cloud/playit-agent)

- a service definition to run `playit-agent` as systemd service

## Usage

Example `flake.nix`:

```Nix

{

  # Optional step. Binary cache to improve the build time

  nixConfig = {

    extra-substituters = [ "https://playit-nixos-module.cachix.org" ];

    extra-trusted-public-keys = [ "playit-nixos-module.cachix.org-1:22hBXWXBbd/7o1cOnh+p0hpFUVk9lPdRLX3p5YSfRz4=" ];

  };

  inputs = {

    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";

    playit-nixos-module.url = "github:pedorich-n/playit-nixos-module";

  }

  output = { nixpkgs, playit-nixos-module }: {

    nixosConfigurations = {

      example = nixpkgs.lib.nixosSystem {

        system = "x86_64-linux";

        modules = [

          playit-nixos-module.nixosModules.default

          ./configuration.nix

        ];

      };

    };

  }

}

```

Setup service:

```Nix

{ config, ... }: {

  services.playit = {

    enable = true;

    user = "playit";

    group = "playit";

    secretPath = config.age.secrets.playit-secret.path;

  };

}

```

### Additional settings

You can configure the port mappings in the [Tunnels](https://playit.gg/account/tunnels) section of the website.

### Obtaining a secret

Run

```Bash

nix run github:pedorich-n/playit-nixos-module#playit-cli -- start

```

The program will prompt the link to the website to claim the agent. Follow the instructions on the website.

After the agent is claimed it will start running and serving the tunnels. You can exit the program at this point.

The TOML file containing the secret for newly claimed agent should be at `~/.config/playit_gg/playit.toml`. This file needs to be passed as `secretPath`.

It is recommended to use secret manager like [agenix](https://github.com/ryantm/agenix) or [sops](https://github.com/Mic92/sops-nix) to avoid having exposed secret in `/nix/store`

### Documentation

To see latest documentation run

```Bash

nix run github:pedorich-n/playit-nixos-module#docs.serve

```