Skip to content

Latest commit

 

History

History
1522 lines (1005 loc) · 23.6 KB

CHANGELOG.md

File metadata and controls

1522 lines (1005 loc) · 23.6 KB
Raw

CHANGELOG

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[7.14.1] - 2024-12-02

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Add missing mention to support on PHP 8.4

[7.14.0] - 2024-11-29

Added

  • Document robots-related env vars that were introduced in Shlink 4.2.0
  • Improve description of the dynamic redirects feature, highlighting capabilities of the rule-based redirect system.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.13.0] - 2024-11-24

Added

  • Improve documentation around API keys management, mentioning hashing and recommending the usage of names

Changed

  • Update dependencies

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.12.0] - 2024-11-14

Added

  • Document IP address and geolocation redirect rules

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.11.4] - 2024-11-01

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Update Bluesky handle

[7.11.3] - 2024-10-17

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Remove references to Twitter/X

[7.11.2] - 2024-10-16

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • RoadRunner systemd config link

[7.11.1] - 2024-10-12

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fix GeoLite2 links

[7.11.0] - 2024-10-04

Added

  • Document support for redis database index.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.10.0] - 2024-08-06

Added

  • Nothing

Changed

  • Update dependencies.

Deprecated

  • Nothing

Removed

  • Remove Google Analytics.

Fixed

  • Nothing

[7.9.0] - 2024-07-16

Added

  • Add astro-expressive-code to improve code blocks and code snippets.

Changed

  • Update to @shlinkio/eslint-config-js-coding-standard 3.0, and migrate to ESLint flat config.
  • Add eslint-plugin-astro and enable linting for .astro files.
  • Update dependencies.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.8.1] - 2024-04-26

Added

  • Nothing

Changed

  • Use new reusable workflow to build and publish docker image
  • Update dependencies

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fix documented port for shlink-web-client in one of the examples.

[7.8.0] - 2024-04-14

Added

  • Document feature from Shlink 4.1.0

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.7.2] - 2024-04-11

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fix more links to redis docs...

[7.7.1] - 2024-04-10

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fix links to redis docs

[7.7.0] - 2024-04-07

Added

  • Update to actual Bluesky logo

Changed

  • Update JS coding standard

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.6.0] - 2024-03-05

Added

  • Add JS SDK link

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.5.0] - 2024-03-04

Added

  • Update documentation to cover changes from Shlink 4.0.0

Changed

  • Update dependencies

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.4.0] - 2024-01-30

Added

  • Update documentation around shlink-web-client, to reflect changes from v4.0.0
  • #477 Add icon to external links in docs menus

Changed

  • Update other dependencies
  • Update shlink-web-client screenshots and recordings

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.3.0] - 2023-12-26

Added

  • Document QR_CODE_FOR_DISABLED_SHORT_URLS env var

Changed

  • Update other dependencies

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.2.0] - 2023-12-06

Added

  • Add link to bluesky.

Changed

  • Update to Astro 4.0
  • Update to vitest 1.0
  • Update other dependencies

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fix some accessibility issues.

[7.1.0] - 2023-11-25

Added

  • #475 Document how to integrate and send visits to Matomo.
  • Document features introduced in Shlink 3.7.0.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[7.0.3] - 2023-11-15

Added

  • Nothing

Changed

  • Update dependencies

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Improve reference to mercure info endpoint.

[7.0.2] - 2023-10-22

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fix Mercure mermaid chart by rendering it in the client, simplifying also the building process.

[7.0.1] - 2023-10-16

Added

  • Nothing

Changed

  • Update Twitter icon to X icon.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fix typo in health endpoint.
  • Fix sitemap link in robots.txt.

[7.0.0] - 2023-10-10

Added

  • Nothing

Changed

  • #421 Migrate from Next.js to Astro
  • #380 Migrate from Jest to vitest
  • Use typed.js directly and remove react-typed, as it still requires react 16.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.50.0] - 2023-09-22

Added

  • Nothing

Changed

  • Update docs around initial API key with changes introduced in Shlink v3.6.4.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.49.2] - 2023-08-03

Added

  • Nothing

Changed

  • Ignore more failing URLs from daily check.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Replace references to docker-compose with docker compose.

[6.49.1] - 2023-07-19

Added

  • Nothing

Changed

  • Display warning about servers.json for shlink-web-client at the top of the page.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fix link to Microsoft SQL Server page, using a generic one instead of Spanish one.
  • Fix cron specification.

[6.49.0] - 2023-07-09

Added

  • #354 Improve health endpoint docs.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.48.0] - 2023-06-17

