gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: remove external media library integrations

Browse Source
This commit is contained in:
Daniel Lautzenheiser
2023-04-12 22:27:15 -04:00
parent 1849729bab
commit 56dc4a1d64
30 changed files with 139 additions and 1057 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
packages/docs/content/docs/beta-features.mdx
View File

@ -92,8 +92,7 @@ Example config:
widget: 'image'
default: '/uploads/chocolate-dogecoin.jpg'
media_library:
config:
max_file_size: 512000 # in bytes, only for default media library
max_file_size: 512000 # in bytes, only for default media library
```
```js
@ -103,9 +102,7 @@ Example config:
widget: 'image',
default: '/uploads/chocolate-dogecoin.jpg',
media_library: {
config: {
max_file_size: 512000 // in bytes, only for default media library
},
max_file_size: 512000 // in bytes, only for default media library
},
},
```
@ -197,11 +194,3 @@ See [Gitea Backend](/docs/gitea-backend) for more information.
Adds support for viewing subfolders and creating new subfolders in the media library, under your configured `media_folder`.
See [Media Library Folders](/docs/configuration-options#media-library-folders) for more information.
## External Media Library
Using an external media library allows you to store your media files outside of your git backend. This is helpful if you are trying to store large media files. There are three external media libraries available in beta:
- [Cloudinary](/docs/cloudinary)
- [Netlify Large Media](/docs/netlify-large-media)
- [Uploadcare](/docs/uploadcare)

235
packages/docs/content/docs/cloudinary.mdx
View File

@ -1,235 +0,0 @@
---
group: Media
title: Cloudinary
weight: 10
beta: true
---
Cloudinary is a digital asset management platform with a broad feature set, including support for responsive image generation and url based image transformation. They also provide a powerful media library UI for managing assets, and tools for organizing your assets into a hierarchy.
The Cloudinary media library integration for Static CMS uses Cloudinary's own media library interface within Static CMS. To get started, you'll need a Cloudinary account and Static CMS 2.3.0 or greater.
## Creating a Cloudinary Account
You can [sign up for Cloudinary](https://cloudinary.com/users/register/free) for free. Once you're logged in, you'll need to retrieve your Cloud name and API key from the upper left corner of the Cloudinary console.
![Cloudinary console screenshot](/img/cloudinary-console-details.webp)
## Connecting Cloudinary
To use the Cloudinary media library within Static CMS, you'll need to update your Static CMS configuration file with the information from your Cloudinary account:
<CodeTabs>
```yaml
media_library:
name: cloudinary
config:
cloud_name: your_cloud_name
api_key: your_api_key
```
```js
media_library: {
name: 'cloudinary',
config: {
cloud_name: 'your_cloud_name',
api_key: 'your_api_key'
},
},
```
</CodeTabs>
**Note:** The user must be logged in to the Cloudinary account connected to the `api_key` used in your Static CMS configuration.
### Security Considerations
Although this setup exposes the `cloud_name` and `api_key` publicly via the `config` endpoint, this information is not sensitive. Any integration of the Cloudinary media library requires this information to be exposed publicly. To use this library or use the restricted Cloudinary API endpoints, the user must have access to the Cloudinary account login details or the `api_secret` associated with the `cloud_name` and `api_key`.
## Static CMS configuration options
The following options are specific to the Static CMS integration for Cloudinary:
- **`output_filename_only`**: _(default: `false`)_\
By default, the value provided for a selected image is a complete URL for the asset on Cloudinary's CDN. Setting `output_filename_only` to `true` will instead produce just the filename (e.g. `image.jpg`). This should be `true` if you will be directly embedding cloudinary transformation urls in page templates. Refer to [Inserting Cloudinary URL in page templates](#inserting-cloudinary-url-in-page-templates).
- **`use_transformations`**: _(default: `true`)_\
If `true`, uses derived url when available (the url will have image transformation segments included). Has no effect if `output_filename_only` is set to `true`.
- **`use_secure_url`**: _(default: `true`)_\
Controls whether an `http` or `https` URL is provided. Has no effect if `output_filename_only` is set to `true`.
## Cloudinary configuration options
The following options are used to configure the media library. All options are listed in Cloudinary's [media library documentation](https://cloudinary.com/documentation/media_library_widget#3_set_the_configuration_options), but only options listed below are available or recommended for the Static CMS integration:
### Authentication
- `cloud_name`
- `api_key`
### Media library behavior
- `default_transformations` _\- only the first [image transformation](#image-transformations) is used, be sure to use the `SDK Parameter` column transformation names from the_ [_transformation reference_](https://cloudinary.com/documentation/image_transformation_reference)
- `max_files` _\- has no impact on images inside the [markdown widget](/docs/widgets/#markdown)_. Refer to [media library documentation](https://cloudinary.com/documentation/media_library_widget#3_set_the_configuration_options) for details on this property
- `multiple` _\- has no impact on images inside the [markdown widget](/docs/widgets/#markdown)_. Refer to [media library documentation](https://cloudinary.com/documentation/media_library_widget#3_set_the_configuration_options) for details on this property
## Image transformations
The Cloudinary integration allows images to be transformed in two ways: directly within Static CMS via [Cloudinary's Media Library](#transforming-images-via-media-library), and separately from Static CMS via Cloudinary's [dynamic URL's](https://cloudinary.com/documentation/image_transformations#delivering_media_assets_using_dynamic_urls) by [inserting cloudinary urls](#inserting-cloudinary-url-in-page-templates).
### Transforming Images
If you transform and insert images from within the Cloudinary media library, the transformed image URL will be output by default. This gives the editor complete freedom to make changes to the image output.
There are two ways to configure image transformation via media library - [globally](#global-configuration) and per [field](#field-configuration). Global options will be overridden by field options.
#### Global configuration
Global configuration, which is meant to affect the Cloudinary widget at all times, can be provided
as seen below, under the primary `media_library` property. Settings applied here will affect every
instance of the Cloudinary widget.
<CodeTabs>
```yaml
# global
media_library:
name: cloudinary
output_filename_only: false
config:
default_transformations:
- - fetch_format: auto
width: 160
quality: auto
crop: scale
```
```js
// global
media_library: {
name: 'cloudinary',
output_filename_only: false,
config: {
default_transformations: [
[
{
fetch_format: 'auto',
width: 160,
quality: 'auto',
crop: 'scale'
}
],
],
},
},
```
</CodeTabs>
#### Field configuration
Configuration can also be provided for individual fields that use the media library. The structure
is very similar to the global configuration, except the settings are added to an individual `field`.
For example:
<CodeTabs>
```yaml
# field
fields: # The fields each document in this collection have
- label: 'Cover Image'
name: 'image'
widget: 'image'
required: false
tagtitle: ''
media_library:
config:
default_transformations:
- fetch_format: auto
width: 300
quality: auto
crop: fill
effect: grayscale
```
```js
// field
fields: [
{
label: 'Cover Image',
name: 'image',
widget: 'image',
required: false,
tagtitle: '',
media_library: {
config: {
default_transformations: [
{
fetch_format: 'auto',
width: 300,
quality: 'auto',
crop: 'fill',
effect: 'grayscale',
},
],
},
},
},
],
```
</CodeTabs>
## Inserting Cloudinary URL in page templates
If you prefer to provide direction so that images are transformed in a specific way, or dynamically retrieve images based on viewport size, you can do so by providing your own base Cloudinary URL and only storing the asset filenames in your content:
- Either globally or for specific fields, configure the Cloudinary extension to only output the asset filename
**Global**
<CodeTabs>
```yaml
# global
media_library:
name: cloudinary
output_filename_only: true
```
```js
// global
media_library: {
name: 'cloudinary',
output_filename_only: true,
},
```
</CodeTabs>
**Field**
<CodeTabs>
```yaml
# field
media_library:
name: cloudinary
output_filename_only: true
```
```js
// field
media_library: {
name: 'cloudinary',
output_filename_only: true,
},
```
</CodeTabs>
- Provide a dynamic URL in the site template
```handlebars
{{! handlebars example }}
<img
src='https://res.cloudinary.com/<cloud_name>/<resource_type>/<type>/<transformations>/{{image}}'
/>
```
Your dynamic URL can be formed conditionally to provide any desired transformations - please see Cloudinary's [image transformation reference](https://cloudinary.com/documentation/image_transformation_reference) for available transformations.

54
packages/docs/content/docs/configuration-options.mdx
View File

@ -67,22 +67,7 @@ Based on the settings above, if a user used an image widget field called `avatar
This setting can be set to an absolute URL e.g. `https://netlify.com/media` should you wish, however in general this is not advisable as content should have relative paths to other content.
## Media Library Folders <BetaImage />
The `media_library_folder_support` flag enables support for viewing subfolders and creating new subfolders in the media library, under your configured `media_folder`.
<CodeTabs>
```yaml
media_library_folder_support: true
```
```js
media_library_folder_support: true,
```
</CodeTabs>
## Media Library Integrations <BetaImage />
## Media Library
Media library integrations are configured via the `media_library` property, and its value should be an object with at least a `name` property. A `config` property can also be used for options that should be passed to the library in use.
@ -91,18 +76,39 @@ Media library integrations are configured via the `media_library` property, and
<CodeTabs>
```yaml
media_library:
name: uploadcare
config:
publicKey: demopublickey
choose_url: true,
max_file_size: 512000
folder_support: true
```
```js
media_library: {
name: 'uploadcare',
config: {
publicKey: 'demopublickey'
{
media_library: {
choose_url: "true,",
max_file_size: 512000,
folder_support: true
}
},
}
```
</CodeTabs>
### Media Library Folders <BetaImage />
The `folder_support` flag enables support for viewing subfolders and creating new subfolders in the media library, under your configured `media_folder`.
<CodeTabs>
```yaml
media_library:
folder_support: true
```
```js
{
media_library: {
folder_support: true;
}
}
```
</CodeTabs>

