Skip to content

Commit

Permalink
Merge pull request #242 from acelaya-forks/feature/ip-based-tracking
Browse files Browse the repository at this point in the history
Documented how to disable tracking from IP addresses via env vars
  • Loading branch information
acelaya authored Oct 10, 2021
2 parents 729609c + ebb071c commit 208f9b4
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to [Semantic Versioning](https://semver.org).

## [Unreleased]
## [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*
Expand Down
1 change: 1 addition & 0 deletions src/content/documentation/environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ This is the complete list of supported env vars. Right next to their name you wi
* `PORT` *(v2.4.0)* : Can be used to set the port in which shlink listens. Defaults to 8080 (Some cloud providers, like Google cloud or Heroku, expect to be able to customize exposed port by providing this env var).
* `AUTO_RESOLVE_TITLES` *(v2.6.0)* : Used to automatically resolve the short URL's title based on the `<title />` tag in the long URL. Defaults to `false`.
* `DISABLE_TRACK_PARAM`: The name of a query param that can be used to visit short URLs avoiding the visit to be tracked. This feature won't be available if no value is provided. (See [Tracking visits](/documentation/tracking-visits/) for more info)
* `DISABLE_TRACKING_FROM`: A comma-separated list of IP address patterns from which all tracking should be disabled. It allows providing fixed IP addresses (`100.200.80.40`), CIDR blocks (`192.168.10.0/24`) or wildcard patterns (`11.22.*.*`)
* `TRACK_ORPHAN_VISITS` *(v2.6.0)* : Tells if [orphan visits](/documentation/tracking-visits/#orphan-visits) should be tracked or not. Defaults to `true`. (See [Tracking visits](/documentation/tracking-visits/) for more info)
* `DISABLE_TRACKING` *(v2.7.0)* : Tells if visits tracking should be completely disabled. Defaults to `false`. (See [Tracking visits](/documentation/tracking-visits/) for more info)
* `DISABLE_IP_TRACKING` *(v2.7.0)* : Tells if tracking of the IP address (and therefore visitors location) should be disabled. Defaults to `false`. (See [Tracking visits](/documentation/tracking-visits/) for more info)
Expand Down

0 comments on commit 208f9b4

Please sign in to comment.