Skip to content

Latest commit

 

History

History
52 lines (27 loc) · 1.68 KB

README.md

File metadata and controls

52 lines (27 loc) · 1.68 KB

Lstu

What does Lstu mean?

It means Let's Shorten That Url.

License

Lstu is licensed under the terms of the WTFPL. See the LICENSE file.

Installation

Please, see the wiki.

Or you can see usage with Docker.

How many URLs can it handle ?

By default, there are 8 361 453 672 available combinations.

I think the sqlite db will explode before you reach this limit, but you can use PostgreSQL or MySQL as database instead of SQLite.

If you want more shortened URLs than that, open lstu.conf and change the length setting.

Every time somebody uses Lstu, it will create 'waiting' shortened URLs codes in order to be quick to shorten the URLs.

Accordingly to the lstu.conf configuration file, it will create provisioning waiting URLs, adding them provis_step by provis_step.

Official instance

You can see it working and use it at https://lstu.fr.

API

See https://lstu.fr/api. Your instance will provide the same page with your URL.

Contributing

See the contributing guidelines.

Other projects dependencies

Lstu is written in Perl with the Mojolicious framework and uses Milligram CSS framework to look not too ugly.

Authors

See the AUTHORS.md file.

Deploy Lstu

An ansible role and a terraform plan reside under the .provision directory. An user could utilize the terraform plan if they chose to deploy lstu on AWS, if that's not the goal, they could simply execute the ansible role in part. Usage docs for both are present in their respective directories.