fix readme, use caddy_anycable correctly and set PORT by target-port

Author: prog-supdex

README.md

@@ -1,12 +1,12 @@
-# Caddy Thruster
+# Caddy Rails
 
 CaddyRails is a reverse proxy module for Ruby on Rails designed to integrate with Caddy, facilitating features like reverse proxying, automatic HTTPS, compression, and more.
 
 ## Features
 
 - **Reverse Proxy:** Simplifies forwarding requests to your application.
 - **Automatic HTTPS:** Automatically manages SSL/TLS certificates. (Currently in progress)
-- **Compression:** Supports Gzip, Brotli and Zstd for reducing data transfer sizes.
+- **Compression:** Supports Gzip, and Zstd for reducing data transfer sizes.
 - **Access Logging:** Enables detailed logging of incoming requests.
 - **Connection Timeouts:** Customizable read, write, and idle timeouts for connections.
 - **Debugging:** Provides extensive debug logs to troubleshoot issues.
@@ -32,14 +32,14 @@ The tool sets up a reverse proxy automatically.
 ```
 
 ### Command Line Arguments
-- `--target-port`: The port that your server should run on.  ProxyRunner will set the PORT environment variable to this value. Default: `3000`.
+- `--target-port`: The port that your server should run on.  caddy-server will set this value to the PORT environment variable. Default: `3000`.
 - `--http-port`: The port to listen on for HTTP traffic. Default: `80`.
 - `--https-port`: The port to listen on for HTTPS traffic. Default: `443`.
 - `-l, --listen`: The address to which to bind the listener. Default: `localhost`.
-- `--ssl-domain`: The domain name to use for SSL provisioning. If not set, SSL will be disabled. (in progress)
+- `--ssl-domain`: The domain name to use for SSL provisioning. If not set, SSL will be disabled.
 - `-v, --debug`: Enable verbose debug logs.
 - `--access-log`: Enable the access log. Default: `true`.
-- `--no-compress`: Disable Brotli, Zstandard and Gzip compression
+- `--no-compress`: Disable Zstandard and Gzip compression
 - `--http-idle-timeout`: The maximum time a client can be idle before the connection is closed. Default: `60s`.
 - `--http-read-timeout`: The maximum time a client can take to send the request headers. Default: `30s`.
 - `--http-write-timeout`: The maximum time during which the client must read the response. Default: `30s`.
@@ -67,7 +67,6 @@ This command creates a Caddyfile in the specified directory, tailoring it with o
 - `--access-log`: Enable the access log. Default: `true`
 - `--ssl-domain`: The domain name for SSL. If empty, SSL is disabled
 - `--backend-port`: THe port that the backend service listens on. Default is `8080`
-- `--https-enable`: Enable HTTPS configuration. Default `false`
 - `--compression-enable`: Enable response compression using gzip and zstd
 - `--anycable-enable`: Enable anycable
 

cmd/caddy_rails/main.go

@@ -4,7 +4,6 @@ import (
 	"flag"
 	"fmt"
 	caddycmd "github.com/caddyserver/caddy/v2/cmd"
-	_ "github.com/evilmartians/caddy_anycable"
 	_ "github.com/evilmartians/caddy_rails/internal/app"
 	_ "github.com/evilmartians/caddy_rails/internal/commands"
 	"github.com/evilmartians/caddy_rails/version"

go.mod

@@ -4,7 +4,7 @@ go 1.22.1
 
 require (
 	github.com/caddyserver/caddy/v2 v2.8.4
-	github.com/caddyserver/certmagic v0.21.3
+	github.com/evilmartians/caddy_anycable v0.0.0-20240603141509-6f07f068c620
 	github.com/spf13/cobra v1.8.0
 	github.com/stretchr/testify v1.9.0
 	go.uber.org/zap v1.27.0
@@ -14,7 +14,6 @@ require (
 	github.com/FZambia/sentinel v1.1.1 // indirect
 	github.com/anycable/anycable-go v1.5.1 // indirect
 	github.com/bufbuild/protocompile v0.13.0 // indirect
-	github.com/evilmartians/caddy_anycable v0.0.0-20240603141509-6f07f068c620
 	github.com/fullstorydev/grpchan v1.1.1 // indirect
 	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
 	github.com/gomodule/redigo v1.9.2 // indirect
@@ -53,6 +52,7 @@ require (
 	github.com/antlr4-go/antlr/v4 v4.13.1 // indirect
 	github.com/aryann/difflib v0.0.0-20210328193216-ff5ff6dc229b // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
+	github.com/caddyserver/certmagic v0.21.3 // indirect
 	github.com/caddyserver/zerossl v0.1.3 // indirect
 	github.com/cenkalti/backoff/v4 v4.2.1 // indirect
 	github.com/cespare/xxhash v1.1.0 // indirect

internal/commands/serve_rails.go

@@ -25,7 +25,7 @@ sets up a reverse proxy to forward requests to it.`,
 			cmd.Flags().Bool("phased-restart", false, "Perform a phased restart of the server")
 			cmd.Flags().Bool("anycable-enabled", false, "Activate AnyCable")
 			cmd.Flags().String("server-type", "puma", "The type of server (puma or unicorn) to control")
