[docs] Publish changelog to gh-pages

- Format ChangeLog in Markdown.
- Publish ChangeLog as part of the mkdocs documentation to gh-pages.
- Fix formatting of sub lists on docs index page.
This commit is contained in:
Christian Meffert 2025-01-26 15:05:28 +00:00
parent 01dbda3ec0
commit 2e019690cd
4 changed files with 594 additions and 534 deletions

238
ChangeLog
View File

@ -1,7 +1,7 @@
ChangeLog for OwnTone # Changelog
---------------------
## Version 28.11 - 2025-01-26
version 28.11
- fix: retrieval of artwork from online sources - fix: retrieval of artwork from online sources
- fix: mpd speaker selection - fix: mpd speaker selection
- fix: autoconf warnings - fix: autoconf warnings
@ -14,7 +14,8 @@ version 28.11
- new: mpd updates, version 0.23.0, e.g. getvol, readpicture, albumart - new: mpd updates, version 0.23.0, e.g. getvol, readpicture, albumart
- new: API for setting skip_count and play_count directly - new: API for setting skip_count and play_count directly
version 28.10 ## Version 28.10 - 2024-09-12
- fix: playlist scanner ignoring lines starting with non-ascii chars - fix: playlist scanner ignoring lines starting with non-ascii chars
- fix: last seconds of a track sometimes being skipped - fix: last seconds of a track sometimes being skipped
- fix: Apple Music password-based auth - fix: Apple Music password-based auth
@ -34,11 +35,12 @@ version 28.10
- config: deprecate "cache_path", replaced by "cache_dir" - config: deprecate "cache_path", replaced by "cache_dir"
- dependency: libxml2 instead of mxml - dependency: libxml2 instead of mxml
version 28.9 ## Version 28.9 - 2024-01-18
- web UI improvements: - web UI improvements:
display lyrics metadata - display lyrics metadata
toggle Spotify on/off in some views - toggle Spotify on/off in some views
many minor improvements - many minor improvements
- use compressed ALAC for Airplay for bandwidth + fixes esp32 issue - use compressed ALAC for Airplay for bandwidth + fixes esp32 issue
- don't merge Spotify albums with local albums - don't merge Spotify albums with local albums
- handle playlist with Unicode BOM - handle playlist with Unicode BOM
@ -49,7 +51,8 @@ version 28.9
- fix FreeBSD possible crash - fix FreeBSD possible crash
- fix crash when keys of incorrect length are used for legacy pairing - fix crash when keys of incorrect length are used for legacy pairing
version 28.8 ## Version 28.8
- fix MacOS bind error: "Protocol wrong type for socket" - fix MacOS bind error: "Protocol wrong type for socket"
- fix BSD build error (no SYS_gettid) - fix BSD build error (no SYS_gettid)
- fix ALAC missing end tag causing ffmpeg decoder warnings - fix ALAC missing end tag causing ffmpeg decoder warnings
@ -57,15 +60,16 @@ version 28.8
- fix duplicates if file within library is replaced - fix duplicates if file within library is replaced
- fix fatal error due to mutex being zeroed - fix fatal error due to mutex being zeroed
version 28.7 ## Version 28.7
- fix compability with ffmpeg 6 - fix compability with ffmpeg 6
- web UI improvements: - web UI improvements:
easier volume sliders - easier volume sliders
incorrect display of genre - incorrect display of genre
Chinese translation - Chinese translation
fix removing RSS podcasts - fix removing RSS podcasts
sort by rating for composer, genre and artist tracks - sort by rating for composer, genre and artist tracks
(and much more) - (and much more)
- changes to artwork search orders (easier static artwork for pipes) - changes to artwork search orders (easier static artwork for pipes)
- major refactor of the http server improving mp3 streaming - major refactor of the http server improving mp3 streaming
- support for m3u8 playlist files - support for m3u8 playlist files
@ -73,7 +77,8 @@ version 28.7
- fix issue with device name capitalization (TuneAero issue) - fix issue with device name capitalization (TuneAero issue)
- drop support for libevent < 2.1.4 - drop support for libevent < 2.1.4
version 28.6 ## Version 28.6
- German translation of web UI - German translation of web UI
- web UI: fix error messages not displaying - web UI: fix error messages not displaying
- fix low resolution Spotify artwork - fix low resolution Spotify artwork
@ -82,7 +87,8 @@ version 28.6
- support password authentication for Airplay 2 - support password authentication for Airplay 2
- support for user config ffmpeg audio filters - support for user config ffmpeg audio filters
version 28.5 ## Version 28.5
- French translation of web UI - French translation of web UI
- improved web UI loading of images - improved web UI loading of images
- add support for Airplay 2 password based auth - add support for Airplay 2 password based auth
@ -92,7 +98,8 @@ version 28.5
- fix for Remote - play item from 'up next' when stopped - fix for Remote - play item from 'up next' when stopped
- use configured bind_address to set mdns network interface - use configured bind_address to set mdns network interface
version 28.4 ## Version 28.4
- fix broken Spotify after libspotify sunset - fix broken Spotify after libspotify sunset
- remove antlr3 dependency, use bison/flex instead - remove antlr3 dependency, use bison/flex instead
- improve search by supporting diacritics and Unicode case folding - improve search by supporting diacritics and Unicode case folding
@ -101,25 +108,26 @@ version 28.4
- smart playlists fixups and new "this week" param - smart playlists fixups and new "this week" param
- fix 'add next' when in queue shuffle mode - fix 'add next' when in queue shuffle mode
- web UI improvements: - web UI improvements:
migration to Vue 3 and Vite - migration to Vue 3 and Vite
honor "radio_playlists" config setting - honor "radio_playlists" config setting
display of search results for composers and playlists - display of search results for composers and playlists
add album / track count to genre and composer pages - add album / track count to genre and composer pages
fix incorrect sorting of album/artist searches - fix incorrect sorting of album/artist searches
minor UI fixes - minor UI fixes
- fix for Spotify config option album_override - fix for Spotify config option album_override
- improved Spotify scan performance - improved Spotify scan performance
- generic browse endpoints for the json api - generic browse endpoints for the json api
- fix slow shutdown with some libwebsocket versions - fix slow shutdown with some libwebsocket versions
version 28.3 ## Version 28.3
- web UI improvements, e.g.: - web UI improvements, e.g.:
composer views - composer views
partial scan (e.g. only update RSS feeds) - partial scan (e.g. only update RSS feeds)
fix http stream button not clickable in mobile view - fix http stream button not clickable in mobile view
fix Spotify playlists not showing - fix Spotify playlists not showing
handling of not playable Spotify tracks - handling of not playable Spotify tracks
handling of podcast play counts - handling of podcast play counts
- support for Spotify podcasts - support for Spotify podcasts
- updates for ffmpeg 5 - updates for ffmpeg 5
- better Spotify logout - better Spotify logout
@ -130,12 +138,13 @@ version 28.3
- fix rare Airplay pairing error - fix rare Airplay pairing error
- many minor error handling fixes - many minor error handling fixes
version 28.2 ## Version 28.2
- add Spotify integration that doesn't depend on libspotify - add Spotify integration that doesn't depend on libspotify
- partial support for AirPlay events (Homepod buttons) - partial support for AirPlay events (Homepod buttons)
- web UI upgraded, now 1.1.0: - web UI upgraded, now 1.1.0:
show "comment" field in track details - show "comment" field in track details
drop double login to Spotify when not using libspotify - drop double login to Spotify when not using libspotify
- easier install by letting 'make install' add user and service files - easier install by letting 'make install' add user and service files
- preserve existing conf file when running 'make install' - preserve existing conf file when running 'make install'
- support for "comment" field when making smart playlists - support for "comment" field when making smart playlists
@ -146,10 +155,12 @@ version 28.2
- fix for CVE-2021-38383 - fix for CVE-2021-38383
- fix some minor time-of-check time-of-use bugs - fix some minor time-of-check time-of-use bugs
version 28.1 ## Version 28.1
- fix incompability in 28.0 with Debian Buster's libwebsockets 2.0 - fix incompability in 28.0 with Debian Buster's libwebsockets 2.0
version 28.0 ## Version 28.0
- rename forked-daapd to OwnTone + new logo - rename forked-daapd to OwnTone + new logo
- fix web UI slow updates due to websockets 3.x changes - fix web UI slow updates due to websockets 3.x changes
- support for ALAC sort tags - support for ALAC sort tags
@ -161,22 +172,24 @@ version 28.0
- refactor how the server binds to sockets (use dual stack ipv4/6) - refactor how the server binds to sockets (use dual stack ipv4/6)
- configurable interface/address binding - configurable interface/address binding
version 27.4 ## Version 27.4
- fix web server path traversal vulnerability - fix web server path traversal vulnerability
version 27.3 ## Version 27.3
- support for AirPlay 2 speakers, incl. compressed ALAC - support for AirPlay 2 speakers, incl. compressed ALAC
- web UI upgraded, now v0.8.5: - web UI upgraded, now v0.8.5:
new design/layout - new design/layout
optimize "Recently added" - optimize "Recently added"
Spotify search dialogue improvements - Spotify search dialogue improvements
drop separate admin web page, now integrated in main web - drop separate admin web page, now integrated in main web
podcast deletion - podcast deletion
make Radio a top level item - make Radio a top level item
show release dates - show release dates
new sorting options - new sorting options
prevent browser caching of playlists - prevent browser caching of playlists
additional settings - additional settings
- improved Chromecast streaming (retransmisson, adaptive etc.) - improved Chromecast streaming (retransmisson, adaptive etc.)
- JSON api support for updating metadata of queue items - JSON api support for updating metadata of queue items
- JSON api new fields, e.g. time_added, time_played and seek - JSON api new fields, e.g. time_added, time_played and seek
@ -193,22 +206,23 @@ version 27.3
- support shairport-sync metadata pipe flush event - support shairport-sync metadata pipe flush event
- misc logging fixup - misc logging fixup
version 27.2 ## Version 27.2
- web UI upgraded to v0.7.2: - web UI upgraded to v0.7.2:
show cover artwork in album pages and lazy loading of artwork - show cover artwork in album pages and lazy loading of artwork
show playlist folders - show playlist folders
use sass/scss for css files - use sass/scss for css files
add "Radio" tab to the music section - add "Radio" tab to the music section
add settings for artwork sources - add settings for artwork sources
add pop up dialog for Remote pairing requests - add pop up dialog for Remote pairing requests
support adding/removing podcast subscriptions - support adding/removing podcast subscriptions
support marking all new podcast episodes/all episodes as played - support marking all new podcast episodes/all episodes as played
support searching by smart pl queries - support searching by smart pl queries
skip buttons for audiobooks and podcasts - skip buttons for audiobooks and podcasts
show localized times/dates - show localized times/dates
generate colored placeholder image if cover artwork is missing - generate colored placeholder image if cover artwork is missing
show "cast" icon for Chromecast outputs - show "cast" icon for Chromecast outputs
styling changes of the navbars and moving the volume controls - styling changes of the navbars and moving the volume controls
- new speaker selection logic (persist user choice even after failure) - new speaker selection logic (persist user choice even after failure)
- speaker autoselect no longer enabled by default - speaker autoselect no longer enabled by default
- removed old admin page, not necessary any more - removed old admin page, not necessary any more
@ -229,7 +243,8 @@ version 27.2
- drop libspotify for artwork, doesn't work any more - drop libspotify for artwork, doesn't work any more
- documentation improvements - documentation improvements
version 27.1 ## Version 27.1
- web UI upgraded to v0.6.0: settings page, display more Spotify data - web UI upgraded to v0.6.0: settings page, display more Spotify data
- support for volumeup, volumedown and mutetoggle DACP commands - support for volumeup, volumedown and mutetoggle DACP commands
- support for multiple ALSA devices - support for multiple ALSA devices
@ -239,7 +254,8 @@ version 27.1
- fix for incorrect update of time_added metadata - fix for incorrect update of time_added metadata
- fix some small memleaks and missing cleanup - fix some small memleaks and missing cleanup
version 27.0 ## Version 27.0
- no fixed resampling to 44100/16, play source quality if possible - no fixed resampling to 44100/16, play source quality if possible
- Chromecast: quick start, better quality (48000/16 Opus encoded) - Chromecast: quick start, better quality (48000/16 Opus encoded)
- performance enhancements: Remote and iTunes will load quicker - performance enhancements: Remote and iTunes will load quicker
@ -258,7 +274,8 @@ version 27.0
- support for some http seeking - support for some http seeking
- fix for macOS Catalinas Apple Music - fix for macOS Catalinas Apple Music
version 26.5 ## Version 26.5
- json api/web ui: file view - json api/web ui: file view
- web ui: artwork support - web ui: artwork support
- web ui: "Add next" and genre tab - web ui: "Add next" and genre tab
@ -273,14 +290,16 @@ version 26.5
- mpd version 0.20 support + support for "listfiles" command - mpd version 0.20 support + support for "listfiles" command
- fix double http auth decline issue - fix double http auth decline issue
version 26.4: ## Version 26.4
- automatic rating - automatic rating
- fix issue in 26.3 causing invalid time_skipped values in the db - fix issue in 26.3 causing invalid time_skipped values in the db
- improved fallback to ipv4 if ipv6 fails - improved fallback to ipv4 if ipv6 fails
- fix issue returning too many queue items to clients - fix issue returning too many queue items to clients
- fix missing prompt for library password - fix missing prompt for library password
version 26.3: ## Version 26.3
- fix AirPlay 2 devices (e.g. Sonos Beam and Airport Express) - fix AirPlay 2 devices (e.g. Sonos Beam and Airport Express)
- fix mdns problems with ATV4 and ipv6 - fix mdns problems with ATV4 and ipv6
- fix possible segfault if null user-agent - fix possible segfault if null user-agent
@ -289,10 +308,12 @@ version 26.3:
- fix for crashes when client provides no User-Agent - fix for crashes when client provides no User-Agent
- logging improvements - logging improvements
version 26.2: ## Version 26.2
- fix for db indexes not being used on fresh installs - fix for db indexes not being used on fresh installs
version 26.1: ## Version 26.1
- player web interface - player web interface
- support for Airplay speaker control commands - support for Airplay speaker control commands
- add non-library items (e.g. radio stations) to the queue - add non-library items (e.g. radio stations) to the queue
@ -303,7 +324,8 @@ version 26.1:
- fix ffmpeg segfault when jpeg encoding - fix ffmpeg segfault when jpeg encoding
- performance improvements + misc - performance improvements + misc
version 26.0: ## Version 26.0
- added web interface - added web interface
- added JSON API - added JSON API
- new mpd commands (e.g. sticker, urlhandlers, playlistfind) - new mpd commands (e.g. sticker, urlhandlers, playlistfind)
@ -322,7 +344,8 @@ version 26.0:
- ffmpeg/transcoding refactored for new ffmpeg API - ffmpeg/transcoding refactored for new ffmpeg API
- and more... - and more...
version 25.0: ## Version 25.0
- improved playback resilience - improved playback resilience
- substitute packet skipping (producing audio "clicks") with start/stop - substitute packet skipping (producing audio "clicks") with start/stop
- support for MacOSX with macports and Bonjour mDNS - support for MacOSX with macports and Bonjour mDNS
@ -343,7 +366,8 @@ version 25.0:
- performance improvements - performance improvements
- and other fixing up... - and other fixing up...
version 24.2: ## Version 24.2
- Pulseaudio support (can be used for Bluetooth speakers) - Pulseaudio support (can be used for Bluetooth speakers)
- new pipe/"fifo" audio output - new pipe/"fifo" audio output
- fix misc Chromecast audio bugs - fix misc Chromecast audio bugs
@ -358,11 +382,13 @@ version 24.2:
- fix possible segfault on http timeouts - fix possible segfault on http timeouts
- fix possible segfault when adding items during playback - fix possible segfault when adding items during playback
version 24.1: ## Version 24.1
- support for Monkey's audio - support for Monkey's audio
- fix build problems on some platforms (e.g. OpenWrt) - fix build problems on some platforms (e.g. OpenWrt)
version 24.0: ## Version 24.0
- support for Chromecast audio - support for Chromecast audio
- support more idv3 tags (eg. date released) - support more idv3 tags (eg. date released)
- support more DAAP tags (eg. datereleased, hasbeenplayed) - support more DAAP tags (eg. datereleased, hasbeenplayed)
@ -382,7 +408,8 @@ version 24.0:
- support for old ffmpeg dropped - support for old ffmpeg dropped
- misc minor bugfixing - misc minor bugfixing
version 23.4: ## Version 23.4
- fix freeze problem on network stream disconnects - fix freeze problem on network stream disconnects
- support for mp3 streaming - support for mp3 streaming
- better ipv6 handling - better ipv6 handling
@ -392,7 +419,8 @@ version 23.4:
- libavresample/libswresample dependency changed to libavfilter - libavresample/libswresample dependency changed to libavfilter
- improved pairinghelper.sh script - improved pairinghelper.sh script
version 23.3: ## Version 23.3
- fix issue where volume gets set to -1 on startup of raop devices - fix issue where volume gets set to -1 on startup of raop devices
- plug various minor memleaks - plug various minor memleaks
- audiobook improvements, eg resuming playback from saved position - audiobook improvements, eg resuming playback from saved position
@ -402,29 +430,35 @@ version 23.3:
- drop legacy ffmpeg stuff - drop legacy ffmpeg stuff
- drop legacy flac, musepack and wma scanner - drop legacy flac, musepack and wma scanner
version 23.2: ## Version 23.2
- fix db lock, m3u and Windows Phone bugs - fix db lock, m3u and Windows Phone bugs
- improvements for Spotify and mpd - improvements for Spotify and mpd
- fixing bugs as always - fixing bugs as always
- sorting of genres and composers - sorting of genres and composers
version 23.1: ## Version 23.1
- support for more mpd commands - support for more mpd commands
version 23.0: ## Version 23.0
- add support for the mpd protocol - add support for the mpd protocol
- add support for smart playlists - add support for smart playlists
- playlist and internet stream overhaul - playlist and internet stream overhaul
version 22.2: ## Version 22.2
- fix for iTunes 12.1 - fix for iTunes 12.1
- fix misc bugs - fix misc bugs
version 22.1: ## Version 22.1
- artwork cache - artwork cache
- some Spotify fixing up - some Spotify fixing up
version 22.0: ## Version 22.0
- queue handling improvements - queue handling improvements
- added DAAP cache, good for low-power devices like the RPi - added DAAP cache, good for low-power devices like the RPi
- support for LastFM scrobbling - support for LastFM scrobbling
@ -437,7 +471,8 @@ version 22.0:
- fix segfault on invalid utf8 while sorting - fix segfault on invalid utf8 while sorting
- fix misc bugs - fix misc bugs
version 21.0: ## Version 21.0
- filescanner performance enhancements (db transactions) - filescanner performance enhancements (db transactions)
- support for queue editing - support for queue editing
- support for showing history - support for showing history
@ -456,7 +491,8 @@ version 21.0:
- fix bug in m3u scanner - fix bug in m3u scanner
- ICY metadata fixes - ICY metadata fixes
version 20.0: ## Version 20.0
- includes patch against timeouts - includes patch against timeouts
- configurable artwork file names - configurable artwork file names
- support for Remote 3 and 4 - support for Remote 3 and 4
@ -492,29 +528,34 @@ version 20.0:
- fixes for video playback - fixes for video playback
- other fixes: non apple players, ffmpeg/libav updates... - other fixes: non apple players, ffmpeg/libav updates...
version 0.19: ## Version 0.19
- more libav 0.7 updates. - more libav 0.7 updates.
- database speedups. - database speedups.
- fix for iTunes 30-minute timeout. - fix for iTunes 30-minute timeout.
- fixes, big and small. - fixes, big and small.
version 0.18: ## Version 0.18
- add config knob for ALSA mixer channel name. - add config knob for ALSA mixer channel name.
- do not elevate privileges for reopening the log file; log file - do not elevate privileges for reopening the log file; log file
will now be owned by the user forked-daapd runs as. will now be owned by the user forked-daapd runs as.
- fixes, big and small. - fixes, big and small.
version 0.17: ## Version 0.17
- support for libav 0.7 - support for libav 0.7
- fixes, big and small. - fixes, big and small.
version 0.16: ## Version 0.16
- fix issue with non-UTF-8 metadata while scanning. - fix issue with non-UTF-8 metadata while scanning.
- use proper file size in HTTP streaming code. - use proper file size in HTTP streaming code.
- fix DAAP songlist bug with sort tags. - fix DAAP songlist bug with sort tags.
- small code fixes. - small code fixes.
version 0.15: ## Version 0.15
- add support for sending metadata to AppleTV during AirTunes streaming. - add support for sending metadata to AppleTV during AirTunes streaming.
- support DOS-encoded Remote pairing files. - support DOS-encoded Remote pairing files.
- rework album_artist_sort handling. - rework album_artist_sort handling.
@ -524,7 +565,8 @@ version 0.15:
- artwork can handle and send out both PNG and JPEG. - artwork can handle and send out both PNG and JPEG.
- fixes, big and small. - fixes, big and small.
version 0.14: ## Version 0.14
- sort headers/tags handling improvements. - sort headers/tags handling improvements.
- better handling of tags for TV shows. - better handling of tags for TV shows.
- better handling of DRM-afflicted files. - better handling of DRM-afflicted files.
@ -532,7 +574,8 @@ version 0.14:
- fix scanning of URL files. - fix scanning of URL files.
- fixes, big and small. - fixes, big and small.
version 0.13: ## Version 0.13
- add Remote v2 support; Remote v1 is not supported anymore. - add Remote v2 support; Remote v1 is not supported anymore.
- add per-speaker volume support. - add per-speaker volume support.
- implement RAOP retransmission. - implement RAOP retransmission.
@ -545,7 +588,8 @@ version 0.13:
- FFmpeg 0.6 support. - FFmpeg 0.6 support.
- fixes, big and small. - fixes, big and small.
version 0.12: ## Version 0.12
- add AirTunes v2 streaming. - add AirTunes v2 streaming.
- add Remote support. - add Remote support.
- add gzipped replies. - add gzipped replies.
@ -553,7 +597,8 @@ version 0.12:
- check for UTF-8 correctness of metadata. - check for UTF-8 correctness of metadata.
- fixes, big and small. - fixes, big and small.
version 0.11: ## Version 0.11
- support iTunes 9. - support iTunes 9.
- add iTunes XML playlist scanner. - add iTunes XML playlist scanner.
- add support for TV shows. - add support for TV shows.
@ -565,5 +610,6 @@ version 0.11:
- preliminary support for Remote (pairing, browsing). - preliminary support for Remote (pairing, browsing).
- fixes, big and small. - fixes, big and small.
version 0.10: ## Version 0.10
- initial release. - initial release.

1
docs/changelog.md Normal file
View File

@ -0,0 +1 @@
--8<-- "ChangeLog"

View File

@ -46,18 +46,27 @@ theme:
# - navigation.indexes # - navigation.indexes
- navigation.top - navigation.top
palette: palette:
- scheme: default # Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white primary: white
accent: teal accent: teal
toggle: toggle:
icon: material/toggle-switch icon: material/brightness-7
name: Switch to dark mode name: Switch to dark mode
- scheme: slate # Palette toggle for dark mode
primary: blue grey - media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: teal accent: teal
toggle: toggle:
icon: material/toggle-switch-off-outline icon: material/brightness-4
name: Switch to light mode name: Switch to system preference
font: font:
text: Roboto text: Roboto
code: Roboto Mono code: Roboto Mono
@ -112,6 +121,9 @@ markdown_extensions:
repo: mkdocs-material repo: mkdocs-material
- pymdownx.mark - pymdownx.mark
- pymdownx.smartsymbols - pymdownx.smartsymbols
- pymdownx.snippets:
base_path: [!relative $config_dir]
check_paths: true
- pymdownx.superfences: - pymdownx.superfences:
custom_fences: custom_fences:
- name: mermaid - name: mermaid
@ -159,4 +171,5 @@ nav:
- Remote Access: advanced/remote-access.md - Remote Access: advanced/remote-access.md
- Multiple Instances: advanced/multiple-instances.md - Multiple Instances: advanced/multiple-instances.md
- Development: development.md - Development: development.md
- Changelog: changelog.md
- JSON API: json-api.md - JSON API: json-api.md