Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
* 'main' of https://github.com/transloadit/uppy.io:
  Fix drag & drop link in quick start (#96)
  Move over migration guide (#95)
  experiment with Merge Queues (#94)
  fix lint error (#93)
  docs: fix typos (#89)
  add docs for the new COMPANION_REDIS_PUBSUB_SCOPE (#88)
  Add @uppy/audio docs (#86)
  Fix vue doc. (#83)
  meta: mark `format:check-diff` on unformatted code as failure (#84)
  uppy-core: prettify (#85)
  Fix locales link
  • Loading branch information
Murderlon committed Apr 3, 2023
2 parents 5e924ef + 42fb763 commit 866ebd2
Show file tree
Hide file tree
Showing 13 changed files with 828 additions and 360 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/linters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ name: Linters
on:
pull_request:
types: [opened, synchronize, reopened]
merge_group:
types: [checks_requested]
push:
branches:
- main
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ on:
- reopened
- synchronize
- closed
merge_group:
types: [checks_requested]

concurrency: test-${{ github.ref }}

Expand Down
32 changes: 25 additions & 7 deletions docs/companion.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,31 +346,47 @@ instance is only allowed to upload to your trusted servers and prevents

#### `COMPANION_PORT`

The port on which to start the standalone server, defaults to 3020.
The port on which to start the standalone server, defaults to 3020. This is a
standalone-only option.

#### `COMPANION_COOKIE_DOMAIN`

Allows you to customize the domain of the cookies created for Express sessions.
This is a standalone-only option.

#### `COMPANION_HIDE_WELCOME`

Setting this to `true` disables the welcome message shown at `/`.
Setting this to `true` disables the welcome message shown at `/`. This is a
standalone-only option.

#### `redisUrl` `COMPANION_REDIS_URL`

URL to running Redis server. This can be used to scale Companion horizontally
using many instances. See [How to scale Companion](#how-to-scale-companion).

#### `COMPANION_REDIS_EXPRESS_SESSION_PREFIX`

Set a custom prefix for redis keys created by
[connect-redis](https://github.com/tj/connect-redis). Defaults to `sess:`.
Sessions are used for storing authentication state and for allowing thumbnails
to be loaded by the browser via Companion. You might want to change this because
if you run a redis with many different apps in the same redis server, it’s hard
to know where `sess:` comes from and it might collide with other apps. **Note:**
in the future, we plan and changing the default to `companion:` and possibly
remove this option. This is a standalone-only option. See also
`COMPANION_REDIS_PUBSUB_SCOPE`.

#### `redisOptions`

An object of
[options supported by redis client](https://www.npmjs.com/package/redis#options-object-properties).
This option can be used in place of `redisUrl`.

#### `redisPubSubScope`
#### `redisPubSubScope` `COMPANION_REDIS_PUBSUB_SCOPE`

Use a scope for the companion events at the Redis server. Setting this option
will prefix all events with the name provided and a colon.
will prefix all events with the name provided and a colon. See also
`COMPANION_REDIS_EXPRESS_SESSION_PREFIX`.

#### `server`

Expand Down Expand Up @@ -528,17 +544,18 @@ app.use(

Enable S3
[Transfer Acceleration](https://docs.aws.amazon.com/AmazonS3/latest/userguide/transfer-acceleration.html).
This is a standalone-only option.

#### `COMPANION_AWS_EXPIRES`

Set `X-Amz-Expires` query parameter in the presigned urls (in seconds, default:
300).
300). This is a standalone-only option.

#### `COMPANION_AWS_ACL`

Set a
[Canned ACL](https://docs.aws.amazon.com/AmazonS3/latest/dev/acl-overview.html#canned-acl)
for uploaded objects.
for uploaded objects. This is a standalone-only option.

#### `customProviders`

Expand Down Expand Up @@ -603,7 +620,8 @@ Allowed CORS Origins (default `true`). Passed as the `origin` option in
#### `COMPANION_CLIENT_ORIGINS_REGEX`

Like COMPANION_CLIENT_ORIGINS, but allows a single regex instead.
`COMPANION_CLIENT_ORIGINS` will be ignored if this is used.
`COMPANION_CLIENT_ORIGINS` will be ignored if this is used. This is a
standalone-only option.

#### `chunkSize` `COMPANION_CHUNK_SIZE`

Expand Down
6 changes: 4 additions & 2 deletions docs/framework-integrations/vue.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ You also need to install the UI plugin you want to use. For instance,

## Use

The following plugins are available as React component wrappers:
The following plugins are available as Vue component wrappers:

- `<Dashboard />` renders [`@uppy/dashboard`](/docs/dashboard)
- `<DragDrop />` renders [`@uppy/drag-drop`](/docs/drag-drop)
Expand All @@ -64,7 +64,9 @@ JavaScript.
const uppy = new Uppy().use(Webcam);
</script>

<main><Dashboard uppy={uppy} plugins={["Webcam"]} /></main>
<template>
<Dashboard :uppy="uppy" :plugins="['Webcam']" />
</template>
```

[vue]: https://vuejs.org
Loading

0 comments on commit 866ebd2

Please sign in to comment.