-			cmd.Flags().Int("target-port", 3000, "The port that your server should run on. ProxyRunner will set PORT to this value when starting your server.")
+			cmd.Flags().Int("target-port", 3000, "The port that your server should run on. caddy-rails will set this values to the PORT env variable when starting your server.")
 			cmd.Flags().Int("http-port", 80, "The port to listen on for HTTP traffic.")
 			cmd.Flags().Int("https-port", 443, "The port to listen on for HTTPS traffic.")
 			cmd.Flags().StringP("listen", "l", "localhost", "The address to which to bind the listener")
@@ -101,6 +101,9 @@ func loadConfigIfNeeded() bool {
 }
 
 func runUpstreamProcess(fs caddycmd.Flags, pidFile string) (int, error) {
+	// Set PORT to be inherited by the upstream process.
+	os.Setenv("PORT", fmt.Sprintf("%d", fs.Int("target-port")))
+
 	upstream := utils.NewUpstreamProcess(fs.Arg(0), fs.Args()[1:], true, pidFile)
 	exitCode, err := upstream.Run()
 	if err != nil {

internal/utils/handlers.go

@@ -61,34 +61,36 @@ func createEncodeRoute() caddyhttp.Route {
 
 func createAnyCableRoute() caddyhttp.Route {
 	anyCableHandler := caddy_anycable.AnyCableHandler{}
-
 	anyCableOptions := os.Getenv("ANYCABLE_OPT")
 	if anyCableOptions != "" {
 		options := strings.Split(anyCableOptions, " ")
 		anyCableHandler.Options = options
 	}
 
-	if err := anyCableHandler.Provision(caddy.Context{}); err != nil {
-		log.Fatalf("Failed to provision anycable handler: %v", err)
-	}
-
 	return caddyhttp.Route{
 		HandlersRaw: []json.RawMessage{caddyconfig.JSONModuleObject(anyCableHandler, "handler", "anycable", nil)},
+		MatcherSetsRaw: []caddy.ModuleMap{
+			{
+				"path": caddyconfig.JSON(caddyhttp.MatchPath{"/cable*"}, nil),
+			},
+		},
 	}
 }
 
 func createReverseProxyRoute(fs cmd.Flags) caddyhttp.Route {
 	reverseProxyHandler := reverseproxy.Handler{
-		TransportRaw: caddyconfig.JSONModuleObject(reverseproxy.HTTPTransport{}, "protocol", "http", nil),
 		Upstreams: reverseproxy.UpstreamPool{
 			{Dial: fmt.Sprintf("%s:%d", fs.String("listen"), fs.Int("target-port"))},
 		},
 		Headers: &headers.Handler{
 			Request: &headers.HeaderOps{
-				Set: map[string][]string{"Host": {"{http.reverse_proxy.upstream.hostport}"}},
+				Set: map[string][]string{
+					"Host": {"{http.reverse_proxy.upstream.hostport}"},
+				},
 			},
 		},
 	}
+
 	return caddyhttp.Route{
 		HandlersRaw: []json.RawMessage{caddyconfig.JSONModuleObject(reverseProxyHandler, "handler", "reverse_proxy", nil)},
 	}
@@ -162,19 +164,20 @@ func createCaddyConfig(httpApp caddyhttp.App, debug bool) *caddy.Config {
 func createGroupedRoutes(fs cmd.Flags) caddyhttp.Route {
 	routes := caddyhttp.RouteList{}
 
+	if fs.Bool("anycable-enabled") {
+		routes = append(routes, createAnyCableRoute())
+	}
+
+	routes = append(routes, createReverseProxyRoute(fs))
+
 	if !fs.Bool("no-compress") {
 		routes = append(routes, createEncodeRoute())
 	}
 
 	routes = append(routes,
-		createReverseProxyRoute(fs),
 		createFileServerRoute(fs),
 	)
 
-	if fs.Bool("anycable-enabled") {
-		routes = append(routes, createAnyCableRoute())
-	}
-
 	subroute := caddyhttp.Subroute{Routes: routes}
 
 	return caddyhttp.Route{