Files
next.js/examples/with-mux-video/README.md
Arian Tron 61f56f997c
Some checks failed
Test examples / Test Examples (20) (push) Has been cancelled
Test examples / Test Examples (22) (push) Has been cancelled
Lock Threads / action (push) Has been cancelled
Trigger Release / start (push) Has been cancelled
Stale issue handler / stale (push) Has been cancelled
Update Font Data / create-pull-request (push) Has been cancelled
build-and-deploy / deploy-target (push) Has been cancelled
build-and-deploy / build (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-musl - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-unknown-linux-gnu - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-pc-windows-msvc - node@16 (push) Has been cancelled
build-and-deploy / stable - aarch64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / stable - x86_64-apple-darwin - node@16 (push) Has been cancelled
build-and-deploy / build-wasm (nodejs) (push) Has been cancelled
build-and-deploy / build-wasm (web) (push) Has been cancelled
build-and-deploy / Deploy preview tarball (push) Has been cancelled
build-and-deploy / Potentially publish release (push) Has been cancelled
build-and-deploy / publish-turbopack-npm-packages (push) Has been cancelled
build-and-deploy / Deploy examples (push) Has been cancelled
build-and-deploy / thank you, build (push) Has been cancelled
build-and-deploy / Upload Turbopack Bytesize metrics to Datadog (push) Has been cancelled
Rspack Next.js development integration tests / Rspack integration tests (push) Has been cancelled
Rspack Next.js production integration tests / Rspack integration tests (push) Has been cancelled
Turbopack Next.js development integration tests / Next.js integration tests (push) Has been cancelled
Turbopack Next.js production integration tests / Next.js integration tests (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack development test manifest (push) Has been cancelled
Update Rspack test manifest / Update and upload Rspack production test manifest (push) Has been cancelled
Upload bundler test manifests to areweturboyet.com / Upload test results (push) Has been cancelled
Update React / create-pull-request (push) Has been cancelled
test-e2e-project-reset-cron / reset-test-project (push) Has been cancelled
Notify about the top 15 issues/PRs/feature requests (most reacted) in the last 90 days / run (push) Has been cancelled
first commit
2026-03-10 19:37:31 +03:30

5.7 KiB

Mux Video

This example uses Mux Video, an API-first platform for video. The example features video uploading and playback in a Next.js application.

Try it out

Deploy your own

New to Mux

If you do not already have a Mux account, the easiest way to get started with Mux is through the native integration in the Vercel Marketplace. Vercel Marketplace users will get $20 of usage/month for $0. Learn more.

Deploy with Vercel

Existing Mux user

If you have an existing Mux account, you can still deploy easily with Vercel:

Deploy with Vercel

Once deployed, continue with step 3 below.

How to use

If you deployed with the native Mux integration, you're all set! However, if you have your own Mux account already, or want to set up things manually, you can follow the following steps.

Step 1. Create your Mux account

The easiest way to get started with Mux is through the native integration in the Vercel Marketplace. Vercel Marketplace users will get $20 of usage/month for $0. Learn more.

You can also get started by creating an account directly in Mux.

Step 2. Create a Next app with this example

Execute create-next-app with npm, Yarn, pnpm, or Bun to bootstrap the example:

npx create-next-app --example with-mux-video with-mux-video-app
yarn create next-app --example with-mux-video with-mux-video-app
pnpm create next-app --example with-mux-video with-mux-video-app
bunx create-next-app --example with-mux-video with-mux-video-app

Step 3. Set up environment variables

Copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):

cp .env.local.example .env.local

Then, go to the settings page in your Mux dashboard, get a new API Access Token. Use that token to set the variables in .env.local:

  • MUX_TOKEN_ID should be the TOKEN ID of your new token
  • MUX_TOKEN_SECRET should be TOKEN SECRET

At this point, you're good to npm run dev or yarn dev or pnpm dev. However, if you want to deploy, read on:

Step 4. Deploy on Vercel

You can deploy this app to the cloud with Vercel (Documentation).

To deploy on Vercel, you need to set the MUX_TOKEN_ID and MUX_TOKEN_SECRET environment variables using either the Vercel Dashboard or the Vercel CLI

Then push the project to GitHub/GitLab/Bitbucket and import to Vercel to deploy.

Notes

Preparing for Production

Important: When creating uploads, this demo sets cors_origin: "*" in the app/(upload)/page.tsx file. For extra security, you should update this value to be something like cors_origin: 'https://your-app.com', to restrict uploads to only be allowed from your application.

How it works

  1. Users land on the home page, app/(upload)/page.tsx. The Mux Direct Uploads API provides an endpoint to Mux Uploader React.
  2. The user uploads a video with Mux Uploader. When their upload is complete, Mux Uploader calls a server action that redirects to...
  3. app/(upload)/asset/[assetId]/page.tsx, which polls the Asset API via server action, waiting for the asset to be ready. Once the asset is ready, it redirects to...
  4. app/v/[assetId]/page.tsx, where users can watch their video using Mux Player React. This page uses the Mux Image API and the Next.js Metadata API to provide an og images tailored to each video.