Add comment

Emyrk · Emyrk · commit ec46e59ac102 · 2023-04-19T09:43:26.000-05:00
diff --git a/enterprise/wsproxy/wsproxy.go b/enterprise/wsproxy/wsproxy.go
@@ -103,6 +103,9 @@ type Server struct {
 	cancel context.CancelFunc
 }
 
+// New creates a new workspace proxy server. This requires a primary coderd
+// instance to be reachable and the correct authorization access token to be
+// provided. If the proxy cannot authenticate with the primary, this will fail.
 func New(ctx context.Context, opts *Options) (*Server, error) {
 	if opts.PrometheusRegistry == nil {
 		opts.PrometheusRegistry = prometheus.NewRegistry()

Original file line number	Diff line number	Diff line change
`@@ -103,6 +103,9 @@ type Server struct {`
`103`	`103`	`cancel context.CancelFunc`
`104`	`104`	`}`
`105`	`105`
	`106`	`+// New creates a new workspace proxy server. This requires a primary coderd`
	`107`	`+// instance to be reachable and the correct authorization access token to be`
	`108`	`+// provided. If the proxy cannot authenticate with the primary, this will fail.`
`106`	`109`	`func New(ctx context.Context, opts Options) (Server, error) {`
`107`	`110`	`if opts.PrometheusRegistry == nil {`
`108`	`111`	`opts.PrometheusRegistry = prometheus.NewRegistry()`