feat(shlink) Added Shlink app
This commit is contained in:
parent
07e6054513
commit
1ba681e6af
|
@ -141,6 +141,7 @@ This is the official repository for the Tipi App Store. It contains all the apps
|
|||
- [SearXNG](https://github.com/searxng/searxng) - SearXNG is a free internet metasearch engine which aggregates results from various search services and databases. Users are neither tracked nor profiled
|
||||
- [Send](https://gitlab.com/timvisee/send) - Simple, private file sharing
|
||||
- [Serge](https://github.com/serge-chat/serge) - A web interface for chatting with Alpaca through llama.cpp.
|
||||
- [Shlink](https://shlink.io/) - API first URL shortener
|
||||
- [SimpleX SMP](https://github.com/simplex-chat/simplexmq) - A reference implementation of the SimpleX Messaging Protocol for simplex queues over public networks.
|
||||
- [Sonarr](https://github.com/Sonarr/Sonarr) - TV show manager for Usenet and BitTorrent
|
||||
- [Speedtest Tracker](https://github.com/alexjustesen/speedtest-tracker) - Internet performance tracking application.
|
||||
|
|
24
apps/shlink/config.json
Normal file
24
apps/shlink/config.json
Normal file
|
@ -0,0 +1,24 @@
|
|||
{
|
||||
"$schema": "../schema.json",
|
||||
"name": "Shlink",
|
||||
"available": true,
|
||||
"exposable": true,
|
||||
"force_expose": true,
|
||||
"port": 8207,
|
||||
"id": "shlink",
|
||||
"tipi_version": 1,
|
||||
"version": "3.7.0",
|
||||
"categories": [
|
||||
"utilities"
|
||||
],
|
||||
"description": "Shlink is a self-hosted URL shortener which provides both a REST and a CLI interface to interact with it.",
|
||||
"short_desc": "Shlink is a self-hosted URL shortener",
|
||||
"author": "https://shlink.io/",
|
||||
"source": "https://github.com/shlinkio/shlink",
|
||||
"website": "https://shlink.io/",
|
||||
"form_fields": [],
|
||||
"supported_architectures": [
|
||||
"arm64",
|
||||
"amd64"
|
||||
]
|
||||
}
|
58
apps/shlink/docker-compose.yml
Normal file
58
apps/shlink/docker-compose.yml
Normal file
|
@ -0,0 +1,58 @@
|
|||
version: "3.9"
|
||||
services:
|
||||
shlink:
|
||||
container_name: shlink
|
||||
image: ghcr.io/shlinkio/shlink:3.7
|
||||
environment:
|
||||
- DEFAULT_DOMAIN=${APP_DOMAIN}
|
||||
- IS_HTTPS_ENABLED=true
|
||||
- DB_DRIVER=postgres
|
||||
- DB_HOST=shlink-db
|
||||
- DB_NAME=shlink
|
||||
- DB_USER=shlink
|
||||
- DB_PASSWORD=shlink
|
||||
ports:
|
||||
- ${APP_PORT}:8080
|
||||
restart: unless-stopped
|
||||
depends_on:
|
||||
- shlink-db
|
||||
volumes: []
|
||||
networks:
|
||||
- tipi_main_network
|
||||
labels:
|
||||
# Main
|
||||
traefik.enable: true
|
||||
traefik.http.middlewares.shlink-web-redirect.redirectscheme.scheme: https
|
||||
traefik.http.services.shlink.loadbalancer.server.port: 8080
|
||||
# Web
|
||||
traefik.http.routers.shlink-insecure.rule: Host(`${APP_DOMAIN}`)
|
||||
traefik.http.routers.shlink-insecure.entrypoints: web
|
||||
traefik.http.routers.shlink-insecure.service: shlink
|
||||
traefik.http.routers.shlink-insecure.middlewares: shlink-web-redirect
|
||||
# Websecure
|
||||
traefik.http.routers.shlink.rule: Host(`${APP_DOMAIN}`)
|
||||
traefik.http.routers.shlink.entrypoints: websecure
|
||||
traefik.http.routers.shlink.service: shlink
|
||||
traefik.http.routers.shlink.tls.certresolver: myresolver
|
||||
# Local domain
|
||||
traefik.http.routers.shlink-local-insecure.rule: Host(`shlink.${LOCAL_DOMAIN}`)
|
||||
traefik.http.routers.shlink-local-insecure.entrypoints: web
|
||||
traefik.http.routers.shlink-local-insecure.service: shlink
|
||||
traefik.http.routers.shlink-local-insecure.middlewares: shlink-web-redirect
|
||||
# Local domain secure
|
||||
traefik.http.routers.shlink-local.rule: Host(`shlink.${LOCAL_DOMAIN}`)
|
||||
traefik.http.routers.shlink-local.entrypoints: websecure
|
||||
traefik.http.routers.shlink-local.service: shlink
|
||||
traefik.http.routers.shlink-local.tls: true
|
||||
shlink-db:
|
||||
container_name: shlink-db
|
||||
image: docker.io/library/postgres:16.1-alpine
|
||||
restart: unless-stopped
|
||||
networks:
|
||||
- tipi_main_network
|
||||
volumes:
|
||||
- ${APP_DATA_DIR}/data/db:/var/lib/postgresql/data
|
||||
environment:
|
||||
- POSTGRES_PASSWORD=shlink
|
||||
- POSTGRES_USER=shlink
|
||||
- POSTGRES_DB=shlink
|
25
apps/shlink/metadata/description.md
Normal file
25
apps/shlink/metadata/description.md
Normal file
|
@ -0,0 +1,25 @@
|
|||
# Shlink
|
||||
|
||||
Shlink is a fast self-hosted URL shortener that offers a RESTful API and a command line interface. Your shortened links are also safely manageable through [app.shlink.io](https://app.shlink.io) which is 100% browser based. Notable features include custom slugs, click tracking, and tag management.
|
||||
|
||||
Please note that the following advanced features are not activated through this Tipi App:
|
||||
* Multi-domain support
|
||||
* Geo-Localisation
|
||||
* RabbitMQ/Mercure real-time updates
|
||||
|
||||
During the installation process, you will be prompted to specify the domain for your shortened URLs.
|
||||
|
||||
## ℹ️ Required post installation step
|
||||
After installing Shlink in Tipi, you will have to generate a API Key before being able to use the service through the following command.
|
||||
```bash
|
||||
docker exec -it shlink shlink api-key:generate
|
||||
```
|
||||
|
||||
Keep your API Key secure, as it is essential for link administration. If you lose the key, rerun the command to generate a new one.
|
||||
|
||||
If you don't have access to the console of your Tipi server, consider using Portainer which is available on Tipi. Within Portainer, you would have to:
|
||||
* Select the local environment
|
||||
* Select the shlink container - not the shlink-db -
|
||||
* Click on Console within the "Container Status" panel
|
||||
* Execute a /bin/sh command
|
||||
* Within the newly opened terminal, enter `shlink api-key:generate`
|
BIN
apps/shlink/metadata/logo.jpg
Normal file
BIN
apps/shlink/metadata/logo.jpg
Normal file
Binary file not shown.
After Width: | Height: | Size: 26 KiB |
Loading…
Reference in New Issue
Block a user