# Openinary Docs

## Docs

- [Create API Key](https://docs.openinary.dev/api-reference/api-keys/create.md): Generate a new API key for authenticating requests
- [Delete API Key](https://docs.openinary.dev/api-reference/api-keys/delete.md): Permanently revoke an API key
- [List API Keys](https://docs.openinary.dev/api-reference/api-keys/list.md): Retrieve all API keys for the account
- [Update API Key](https://docs.openinary.dev/api-reference/api-keys/update.md): Rename or enable/disable an existing API key
- [Invalidate Cache](https://docs.openinary.dev/api-reference/cache/invalidate.md): Clear all cached transformation variants for a file without deleting the original
- [Create Folder](https://docs.openinary.dev/api-reference/files/create-folder.md): Create an empty folder in storage
- [Download Original File](https://docs.openinary.dev/api-reference/files/download.md): Download the original uploaded file without any transformation
- [Upload Files](https://docs.openinary.dev/api-reference/files/upload.md): Upload one or more media files, optionally pre-generating cached transformation variants
- [Health](https://docs.openinary.dev/api-reference/health.md): Check server and database availability
- [API Reference](https://docs.openinary.dev/api-reference/introduction.md): Complete reference for the Openinary REST API
- [Authenticated Transform](https://docs.openinary.dev/api-reference/media/authenticated-transform.md): Apply transformations via a signed URL that cannot be guessed or tampered with
- [Transform Media](https://docs.openinary.dev/api-reference/media/transform.md): Apply on-the-fly transformations to images and videos via URL parameters
- [Queue Events (SSE)](https://docs.openinary.dev/api-reference/queue/events.md): Subscribe to real-time video processing job updates via Server-Sent Events
- [Queue Jobs](https://docs.openinary.dev/api-reference/queue/jobs.md): List, retry, cancel, and delete video processing jobs
- [Queue Statistics](https://docs.openinary.dev/api-reference/queue/stats.md): Retrieve current video processing queue statistics
- [Delete File](https://docs.openinary.dev/api-reference/storage/delete.md): Permanently delete a file from storage along with all its cached transformation variants
- [List Storage](https://docs.openinary.dev/api-reference/storage/list.md): Retrieve the full folder and file tree from storage
- [Get File Metadata](https://docs.openinary.dev/api-reference/storage/metadata.md): Retrieve size and timestamps for a specific file
- [Video Processing Status](https://docs.openinary.dev/api-reference/video/status.md): Check the processing status of a video file by its storage path
- [Cloudinary vs Openinary](https://docs.openinary.dev/cloudinary-comparison.md): An honest, feature-by-feature comparison of what Cloudinary offers versus what Openinary supports today.
- [Docker Resources](https://docs.openinary.dev/configuration/docker-resources.md): Set CPU and memory limits and reservations for Docker containers
- [Server Configuration](https://docs.openinary.dev/configuration/server.md): Environment variables for Openinary server mode, authentication secrets, CORS origin, signed URL secret, database path, and public-route rate limiting.
- [Storage](https://docs.openinary.dev/configuration/storage.md): Configure local or S3-compatible cloud storage
- [Video Processing](https://docs.openinary.dev/configuration/video-processing.md): Configure the video job queue: concurrency, retries, and cleanup
- [Deploy on Coolify](https://docs.openinary.dev/guides/coolify-deployment.md): Step-by-step guide to deploy Openinary on Coolify
- [Deploy on Dokploy](https://docs.openinary.dev/guides/dokploy-deployment.md): Step-by-step guide to deploy Openinary on Dokploy
- [Deploy on Railway](https://docs.openinary.dev/guides/railway-deployment.md): One-click deploy Openinary on Railway with a pre-configured template — includes a managed S3 bucket, no infrastructure setup required.
- [Openinary](https://docs.openinary.dev/index.md): Self-hosted, open-source alternative to Cloudinary. Resize, crop, convert, and deliver images and videos on-the-fly via URL parameters.
- [Local Development](https://docs.openinary.dev/local-development.md): Set up a local Openinary development environment with Node.js 20, pnpm, and FFmpeg. Runs the API on :3000 and the dashboard on :3001.
- [Image Transformations](https://docs.openinary.dev/media-transformations/image-transformations.md): Resize, crop, rotate, and optimize images with URL-based parameters
- [Automatic Format Selection](https://docs.openinary.dev/media-transformations/intelligent-compression.md): How Openinary automatically picks AVIF, WebP, or JPEG based on browser support — and how to override it with the f parameter.
- [How Transformations Work](https://docs.openinary.dev/media-transformations/overview.md): URL structure for on-the-fly image and video transformations, caching behavior, and cache invalidation with Openinary.
- [Signed URLs](https://docs.openinary.dev/media-transformations/signed-urls.md): Restrict transformation access with HMAC-signed URLs that cannot be forged or tampered with
- [Upload & Cache Warming](https://docs.openinary.dev/media-transformations/upload-and-prewarm.md): Upload images and videos via the API and pre-generate transformed variants so the first public request is served instantly from cache.
- [Video Transformations](https://docs.openinary.dev/media-transformations/video-transformations.md): Resize, trim, extract thumbnails, and re-encode videos with URL-based parameters
- [Project Structure](https://docs.openinary.dev/project-structure.md): Openinary monorepo layout: Hono.js API, Next.js 15 dashboard, and a shared auth/database package — with key file paths for contributors.
- [Quick Start](https://docs.openinary.dev/quickstart.md): Run Openinary with Docker in three commands, create an admin account, and make your first image transformation.
- [Security](https://docs.openinary.dev/security.md): Openinary authentication model: Better Auth sessions, API key management, rate limiting on public routes, Docker non-root containers, and incident response.