Releases: shlinkio/shlink
v1.16.0
Added
-
#304 Added health endpoint to check healthiness of the service. Useful in container-based infrastructures.
Call [GET /rest/health] in order to get a response like this:
HTTP/1.1 200 OK Content-Type: application/health+json Content-Length: 681 { "status": "pass", "version": "1.16.0", "links": { "about": "https://shlink.io", "project": "https://github.com/shlinkio/shlink" } }
The status code can be
200 OK
in case of success or503 Service Unavailable
in case of error, while thestatus
property will be one ofpass
orfail
, as defined in the Health check RFC. -
#279 Added new
findIfExists
flag to the[POST /short-url]
REST endpoint and theshort-urls:generate
CLI command. It can be used to return existing short URLs when found, instead of creating new ones.Thanks to this flag you won't need to remember if you created a short URL for a long one. It will just create it if needed or return the existing one if possible.
The behavior might be a little bit counterintuitive when combined with other params. This is how the endpoint behaves when providing this new flag:
- Only the long URL is provided: It will return the newest match or create a new short URL if none is found.
- Long url and custom slug are provided: It will return the short URL when both params match, return an error when the slug is in use for another long URL, or create a new short URL otherwise.
- Any of the above but including other params (tags, validSince, validUntil, maxVisits): It will behave the same as the previous two cases, but it will try to exactly match existing results using all the params. If any of them does not match, it will try to create a new short URL.
-
#336 Added an API test suite which performs API calls to an actual instance of the web service.
Changed
- #342 The installer no longer asks for a charset to be provided, and instead, it shuffles the base62 charset.
- #320 Replaced query builder by plain DQL for all queries which do not need to be dynamically generated.
- #330 No longer allow failures on PHP 7.3 envs during project CI build.
- #335 Renamed functional test suite to database test suite, since that better describes what it actually does.
- #346 Extracted installer as an independent tool.
- #261 Increased mutation score to 70%.
Deprecated
- #351 Deprecated
config:generate-charset
andconfig:generate-secret
CLI commands.
Removed
- Nothing
Fixed
v1.15.1
Added
- #162 Added non-rest endpoints to swagger definition.
Changed
- #312 Now all config files both in
php
andjson
format are loaded fromconfig/params
folder, easing users to provided customizations to docker image. - #226 Updated how table are rendered in CLI commands, making use of new features in Symfony 4.2.
- #321 Extracted entities mappings from entities to external config files.
- #308 Automated docker image building.
Deprecated
- Nothing
Removed
- #301 Removed custom
AccessLogFactory
in favor of the implementation included in zendframework/zend-expressive-swoole v2.2.0
Fixed
v1.15.0
Added
-
#208 Added initial support to run shlink using swoole, a non-blocking IO server which improves the performance of shlink from 4 to 10 times.
Run shlink with
./vendor/bin/zend-expressive-swoole start
to start-up the service, which will be exposed in port8080
.Adding the
-d
flag, it will be started as a background service. Then you can use the./vendor/bin/zend-expressive-swoole stop
command in order to stop it. -
#266 Added pagination to
GET /short-urls/{shortCode}/visits
endpoint.In order to make it backwards compatible, it keeps returning all visits by default, but it now allows to provide the
page
anditemsPerPage
query parameters in order to configure the number of items to get.
Changed
- #267 API responses and the CLI interface is no longer translated and uses english always. Only not found error templates are still translated.
- #289 Extracted coding standard rules to a separated package.
- #273 Improved code coverage in repository classes.
Deprecated
- Nothing
Removed
- Nothing
Fixed
v1.14.1
Added
- Nothing
Changed
- #260 Increased mutation score to 65%.
Deprecated
- Nothing
Removed
- Nothing
Fixed
v1.14.0
Added
-
#236 Added option to define a redirection to a custom URL when a user hits an invalid short URL.
It only affects URLs matched as "short URL" where the short code is invalid, not any 404 that happens in the app. For example, a request to the path
/foo/bar
will keep returning a 404.This new option will be asked by the installer both for new shlink installations and for any previous shlink version which is updated.
-
#189 and #240 Added new GeoLite2-based geolocation service which is faster and more reliable than previous one.
It does not have API limit problems, since it uses a local database file.
Previous service is still used as a fallback in case GeoLite DB does not contain any IP address.
Changed
- #241 Fixed columns in
visit_locations
table, to be snake_case instead of camelCase. - #228 Updated how exceptions are serialized into logs, by using monlog's
PsrLogMessageProcessor
. - #225 Performance and maintainability slightly improved by enforcing via code sniffer that all global namespace classes, functions and constants are explicitly imported.
- #196 Reduced anemic model in entities, defining more expressive public APIs instead.
- #249 Added functional-php to ease collections handling.
- #253 Increased
user_agent
column length invisits
table to 512. - #256 Updated to Infection v0.11.
- #202 Added missing response examples to OpenAPI docs.
Deprecated
- Nothing
Removed
- Nothing
Fixed
- #223 Fixed PHPStan errors produced with symfony/console 4.1.5
v1.13.2
Added
- #233 Added PHP 7.3 to build matrix allowing its failure.
Changed
- #235 Improved update instructions (thanks to tivyhosting).
Deprecated
- Nothing
Removed
- Nothing
Fixed
-
#237 Solved errors when trying to geo-locate
null
IP addresses.Also improved how visitor IP addresses are discovered, thanks to akrabat/ip-address-middleware package.
v1.13.1
v1.13.0
Added
-
#197 Added cakephp/chronos library for date manipulations.
-
#214 Improved build script, which allows builds to be done without "jumping" outside the project directory, and generates smaller dist files.
It also allows automating the dist file generation in travis-ci builds.
-
#207 Added two new config options which are asked during installation process. The config options already existed in previous shlink version, but you had to manually set their values.
These are the new options:
- Visits threshold to allow short URLs to be deleted.
- Check the visits threshold when trying to delete a short URL via REST API.
Changed
-
#211 Extracted installer to its own module, which will simplify moving it to a separated package in the future.
-
#200 and #201 Renamed REST Action classes and CLI Command classes to use the concept of
ShortUrl
instead of the concept ofShortCode
when referring to the entity, and left theshort code
concept to the identifier which is used as a unique code for a specificShort URL
. -
#181 When importing the configuration from a previous shlink installation, it no longer asks to import every block. Instead, it is capable of detecting only new config options introduced in the new version, and ask only for those.
If no new options are found and you have selected to import config, no further questions will be asked and shlink will just import the old config.
Deprecated
-
#205 Deprecated
[POST /authenticate]
endpoint, and allowed any API request to be automatically authenticated using theX-Api-Key
header with a valid API key.This effectively deprecates the
Authorization: Bearer <JWT>
authentication form, but it will keep working. -
As of #200 and #201 REST urls have changed from
/short-codes/...
to/short-urls/...
, and the command namespaces have changed fromshort-code:...
toshort-url:...
.In both cases, backwards compatibility has been retained and the old ones are aliases for the new ones, but the old ones are considered deprecated.
Removed
- Nothing
Fixed
v1.12.0
Added
-
#187 Included an API endpoint and a CLI command to delete short URLs.
Due to the implicit danger of this operation, the deletion includes a safety check. URLs cannot be deleted if they have more than a specific amount of visits.
The visits threshold is set to 15 by default and currently it has to be manually changed. In future versions the installation/update process will ask you about the value of the visits threshold.
In order to change it, open the
config/autoload/delete_short_urls.global.php
file, which has this structure:return [ 'delete_short_urls' => [ 'visits_threshold' => 15, 'check_visits_threshold' => true, ], ];
Properties are self explanatory. Change
check_visits_threshold
tofalse
to completely disable this safety check, and change the value ofvisits_threshold
to allow short URLs with a different number of visits to be deleted.Once changed, delete the
data/cache/app_config.php
file (if any) to let shlink know about the new values.This check is implicit for the API endpoint, but can be "disabled" for the CLI command, which will ask you when trying to delete a URL which has reached to threshold in order to force the deletion.
-
#183 and #190 Included important documentation improvements in the repository itself. You no longer need to go to the website in order to see how to install or use shlink.
-
#186 Added a small robots.txt file that prevents 404 errors to be logged due to search engines trying to index the domain where shlink is located. Thanks to @robwent for the contribution.
Changed
-
#145 Shlink now obfuscates IP addresses from visitors by replacing the latest octet by
0
, which does not affect geolocation and allows it to fulfil the GDPR.Other known services follow this same approach, like Google Analytics or Matomo
-
#182 The short URL creation API endpoints now return the same model used for lists and details endpoints.
Deprecated
- Nothing
Removed
- Nothing
Fixed
- #188 Shlink now allows multiple short URLs to be created that resolve to the same long URL.
v1.11.0
Added
-
#170 and #171 Updated
[GET /short-codes]
and[GET /short-codes/{shortCode}]
endpoints to return more meaningful information and make their response consistent.The short URLs are now represented by this object in both cases:
{ "shortCode": "12Kb3", "shortUrl": "https://doma.in/12Kb3", "longUrl": "https://shlink.io", "dateCreated": "2016-05-01T20:34:16+02:00", "visitsCount": 1029, "tags": [ "shlink" ], "originalUrl": "https://shlink.io" }
The
originalUrl
property is considered deprecated and has been kept for backward compatibility purposes. It holds the same value as thelongUrl
property.
Changed
- Nothing
Deprecated
- The
originalUrl
property in[GET /short-codes]
and[GET /short-codes/{shortCode}]
endpoints is now deprecated and replaced by thelongUrl
property.
Removed
- Nothing
Fixed
- Nothing