Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NayamAmarshe/MagLit
🔥 MagLit - Privacy Respecting Encrypted Link Shortener with Password Protection and Torrent Magnet Links support
https://github.com/NayamAmarshe/MagLit
encryption foss free linkshortener nextjs open-source privacy self-hosted
Last synced: about 1 month ago
JSON representation
🔥 MagLit - Privacy Respecting Encrypted Link Shortener with Password Protection and Torrent Magnet Links support
- Host: GitHub
- URL: https://github.com/NayamAmarshe/MagLit
- Owner: NayamAmarshe
- License: agpl-3.0
- Created: 2022-02-15T20:09:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-17T03:22:02.000Z (4 months ago)
- Last Synced: 2024-08-17T04:27:19.838Z (4 months ago)
- Topics: encryption, foss, free, linkshortener, nextjs, open-source, privacy, self-hosted
- Language: JavaScript
- Homepage: https://maglit.me
- Size: 1.28 MB
- Stars: 525
- Watchers: 5
- Forks: 49
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-codebases - Maglit - MagLit - Privacy Respecting Encrypted Link Shortener with Password Protection and Torrent Magnet Links support (**Awesome Codebases** [](https://github.com/sindresorhus/awesome))
README
MagLit has been sponsored by Vercel. Many thanks!
Mag🔥Lit
🔥 MagLit - A **super fast** and **easy-to-use** **Free** and **Open Source Privacy Respecting Encrypted** Magnet/HTTP(s) Link Shortener with **Password Protection** 🔥
### https://maglit.me
# 🔥 Featured on [Awesome Open Source](https://awesomeopensource.com/) and [Awesome Privacy](https://github.com/pluja/awesome-privacy#link-shorteners)
## MagLit Features
✅ 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!
**WYSIWYG:** [MagLit builds are fully verifiable: The code in this repository is the same code that's deployed on MagLit.me, Nothing added, nothing ripped, so you know it's 100% trusted ;) ](https://github.com/NayamAmarshe/MagLit/deployments)
## Self Hosting
**PREPARE**
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`.
This step is a **hard requeriment** and any change to this file, **requires a rebuild to the project from scratch** (either through npm install/npm run dev or by using the docker steps)
Clone the project and install dependencies using:
```bash
npm install
```
You need npm or yarn installed for this.
Then, run the development server:
```bash
npm run dev
```
**DOCKER:**
> [!IMPORTANT]
> Make sure the .env.local file is available before the build.
```bash
# BUILD AND RUN IMAGE USING NPM
npm run docker:build
# RUN IMAGE
npm run docker
# OR RUN IN DETACHED MODE
npm run docker:d
```
Open [http://localhost:3000](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](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/xxxxxx](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](https://nextjs.org/docs/api-routes/introduction).
## If you like the project
### 🔥 https://maglit.me 🔥