Download the PHP package shlinkio/shlink without Composer
On this page you can find all versions of the php package shlinkio/shlink. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shlinkio/shlink
More information about shlinkio/shlink
Files in shlinkio/shlink
Package shlink
Short Description A self-hosted and PHP-based URL shortener application with CLI and REST interfaces
License MIT
Homepage https://shlink.io
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package shlink
A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own domain.
Table of Contents
- Full documentation
- Docker image
- Self-hosted
- Download
- Configure
- Using shlink
- Contributing
Full documentation
This document contains the very basics to get started with Shlink. If you want to learn everything you can do with it, visit the full searchable documentation.
Docker image
You can learn how to use the official docker image by reading the docs.
The idea is that you can just generate a container using the image and provide the custom config via env vars.
Self-hosted
First, make sure the host where you are going to run shlink fulfills these requirements:
- PHP 8.2 or 8.3
- The next PHP extensions: json, curl, pdo, intl, gd and gmp/bcmath.
- apcu extension is recommended if you don't plan to use RoadRunner.
- xml extension is required if you want to generate QR codes in svg format.
- sockets and bcmath extensions are required if you want to integrate with a RabbitMQ instance.
- MySQL, MariaDB, PostgreSQL, MicrosoftSQL or SQLite.
- You will also need the corresponding pdo variation for the database you are planning to use:
pdo_mysql,pdo_pgsql,pdo_sqlsrvorpdo_sqlite.
- You will also need the corresponding pdo variation for the database you are planning to use:
Download
In order to run Shlink, you will need a built version of the project. There are two ways to get it.
-
Using a dist file
The easiest way to install shlink is by using one of the pre-bundled distributable packages.
Go to the latest version and download the
shlink*_dist.zipfile that suits your needs. You will find one for every supported PHP version.Finally, decompress the file in the location of your choice.
-
Building from sources
If for any reason you want to build the project yourself, follow these steps:
- Clone the project with git (
git clone https://github.com/shlinkio/shlink.git), or download it by clicking the Clone or download green button. - Download the Composer PHP package manager inside the project folder.
- Run
./build.sh 3.0.0, replacing the version with the version number you are going to build (the version number is used as part of the generated dist file name, and to set the value returned when runningshlink -Vfrom the command line).
After that, you will have a dist file inside the
builddirectory, that you need to decompress in the location of your choice.Note
This is the process used when releasing new Shlink versions. After tagging the new version with git, the GitHub release is automatically created by a GitHub workflow, attaching the generated dist file to it.
- Clone the project with git (
Configure
Despite how you built the project, you now need to configure it, by following these steps:
- If you are going to use MySQL, MariaDB, PostgreSQL or Microsoft SQL Server, create an empty database with the name of your choice.
- Recursively grant write permissions to the
datadirectory. Shlink uses it to cache some information. - Set up the application by running the
vendor/bin/shlink-installer installscript. It is a command line tool that will guide you through the installation process. Take into account that this tool has to be run directly on the server where you plan to host Shlink. Do not run it before uploading/moving it there. - Generate your first API key by running
bin/cli api-key:generate. You will need the key in order to interact with Shlink's API.
Using shlink
Once shlink is installed, there are two main ways to interact with it:
-
The command line: Try running
bin/clito see all the available commands.All of them can be run with the
--help/-hflag in order to see how to use them and all the available options.It is probably a good idea to symlink the CLI entry point (
bin/cli) to somewhere in your path, so that you can run shlink from any directory. -
The REST API: The complete docs on how to use the API can be found here, and a sandbox which also documents every endpoint can be found in the API Spec portal.
However, you probably don't want to consume the raw API yourself. That's why a nice web client is provided that can be directly used from https://app.shlink.io, or hosted by yourself.
Both the API and CLI allow you to do mostly the same operations, except for API key management, which can be done from the command line interface only.
Contributing
If you are trying to find out how to run the project in development mode or how to provide contributions, read the CONTRIBUTING doc.
This product includes GeoLite2 data created by MaxMind, available from https://www.maxmind.com
All versions of shlink with dependencies
ext-curl Version *
ext-gd Version *
ext-json Version *
ext-pdo Version *
akrabat/ip-address-middleware Version ^2.1
cakephp/chronos Version ^3.0.2
doctrine/dbal Version ^4.0
doctrine/migrations Version ^3.6
doctrine/orm Version ^3.0
endroid/qr-code Version ^5.0
friendsofphp/proxy-manager-lts Version ^1.0
geoip2/geoip2 Version ^3.0
guzzlehttp/guzzle Version ^7.5
jaybizzle/crawler-detect Version ^1.2.116
laminas/laminas-config Version ^3.8
laminas/laminas-config-aggregator Version ^1.13
laminas/laminas-diactoros Version ^3.3
laminas/laminas-inputfilter Version ^2.27
laminas/laminas-servicemanager Version ^3.21
laminas/laminas-stdlib Version ^3.17
matomo/matomo-php-tracker Version ^3.2
mezzio/mezzio Version ^3.17
mezzio/mezzio-fastroute Version ^3.11
mezzio/mezzio-problem-details Version ^1.13
mlocati/ip-lib Version ^1.18
mobiledetect/mobiledetectlib Version ^4.8
pagerfanta/core Version ^3.8
pugx/shortid-php Version ^1.1
ramsey/uuid Version ^4.7
shlinkio/doctrine-specification Version ^2.1.1
shlinkio/shlink-common Version ^6.0
shlinkio/shlink-config Version ^3.0
shlinkio/shlink-event-dispatcher Version ^4.0
shlinkio/shlink-importer Version ^5.3
shlinkio/shlink-installer Version ^9.0
shlinkio/shlink-ip-geolocation Version ^4.0
shlinkio/shlink-json Version ^1.1
spiral/roadrunner Version ^2023.3
spiral/roadrunner-cli Version ^2.6
spiral/roadrunner-http Version ^3.3
spiral/roadrunner-jobs Version ^4.3
symfony/console Version ^7.0
symfony/filesystem Version ^7.0
symfony/lock Version ^7.0
symfony/process Version ^7.0
symfony/string Version ^7.0