A minimal URL shortener written in Rust
Go to file
tarneo 24b32edf0c
Use podman instead of docker for publishing
2023-12-29 12:42:49 +01:00
src fix: add address to config and default to 0.0.0.0 2023-07-10 15:55:04 +02:00
.dockerignore Add .dockerignore to prevent copying target/ 2023-07-10 19:39:51 +02:00
.gitignore First working version 2023-06-22 16:42:57 +02:00
Cargo.lock Use podman instead of docker for publishing 2023-12-29 12:42:49 +01:00
Cargo.toml Use podman instead of docker for publishing 2023-12-29 12:42:49 +01:00
Dockerfile Add Dockerfile, docker-compose and example config 2023-07-10 16:11:40 +02:00
LICENSE Add LICENSE 2023-06-29 12:39:33 +02:00
README.md fix(README): absolute docker-compose.yml link 2023-07-11 10:53:12 +02:00
config.yml Add Dockerfile, docker-compose and example config 2023-07-10 16:11:40 +02:00
docker-compose.yml Add docker instructions to README 2023-07-11 10:44:47 +02:00
publish.sh Use podman instead of docker for publishing 2023-12-29 12:42:49 +01:00

README.md

Shlonk - A simple, fast, URL shortener

Shlink is another self-hosted URL shortener. Though it does too much: it has a REST API, a web GUI, and many other features you are probably never going to use.

Shlonk tries to do only one thing, redirect clients to other sites, and does it well with its Yaml configuration file. Here's an example:

urls:
  home: # /home redirects to...
    url: https://git.renn.es/shlonk
  example: # /example redirects to...
    url: https://example.com/
    permanent: true
port: 8080 # Default value
address: 0.0.0.0 # Default value

To launch Shlonk, write this config to a file, say config.yml, and then run:

shlonk -c ./config.yml

That's it. That's the documentation for Shlonk. And guess what: the code is less than 200 lines long.

Installation

Cargo:

cargo install shlonk

Docker installation

See the example docker-compose.

Why the name?

It is a variation on Shlink, and here is a definition from the urban dictionary:

V. To do anything.

Shlonking is a lifestyle choice, a way to express how much better you are than any person who doesn't shlonk the same way you do. Use it as a replacement for any verb in the hopes that more individuals realize the importance of gang shlonk.

I just had to choose that name.