Installation

Envault is a self-hostable application. You can run it locally for development or deploy it to your own infrastructure.

Prerequisites

Before you begin, ensure you have the following installed:

• Node.js 18+ (LTS recommended)
• Supabase project (or a local Supabase instance)
• Redis (optional, for caching)

Quick Start

git clone https://github.com/dinanathdash/envault.git
cd envault

npm install

pnpm install

yarn install

bun install

cp .env.example .env.local

npm install -g portless
npm run dev

Docker Compose

For a quick local setup with all dependencies (including Redis and Postgres), you can use Docker Compose.

version: '3.8'
services:
  envault:
    build: .
    ports:
      - "3000:3000"
    environment:
      - DATABASE_URL=postgresql://postgres:postgres@db:5432/envault
      - ENCRYPTION_KEY=...
    depends_on:
      - db
      - redis
  
  db:
    image: postgres:15-alpine
    environment:
      POSTGRES_PASSWORD: postgres
      
  redis:
    image: redis:alpine

docker-compose up -d

Verify Installation

To ensure everything is working correctly:

1. Sign In: Open the app and try signing in (this tests Supabase Auth).
2. Create Project: Create a new project called "Test Project" (tests Database write).
3. Add Secret: Add a key-value pair TEST_KEY=123 (tests Encryption).

Troubleshooting

ENCRYPTION_KEY Error

If you see "Invalid Encryption Key", run this command to generate a valid one:

openssl rand -hex 32

Add the output to your .env.local.

Database Connection Failed

Check your DATABASE_URL and ensure your Supabase project is active. If running locally, make sure your local Supabase instance is running with npx supabase start.