# Shlink — self-hosted URL shortener

Deployed on [Coolify](https://coolify.io) via Docker Compose.

## Coolify setup

1. Create a new resource → **Docker Compose** → point to this repo.
2. In the Coolify environment variables UI, set the values from `.env.example`:
   - `DEFAULT_DOMAIN` — your short URL domain (e.g. `s.example.com`)
   - `DB_PASSWORD` — strong random password
   - `INITIAL_API_KEY` — initial API key (`openssl rand -hex 32`)
   - `TIMEZONE` — your timezone
3. In the resource's **Domains** settings, enter your domain with the container port appended: `https://s.example.com:8080`
4. Deploy.

## Shlink Web UI

Optionally connect [shlink-web-client](https://app.shlink.io) to your instance using your domain and API key.