hacking.md: more details about TANGLED_VM_SPINDLE_OWNER #461

merged

opened by

ilyagr.bsky.social 4 months ago targeting master from ilyagr.bsky.social/core: hacking

I think it'd be nice to make setting TANGLED_VM_SPINDLE_OWNER optional and run VMs without a spindle in that case, but let's just document the status quo for now.

options

unified split

Changed files

+8 -1

docs

hacking.md

+8 -1

docs/hacking.md

···

       61
        
       ideally in a `.envrc` with [direnv](https://direnv.net) so you

     

       62
        
       don't lose it.

     

       63
        
       

     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       0
        
       
     

       64
        
       You can now start a lightweight NixOS VM using

     

       65
        
       `nixos-shell` like so:

     

       66
        
       

     
···

       92
        
       

     

       93
        
       ## running a spindle

     

       94
        
       

     

       95
       -
       Be sure to set `$TANGLED_VM_SPINDLE_OWNER` to your own DID.

     

       0
        
       
     

       0
        
       
     

       96
        
       The above VM should already be running a spindle on `localhost:6555`.

     

       97
        
       You can head to the spindle dashboard on `http://localhost:3000/spindles`,

     

       98
        
       and register a spindle with hostname `localhost:6555`. It should instantly

···

       61
        
       ideally in a `.envrc` with [direnv](https://direnv.net) so you

     

       62
        
       don't lose it.

     

       63
        
       

     

       64
       +
       You will also need to set the `$TANGLED_VM_SPINDLE_OWNER`

     

       65
       +
       variable to some value. If you don't want to [set up a

     

       66
       +
       spindle](#running-a-spindle), you can use any placeholder

     

       67
       +
       value. 

     

       68
       +
       

     

       69
        
       You can now start a lightweight NixOS VM using

     

       70
        
       `nixos-shell` like so:

     

       71
        
       

     
···

       97
        
       

     

       98
        
       ## running a spindle

     

       99
        
       

     

       100
       +
       You will need to find out your DID by entering your login handle into

     

       101
       +
       <https://pdsls.dev/>. Set `$TANGLED_VM_SPINDLE_OWNER` to your DID.

     

       102
       +
       

     

       103
        
       The above VM should already be running a spindle on `localhost:6555`.

     

       104
        
       You can head to the spindle dashboard on `http://localhost:3000/spindles`,

     

       105
        
       and register a spindle with hostname `localhost:6555`. It should instantly