Skip to content

Commit

Permalink
Merge pull request #807 from acelaya-forks/feature/missing-docs
Browse files Browse the repository at this point in the history
Feature/missing docs
  • Loading branch information
acelaya authored Nov 29, 2024
2 parents d36cc83 + f88f65f commit 9618e22
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,24 @@ 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).

## [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
Expand Down
5 changes: 5 additions & 0 deletions src/pages/documentation/environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,11 @@ Strikethrough env vars are deprecated.
* `DEFAULT_QR_CODE_BG_COLOR` *(v4.0.0)* : The QR code background color. Defaults to `#FFFFFF` (white).
* `DEFAULT_QR_CODE_LOGO_URL` *(v4.0.0)* : A URL pointing to a logo that will be placed in the middle of the QR code. This one is experimental, as some images might break the QR code.

#### Robots.txt

* `ROBOTS_ALLOW_ALL_SHORT_URLS` *(v4.2.0)* : Whether all short URLs should be allowed via robots.txt or not. If set to `true`, the `crawlable` option set in individual short URLs will be ignored. Defaults to `false`.
* `ROBOTS_USER_AGENTS` *(v4.2.0)* : A comma-separated list of allowed user agents via robots.txt. Defaults to `*`.

#### Redis integration

* `REDIS_SERVERS`: A comma-separated list of redis servers which Shlink uses for shared locks, cache, and optionally real-time updates through pub/sub (make sure to include the port number and credentials for every server).
Expand Down
3 changes: 1 addition & 2 deletions src/pages/features.astro
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ import Layout from '../layouts/Layout.astro';
icon={faMobileScreenButton}
link="/documentation/advanced/dynamic-rule-based-redirects-system"
>
Dynamically redirect visitors to different places, like the App Store for iPhone users or different
landing pages based on the language.
Dynamically redirect visitors to different places based on geolocation, device type, language, etc.
</Feature>
<Feature title="QR Codes" icon={faQrcode} link="/documentation/some-features/#qr-codes">
Generate QR codes on the fly pointing to your short URLs.
Expand Down

0 comments on commit 9618e22

Please sign in to comment.