commit 42e4a510e2eab89e0a1841a45ef5e6d95c6dcbbd · edouard.paris/atproto-nix-env

+12 -12
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
       -
       ## ⚠️ Security Warning

     

       6
       6
       -
       

     

       7
       7
       -
       **This environment uses a modified AT Protocol relay with SSRF protection disabled.** 

     

       8
       8
       -
       

     

       9
       9
       -
       - The relay is built from a forked repository (`edouardparis/indigo`) with SSRF (Server-Side Request Forgery) protections disabled

     

       10
       10
       -
       - Custom ports are allowed without restrictions

     

       11
       11
       -
       - **This configuration is ONLY safe for local development environments**

     

       12
       12
       -
       - **DO NOT use this relay configuration against external hosts or in production**

     

       13
       13
       -
       - **DO NOT expose this relay to the internet**

     

       14
       14
       -
       

     

       15
       15
       -
       This setup is designed for controlled local testing where you need flexibility in network access that would normally be restricted for security reasons.

     

       16
       16
       -
       

     

       17
       5
        
       ## Prerequisites

     

       18
       6
        
       

     

       19
       7
        
       1. **Install mkcert** (required for SSL certificate generation):

     
···

       110
       98
        
       - `tmux kill-session -t atproto` - Stop all services

     

       111
       99
        
       - `nix run .#mailhog` - Start MailHog (run separately if needed)

     

       112
       100
        
       - `nix run .#generate-certs` - Generate SSL certificates

     

       101
       101
       +
       

     

       102
       102
       +
       ## ⚠️ Security Warning

     

       103
       103
       +
       

     

       104
       104
       +
       **This environment uses a modified AT Protocol relay with SSRF protection disabled.** 

     

       105
       105
       +
       

     

       106
       106
       +
       - The relay is built from a forked repository (`edouardparis/indigo`) with SSRF (Server-Side Request Forgery) protections disabled

     

       107
       107
       +
       - Custom ports are allowed without restrictions

     

       108
       108
       +
       - **This configuration is ONLY safe for local development environments**

     

       109
       109
       +
       - **DO NOT use this relay configuration against external hosts or in production**

     

       110
       110
       +
       - **DO NOT expose this relay to the internet**

     

       111
       111
       +
       

     

       112
       112
       +
       This setup is designed for controlled local testing where you need flexibility in network access that would normally be restricted for security reasons.