feat: v1.20 with check.ipfs.network button (#301)

* fix: add diagnostic-service-url flag

adds RAINBOW_DIAGNOSTIC_SERVICE_URL configuration option to expose
boxo/gateway's DiagnosticServiceURL setting. when gateway returns 504
timeout, users will see "Inspect retrievability of CID" button linking
to diagnostic service with CID as query parameter.

defaults to https://check.ipfs.network, can be disabled by setting to
empty string.

related to ipshipyard/roadmaps#14

* docs: clarify diagnostic service provider and self-hosting option

* chore: release v1.20.0

Author: lidel

CHANGELOG.md

@@ -17,15 +17,24 @@ The following emojis are used to highlight certain changes:
 
 ### Changed
 
-- Upgrade go-ds-pebble to [v0.5.3](https://github.com/ipfs/go-ds-pebble/releases/tag/v0.5.3)
-
 ### Fixed
 
 ### Removed
 
 ### Security
 
 
+## v1.20.0
+
+### Added
+
+- `--diagnostic-service-url` / `RAINBOW_DIAGNOSTIC_SERVICE_URL`: Configure URL for CID retrievability diagnostic service (default: `https://check.ipfs.network`). When gateway returns 504 timeout, users see "Inspect retrievability of CID" button linking to diagnostic service. Set to empty string to disable.
+
+### Changed
+
+- Upgrade go-ds-pebble to [v0.5.3](https://github.com/ipfs/go-ds-pebble/releases/tag/v0.5.3)
+
+
 ## v1.19.0
 
 ### Added

docs/environment-variables.md

@@ -29,6 +29,7 @@
   - [`RAINBOW_MAX_CONCURRENT_REQUESTS`](#rainbow_max_concurrent_requests)
   - [`RAINBOW_RETRIEVAL_TIMEOUT`](#rainbow_retrieval_timeout)
   - [`RAINBOW_MAX_RANGE_REQUEST_FILE_SIZE`](#rainbow_max_range_request_file_size)
+  - [`RAINBOW_DIAGNOSTIC_SERVICE_URL`](#rainbow_diagnostic_service_url)
 - [Experiments](#experiments)
   - [`RAINBOW_SEED_PEERING`](#rainbow_seed_peering)
   - [`RAINBOW_SEED_PEERING_MAX_INDEX`](#rainbow_seed_peering_max_index)
@@ -313,6 +314,16 @@ Set to `0` to disable this limit and allow range requests for files of any size
 
 Default: `5368709120` (5 GiB - matches Cloudflare's threshold to prevent excess billing)
 
+### `RAINBOW_DIAGNOSTIC_SERVICE_URL`
+
+URL for a service to diagnose CID retrievability issues. When the gateway returns a 504 Gateway Timeout error, an "Inspect retrievability of CID" button will be shown that links to this service with the CID appended as `?cid=<CID-to-diagnose>`.
+
+The default service is provided by [Shipyard](https://ipshipyard.com) on best-effort basis, but anyone can run their own instance of [ipfs-check](https://github.com/ipfs/ipfs-check) and point this setting to it.
+
+Set to empty string to disable the button.
+
+Default: `https://check.ipfs.network`
+
 ## Experiments
 
 ### `RAINBOW_SEED_PEERING`

handlers.go

@@ -320,6 +320,7 @@ func setupGatewayHandler(cfg Config, nd *Node) (http.Handler, error) {
 		MaxConcurrentRequests:   cfg.MaxConcurrentRequests, // When exceeded, returns 429 with Retry-After: 60 (hardcoded in boxo)
 		RetrievalTimeout:        cfg.RetrievalTimeout,
 		MaxRangeRequestFileSize: cfg.MaxRangeRequestFileSize,
+		DiagnosticServiceURL:    cfg.DiagnosticServiceURL,
 	}
 	gwHandler := gateway.NewHandler(gwConf, backend)
 

main.go

@@ -486,6 +486,12 @@ Generate an identity seed and launch a gateway:
 			EnvVars: []string{"RAINBOW_MAX_RANGE_REQUEST_FILE_SIZE"},
 			Usage:   "Maximum file size in bytes for which range requests are supported. Range requests for larger files will return 501. Set to 0 to disable limit",
 		},
+		&cli.StringFlag{
+			Name:    "diagnostic-service-url",
+			Value:   "https://check.ipfs.network",
+			EnvVars: []string{"RAINBOW_DIAGNOSTIC_SERVICE_URL"},
+			Usage:   "URL for a service to diagnose CID retrievability issues. When the gateway returns a 504 Gateway Timeout error, an \"Inspect retrievability of CID\" button will be shown. Set to empty string to disable",
+		},
 		&cli.StringSliceFlag{
 			Name:    "dnslink-resolvers",
 			Value:   cli.NewStringSlice(". : auto"),
@@ -720,6 +726,7 @@ share the same seed as long as the indexes are different.
 			MaxConcurrentRequests:   cctx.Int("max-concurrent-requests"),
 			RetrievalTimeout:        cctx.Duration("retrieval-timeout"),
 			MaxRangeRequestFileSize: cctx.Int64("max-range-request-file-size"),
+			DiagnosticServiceURL:    cctx.String("diagnostic-service-url"),
 		}
 
 		// Store original values for display

setup.go

@@ -178,6 +178,7 @@ type Config struct {
 	MaxConcurrentRequests   int
 	RetrievalTimeout        time.Duration
 	MaxRangeRequestFileSize int64
+	DiagnosticServiceURL    string
 }
 
 func SetupNoLibp2p(ctx context.Context, cfg Config, dnsCache *cachedDNS) (*Node, error) {

version.json

@@ -1,3 +1,3 @@
 {
-  "version": "v1.19.0"
+  "version": "v1.20.0"
 }