🔐 Keyper - Self-Hosted Credential Management

<div align="center"> <img src="./public/logo.png" alt="Keyper Logo" width="300" />

✨ Your Credentials. Your Security. Your Rules. ✨

A modern, secure, self-hosted credential management application for storing and organizing your digital credentials with complete privacy and control.

🚀 Quick Start • 🖼️ Screenshots • 📦 Installation • 🗄️ Setup • 📱 PWA • 🔧 Troubleshooting

</div>

---

📥 Download

Desktop installers are available on the Keyper website.

| Platform | Package | Download | | ---------- | --------------- | ---------------------------------------------------------------------------------------------------- | | 🪟 Windows | NSIS installer | KeyperSetup.v1.1.1.exe | | 🐧 Linux | AppImage | Keyper-1.1.1.AppImage | | 🐧 Linux | .deb (x86_64) | keyper_1.1.1_amd64.deb | | 🐧 Linux | .deb (ARM64) | keyper_1.1.1_arm64.deb |

---

🖼️ Screenshots

---

🌟 Features

🔒 Secure Credential Storage

• 🔑 API Keys - Store and organize your API credentials
• 🔐 Login Credentials - Username/password combinations
• 🤫 Secrets - Sensitive configuration values
• 🎫 Tokens - Authentication and access tokens
• 📜 Certificates - SSL certificates and keys
• 📄 Documents - Secure file uploads for .pdf, .doc, .docx, .odt, .txt, .md
• 🧩 Miscellaneous - Large multiline secure notes/commands/scripts that don’t fit fixed types

🏷️ Smart Organization

• 📂 Categories - Group credentials by service or type
• 🔖 Tags - Flexible labeling system
• ⚡ Priority Levels - Low, Medium, High, Critical
• 📅 Expiration Tracking - Never miss renewal dates
• 🔍 Real-time Search - Find credentials instantly
• 👁️ Quick Reveal & Copy - Reveal and copy sensitive values directly from the credential detail view
• 👁️ Inline Text Document Preview - Text-like document credentials (.txt, .md, text/*) can be previewed inline in credential detail view
• ⬇️ Secure Document Download - All document credentials can be downloaded from detail view

🛡️ Enterprise-Grade Security

• 🔒 Row Level Security (RLS) - Database-level isolation
• 🔐 End-to-End Encryption - Client-side encryption, zero-knowledge architecture
• 👤 Multi-User Support - Self-service registration, account switching, and per-user vault isolation
• 🌐 Secure Connections - HTTPS/TLS encryption
• 🏠 Self-Hosted - Complete control over your data

🔐 Advanced Encryption Features

• Zero-Knowledge Architecture - All encryption happens client-side
• AES-256-GCM Encryption - Industry-standard authenticated encryption
• Argon2id Key Derivation - Memory-hard, ASIC-resistant (with PBKDF2 fallback)
• Auto-Lock Protection - 15-minute inactivity timeout with activity detection
• Simplified Bcrypt Master Passphrase - Secure bcrypt-only authentication for new users
• Backwards Compatibility - Legacy wrapped DEK system maintained for existing users
• User-Controlled Reset - Secure emergency passphrase reset without admin backdoors
• Database-Only Storage - No localStorage usage except for database config
• Professional Security Audit - EXCELLENT security rating

📱 Modern Experience

• 🌙 Dark Theme - Easy on the eyes
• 📱 Responsive Design - Works on all devices
• ⚡ Progressive Web App - Install like a native app
• 🚀 Fast Performance - Built with Vite and React 19
• 🎨 Beautiful UI - Modern glassmorphism design

---

🚀 Quick Start

Get Keyper running on your own infrastructure in under 5 minutes!

Prerequisites

• Node.js 18+ installed on your system
• Database (choose one):
  • 🗄️ SQLite (local mode) — no account or server required, zero configuration, works in browser and Electron desktop
  • ☁️ Supabase — free tier works perfectly for hosted/remote/multi-device usage
• Modern web browser (Chrome, Firefox, Safari, Edge)

⚡ 1-Minute Installation

# Install Keyper globally
npm install -g @pinkpixel/keyper

# Start the server (default port 4173)
keyper

# Or start with custom port
keyper --port 3000

# Open in your browser
# 🌐 http://localhost:4173 (or your custom port)

That's it! 🎉 Follow the in-app setup wizard to configure your database (choose SQLite for zero-config local storage, or Supabase for hosted cloud storage).

🌐 Try the Demo

Want to try Keyper before installing? Visit our hosted demo:

🔗 app.keyper.icu

Just enter your own Supabase credentials and start managing your encrypted credentials instantly! Your data stays completely private since all encryption happens in your browser.

Demo Usage:

• ✅ Completely Secure - Zero-knowledge architecture means your data never leaves your browser
• ✅ Real Functionality - Full Keyper experience with your own Supabase instance
• ✅ No External Signup Required - Just bring your Supabase URL and anon/publishable key
• ✅ In-App User Registration Available - Create multiple isolated user vaults directly inside Keyper
• ⚠️ Demo Limitations - Recommended for testing and light usage only
• 🏠 Self-Host for Production - Install locally for best performance and full control

Note: The demo uses the same secure architecture as self-hosted Keyper. Your Supabase credentials are stored only in your browser's localStorage and never transmitted to our servers.

---

📦 Installation

Method 1: Global NPM Installation (Recommended)

npm install -g @pinkpixel/keyper

Available Commands:

• keyper - Start Keyper server
• keyper --port 3000 - Start on custom port
• keyper --help - Show help and usage
• credential-manager - Alternative command
• keyper-dashboard - Another alternative

Method 2: NPX (No Installation Required)

npx @pinkpixel/keyper

Method 3: Local Development

git clone https://github.com/pinkpixel-dev/keyper.git
cd keyper
npm install
npm run build
npm start

Method 4: 🐳 Docker

Run Keyper as a containerised web app — no Node.js required on the host!

# Clone the repo
git clone https://github.com/pinkpixel-dev/keyper.git
cd keyper

# Build & start (serves on http://localhost:8080)
docker compose up -d

# Or on a custom port
HOST_PORT=3030 docker compose up -d

# Force rebuild after source changes
docker compose up -d --build

# Stop
docker compose down

# Follow logs
docker compose logs -f

To build and run the image directly (without Compose):

docker build -t keyper .
docker run -d -p 8080:80 --name keyper --restart unless-stopped keyper

Note: Keyper stores all configuration (Supabase credentials or SQLite provider selection) in browser localStorage — no environment variables or volumes are required.

Method 5: ⚡ Electron Desktop App

Run Keyper as a native desktop app on Windows or Linux!

Published desktop downloads

• Windows installer: KeyperSetup.v1.1.1.exe
• Linux AppImage: Keyper-1.1.1.AppImage
• Linux .deb (x86_64): keyper_1.1.1_amd64.deb
• Linux .deb (ARM64): keyper_1.1.1_arm64.deb

Preview (no packaging)

git clone https://github.com/pinkpixel-dev/keyper.git
cd keyper
npm install
npm run electron:preview

Build a distributable installer

# desktop packaging from source
npm run electron:build:linux   # AppImage + deb
npm run electron:build:win     # NSIS installer

Installers are output to dist-electron/.

---

🗄️ Database Setup

Keyper supports two database bac