60
packages/docs/content/docs/migration-guide-v2.mdx
View File

@ -190,6 +190,60 @@ collections:
</CodeTabs>
## External Media Libraries
External media integrations (Cloudinary, Netlify Large Media and Uploadcare) have been removed as part of an ongoing to effect to narrow the focus of Static CMS. With [Decap](https://decapcms.org/) (previously Netlify CMS) being supported again its not as critical for Static CMS to support every possible option.
The external media integrations have been broken for sometime, and would require a lot of effort to get them back to the level already available in Decap. So, in order to focus our efforts on other features, it has been decided to remove all external media integrations.
This brings with it some breaking changes for the `media_library` config property.
**Old Config**
<CodeTabs>
```yaml
media_library:
choose_url: true
config:
max_file_size: 512000
```
```js
{
media_library: {
choose_url: true,
config: {
max_file_size: 512000
}
}
}
```
</CodeTabs>
**New Config**
<CodeTabs>
```yaml
media_library:
choose_url: true
max_file_size: 512000
```
```js
{
media_library: {
choose_url: true,
max_file_size: 512000
}
}
```
</CodeTabs>
Also the `clearMediaControl` and `removeMediaControl` widget control props have been removed as they were only used for the external media library integrations.
## Other Breaking Changes
- [Card previews](/docs/custom-previews#collection-card-preview) now are only used for the card view. The `viewStyle` property has been removed. [Field previews](/docs/custom-previews#field-preview) can be used to change the table view.
@ -209,10 +263,8 @@ collections:
In the Widget Control component property, the following properties have been deprecated. They will be removed in `v3.0.0`.
| Param | Type | Description |
| ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Param | Type | Description |
| ------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| mediaPaths | object | <Deprecated>Use [useMediaInsert](/docs/custom-widgets#interacting-with-the-media-library) instead.</Deprecated> Key/value object of control IDs (passed to the media library) mapping to media paths |
| clearMediaControl | function | <Deprecated>Use [useMediaInsert](/docs/custom-widgets#interacting-with-the-media-library) instead.</Deprecated> Clears a control ID's value from the internal store |
| openMediaLibrary | function | <Deprecated>Use [useMediaInsert](/docs/custom-widgets#interacting-with-the-media-library) instead.</Deprecated> Opens the media library popup. See [Open Media Library](#open-media-library) |
| removeInsertedMedia | function | <Deprecated>Use [useMediaInsert](/docs/custom-widgets#interacting-with-the-media-library) instead.</Deprecated> Removes draft media for a give control ID |
| removeMediaControl | function | <Deprecated>Use [useMediaInsert](/docs/custom-widgets#interacting-with-the-media-library) instead.</Deprecated> Clears a control ID completely from the internal store |

31
packages/docs/content/docs/netlify-large-media.mdx
View File

@ -1,31 +0,0 @@
---
group: Media
title: Netlify Large Media
weight: 20
beta: true
---
[Netlify Large Media](https://www.netlify.com/features/large-media/) is a [Git LFS](https://git-lfs.github.com/) implementation for repositories connected to Netlify sites. This means that you can use Git to work with large asset files like images, audio, and video, without bloating your repository. It does this by replacing the asset files in your repository with text pointer files, then uploading the assets to the Netlify Large Media storage service.
If you have a Netlify site with Large Media enabled, Static CMS will handle Large Media asset files seamlessly, in the same way as files stored directly in the repository.
## Requirements
To use Netlify Large Media with Static CMS, you will need to do the following:
- Configure Static CMS to use the [Git Gateway backend with Netlify Identity](/docs/git-gateway-backend).
- Configure the Netlify site and connected repository to use Large Media, following the [Large Media docs on Netlify](https://www.netlify.com/docs/large-media/).
When these are complete, you can use Static CMS as normal, and the configured asset files will automatically be handled by Netlify Large Media.
## Image transformations
All JPEG, PNG, and GIF files that are handled with Netlify Large Media also have access to Netlify's on-demand image transformation service. This service allows you to request an image to match the dimensions you specify in a query parameter added to the image URL.
You can learn more about this feature in [Netlify's image transformation docs](https://www.netlify.com/docs/image-transformation/).
### Media Gallery Thumbnails
In repositories enabled with Netlify Large Media, Static CMS will use the image transformation query parameters to load thumbnail-sized images for the media gallery view. This makes images in the media gallery load significantly faster.
**Note:** When using this option all tracked file types have to be imported into Large Media. For example if you track `*.jpg` but still have jpg-files that are not imported into Large Media the backend will throw an error. Check the [netlify docs](https://docs.netlify.com/large-media/setup/#migrate-files-from-git-history) on how to add previously committed files to Large Media.

121
packages/docs/content/docs/uploadcare.mdx
View File

@ -1,121 +0,0 @@
---
group: Media
title: Uploadcare
weight: 30
beta: true
---
Uploadcare is a sleek service that allows you to upload files without worrying about maintaining a growing collection — more of an asset store than a library. Just upload when you need to, and the files are hosted on their CDN. They provide image processing controls from simple cropping and rotation to filters and face detection, and a lot more. You can check out Uploadcare's full feature set on their [website](https://uploadcare.com/).
The Uploadcare media library integration for Static CMS allows you to use Uploadcare as your media handler within Static CMS itself. It's available by default as of our 2.1.0 release, and works in tandem with the existing file and image widgets, so using it only requires creating an Uploadcare account and updating your Static CMS configuration.
**Please make sure that Static CMS is updated to 2.1.0 or greater before proceeding.**
## Creating an Uploadcare Account
You can [sign up](https://uploadcare.com/accounts/signup/) for a free Uploadcare account to get started. Once you've signed up, go to your dashboard, select a project, and then select "API keys" from the menu on the left. The public key on the API keys page will be needed in your Static CMS configuration. For more info on getting your API key, visit their [walkthrough](https://uploadcare.com/docs/keys/).
## Updating Static CMS Configuration
The next and final step is updating your Static CMS configuration file:
1. Add a `media_library` property at the same level as `media_folder`, with an object as it's value.
2. In the `media_library` object, add the name of the media player under `name`.
3. Add a `config` object under name with a `publicKey` property with your Uploadcare public key as it's value.
Your `config` should now include something like this (except with a real API key):
<CodeTabs>
```yaml
media_library:
name: uploadcare
config:
publicKey: YOUR_UPLOADCARE_PUBLIC_KEY
```
```js
media_library: {
name: 'uploadcare',
config: {
publicKey: 'YOUR_UPLOADCARE_PUBLIC_KEY',
},
},
```
</CodeTabs>
Once you've finished updating your Static CMS configuration, the Uploadcare widget will appear when using the image or file widgets.
**Note:** You'll need to [register the media libraries yourself](/blog/2019/07/netlify-cms-gatsby-plugin-4-0-0#using-media-libraries-with-netlify-cms-app).
## Configuring the Uploadcare Widget
The Uploadcare widget can be configured with settings that are outlined [in their docs](https://uploadcare.com/docs/file_uploads/widget/options/). The widget itself accepts configuration through global variables and data properties on HTML elements, but with Static CMS you can pass configuration options directly through your `config`.
**Note:** all default values described in Uploadcare's documentation also apply in the Static CMS integration, except for `previewStep`, which is set to `true`. This was done because the preview step provides helpful information like upload status, and provides access to image editing controls. This option can be disabled through the configuration options below.
### Global configuration
Global configuration, which is meant to affect the Uploadcare widget at all times, can be provided as seen above, under the primary `media_library` property. Settings applied here will affect every instance of the Uploadcare widget.
## Field configuration
Configuration can also be provided for individual fields that use the media library. The structure is very similar to the global configuration, except the settings are added to an individual `field`. For example:
<CodeTabs>
```yaml
fields:
name: cover
label: Cover Image
widget: image
media_library:
config:
multiple: true
previewStep: false
```
```js
fields: {
name: 'cover',
label: 'Cover Image',
widget: 'image',
media_library: {
config: {
multiple: true,
previewStep: false,
},
},
},
```
</CodeTabs>
## Integration settings
There are several settings that control the behavior of integration with the widget.
* `autoFilename` (`boolean`) - specify whether to add a filename to the end of the url. Example: `http://ucarecdn.com/:uuid/filename.png`
* `defaultOperations` (`string`) - specify a string added at the end of the url. This could be useful to apply a set of CDN operations to each image, for example resizing or compression. All the possible operations are listed [here](https://uploadcare.com/docs/api_reference/cdn/).
<CodeTabs>
```yaml
media_library:
name: uploadcare
config:
publicKey: YOUR_UPLOADCARE_PUBLIC_KEY
settings:
autoFiletitle: true
defaultOperations: '/resize/800x600/'
```
```js
media_library: {
name: 'uploadcare',
config: {
publicKey: 'YOUR_UPLOADCARE_PUBLIC_KEY',
},
settings: {
autoFiletitle: true,
defaultOperations: '/resize/800x600/',
},
},
```
</CodeTabs>

4
packages/docs/content/menu.json
View File

@ -21,10 +21,6 @@
"name": "Widgets",
"title": "Widgets"
},
{
"name": "Media",
"title": "Media"
},
{
"name": "Customization",
"title": "Customizing Static CMS"