Installation

Install only what you need. Each tool is independent.

By use case

Play encrypted video
Encrypt & upload (CLI)
Browser upload SDK
Production key server

pnpm add @blindcast/player hls.js

hls.js is a peer dependency. See Player docs.

npm install -g @blindcast/cli

Or use without installing: npx @blindcast/cli <command>. See CLI docs.

pnpm add @blindcast/uploader

See Uploader docs.

docker pull blindcast/keyserver

See Key Server docs.

Requirements

Tool	Requirements
Player	Any modern browser with Web Crypto API (Chrome 37+, Firefox 34+, Safari 11+, Edge 79+)
CLI	Node.js 18+
Uploader	Any modern browser with Web Crypto API
Key Server	Docker 20+

TypeScript

All npm packages ship with TypeScript declarations. No @types/* packages needed. Set "moduleResolution": "bundler" or "node16" in tsconfig.json:

tsconfig.json

{
  "compilerOptions": {
    "moduleResolution": "bundler",
    "target": "ES2020",
    "lib": ["ES2020", "DOM"]
  }
}

Next: Quick Start — see encrypted playback in ~10 minutes.

Architecture Overview

Quick Start

Introduction

Getting Started

Server

Player

CLI

Uploader

Key Server

Serverless

Going to Production

Reference

By use case

Requirements

TypeScript

​By use case

​Requirements

​TypeScript

By use case

Requirements

TypeScript