Added

  • Document supported database engines.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.47.0] - 2023-05-28

Added

  • #322 Add link to PHP SDK documentation.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.46.0] - 2023-05-23

Added

  • #352 Document changes introduced in Shlink 3.6.0.

Changed

  • Update dependencies, including Next.js 13.4

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.45.0] - 2023-04-12

Added

  • Document limitation on real-time updates not dispatched when creating short URLs from CLI with openswoole.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.44.0] - 2023-04-07

Added

  • Document considerations when importing URLs.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.43.0] - 2023-03-08

Added

  • Document the best way to update multiple Shlink versions.
  • Mention the existence of INITIAL_API_KEY in the documentation about Shlink's docker image.

Changed

  • Replace references to loosely mode by loose.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.42.0] - 2023-01-28

Added

  • Documented support for short URL mode.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.41.0] - 2023-01-23

Added

  • Documented support for redirect statuses 308 and 307.
  • Documented openswoole-specific env-vars.
  • #342 Documented device-specific redirects.

Changed

  • #340 Replaced references to doma.in by s.test.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed typo

[6.40.2] - 2023-01-03

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Added missing rel="me" to mastodon link for proper verification.

[6.40.1] - 2022-12-30

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Removed hardcoded link to localhost.

[6.40.0] - 2022-12-29

Added

  • #330 Added mermaid integration to render charts and graphs. Used to illustrate the integration with mercure.
  • #332 Documented features introduced in Shlink 3.4.0.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.39.0] - 2022-11-17

Added

  • #328 Added link to mastodon profile.

Changed

  • Updated to Next 13

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.38.2] - 2022-10-27

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed Smol Links image.

[6.38.1] - 2022-10-27

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed typo when referencing to docker registries.
  • Renamed Shlinkify app to Smol Links, as it has been rebranded.

[6.38.0] - 2022-10-01

Added

  • Added Shlinkify to apps section.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Removed warning referencing the use of multi-segment slugs and trailing slashes for a situation that cannot actually happen.

[6.37.0] - 2022-09-18

Added

  • #315 Documented support for RoadRunner.
  • #316 Documented support for trailing slashes in short URLs.
  • Documented INITIAL_API_KEY env var.
  • Documented SKIP_INITIAL_GEOLITE_DOWNLOAD env var.

Changed

  • Migrated to reusable workflow to build docker image.
  • Updated dependencies.
  • Updated long-running tasks section.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.36.1] - 2022-08-17

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed references to wrong docker image names.

[6.36.0] - 2022-08-15

Added

  • Documented support on GitHub Container Registry.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.35.0] - 2022-08-04

Added

  • Documented support on redis pub/sub for real-time updates.
  • #312 Documented multi-segment custom slugs.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.34.3] - 2022-07-31

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Documented the requirement of providing the port number for redis servers.

[6.34.2] - 2022-07-25

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed strikethrough on deprecated env vars.

[6.34.1] - 2022-06-20

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • #273 Fixed screenshots for Short Menu integration.
  • Fixed dependency install in CI

[6.34.0] - 2022-05-31

Added

  • Updated CLI help description.

Changed

  • Updated dependencies, including React 18 and jest 28.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed typos on installation tool references from update instructions.

[6.33.0] - 2022-04-23

Added

  • Documented timezone env var and the recommendation to set it to the same zone where you plan to consume it.
  • Extended documentation regarding dates behavior on the API.

Changed

  • Added shlinkio coding standards, together with nextjs recommended ones.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.32.0] - 2022-03-21

Added

  • #296 Updated to fontawesome 6.1
  • #295 Updated to bootstrap 5.1
  • #291 Automated generation of sitemap and robots.txt files.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.31.0] - 2022-02-19

Added

  • #292 Added emojis to features.

Changed

  • Updated dependencies

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.30.1] - 2022-02-04

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Added missing Sitemap entries

[6.30.0] - 2022-01-31

Added

  • #283 Added warning noticing installation tool has to be run from Shlink's root folder.
  • #285 Documented deprecated webhooks.
  • #286 Grouped env vars by context, and added deep-linking to specific groups when relevant.
  • #281 Documented Shlink architecture.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.29.0] - 2022-01-30

Added

  • #278 Documented installer tool.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • #267 Fixed linting by migrating to Next.js recommended rules.
  • #279 Documented missing mention to the requirement of installing the corresponding pdo variation for the database of your choice.

[6.28.0] - 2022-01-28

Added

  • #267 Updated docs to fulfil Shlink 3.0.0.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.27.0] - 2021-12-26

