# shlink

> Shlink is a self-hosted url shortner.

<!-- metadata -->

* **Category**: Apps
* **Status**: 2
* **Image**: [`shlink`](https://hub.docker.com/r/shlink), 4, upstream
* **Healthcheck**: No
* **Backups**: Yes
* **Email**: No
* **Tests**: No
* **SSO**: No
* **Maintainers**: [@Zigzagill](https://git.coopcloud.tech/Zigzagill), [@ammaratef45](https://git.coopcloud.tech/ammaratef45)

<!-- endmetadata -->

## Quick start

* `abra app new shlink`
* `abra app deploy <app-name>`
* `abra app run <app-name> app sh`
* `bin/cli short-url:create`

For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).

## Using the console

The recipe will deploy a `console.<app-name>` as well that you can use to manage and monitor short urls.

To do so, you will need an api-key, which you can create by using the `./bin/cli api-key:generate`.