next-tinacms-owncloud
v4.3.4
Published
Manage **Cloudinary media assets** in TinaCMS.
Downloads
30
Readme
next-tinacms-cloudinary
Manage Cloudinary media assets in TinaCMS.
Installation
With Yarn
yarn add next-tinacms-cloudinary
With NPM
npm install next-tinacms-cloudinary
Connect with Cloudinary
You need some credentials provided by Cloudinary to set this up properly. If you do not already have an account, you can (register here)[https://cloudinary.com/users/register/free].
next-tinacms-cloudinary uses environment variables within the context of a Next.js site to properly access your Cloudinary account.
Add the following variables to an .env
file.
NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME=<Your Cloudinary Cloud Name>
NEXT_PUBLIC_CLOUDINARY_API_KEY=<Your Cloudinary API key>
CLOUDINARY_API_SECRET=<Your Cloudinary API secret>
Register the Media Store
Now, you can register the Cloudinary Media store with the instance of Tina in your app by passing the TinaCloudCloudinaryMediaStore
to the TinaCMS
instance via its mediaStore
prop.
This is also where we can update our mediaOptions
on the cms object.
// Typically in the _app.js file of a Next.js project
import dynamic from "next/dynamic";
import { TinaEditProvider } from "tinacms/dist/edit-state";
import { Layout } from "../components/layout";
import { TinaCloudCloudinaryMediaStore } from "next-tinacms-cloudinary";
const TinaCMS = dynamic(() => import("tinacms"), { ssr: false });
const App = ({ Component, pageProps }) => {
return (
<>
<TinaEditProvider
editMode={
<TinaCMS
branch="main"
clientId={NEXT_PUBLIC_TINA_CLIENT_ID}
isLocalClient={Boolean(Number(NEXT_PUBLIC_USE_LOCAL_CLIENT))}
mediaStore={async () => {
const pack = await import("next-tinacms-cloudinary");
return pack.TinaCloudCloudinaryMediaStore;
}}
{...pageProps}
>
{(livePageProps) => (
<Layout
rawData={livePageProps}
data={livePageProps.data?.getGlobalDocument?.data}
>
<Component {...livePageProps} />
</Layout>
)}
</TinaCMS>
}
>
<Layout
rawData={pageProps}
data={pageProps.data?.getGlobalDocument?.data}
>
<Component {...pageProps} />
</Layout>
</TinaEditProvider>
</>
);
};
...
Set up API routes
Set up a new API route in the pages
directory of your Next.js app, e.g. pages/api/cloudinary
.
Then add a new catch all API route for media.
Call createMediaHandler
to set up routes and connect your instance of the Media Store to your Cloudinary account.
Import isAuthorized
from @tinacms/auth
.
The authorized
key will make it so only authorized users within Tina Cloud can upload and make media edits.
//[...media].tsx
import {
mediaHandlerConfig,
createMediaHandler,
} from "next-tinacms-cloudinary/dist/handlers";
import { isAuthorized } from "@tinacms/auth";
export const config = mediaHandlerConfig;
export default createMediaHandler({
cloud_name: process.env.NEXT_PUBLIC_CLOUDINARY_CLOUD_NAME,
api_key: process.env.NEXT_PUBLIC_CLOUDINARY_API_KEY,
api_secret: process.env.CLOUDINARY_API_SECRET,
authorized: async (req, _res) => {
if (process.env.NEXT_PUBLIC_USE_LOCAL_CLIENT === "1") {
return true;
}
try {
const user = await isAuthorized(req);
return user && user.verified;
} catch (e) {
console.error(e);
return false;
}
},
});
Update Schema
Now that the media store is registered and the API route for media set up, let's add an image to your schema.
In your .tina/schema.ts
add a new field for the image, e.g:
{
name: 'hero',
type: 'image',
label: 'Hero Image',
}
Now, when editing your site, the image field will allow you to connect to your Cloudinary account via the Media Store to manage your media assets.