🔥 MagLit - A super fast and easy-to-use Free and Open Source Privacy Respecting Encrypted Magnet/HTTP(s) Link Shortener with Password Protection 🔥
🔥 Featured on Awesome Open Source and Awesome Privacy
✅ 100% Easy to use
✅ 100% Free and Open Source
✅ 100% Encrypted
✅ 100% Private
✅ 0% Personal Data stored
New Features
🆕 MagLit now supports custom links!
🆕 MagLit now lets you generate QR Codes for your lit links!
Clone the project and install dependencies using:
npm install
You need npm or yarn installed for this.
Then, run the development server:
npm run dev
DOCKER:
# TO BUILD IMAGE
npm run build-docker-image
# TO START THE DOCKER IMAGE SERVER
npm run start-docker-image
You can also use a pre-built image (supports amd64 and arm64), which contains the code that resides on main
:
docker pull ghcr.io/nayamamarshe/maglit:main
The docker-compose
file is setup to use the remote image. Just remember to fill the firebase environment variables. You can start using docker compose with:
docker compose up -d
Open http://localhost:3000 with your browser to see the result.
You can start editing the page by modifying pages/index.js
. The page auto-updates as you edit the file.
API routes can be accessed on http://localhost:3000/api/xxxxxx. This endpoint can be edited in pages/api/xxxxxx.js
.
The pages/api
directory is mapped to /api/*
. Read more about API routes.
MagLit uses Firebase Firestore as a database. You must first create a new Firebase project, then a file with the name .env.local
in root directory of the project and fill the details as mentioned in .env.local.example
.
ETH (ERC-20) Wallet: 0x14858f5334ea1014e68212c2d4b32792d137f256