Skip to content
poliusPublic

About

Securely encrypt and decrypt your files directly in your browser.

Topics

Resources

Contributing

Security policy

Stars

98 stars

Watchers

1 watching

Forks

Repository files navigation

VAULT

Encrypt files locally. Lock any file or folder with a password, right in your browser.
Nothing is ever uploaded.

Release workflow GitHub Release Docker Pulls

Watch the VAULT video: a one-minute walkthrough of encrypting and decrypting a file

Try it at vault.alzina.dev · Self-host · How it's secured

Features

  • Files or whole folders. Several files or a folder become a single .vault file.
  • One drop zone. Drop anything anywhere; .vault files switch to decrypt.
  • Strong crypto. AES-256-GCM and Argon2id. File name and size are encrypted too.
  • Tamper-evident. Wrong passwords fail up front; edited or truncated files are rejected.
  • Large files. Streams straight to disk where the browser supports it.
  • Better passwords. Strength estimate, confirmation field and passphrase generator.
  • A seal for every file. Each .vault file has its own fine-line seal, drawn from its salt, so you can recognise it at a glance.
  • Accessible. Light and dark themes, keyboard and screen-reader friendly.

The .vault format is documented in FORMAT.md, and the threat model in SECURITY.md.

Installation

The recommended installation method is Docker. The image is a static nginx site that runs as a non-root user and listens on port 8080 inside the container.

Run with Docker CLI

docker run -d --name vault -p 80:8080 poliuscorp/vault

Run with Docker Compose

services:
  vault:
    image: poliuscorp/vault
    container_name: vault
    ports:
      - "80:8080"
    restart: unless-stopped

Important

Browsers only allow the cryptography VAULT needs on HTTPS pages (or http://localhost). Served over plain HTTP from another machine, VAULT shows a notice instead of working. For anything beyond your own computer, use the HTTPS setup below or put VAULT behind your existing reverse proxy.

Run it with HTTPS

The deploy folder runs VAULT behind Caddy, which gets and renews a Let's Encrypt certificate automatically.

  1. Point a DNS record for your domain at the server, and open ports 80 and 443.

  2. Download docker-compose.yml and Caddyfile into one folder.

  3. In the Caddyfile, replace yourdomain.com with your domain.

  4. Start the stack:

    docker compose up -d
  5. Open https://yourdomain.com.

To stop and remove the stack: docker compose down.

Behind your own reverse proxy

Proxy to the container's port 8080. VAULT sends its own security headers (Content-Security-Policy, X-Frame-Options, and so on); don't strip them, and don't let the proxy or a CDN inject scripts into the page, as the CSP will block them. Add Strict-Transport-Security at the proxy.

Static hosting

src/ is a plain static site with no build step, so you can serve it from any static host. The CSP is also set in a <meta> tag, but for the full set of headers copy the ones in nginx.conf into your host's configuration.

License

MIT.

About

Securely encrypt and decrypt your files directly in your browser.

Topics

Resources

Contributing

Security policy

Stars

98 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages