Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/deuxhuithuit/craft-cloudflare-stream

Upload your videos assets to Cloudflare Stream from Craft CMS assets interface
https://github.com/deuxhuithuit/craft-cloudflare-stream

craft-plugin craftcms craftcms-plugin hacktoberfest

Last synced: about 1 month ago
JSON representation

Upload your videos assets to Cloudflare Stream from Craft CMS assets interface

Host: GitHub
URL: https://github.com/deuxhuithuit/craft-cloudflare-stream
Owner: DeuxHuitHuit
License: other
Created: 2023-07-21T21:35:41.000Z (over 1 year ago)
Default Branch: dev
Last Pushed: 2024-10-23T18:10:27.000Z (2 months ago)
Last Synced: 2024-10-23T22:57:35.197Z (about 2 months ago)
Topics: craft-plugin, craftcms, craftcms-plugin, hacktoberfest
Language: PHP
Homepage: https://plugins.craftcms.com/cloudflare-stream
Size: 174 KB
Stars: 1
Watchers: 2
Forks: 1
Open Issues: 2
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md

Awesome Lists containing this project

README

# Craft CMS Cloudflare Stream

> This plugin offers a easy way to upload your videos assets from Craft CMS to Cloudflare stream.

## Installation

1) Install with composer

```sh
composer require deuxhuithuit/craft-cloudflare-stream
```

2) Install in craft

```sh
craft plugin/install cloudflare-stream
```

3) Add your account id and api token in the settings. You can (and should) use env vars.
Make sure to also choose your upload mechanism. If your volume does not have public urls,
turn on form data upload. This is the recommended value, but not the default since not all
hosts allows it.

4) Create a video stream Field and add it to your Asset data model.

5) When editing an asset, you can now opt-in into sending videos in
[Cloudflare Stream](https://www.cloudflare.com/products/cloudflare-stream/).

6) If your are using twig, with a field named `stream` you can access the stream data like so:

```twig
{% set value = asset.stream %}

{% if value.mp4Url and value.completed %}

{% endif %}
{% if value.playback.hls %}

{% endif %}
{% if value.playback.dash %}

{% endif %}

```

7) If you are using graphql, there is a type registered to make it easy to request the proper data.

```graphql
query MyQuery {
asset(site: ["en"], volume: "stream") {
url
kind
extension
filename
... on stream_Asset {
videoStream {
uid
name
size
thumbnailTimestampPct
thumbnail
preview
hls
dash
mp4
ready
completed
watermark {
uid
created
downloadedFrom
height
name
opacity
padding
position
scale
size
width
}
input {
width
height
}
}
}
}
}
```

8) You can also mass re-upload everything via Craft's cli. Please note that this creates _new_ streams videos
and is useful mainly when changing accounts.

```sh
./craft cloudflare-stream/reupload
```

This extension uses Craft's Queue system, so make sure it works properly.

## Dealing with large files

Videos can be quite large, which makes uploading them a little trickier.
Please make sure that Craft's and php's max upload limit are properly set.

If you still want to deal with larger file than what your host allows,
you might want to try the [Chunked Upload plugin](https://plugins.craftcms.com/chunked-uploads)
to bypass your host restrictions. The plugin will use TUS when appropriated. The chunk size can
be set by setting the `CF_STREAM_TUS_CHUNK_SIZE` env var to a value in bytes, in the 5 to 200 Mb range.

Made with ❤️ in Montréal.