commit c5789977184e9f9ad486dcc6e93469f5523ba1d8 · dunkirk.sh/dots

+32
modules/nixos/services/bore/README.md
···

       1
       1
       +
       # Bore

     

       2
       2
       +
       

     

       3
       3
       +
       ![screenshot](https://hc-cdn.hel1.your-objectstorage.com/s/v3/7652f29dacb8f76d_screenshot_2025-12-09_at_16.57.47.png)

     

       4
       4
       +
       

     

       5
       5
       +
       Bore is a lightweight wrapper around `frp` which provides a dashboard and a nice `gum` based cli. If you would like to run this in your own nix flake then simplify vendor this folder and `./modules/home/bore` and import the folders into the appropriate home manager and nixos configurations.

     

       6
       6
       +
       

     

       7
       7
       +
       ```nix

     

       8
       8
       +
       atelier = {

     

       9
       9
       +
           bore = {

     

       10
       10
       +
               enable = true;

     

       11
       11
       +
               authTokenFile = osConfig.age.secrets.bore.path

     

       12
       12
       +
           };

     

       13
       13
       +
       }

     

       14
       14
       +
       ```

     

       15
       15
       +
       

     

       16
       16
       +
       and be sure to have a definition for your agenix secret in the osConfig as well:

     

       17
       17
       +
       

     

       18
       18
       +
       ```nix

     

       19
       19
       +
       age = {

     

       20
       20
       +
           identityPaths = [

     

       21
       21
       +
               "path/to/ssh/key"

     

       22
       22
       +
           ];

     

       23
       23
       +
           secrets = {

     

       24
       24
       +
               bore = {

     

       25
       25
       +
                   file = ./path/to/bore.age;

     

       26
       26
       +
                   owner = "username";

     

       27
       27
       +
               };

     

       28
       28
       +
           };

     

       29
       29
       +
       }

     

       30
       30
       +
       ```

     

       31
       31
       +
       

     

       32
       32
       +
       The secret file is just a oneline file with the key in it. If you do end up deploying this feel free to email me and let me know! I would love to hear about your setup!