Descargar shlink - Descarga del código fuente de shlink

enlace

Otro código fuente

v4.2.5

Descargar

Un acortador de URL autohospedado basado en PHP que se puede utilizar para ofrecer URL acortadas bajo su propio dominio.

Tabla de contenido

Documentación completa
imagen acoplable
Autohospedado
- Descargar
- Configurar
usando enlace shlink
Contribuyendo

Documentación completa

Este documento contiene los conceptos básicos para comenzar con Shlink. Si desea saber todo lo que puede hacer con él, visite la documentación completa con capacidad de búsqueda.

imagen acoplable

Puede aprender a utilizar la imagen oficial de Docker leyendo los documentos.

La idea es que puedas generar un contenedor usando la imagen y proporcionar la configuración personalizada a través de env vars.

Autohospedado

Primero, asegúrese de que el host donde va a ejecutar shlink cumpla con estos requisitos:

PHP 8.2 o 8.3
Las siguientes extensiones PHP: json, curl, pdo, intl, gd y gmp/bcmath.
- Se recomienda la extensión apcu si no planea utilizar RoadRunner.
- Se requiere la extensión xml si desea generar códigos QR en formato svg.
- Se requieren sockets y extensiones bcmath si desea realizar la integración con una instancia de RabbitMQ.
MySQL, MariaDB, PostgreSQL, MicrosoftSQL o SQLite.
- También necesitará la variación de pdo correspondiente para la base de datos que planea usar: pdo_mysql , pdo_pgsql , pdo_sqlsrv o pdo_sqlite .

Descargar

Para ejecutar Shlink, necesitará una versión compilada del proyecto. Hay dos formas de conseguirlo.

Usando un archivo dist
La forma más sencilla de instalar shlink es utilizando uno de los paquetes distribuibles incluidos previamente.
Vaya a la última versión y descargue el archivo shlink*_dist.zip que se adapte a sus necesidades. Encontrará uno para cada versión de PHP compatible.
Finalmente, descomprime el archivo en la ubicación que elijas.
Construyendo a partir de fuentes
Si por algún motivo desea crear el proyecto usted mismo, siga estos pasos:
- Clona el proyecto con git ( git clone https://github.com/shlinkio/shlink.git ), o descárgalo haciendo clic en el botón verde Clonar o descargar .
- Descargue el administrador de paquetes PHP de Composer dentro de la carpeta del proyecto.
- Ejecute ./build.sh 3.0.0 , reemplazando la versión con el número de versión que va a compilar (el número de versión se usa como parte del nombre del archivo dist generado y para establecer el valor devuelto al ejecutar shlink -V desde el línea de comando).
Después de eso, tendrá un archivo dist dentro del directorio build , que deberá descomprimir en la ubicación que elija.
Nota
Este es el proceso que se utiliza al lanzar nuevas versiones de Shlink. Después de etiquetar la nueva versión con git, un flujo de trabajo de GitHub crea automáticamente la versión de GitHub, adjuntándole el archivo dist generado.

Configurar

Independientemente de cómo haya creado el proyecto, ahora necesita configurarlo siguiendo estos pasos:

Si vas a utilizar MySQL, MariaDB, PostgreSQL o Microsoft SQL Server, crea una base de datos vacía con el nombre de tu elección.
Otorgue permisos de escritura de forma recursiva al directorio data . Shlink lo usa para almacenar en caché cierta información.
Configure la aplicación ejecutando el script vendor/bin/shlink-installer install . Es una herramienta de línea de comandos que lo guiará a través del proceso de instalación. Tenga en cuenta que esta herramienta debe ejecutarse directamente en el servidor donde planea alojar Shlink. No lo ejecute antes de cargarlo o moverlo allí.
Genere su primera clave API ejecutando bin/cli api-key:generate . Necesitará la clave para interactuar con la API de Shlink.

usando enlace shlink

Una vez instalado shlink, hay dos formas principales de interactuar con él:

La línea de comando : intente ejecutar bin/cli para ver todos los comandos disponibles.
Todos ellos se pueden ejecutar con el indicador --help / -h para ver cómo usarlos y todas las opciones disponibles.
Probablemente sea una buena idea vincular simbólicamente el punto de entrada CLI ( bin/cli ) a algún lugar de su ruta, para que pueda ejecutar shlink desde cualquier directorio.
La API REST : los documentos completos sobre cómo usar la API se pueden encontrar aquí, y se puede encontrar una zona de pruebas que también documenta cada punto final en el portal de especificaciones de API.
Sin embargo, probablemente no quieras consumir la API sin formato tú mismo. Es por eso que se proporciona un buen cliente web que puede usar directamente desde https://app.shlink.io o hospedarlo usted mismo.

Tanto la API como la CLI le permiten realizar prácticamente las mismas operaciones, excepto la administración de claves API, que se puede realizar únicamente desde la interfaz de línea de comandos.