|
1 | 1 | # Strapi plugin mux
|
2 | 2 |
|
3 |
| -A quick description of mux. |
| 3 | +## Summary |
| 4 | + |
| 5 | +A [Strapi](https://strapi.io/) plugin for managing uploads to [Mux](https://mux.com). |
| 6 | + |
| 7 | +This plugin provides the ability to upload content via a url or a direct file upload to [Mux](https://mux.com). |
| 8 | + |
| 9 | +## Install |
| 10 | + |
| 11 | +``` |
| 12 | +npm i strapi-plugin-mux-video-uploader |
| 13 | +``` |
| 14 | + |
| 15 | +or |
| 16 | + |
| 17 | +``` |
| 18 | +yarn add strapi-plugin-mux-video-uploader |
| 19 | +``` |
| 20 | + |
| 21 | +## Usage |
| 22 | + |
| 23 | +### Dependencies |
| 24 | + |
| 25 | +- A [Mux](https://mux.com) account |
| 26 | +- You will need both the **Access Token** and **Secret Key** scoped with "Full Access" permissions which can be created in the [Mux Dashboard](https://dashboard.mux.com/settings/access-tokens) |
| 27 | +- The **Webhook Signing Secret** which can be created in the [Mux Dashboard](https://dashboard.mux.com/settings/webhooks) (See the [Webhooks](#Webhooks) section for more info) |
| 28 | + |
| 29 | +### Webhooks |
| 30 | + |
| 31 | +When setting up your Webhook configuration in the [Mux Dashboard](https://dashboard.mux.com/settings/webhooks), the "URL to notify" field should be in the format of— |
| 32 | + |
| 33 | +``` |
| 34 | +{STRAPI_BASE_URL}/mux-video-uploader/webhook-handler |
| 35 | +``` |
| 36 | + |
| 37 | +Where `{STRAPI_BASE_URL}` is the publicly accessible hostname of your [Strapi](https://strapi.io/) instance. |
| 38 | + |
| 39 | +### Configuration |
| 40 | + |
| 41 | +In order for this plugin to communicate with [Mux](https://mux.com), some configuration values need to be set for the plugin before it can be used. |
| 42 | + |
| 43 | +With your **Access Token**, **Secret Key** and **Webhook Signing Secret**, navigate to the Settings view within [Strapi](https://strapi.io/) and click the "General" section under **MUX VIDEO UPLOADER**. |
| 44 | + |
| 45 | +On this view, set the appropriate values to their fields and click the Save button. |
| 46 | + |
| 47 | +### Permissions |
| 48 | + |
| 49 | +*TBD* |
| 50 | + |
| 51 | +## Features |
| 52 | + |
| 53 | +- Upload videos using a url or a file to [Mux](https://mux.com) from inside of [Strapi](https://strapi.io/) |
| 54 | +- [Mux](https://mux.com) updates [Strapi](https://strapi.io/) when the asset is ready |
| 55 | +- A `MuxAsset` content-type is provided to track asset readiness and that can be referenced by other [Strapi](https://strapi.io/) content-types |
| 56 | + |
| 57 | +## Contributing |
| 58 | +Contributions, issues and feature requests are welcome! |
| 59 | + |
| 60 | +Feel free to check issues page. |
| 61 | + |
| 62 | +## FAQ |
| 63 | + |
| 64 | +#### My Strapi instance is not publically available, can I still use Webhooks? |
| 65 | + |
| 66 | +Yes! However, in order to make it work, you'll need a "Webhook Relay" that runs from within your network. You can use a Webhook Relay service like Smee (https://smee.io/) or ngrok (https://ngrok.com/) to forward Webhook events to an instance of [Strapi](https://strapi.io/) behind a firewall. |
| 67 | + |
| 68 | +## Thanks |
| 69 | + |
| 70 | +[Strapi.io](https://strapi.io/) |
| 71 | + |
| 72 | +## References |
| 73 | + |
| 74 | +- [Mux - Webhooks](https://docs.mux.com/docs/webhooks) |
| 75 | +- [Mux - Authentication](https://docs.mux.com/docs/authentication) |
0 commit comments