12abcloud/tiny-link-rust repository overview

⁠tiny-link-rust

Tiny-link-rust is a fast and private URL shortner written in rust with several different ways to shorten any URL. It is available as Firefox and Chrome Plugin.  

⁠Pre requirements

For hosting your own tiny-link instance you only need docker installed. Here you find a short documentation how to install docker⁠.

⁠How to run

⁠Docker run

To persist the shortened links we mount the path where the links are saved to our local file system(with -v ).

docker run -d -p 8080:8080 -v /data/tiny-link:/var/lib/tiny-link/ 12abcloud/tiny-link-rust

⁠API calls

Checkout the swagger documentation as well https://app.swaggerhub.com/apis-docs/aeggerd/tiny-link-rust/1.5.0#/⁠

⁠Create short URL

curl -X POST \
  -H "Content-Type: application/json" \
  http://localhost:8080/create \
  -d '{"longurl":"https://example.com","duration":"1Y10m","selfdestruct":true}'

http://localhost:8080/l/e4f-e8

⁠Open short URL

curl -X GET \
  http://localhost:8080/l/526-e

⁠Delete short URL

curl -X DELETE \
  http://localhost:8080/l/526-e

⁠Environment variables

Environment variables can get set with the -e parameter, like docker run -e APP_DEBUG=true 12abcloud/tiny-link-rust

⁠HTTP status codes/methodes

⁠How to use your own Server

⁠Browser plugin

1. Install the latest Browser Plug-in

⁠  
2. Open the Plug-in Settings  
3. Enter your endpoint (e.g. https://example.com/create⁠) and hit Save