OilfieldToolsNet/shlink
4
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2024-12-23 07:33:58 -06:00
Code Issues Packages Projects Releases Wiki Activity
The definitive self-hosted URL shortener
2,689 Commits 5 Branches 137 Tags 43 MiB
PHP 99.2%
Dockerfile 0.4%
Shell 0.3%
HTML 0.1%
3ffe530461
Go to file
Alejandro Celaya 3ffe530461 Updated changelog
2021-10-08 18:52:53 +02:00
.github Fixed typo in ci workflow 2021-09-26 10:20:09 +02:00
bin Added phpstan-symfony plugin to improve inspections on getArgument and getOption 2021-07-19 20:00:53 +02:00
config Added support to provide redis sentinel when using redis cache 2021-10-08 18:52:17 +02:00
data Added forwardQuery property in short URLs, that determines if the query should be forwarded to the long URL 2021-10-02 09:32:04 +02:00
docker Deprecated SHORT_DOMAIN_* env vars with replacements 2021-09-26 09:10:54 +02:00
docs Added forwardQuery prop to the SHortUrl serialization 2021-10-02 10:31:23 +02:00
module Ensured NotFoundRedirectResolver replaces placeholders from the URL 2021-10-03 16:45:13 +02:00
public Added phpstan-symfony plugin to improve inspections on getArgument and getOption 2021-07-19 20:00:53 +02:00
.dockerignore Updated docker entry point so that it tries to download the GeoLite2 db file when the license key was provided 2021-04-08 14:32:19 +02:00
.gitattributes Replaced scrutinizer with codecov 2020-12-19 10:25:19 +01:00
.gitignore Ensured events triggered as a result of a new visit are never skipped 2021-04-08 14:09:26 +02:00
.phpstorm.meta.php Project migrated from zend to laminas 2020-01-01 21:13:09 +01:00
build.sh Updated build script so that it allows building a dist file for non-swoole envs 2021-02-13 12:56:41 +01:00
CHANGELOG.md Updated changelog 2021-10-08 18:52:53 +02:00
composer.json Added support to provide redis sentinel when using redis cache 2021-10-08 18:52:17 +02:00
CONTRIBUTING.md Update CONTRIBUTING.md 2021-06-13 22:24:20 +08:00
docker-compose.ci.yml Moved initial ci databases to specific docker-compose file 2020-05-04 21:00:09 +02:00
docker-compose.override.yml.dist Added mariadb container for development environment 2019-10-06 11:21:41 +02:00
docker-compose.yml Updated to shlink-event-dispatcher 2.1 2021-02-13 11:39:51 +01:00
Dockerfile Downgraded pdo_sqlsrv version for PHP 8.0 2021-09-26 10:19:26 +02:00
indocker Removed custom AccessLogFactory by updating to zend-expressive-swoole 2.2 2018-12-05 21:26:19 +01:00
infection-db.json Applied API role specs to single short URL edition 2021-01-03 16:41:44 +01:00
infection.json Applied API role specs to single short URL edition 2021-01-03 16:41:44 +01:00
LICENSE Updated year in license 2021-02-13 09:38:34 +01:00
migrations.php Removed commented migrations option 2020-06-23 19:23:33 +02:00
phpcs.xml Added all docker stuff to the project 2019-08-16 18:38:26 +02:00
phpstan.neon Installed phpstan-dcotrine and fixed more static analysis errors 2021-07-20 13:29:50 +02:00
phpunit-api.xml Updated link to PHPUnit's xsd to use local one 2021-01-24 22:56:43 +01:00
phpunit-db.xml Updated link to PHPUnit's xsd to use local one 2021-01-24 22:56:43 +01:00
phpunit.xml.dist Updated link to PHPUnit's xsd to use local one 2021-01-24 22:56:43 +01:00
README.md Migrated all constructor props to property promotion when possible 2021-05-23 11:57:31 +02:00
UPGRADE.md Added missing information in upgrading document 2020-01-09 07:37:59 +01:00

README.md

Shlink

Build Status Code Coverage Latest Stable Version Docker pulls License Paypal donate

A PHP-based self-hosted URL shortener that can be used to serve shortened URLs under your own custom domain.

Table of Contents

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

Starting with version 1.15.0, an official docker image is provided. You can learn how to use it 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.0
  • The next PHP extensions: json, curl, pdo, intl, gd and gmp.
    • apcu extension is recommended if you don't plan to use swoole.
    • xml extension is required if you want to generate QR codes in svg format.
  • MySQL, MariaDB, PostgreSQL, Microsoft SQL Server or SQLite.
  • The web server of your choice with PHP integration (Apache or Nginx recommended).

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.zip file that suits your needs. You will find one for every supported PHP version and with/without swoole integration.

    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 1.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 running shlink -V from the command line).

    After that, you will have a dist file inside the build directory, that you need to decompress in the location of your choice.

    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.

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 data directory. Shlink uses it to cache some information.
  • Setup the application by running the bin/install script. 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/cli and see all the available commands.

    All of those commands can be run with the --help/-h flag 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 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