Ver código fonte

update uppy-server docs cc @arturi

Ifedapo Olarewaju 7 anos atrás
pai
commit
043fc7ba05
1 arquivos alterados com 23 adições e 2 exclusões
  1. 23 2
      website/src/docs/server.md

+ 23 - 2
website/src/docs/server.md

@@ -96,9 +96,23 @@ uppy-server
 If you cloned the repo from GitHub and want to run it as a standalone server, you may also run the following command from within its directory:
 
 ```bash
-npm run start:production
+npm start
 ```
 
+You can also pass in the path to your json config file like so:
+
+```bash
+uppy-server --config /path/to/uppyconf.json
+```
+
+or
+
+```bash
+npm start -- --config /path/to/uppyconf.json
+```
+
+Please see [options](#Options) for possible options.
+
 #### Configure Standalone
 
 To run uppy-server as a standalone server, you are required to set your uppy [options](#Options) via environment variables:
@@ -198,7 +212,10 @@ See [env.example.sh](https://github.com/transloadit/uppy-server/blob/master/env.
     protocol: "http"
   },
   filePath: "path/to/download/folder",
-  sendSelfEndpoint: "localhost:3020"
+  sendSelfEndpoint: "localhost:3020",
+  secret: 'mysecret',
+  uploadUrls: ['https://myuploadurl.com', 'http://myuploadurl2.com']
+  debug: true
 }
 ```
 
@@ -222,6 +239,10 @@ See [env.example.sh](https://github.com/transloadit/uppy-server/blob/master/env.
 
 7. **uploadUrls(optional)** - An array of urls (full path), which uppy-server should only upload to.
 
+8. **secret(required)** - A secret string with which uppy uses to generate authorization tokens.
+
+9. **debug(optional)** - A boolean flag to tell uppy whether or not to log useful debug information while running.
+
 ### S3 Options
 
 The S3 uploader has some options in addition to the ones necessary for authentication.