README.md 1.33 KB
Newer Older
1
# Lstu
Luc Didry's avatar
Luc Didry committed
2

Luc Didry's avatar
Luc Didry committed
3
## What does Lstu mean?
Luc Didry's avatar
Luc Didry committed
4 5 6

It means Let's Shorten That Url.

Luc Didry's avatar
Luc Didry committed
7
## License
Luc Didry's avatar
Luc Didry committed
8

9
Lstu is licensed under the terms of the WTFPL. See the LICENSE file.
Luc Didry's avatar
Luc Didry committed
10

Luc Didry's avatar
Luc Didry committed
11
## Installation
12

13
Please, see the [wiki](https://framagit.org/luc/lstu/wikis/home).
Luc Didry's avatar
Luc Didry committed
14

Arnaud de Mouhy's avatar
Arnaud de Mouhy committed
15 16
Or you can see [usage with Docker](https://framagit.org/luc/lstu/wikis/usage-with-docker).

17
## How many URLs can it handle ?
18

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

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

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

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

Luc Didry's avatar
Luc Didry committed
27 28
Accordingly to the `lstu.conf` configuration file, it will create `provisioning` waiting URLs, adding them `provis_step` by `provis_step`.

Luc Didry's avatar
Luc Didry committed
29
## Official instance
Luc Didry's avatar
Luc Didry committed
30

31
You can see it working and use it at <https://lstu.fr>.
Luc Didry's avatar
Luc Didry committed
32

Luc Didry's avatar
Luc Didry committed
33
## API
Luc Didry's avatar
Luc Didry committed
34

35 36
See <https://lstu.fr/api>.
Your instance will provide the same page with your URL.
Luc Didry's avatar
Luc Didry committed
37

Luc Didry's avatar
Luc Didry committed
38 39 40 41
## Contributing

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

Luc Didry's avatar
Luc Didry committed
42
## Other projects dependencies
Luc Didry's avatar
Luc Didry committed
43

44
Lstu is written in Perl with the Mojolicious framework and uses [Milligram](https://milligram.io/) CSS framework to look not too ugly.
Luc Didry's avatar
Luc Didry committed
45 46 47 48

## Authors

See the [AUTHORS.md](AUTHORS.md) file.