34 lines
1.5 KiB
Markdown
34 lines
1.5 KiB
Markdown
# Integration between Contentstack and ImageVault
|
|
|
|
Provides the following:
|
|
|
|
- A Custom field for Contentstack to select images in an ImageVault instance.
|
|
- A Custom RTE field for Contentstack to insert images from an ImageVault instance into an JSON RTE field.
|
|
|
|
## Custom field
|
|
|
|
The code is in `remix` folder.
|
|
|
|
## Custom RTE field
|
|
|
|
The code is in `rte` folder.
|
|
|
|
### Configuration
|
|
|
|
The RTE plugin has the following configuration available. The values should be set on App Config level and overriden when needed on Plugin Config level.
|
|
|
|
- `baseUrl`: The base url for Contentstack, most likely `https://eu-app.contentstack.com/`
|
|
- `formatId`: The id for the format in ImageVault to use when selecting an asset in ImageVault
|
|
- `imageVaultUrl`: The URL to the ImageVault instance to use when selecting an asset.
|
|
|
|
## Getting started
|
|
|
|
Run `npm install` in the root, the [rte](rte) and [remix](remix) folders to install all dependencies. After that you can start the project by running `npm run dev` in the root of the repository.
|
|
|
|
To use the local version of ImageVault inside contentstack, you need to add the `Dev ImageVault Custom field` as custom extension instead of the default `ImageVault` extension.
|
|
|
|
### Possible issues
|
|
|
|
- Browsers/Browser extensions
|
|
- ContentStack is using the extension from your locally served extension through `localhost:3000`. This means that some browsers or browser extensions block ContentStack from talking with `localhost`. **Solution:** Disable this functionality in your browser.
|