Added

  • #271 Enhanced multi-domain docs explaining the steps that need to be performed outside of Shlink.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.26.2] - 2021-12-26

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • #269 Fixed link to image used when sharing on Twitter.

[6.26.1] - 2021-12-21

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed documentation regarding GeoLite2, mentioning the default key is now disabled and therefore, you need to provide your own.

[6.26.0] - 2021-12-16

Added

  • Migrated to latest docsearch

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.25.0] - 2021-12-12

Added

  • #253 Documented how to import from YOURLS.
  • Documented new not-found redirect env vars that deprecate existing ones.
  • #259 Documented new IS_HTTPS_ENABLED env var.
  • #261 Documented how to integrate with a RabbitMQ instance.
  • #252 Explained considerations when using multiple domains.
  • #258 Documented support for openswoole, and recommended using it over regular swoole.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.24.1] - 2021-11-21

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed PSShlink image width in mobile devices.

[6.24.0] - 2021-11-21

Added

  • #248 Added PSShlink to the list of apps.
  • #249 Documented "Email Tracking" feature.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.23.0] - 2021-10-31

Added

  • #212 Documented how to solve issues with CORS when using mercure >=0.11
  • #229 Documented how to solve issues with CORS when using mercure >=0.11

Changed

  • Moved ci workflow to external repo and reused
  • Updated to node 16.15
  • #244 Updated to Next.js 12.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • #235 Fixed sass deprecation warning.

[6.22.0] - 2021-10-10

Added

  • Added QR code env vars, and documented deprecated env vars.
  • Added note mentioning that query params forwarding can be disabled since Shlink v2.9.0.
  • Documented placeholders supported in not-found redirects since Shlink v2.9.0.
  • Documented REDIS_SENTINEL_SERVICE env var.
  • Documented how to enable sending orphan visit notifications to webhooks.
  • Documented how to disable tracking based on IP addresses.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.21.0] - 2021-09-18

Added

  • Documented environment variables as something that can be used with non-docker installations.

Changed

  • Updated ALL dependencies

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.20.0] - 2021-08-04

Added

  • Documented extra path forwarding feature.
  • #227 Documented domain-specific "not found" redirects.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.19.0] - 2021-07-13

Added

  • Nothing

Changed

  • #223 Updated dependencies, including Next.js to v11.
  • #225 Documented errorCorrection param for QR codes.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.18.0] - 2021-05-30

Added

  • #220 Documented new ways to pre-configure servers in shlink-web-client after v3.2.0
  • #216 Documented ENABLE_PERIODIC_VISIT_LOCATE env var for docker container.
  • #218 Documented how bot detection works in Shlink v2.7.0.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.17.1] - 2021-05-23

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Added missing tracking env vars in docker example.

[6.17.0] - 2021-05-23

Added

  • #215 Documented new tracking capabilities introduced in Shlink v2.6.0.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.16.1] - 2021-04-24

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed duplicated troubleshooting section, by making one reference the other.

[6.16.0] - 2021-04-23

Added

  • Improved troubleshooting docs
  • Documented importing from Shlink instance

Changed

  • Updated coding styles

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.15.1] - 2021-02-13

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Fixed docs to reflect new dist files system and support for PHP 8.

[6.15.0] - 2021-02-11

Added

  • #195 Documented title feature introduced in Shlink v2.6.0.
  • #196 Documented how to import links from a CSV file.
  • #197 Documented margin prop for QR codes.
  • #201 Documented how Shlink tracks visits and its considerations.
  • #203 Documented special redirects.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.14.3] - 2021-01-26

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Improved REST API feature description.

[6.14.2] - 2021-01-24

Added

  • Nothing

Changed

  • #187 Improved CORS-related docs.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • #188 Fixed anchor links when they are dynamically loaded.

[6.14.1] - 2021-01-19

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Added missing reference to xml PHP extension required to generate QR codes in SVG format.

[6.14.0] - 2021-01-17

Added

  • Documented API key roles.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.13.1] - 2021-01-06

Added

  • Nothing

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • #181 Fixed shlink-web-client video for some devices, and added placeholder image for others.

[6.13.0] - 2021-01-02

Added

  • #157 Documented some minor features, like QR codes, X-Request-Id and query params forwarding.

Changed

  • Nothing

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing

[6.12.0] - 2020-12-22

Added

  • #142 Documented how to troubleshoot the most common issues.
  • #179 Added collapsible menu to docs.

Changed

  • #174 Updated shlink-web-client video, using a v3 recording.

Deprecated

  • Nothing

Removed

  • Nothing

Fixed

  • Nothing