LynkVault¶
Welcome to LynkVault - a self-hostable link management platform.
What is LynkVault?¶
LynkVault is a modern link shortening and management platform that you can host on your own infrastructure. Built with Next.js, it provides:
- Link Shortening - Create short, memorable links
- Custom Domains - Use your own domains for branded links
- Multi-Organisation Support - Manage multiple teams and organisations
- Two-Factor Authentication - Secure access with 2FA
- Analytics - Track link performance and clicks
- Self-Hosted - Full control over your data and infrastructure
Quick Start¶
The fastest way to get started:
git clone https://gitlab.beantech.uk/my-projects/link-shortener.git
cd link-shortener
cp .env.example .env
# Edit .env with your configuration
docker compose -f docker-compose.local.yml up
Visit http://localhost:3000
For full deployment instructions, see Getting Started →
Official Docker Images¶
Pre-built images are available on Docker Hub:
beenhamo/lynkvault:latest- Latest stable releasebeenhamo/lynkvault:1.0.0- Specific version
Technology¶
- Framework: Next.js 15 (React 19)
- Database: MySQL 8.4+
- Authentication: better-auth with 2FA
- Language: TypeScript
Requirements¶
Minimum:
- 1 CPU core
- 1 GB RAM
- 10 GB storage
- Docker (for container deployment)
Recommended:
- 2+ CPU cores
- 2+ GB RAM
- 20+ GB SSD storage
Self-Hosted vs SaaS¶
This documentation is for self-hosted deployments.
Self-Hosted:
- Full control of your data
- Host on your infrastructure
- Customize as needed
SaaS (lynkvault.net):
- Hosted on our infrastructure
- Automatic updates
Support¶
- Bug Reports: owb.gg/bugs
- Feature Requests: owb.gg/features
- Contact: hello@beenhamow.co.uk
Next Steps¶
Ready to deploy?
- Review Getting Started
- Choose Docker or Kubernetes deployment
- Configure your environment variables
- Deploy and start using LynkVault