commit 863780d19f0ddcb0ccd484e52b5aa13a43d3772f · edouard.paris/atproto-nix-env

+13 -13
README.md
···

       2
       2
        
       

     

       3
       3
        
       A Nix-based development environment for running AT Protocol services (PDS, PLC, Caddy proxy, and MailHog).

     

       4
       4
        
       

     

       5
       5
       +
       ## Prerequisites

     

       6
       6
       +
       

     

       7
       7
       +
       Make sure to add these lines to your `/etc/hosts` file:

     

       8
       8
       +
       ```

     

       9
       9
       +
       127.0.0.1 pds.example.org

     

       10
       10
       +
       127.0.0.1 plc.example.org

     

       11
       11
       +
       ```

     

       12
       12
       +
       

     

       13
       13
       +
       Generate SSL certificates before first use:

     

       14
       14
       +
       ```bash

     

       15
       15
       +
       nix run .#generate-certs

     

       16
       16
       +
       ```

     

       17
       17
       +
       

     

       5
       18
        
       ## Quick Start

     

       6
       19
        
       

     

       7
       20
        
       1. **Enter the development environment:**

     
···

       63
       76
        
       - `tmux attach -t atproto` - Attach to the services session

     

       64
       77
        
       - `tmux kill-session -t atproto` - Stop all services

     

       65
       78
        
       - `nix run .#generate-certs` - Generate SSL certificates

     

       66
       66
       -
       

     

       67
       67
       -
       ## Prerequisites

     

       68
       68
       -
       

     

       69
       69
       -
       Make sure to add these lines to your `/etc/hosts` file:

     

       70
       70
       -
       ```

     

       71
       71
       -
       127.0.0.1 pds.example.org

     

       72
       72
       -
       127.0.0.1 plc.example.org

     

       73
       73
       -
       ```

     

       74
       74
       -
       

     

       75
       75
       -
       Generate SSL certificates before first use:

     

       76
       76
       -
       ```bash

     

       77
       77
       -
       nix run .#generate-certs

     

       78
       78
       -
       ```