Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ldidry/lstu

Lightweight URL shortener. Read-only mirror of https://framagit.org/fiat-tux/hat-softwares/lstu
https://github.com/ldidry/lstu

Last synced: 7 days ago
JSON representation

Lightweight URL shortener. Read-only mirror of https://framagit.org/fiat-tux/hat-softwares/lstu

Awesome Lists containing this project

README

        

# 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](https://framagit.org/fiat-tux/hat-softwares/lstu/wikis/home).

Or you can see [usage with Docker](https://framagit.org/fiat-tux/hat-softwares/lstu/wikis/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 .

## API

See .
Your instance will provide the same page with your URL.

## Contributing

See the [contributing guidelines](CONTRIBUTING.md).

## Other projects dependencies

Lstu is written in Perl with the Mojolicious framework and uses [Milligram](https://milligram.io/) CSS framework to look not too ugly.

## Authors

See the [AUTHORS.md](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.