Parcourir la source

add corsOrigins to docs (#3554)

fixes #3548
Mikael Finstad il y a 3 ans
Parent
commit
ae1c512b32
1 fichiers modifiés avec 5 ajouts et 2 suppressions
  1. 5 2
      website/src/docs/companion.md

+ 5 - 2
website/src/docs/companion.md

@@ -163,9 +163,9 @@ export COMPANION_HIDE_METRICS="true"
 # instead (e.g Nginx).
 export COMPANION_IMPLICIT_PATH="/SERVER/PATH/TO/WHERE/UPPY/SERVER/LIVES"
 
-# comma-separated client hosts to whitlelist by the server
+# corresponds to the corsOrigins option, but can contain a comma-separated list of String values.
 # if neither this or COMPANION_CLIENT_ORIGINS_REGEX specified, the server would allow any host
-export COMPANION_CLIENT_ORIGINS="localhost:3452,uppy.io"
+export COMPANION_CLIENT_ORIGINS="http://localhost:3452,https://uppy.io"
 
 # Like COMPANION_CLIENT_ORIGINS, but allows a single regex instead
 # (COMPANION_CLIENT_ORIGINS will be ignored if this is used and vice versa)
@@ -317,6 +317,7 @@ const options = {
   periodicPingUrls: [],
   periodicPingInterval: 60000,
   periodicPingStaticPayload: { static: 'payload' },
+  corsOrigins: true,
 }
 ```
 
@@ -365,6 +366,8 @@ const options = {
 
 19. **allowLocalUrls(optional)** - A boolean flag to tell Companion whether to allow requesting local URLs. Note: Only enable this in development. **Enabling it in production is a security risk.**
 
+20. **corsOrigins(optional)** - Allowed CORS Origins (default `true`. Passed as the `origin` option in [cors](https://github.com/expressjs/cors#configuration-options))
+
 ### Provider Redirect URIs
 
 When generating your provider API keys on their corresponding developer platforms (e.g [Google Developer Console](https://console.developers.google.com/)), you’d need to provide a `redirect URI` for the OAuth authorization process. In general the redirect URI for each provider takes the format: