docs: Add an example of an origin.

h2oai · Mar 5, 2024 · ccac023 · ccac023
1 parent adc0a30
commit ccac023
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/conf.go b/conf.go
@@ -115,5 +115,5 @@ type Conf struct {
 	KeepAppLive           bool   `cfg:"keep-app-live" env:"H2O_WAVE_KEEP_APP_LIVE" cfgDefault:"false" cfgHelper:"do not unregister unresponsive apps"`
 	Conf                  string `cfg:"conf" env:"H2O_WAVE_CONF" cfgDefault:".env" cfgHelper:"path to configuration file"`
 	ReconnectTimeout      string `cfg:"reconnect-timeout" env:"H2O_WAVE_RECONNECT_TIMEOUT" cfgDefault:"2s" cfgHelper:"Time to wait for reconnect before dropping the client"`
-	AllowedOrigins        string `cfg:"allowed-origins" env:"H2O_WAVE_ALLOWED_ORIGINS" cfgDefault:"" cfgHelper:"comma-separated list of allowed origins for websocket upgrades"`
+	AllowedOrigins        string `cfg:"allowed-origins" env:"H2O_WAVE_ALLOWED_ORIGINS" cfgDefault:"" cfgHelper:"comma-separated list of allowed origins (e.g. http://foo.com) for websocket upgrades"`
 }
diff --git a/website/docs/configuration.md b/website/docs/configuration.md
@@ -60,7 +60,7 @@ Wave can be configured via configuration (`.env`) file, environment variables or
 | H2O_WAVE_CONF                          | -conf string                          | path to a configuration file (default ".env")                                                                                                                                                                                                                                                                        |
 | H2O_WAVE_PING_INTERVAL                 | -ping-interval string                 | how often should ping messages be sent (e.g. 60s or 1m or 0.1h) to keep the websocket connection alive (default "50s")                                                                                                                                                                                               |
 | H2O_WAVE_RECONNECT_TIMEOUT             | -reconnect-timeout string             | Time to wait for reconnect before dropping the client (default "2s")                                                                                                                                                                                                                                                 |
-| H2O_WAVE_ALLOWED_ORIGINS               | -allowed-origins string               | comma-separated list of allowed origins for websocket upgrades                                                                                                                                                                                                                                                       |
+| H2O_WAVE_ALLOWED_ORIGINS               | -allowed-origins string               | comma-separated list of allowed origins (e.g. http://foo.com) for websocket upgrades                                                                                                                                                                                                                                 |
 
 [^1]: `1`, `t`, `true` to enable; `0`, `f`, `false` to disable (case insensitive).
 [^2]: Use OS-specific path list separator to specify multiple arguments - `:` for Linux/OSX and `;` for Windows. For example, `H2O_WAVE_PUBLIC_DIR=/images/@./files/images:/downloads/@./files/downloads`.