Skip to content

πŸ›οΈ Vault – Your Self-Hosted, GitHub Authenticated Cloud Vault for Markdown, Files, and Ideas

License

Notifications You must be signed in to change notification settings

ParthKapoor-dev/vault

Repository files navigation

🧠 LNX Vault

Your own private, self-hostable digital vault β€” powered by GitHub Auth and S3. Create directories, upload files, write beautiful markdowns, and access it all from a minimal web UI. Perfect for dotfiles, resumes, personal notes, and more β€” with support for public/private access control.

🌐 Live Demo: lnx.parthkapoor.me


✨ Features

  • πŸ” GitHub Authentication with Admin access control
  • πŸͺ£ S3-Backed Storage (DigitalOcean Spaces, AWS S3, etc.)
  • πŸ“‚ Directory and File Management via Web
  • πŸ“ Markdown Editor for notes, resumes, and guides
  • 🌐 Public/Private Access for files and folders
  • πŸš€ One-Click Deploy on Vercel

βš™οΈ Tech Stack

  • Frontend: Next.js (TypeScript)
  • Auth: Better Stack Auth
  • Storage: S3-compatible (Spaces, AWS, etc.)
  • Cache: Upstash Redis
  • Markdown: MDX Rendering

πŸš€ Self-Hosting Guide

1. 🍴 Clone the Repository

git clone https://github.com/parthkapoor-dev/lnx-vault.git
cd lnx-vault

2. πŸ§ͺ Set Up Environment Variables

Create a .env file in the root:

# Your live or local URL
NEXT_PUBLIC_SITE_URL="http://localhost:3000"

# Better Auth
BETTER_AUTH_SECRET=""
BETTER_AUTH_URL="http://localhost:3000"

# GitHub OAuth App
GITHUB_CLIENT_ID=""
GITHUB_CLIENT_SECRET=""
GITHUB_ADMIN_EMAIL=""

# Upstash Redis
UPSTASH_REDIS_REST_URL=""
UPSTASH_REDIS_REST_TOKEN=""

# S3 / Spaces
SPACES_KEY=""
SPACES_SECRET=""
SPACES_BUCKET=""

πŸ’‘ You can use DigitalOcean Spaces or any S3-compatible provider.


3. πŸ§‘β€πŸ’» Run Locally

npm install
npm run dev

Now open http://localhost:3000 in your browser.


4. ☁️ Deploy on Vercel (Recommended)

  1. Push the repo to your GitHub
  2. Go to vercel.com
  3. Click "Import Project", choose your repo
  4. Set the environment variables in Vercel dashboard
  5. Click Deploy

Done πŸŽ‰ Your personalized cloud vault is now live!


πŸ” Admin Access

By default, only the GitHub account marked as "admin" in your .env-connected auth logic can:

  • Create/upload/edit files & markdowns
  • Add/remove directories
  • Toggle public/private flags

πŸ“„ License

MIT Β© Parth Kapoor


🌟 Star This Project

If this helped you organize your digital life β€” consider giving it a ⭐ on GitHub!

About

πŸ›οΈ Vault – Your Self-Hosted, GitHub Authenticated Cloud Vault for Markdown, Files, and Ideas

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published