Simple, usable and end-to-end encrypted URL shortener written in Node.js
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 

1.3 KiB

yeeturl

Simple and 🔒 end-to-end encrypted URL shortener written in Node.js.

Installation 💻

  1. Install the MongoDB server and Node.js
  2. Clone this repository
  3. Download all third-party libraries; open a terminal, cd into the repo you just cloned, and type npm i.
  4. Copy env.example into .env and replace all the values in here
  5. Write your own privacy policy and terms of service at web/privacy.txt. If you are running yeeturl for yourself or just for a couple of friends, you can just remove everything from this file.
  6. Run yeeturl with node index.js or npm start

It is recommended that you run yeeturl behind a reverse proxy with a secure HTTPS configuration.

Backups 💥

This is as simple as backing up your MongoDB database - an official guide is published here. yeeturl doesn't save any files on your machine; you could even run it with no write access as long as the database does have it, making it easy to restore everything. Usually, the restore process should be done by restoring your MongoDB database and following the self-hosting steps above.

To-Do