Skip to content

About

Self-hosted URL shortener with statistics, QR codes, and password protection.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

106 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

MSK Shortener

License: AGPL v3 Next.js TypeScript

Self-hosted URL shortener with statistics, QR codes and password protection.

MSK Shortener turns long links into short ones under your own domain, shows how often they are opened without tracking anyone, and hands out a QR code for every link. Links can carry a password or an expiry date and are deleted with a token instead of an account.

It is part of the MSK Scripts ecosystem and runs at s.msk-scripts.de. You are welcome to use it there or to host your own instance.

Quick start

git clone https://github.com/MSK-Scripts/msk-shortener.git
cd msk-shortener
npm install
cp .env.example .env   # database credentials and IP_HASH_SECRET
npm run migrate
npm run dev            # http://localhost:3000

Documentation

Topic
Features What the shortener does
Development Tech stack, local setup, languages
REST API and API keys Endpoints, examples, issuing keys on the server
Operations Production server, configuration
Security and privacy What is stored, spam and phishing protection
Design system Colours, type, layout and components
Deployment guide Apache, MariaDB, systemd, CI/CD
Contributing and license How to contribute, the AGPL in plain words

Help and contributing

Questions and bugs go to the issue tracker; security issues as described in SECURITY.md. Contributions are welcome: please open an issue before larger changes, keep pull requests focused and read CONTRIBUTING.md.

License

GNU Affero General Public License v3.0 or later © MSK Scripts. If you offer a modified version as a network service, you must publish your changes under the same license. For a commercial license without these obligations, write to info@msk-scripts.de.

About

Self-hosted URL shortener with statistics, QR codes, and password protection.

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Used by

Contributors

Languages