leonwww/protocol/cli/README.md

Gurty - a CLI tool to setup your GURT Protocol server

Setup for Production

For production deployments, you'll need to generate your own certificates since traditional Certificate Authorities don't support custom protocols:

1. Generate production certificates with OpenSSL:

   # Generate private key
   openssl genpkey -algorithm RSA -out gurt-server.key -pkcs8 -v
   
   # Generate certificate signing request
   openssl req -new -key gurt-server.key -out gurt-server.csr
   
   # Generate self-signed certificate (valid for 365 days)
   openssl x509 -req -days 365 -in gurt-server.csr -signkey gurt-server.key -out gurt-server.crt
   
   # Or generate both key and certificate in one step
   openssl req -x509 -newkey rsa:4096 -keyout gurt-server.key -out gurt-server.crt -days 365 -nodes
   

2. Deploy with production certificates:

   cargo run --release serve --cert gurt-server.crt --key gurt-server.key --host 0.0.0.0 --port 4878
   

Development Environment Setup

To set up a development environment for GURT, follow these steps:

1. Install mkcert:

   # Windows (with Chocolatey)
   choco install mkcert
   
   # Or download from: https://github.com/FiloSottile/mkcert/releases
   

2. Install local CA in system:

   mkcert -install
   

   This installs a local CA in your system certificate store.

3. Generate localhost certificates:

   cd gurted/protocol/cli
   mkcert localhost 127.0.0.1 ::1
   

   This creates:

   • localhost+2.pem (certificate)
   • localhost+2-key.pem (private key)

4. Start GURT server with certificates:

   cargo run --release serve --cert localhost+2.pem --key localhost+2-key.pem