diff --git a/.codespellignore b/.codespellignore
index c305ceb85..4e872e52b 100644
--- a/.codespellignore
+++ b/.codespellignore
@@ -7,7 +7,9 @@ nd
readby
serie
upto
+afterall
# Names
nin
noe
+manuel
diff --git a/.gitignore b/.gitignore
index b37e36601..97ef7bf6c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,5 @@
+/dist
+
### OSX ###
.DS_Store
.AppleDouble
@@ -83,8 +85,12 @@ front/yarn-debug.log*
front/yarn-error.log*
front/tests/unit/coverage
front/tests/e2e/reports
+front/test_results.xml
+front/coverage/
front/selenium-debug.log
docs/_build
+#Tauri
+front/tauri/gen
/data/
.env
@@ -104,3 +110,9 @@ tsconfig.tsbuildinfo
# Vscode
.vscode/
+
+# Nix
+.direnv/
+.envrc
+flake.nix
+flake.lock
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
index b51f56dfc..387c58100 100644
--- a/.gitlab-ci.yml
+++ b/.gitlab-ci.yml
@@ -118,21 +118,16 @@ review_docs:
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
changes: [docs/**/*]
- image: $CI_REGISTRY/funkwhale/ci/python-funkwhale-api:3.11
- variables:
- BUILD_PATH: "../docs-review"
+ image: $CI_REGISTRY/funkwhale/ci/python-funkwhale-docs:3.11
environment:
name: review/docs/$CI_COMMIT_REF_NAME
url: http://$CI_PROJECT_NAMESPACE.pages.funkwhale.audio/-/$CI_PROJECT_NAME/-/jobs/$CI_JOB_ID/artifacts/docs-review/index.html
cache: *docs_cache
before_script:
- - mkdir docs-review
- cd docs
- - apt-get update
- - apt-get install -y graphviz
- - poetry install
+ - make install
script:
- - poetry run python3 -m sphinx . $BUILD_PATH
+ - make build BUILD_DIR=../docs-review
artifacts:
expire_in: 2 weeks
paths:
@@ -149,7 +144,6 @@ find_broken_links:
--cache
--no-progress
--exclude-all-private
- --exclude-mail
--exclude 'demo\.funkwhale\.audio'
--exclude 'nginx\.com'
--exclude-path 'docs/_templates/'
@@ -236,7 +230,7 @@ test_api:
image: $CI_REGISTRY/funkwhale/ci/python-funkwhale-api:$PYTHON_VERSION
parallel:
matrix:
- - PYTHON_VERSION: ["3.8", "3.9", "3.10", "3.11"]
+ - PYTHON_VERSION: ["3.8", "3.9", "3.10", "3.11", "3.12"]
services:
- name: postgres:15-alpine
command:
@@ -253,7 +247,7 @@ test_api:
CACHE_URL: "redis://redis:6379/0"
before_script:
- cd api
- - poetry install --all-extras
+ - make install
script:
- >
poetry run pytest
@@ -293,6 +287,7 @@ test_front:
coverage_report:
coverage_format: cobertura
path: front/coverage/cobertura-coverage.xml
+ coverage: '/All files\s+(?:\|\s+((?:\d+\.)?\d+)\s+){4}.*/'
build_metadata:
stage: build
@@ -317,7 +312,9 @@ test_integration:
- if: $RUN_CYPRESS
interruptible: true
- image: cypress/base:18.12.1
+ image:
+ name: cypress/included:13.6.4
+ entrypoint: [""]
cache:
- *front_cache
- key:
@@ -354,7 +351,7 @@ build_api_schema:
API_TYPE: "v1"
before_script:
- cd api
- - poetry install --all-extras
+ - make install
- poetry run funkwhale-manage migrate
script:
- poetry run funkwhale-manage spectacular --file ../docs/schema.yml
@@ -372,19 +369,13 @@ build_docs:
- if: $CI_COMMIT_BRANCH =~ /(stable|develop)/
- changes: [docs/**/*]
- image: $CI_REGISTRY/funkwhale/ci/python-funkwhale-api:3.11
- variables:
- BUILD_PATH: "../public"
- GIT_STRATEGY: clone
- GIT_DEPTH: 0
+ image: $CI_REGISTRY/funkwhale/ci/python-funkwhale-docs:3.11
cache: *docs_cache
before_script:
- cd docs
- - apt-get update
- - apt-get install -y graphviz
- - poetry install
+ - make install
script:
- - ./build_docs.sh
+ - make build-all BUILD_DIR=../public
artifacts:
expire_in: 2 weeks
paths:
@@ -439,6 +430,25 @@ build_api:
paths:
- api
+build_tauri:
+ stage: build
+ rules:
+ - if: $CI_COMMIT_BRANCH =~ /(stable|develop)/
+ - changes: [front/**/*]
+
+ image: $CI_REGISTRY/funkwhale/ci/node-tauri:18
+ variables:
+ <<: *keep_git_files_permissions
+ before_script:
+ - source /root/.cargo/env
+ - yarn install
+ script:
+ - yarn tauri build --verbose
+ artifacts:
+ name: desktop_${CI_COMMIT_REF_NAME}
+ paths:
+ - front/tauri/target/release/bundle/appimage/*.AppImage
+
deploy_docs:
interruptible: false
extends: .ssh-agent
@@ -471,22 +481,23 @@ docker:
variables:
BUILD_ARGS: >
--set *.platform=linux/amd64,linux/arm64,linux/arm/v7
- --set *.no-cache
+ --no-cache
--push
- if: $CI_COMMIT_BRANCH =~ /(stable|develop)/
variables:
BUILD_ARGS: >
--set *.platform=linux/amd64,linux/arm64,linux/arm/v7
- --set *.cache-from=type=registry,ref=$DOCKER_CACHE_IMAGE:$CI_COMMIT_BRANCH
- --set *.cache-to=type=registry,ref=$DOCKER_CACHE_IMAGE:$CI_COMMIT_BRANCH,mode=max
+ --set *.cache-from=type=registry,ref=$DOCKER_CACHE_IMAGE:$CI_COMMIT_BRANCH,oci-mediatypes=false
+ --set *.cache-to=type=registry,ref=$DOCKER_CACHE_IMAGE:$CI_COMMIT_BRANCH,mode=max,oci-mediatypes=false
--push
- - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+ - if: $CI_PIPELINE_SOURCE == "merge_request_event" && $CI_PROJECT_NAMESPACE == "funkwhale"
+ # We don't provide priviledged runners to everyone, so we can only build docker images in the funkwhale group
variables:
BUILD_ARGS: >
--set *.platform=linux/amd64
- --set *.cache-from=type=registry,ref=$DOCKER_CACHE_IMAGE:$CI_MERGE_REQUEST_TARGET_BRANCH_NAME
+ --set *.cache-from=type=registry,ref=$DOCKER_CACHE_IMAGE:$CI_MERGE_REQUEST_TARGET_BRANCH_NAME,oci-mediatypes=false
image: $CI_REGISTRY/funkwhale/ci/docker:20
services:
@@ -517,3 +528,24 @@ docker:
name: docker_metadata_${CI_COMMIT_REF_NAME}
paths:
- metadata.json
+
+package:
+ stage: publish
+ needs:
+ - job: build_metadata
+ artifacts: true
+ - job: build_api
+ artifacts: true
+ - job: build_front
+ artifacts: true
+ - job: build_tauri
+ artifacts: true
+ rules:
+ - if: $CI_COMMIT_BRANCH =~ /(stable|develop)/
+
+ image: $CI_REGISTRY/funkwhale/ci/python:3.11
+ variables:
+ <<: *keep_git_files_permissions
+ script:
+ - make package
+ - scripts/ci-upload-packages.sh
diff --git a/.gitlab/renovate.json b/.gitlab/renovate.json
index 0b8e75237..a4e7ec774 100644
--- a/.gitlab/renovate.json
+++ b/.gitlab/renovate.json
@@ -25,6 +25,16 @@
"branchConcurrentLimit": 0,
"prConcurrentLimit": 0
},
+ {
+ "matchBaseBranches": ["develop"],
+ "matchUpdateTypes": ["major"],
+ "prPriority": 2
+ },
+ {
+ "matchBaseBranches": ["develop"],
+ "matchUpdateTypes": ["minor"],
+ "prPriority": 1
+ },
{
"matchUpdateTypes": ["major", "minor"],
"matchBaseBranches": ["stable"],
@@ -35,12 +45,6 @@
"matchBaseBranches": ["stable"],
"enabled": false
},
- {
- "matchUpdateTypes": ["patch", "pin", "digest"],
- "matchBaseBranches": ["develop"],
- "automerge": true,
- "automergeType": "branch"
- },
{
"matchManagers": ["npm"],
"addLabels": ["Area::Frontend"]
@@ -70,6 +74,10 @@
],
"fileFilters": ["changes/changelog.d/postgres.update"]
}
+ },
+ {
+ "matchPackageNames": ["python"],
+ "rangeStrategy": "widen"
}
]
}
diff --git a/.gitpod.yml b/.gitpod.yml
index b634d541c..993afaf10 100644
--- a/.gitpod.yml
+++ b/.gitpod.yml
@@ -14,11 +14,12 @@ tasks:
docker-compose up -d
poetry env use python
- poetry install
+ make install
gp ports await 5432
poetry run funkwhale-manage migrate
+ poetry run funkwhale-manage fw users create --superuser --username gitpod --password funkwhale --email test@example.org
poetry run funkwhale-manage gitpod init
command: |
echo "MEDIA_URL=`gp url 8000`/media/" >> ../.gitpod/.env
@@ -47,49 +48,66 @@ tasks:
yarn install
command: yarn dev --host 0.0.0.0 --base ./
+ - name: Documentation
+ before: cd docs
+ init: make install
+ command: make dev
+
- name: Welcome to Funkwhale development!
env:
COMPOSE_FILE: /workspace/funkwhale/.gitpod/docker-compose.yml
ENV_FILE: /workspace/funkwhale/.gitpod/.env
VUE_EDITOR: code
DJANGO_SETTINGS_MODULE: config.settings.local
- init: pre-commit install
+ init: |
+ pre-commit install
+ pre-commit run --all
command: |
- pre-commit run --all && clear
echo ""
echo -e " ⠀⠀⠸⣿⣷⣦⣄⣠⣶⣾⣿⠇⠀⠀ You can now start developing Funkwhale with gitpod!"
echo -e " ⠀⠀⠀⠈⠉⠻⣿⣿⠟⠉⠁⠀⠀⠀"
echo -e " \u1b[34m⣀⠀⢀⡀⢀⣀\u1b[0m⠹⠇\u1b[34m⣀⡀⢀⡀⠀⣀ \u1b[0mTo sign in to the superuser account,"
echo -e " \u1b[34m⢻⣇⠘⣧⡈⠻⠶⠶⠟⢁⣾⠃⣸⡟ \u1b[0mplease use these credentials:"
echo -e " \u1b[34m⠀⠻⣦⡈⠻⠶⣶⣶⠶⠟⢁⣴⠟⠀"
- echo -e " \u1b[34m⠀⠀⠈⠻⠷⣦⣤⣤⣴⠾⠟⠁⠀⠀ gitpod\u1b[0m:\u1b[34mgitpod"
+ echo -e " \u1b[34m⠀⠀⠈⠻⠷⣦⣤⣤⣴⠾⠟⠁⠀⠀ gitpod\u1b[0m:\u1b[34mfunkwhale"
echo ""
ports:
- - port: 8000
+ - name: Funkwhale
+ port: 8000
visibility: public
onOpen: notify
- - port: 5000
+ - name: Funkwhale API
+ port: 5000
visibility: private
onOpen: ignore
- - port: 5432
+ - name: PostgreSQL
+ port: 5432
visibility: private
onOpen: ignore
- - port: 5678
+ - name: Debugpy
+ port: 5678
visibility: private
onOpen: ignore
- - port: 6379
+ - name: Redis
+ port: 6379
visibility: private
onOpen: ignore
- - port: 8080
+ - name: Frontend
+ port: 8080
visibility: private
onOpen: ignore
+ - name: Documentation
+ port: 8001
+ visibility: public
+ onOpen: notify
+
vscode:
extensions:
- Vue.volar
diff --git a/.gitpod/Dockerfile b/.gitpod/Dockerfile
index 7236a7e3e..899bd8520 100644
--- a/.gitpod/Dockerfile
+++ b/.gitpod/Dockerfile
@@ -1,9 +1,13 @@
-FROM gitpod/workspace-full:2022-11-15-17-00-18
+FROM gitpod/workspace-full:2023-10-25-20-43-33
USER gitpod
RUN sudo apt update -y \
&& sudo apt install libsasl2-dev libldap2-dev libssl-dev ffmpeg gettext -y
-RUN pip install poetry pre-commit \
+RUN pyenv install 3.11 && pyenv global 3.11
+
+RUN brew install neovim
+
+RUN pip install poetry pre-commit jinja2 towncrier \
&& poetry config virtualenvs.create true \
&& poetry config virtualenvs.in-project true
diff --git a/.gitpod/docker-compose.yml b/.gitpod/docker-compose.yml
index 9b764307d..62b5f5930 100644
--- a/.gitpod/docker-compose.yml
+++ b/.gitpod/docker-compose.yml
@@ -18,7 +18,6 @@ services:
- 6379:6379
nginx:
- command: /entrypoint.sh
env_file:
- ./.env
image: nginx
@@ -29,15 +28,16 @@ services:
environment:
- "NGINX_MAX_BODY_SIZE=100M"
- "FUNKWHALE_API_IP=host.docker.internal"
+ - "FUNKWHALE_API_HOST=host.docker.internal"
- "FUNKWHALE_API_PORT=5000"
- "FUNKWHALE_FRONT_IP=host.docker.internal"
- "FUNKWHALE_FRONT_PORT=8080"
- "FUNKWHALE_HOSTNAME=${FUNKWHALE_HOSTNAME-host.docker.internal}"
+ - "FUNKWHALE_PROTOCOL=https"
volumes:
- - ../data/media:/protected/media:ro
+ - ../data/media:/workspace/funkwhale/data/media:ro
- ../data/music:/music:ro
- - ../data/staticfiles:/staticfiles:ro
+ - ../data/staticfiles:/usr/share/nginx/html/staticfiles/:ro
- ../deploy/funkwhale_proxy.conf:/etc/nginx/funkwhale_proxy.conf:ro
- - ../docker/nginx/conf.dev:/etc/nginx/nginx.conf.template:ro
- - ../docker/nginx/entrypoint.sh:/entrypoint.sh:ro
+ - ../docker/nginx/conf.dev:/etc/nginx/templates/default.conf.template:ro
- ../front:/frontend:ro
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
index 34b7285bb..ae2fc6994 100644
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -53,18 +53,18 @@ repos:
- id: isort
- repo: https://github.com/pycqa/flake8
- rev: 6.0.0
+ rev: 6.1.0
hooks:
- id: flake8
- repo: https://github.com/pre-commit/mirrors-prettier
- rev: v3.0.2
+ rev: v3.0.3
hooks:
- id: prettier
files: \.(md|yml|yaml|json)$
- repo: https://github.com/codespell-project/codespell
- rev: v2.2.5
+ rev: v2.2.6
hooks:
- id: codespell
additional_dependencies: [tomli]
diff --git a/CHANGELOG.md b/CHANGELOG.md
index cf8fd7f77..530210158 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,193 @@ This changelog is viewable on the web at https://docs.funkwhale.audio/changelog.
+## 1.4.0 (2023-12-12)
+
+Upgrade instructions are available at https://docs.funkwhale.audio/administrator/upgrade/index.html
+
+Features:
+
+- Add a management command to generate dummy notifications for testing
+- Add atom1.0 to node info services (#2085)
+- Add basic cypress testing
+- Add NodeInfo 2.1 (#2085)
+- Add support for Funkwhale UI library.
+- Add support for Python 3.12
+- Allow moderators to set moderation languages (#2085)
+- Allow to set the instances server location (#2085)
+- Cache radio queryset into redis. New radio track endpoint for api v2 is /api/v2/radios/sessions/{radiosessionid}/tracks (#2135)
+- Create a testing environment in production for ListenBrainz recommendation engine (troi-recommendation-playground) (#1861)
+- Generate all nginx configurations from one template
+- New management command to update Uploads which have been imported using --in-place and are now
+ stored in s3 (#2156)
+- Only allow MusicBrainz tagged file on a pod (#2083)
+- Prohibit the creation of new users using django's `createsuperuser` command in favor of our own CLI
+ entry point. Run `funkwhale-manage fw users create --superuser` instead. (#1288)
+
+Enhancements:
+
+- Add custom logging functionality (#2155)
+- Adding typesense container and api client (2104)
+- Cache pip package in api docker builds (#2193)
+- Connect loglevel and debug mode (#1538)
+- Get api version from python package
+- Log service worker registration error and add a warning about Firefox SW incompatibility in development mode
+- Maintain api version using poetry
+- Maloja: Submit album artists and duration and allow to disable server side metadata fixing
+- Replace pytz with zoneinfo in the API
+- Speed up linting and type-checking by using cache
+- Split front large bundles into smaller chunks
+- Support boolean config fields in plugins
+
+Bugfixes:
+
+- `postgres > db_dump.sql` cannot be used if the postgres container is stopped. Update command.
+- Avoid troi radio to give duplicates (#2231)
+- Do not cache all requests to avoid missing updates #2258
+- Fix broken nginx templates for docker setup (#2252)
+- Fix help messages for running scripts using funkwhale-manage
+- Fix missing og meta tags (#2208)
+- Fix multiarch docker builds #2211
+- Fix regression that prevent static files from being served in non-docker-deployments (#2256)
+- Fixed an issue where the copy button didn't copy the Embed code in the embed modal.
+- Fixed an issue with the nginx templates that caused issues when connecting to websockets.
+- Fixed development docker setup (2102)
+- Fixed development docker setup (2196)
+- Fixed embedded player crash when API returns relative listen URL. (#2163)
+- Fixed issue with regular expression in embed.
+- Make Artist ordering by name case insensitive
+- Make sure build requirements for ujson are met
+- Make sure embed codes generated before 1.3.0 are still working
+- Make sure funkwhale_api package and metadata are available for docs
+- Make sure meta tags link to embedded player correctly
+- Merge nginx configs for docker production and development setups (#1939)
+- Updated links to the Funkwhale website in the UI. (#2235)
+- Use correct data field for rate limiting identity field (#2248)
+
+Documentation:
+
+- Add missing `has_mbid` requirement to quality filter spec.
+- Add spec for user following.
+- Added CoC link to nodeinfo endpoint spec.
+- Added multi-artist support spec.
+- Added new collections spec.
+- Added NodeInfo 2.1 specification
+- Archived the pre-1.0 changelog
+- Updated nodeinfo spec to include usage statistics.
+- Updated the Nodeinfo 2 spec to address feedback from implementation.
+
+Other:
+
+- Add build metadata script
+- Don't run CI on branch containing stable or develop
+- Fix CI deploy docs job after stable branch merge
+- Format api container file
+- Lint api code using pylint
+- Make renovate not pinning the python version to the latest one
+- Rename CHANGELOG to CHANGELOG.md
+- Replace docs scripts with make
+- Rework the CI pipeline
+- Use buildx bake in docker job
+
+Removal:
+
+- Drop support for python3.7
+- This release doesn't support Debian 10 anymore. If you are still on Debian 10, we recommend
+ updating to a later version. Alternatively, install a supported Python version (>= Python 3.8). Python 3.11 is recommended.
+
+Contributors to our Issues:
+
+- AMoonRabbit
+- Alexandra Parker
+- ChengChung
+- Ciarán Ainsworth
+- Georg Krause
+- Ghost User
+- Johann Queuniet
+- JuniorJPDJ
+- Kasper Seweryn
+- Kay Borowski
+- Marcos Peña
+- Mathieu Jourdan
+- Nicolas Derive
+- Virgile Robles
+- jooola
+- petitminion
+- theit8514
+
+Contributors to our Merge Requests:
+
+- AMoonRabbit
+- Alexander Dunkel
+- Alexander Torre
+- Ciarán Ainsworth
+- Georg Krause
+- JuniorJPDJ
+- Kasper Seweryn
+- Kay Borowski
+- Marcos Peña
+- Mathieu Jourdan
+- Philipp Wolfer
+- Virgile Robles
+- interfect
+- jooola
+- petitminion
+
+Committers:
+
+- Aitor
+- Alexander Dunkel
+- alextprog
+- Aznörth Niryn
+- Ciarán Ainsworth
+- dignny
+- drakonicguy
+- Fun.k.whale Trad
+- Georg krause
+- Georg Krause
+- Jérémie Lorente
+- jo
+- jooola
+- josé m
+- Julian-Samuel Gebühr
+- JuniorJPDJ
+- Kasper Seweryn
+- Marcos Peña
+- Mathieu Jourdan
+- Matteo Piovanelli
+- Matyáš Caras
+- MhP
+- omarmaciasmolina
+- petitminion
+- Philipp Wolfer
+- ppom
+- Quentin PAGÈS
+- rinenweb
+- Thomas
+- Transcriber allium
+
+## 1.3.4 (2023-11-16)
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html
+
+Bugfixes:
+
+- Remove dangling dependency howler
+
+Documentation:
+
+- Fix a redirect loop on documentation for moderators
+
+Contributors to our Merge Requests:
+
+- Georg Krause
+- Thomas
+
+Committers:
+
+- Georg Krause
+
## 1.3.3 (2023-09-07)
Upgrade instructions are available at
@@ -1559,3345 +1746,3 @@ Contributors to this release (translation, development, documentation, reviews,
- Ventura Pérez García
- vicdorke
- Xosé M
-
-## 0.21.2 (2020-07-27)
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/administrator/upgrade/index.html
-
-Enhancements:
-
-- Added a new ?related=obj_id filter for artists, albums and tracks, based on tags
-- Can now filter subscribed content through API (#1116)
-- Support ordering=random for artists, albums, tracks and channels endpoints (#1145)
-- Use role=alert on forms/toast message to improve accessibility (#1134)
-
-Bugfixes:
-
-- Fix embedded player not working on channel series/album (#1175)
-- Fixed broken mimetype detection during import (#1165)
-- Fixed crash when loading recent albums via Subsonic (#1158)
-- Fixed crash with null help text in admin (#1161)
-- Fixed invalid metadata when importing multi-artists tracks/albums (#1104)
-- Fixed player crash when using Funkwhale as a PWA (#1157)
-- Fixed wrong convert art displaying in some situations (#1138)
-- Make channel card updated times more humanly readable, add internationalization (#1089)
-
-Contributors to this release (development, documentation, reviews):
-
-- Agate
-- Bheesham Persaud
-- Ciarán Ainsworth
-
-## 0.21.1 (2020-06-11)
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/administrator/upgrade/index.html
-
-Features:
-
-- Support a --watch mode with `import_files` to automatically add, update and remove files when filesystem is updated (#721)
-
-Enhancements:
-
-- Added new channels widget on pod landing page (#1113)
-- Fix HTML
not including instance name in some situations (#1107)
-- Make URL-building logic more resilient against reverse proxy misconfiguration (#1085)
-- Removed unused masonry dependency (#1112)
-- Support for specifying itunes:email and itunes:name in channels for compatibility with third-party platforms (#1154)
-- Updated the /api/v1/libraries endpoint to support listing public libraries from other users/pods (#1151)
-
-Bugfixes:
-
-- Added safeguard to ensure local uploads are never purged from cache (#1086)
-- Ensure firefox password manager dont autofill username in search bar (#1090)
-- Ensure player doesn't disappear when last queue track is removed manually (#1092)
-- Ensure tracks linked to skipped upload can be pruned (#1011)
-- Fix playlist modal only listing 50 first playlists (#1087)
-- Fixed a wording issue on artist channel page (#1117)
-- Fixed crash on python 3.5 with cli importer (#1155)
-- Fixed issue when displaying starred tracks on subsonic (#1082)
-- Fixed mimetype detection issue that broke transcoding on some tracks (#1093). Run `python manage.py fix_uploads --mimetype` to set proper mimetypes on existing uploads.
-- Fixed page not refreshing when switching between My Library and Explore sections (#1091)
-- Fixed recursive CLI importing crashing under Python 3.5 (#1148, #1147)
-- Fixed wrong album and track count in admin artist API (#1096)
-- Include tracks by album artist when filtering by artist on /api/v1/tracks (#1078)
-
-### Small API breaking change in `/api/v1/libraries`
-
-To allow easier crawling of public libraries on a pod,we had to make a slight breaking change
-to the behaviour of `GET /api/v1/libraries`.
-
-Before, it returned only libraries owned by the current user.
-
-Now, it returns all the accessible libraries (including ones from other users and pods).
-
-If you are consuming the API via a third-party client and need to retrieve your libraries,
-use the `scope` parameter, like this: `GET /api/v1/libraries?scope=me`
-
-Contributors to this release (development, documentation, reviews, testing):
-
-- Agate
-- Ciarán Ainsworth
-- Creak
-- gisforgabriel
-- Siren
-- Tony Wasserka
-
-## 0.21 "Agate" (2020-04-24)
-
-This 0.21 release is dedicated to Agate, to thank her, for both having created the Funkwhale project, being the current lead developer, and for her courage of coming out. Thank you Agate from all the members of the Funkwhale community <3
-
-We are truly grateful as well to the dozens of people who contributed to this release with translations, development, documentation, reviews, design, testing, feedback, financial support, third-party projects and integrations… You made it possible!
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/administrator/upgrade/index.html, there are also additional operations you need to execute, listed in the changelog below (search "Manual action").
-
-### Channels and podcasts
-
-Funkwhale 0.21 includes a brand new feature: Channels!
-
-Channels can be used as a replacement to public libraries,
-to publish audio content, both musical and non-musical. They federate with other Funkwhale pods, but also other
-fediverse software, in particular Mastodon, Pleroma, Friendica and Reel2Bits, meaning people can subscribe to your channel
-from any of these software. To get started with publication, simply visit your profile and create a channel from there.
-
-Each Funkwhale channel also comes with RSS feed that is compatible with existing podcasting applications, like AntennaPod
-on Android and, within Funkwhale, you can also subscribe to any podcast from its RSS feed!
-
-Many, many thanks to the numerous people who helped with the feature design, development and testing, and in particular
-to the members of the working group who met every week for months in order to get this done, and the members of other third-party
-projects who took the time to work with us to ensure compatibility.
-
-### Redesigned navigation, player and queue
-
-This release includes a full redesign of our navigation, player and queue. Overall, it should provide
-a better, less confusing experience, especially on mobile devices. This redesign was suggested
-14 months ago, and took a while, but thanks to the involvement and feedback of many people, we got it done!
-
-### Improved search bar for searching remote objects
-
-The search bar now support fetching arbitrary objects using a URL. In particular, you can use this to quickly:
-
-- Subscribe to a remote library via its URL
-- Listen a public track from another pod
-- Subscribe to a channel
-
-### Screening for sign-ups and custom sign-up form
-
-Instance admins can now configure their pod so that registrations required manual approval from a moderator. This
-is especially useful on private or semi-private pods where you don't want to close registrations completely,
-but don't want spam or unwanted users to join your pod.
-
-When this is enabled and a new user register, their request is put in a moderation queue, and moderators
-are notified by email. When the request is approved or refused, the user is also notified by email.
-
-In addition, it's also possible to customize the sign-up form by:
-
-- Providing a custom help text, in markdown format
-- Including additional fields in the form, for instance to ask the user why they want to join. Data collected through these fields is included in the sign-up request and viewable by the mods
-
-### Federated reports
-
-It's now possible to send a copy of a report to the server hosting the reported object, in order to make moderation easier and more distributed.
-
-This feature is inspired by Mastodon's current design, and should work with at least Funkwhale and Mastodon servers.
-
-### Improved search performance
-
-Our search engine went through a full rewrite to make it faster. This new engine is enabled
-by default when using the search bar, or when searching for artists, albums and tracks. It leverages
-PostgreSQL full-text search capabilities.
-
-During our tests, we observed huge performance improvements after the switch, by an order of
-magnitude. This should be especially perceptible on pods with large databases, more modest hardware
-or hard drives.
-
-We plan to remove the old engine in an upcoming release. In the meantime, if anything goes wrong,
-you can switch back by setting `USE_FULL_TEXT_SEARCH=false` in your `.env` file.
-
-### Enforced email verification
-
-The brand new `ACCOUNT_EMAIL_VERIFICATION_ENFORCE` setting can be used to make email verification
-mandatory for your users. It defaults to `false`, and doesn't apply to superuser accounts created through
-the CLI.
-
-If you enable this, ensure you have a SMTP server configured too.
-
-### More reliable CLI importer [manual action required]
-
-Our CLI importer is now more reliable and less prone to Out-of-Memory issues, especially when scanning large libraries. (hundreds of GB or bigger)
-
-We've also improved the directory crawling logic, so that you don't have to use glob patterns or specify extensions when importing. As a result, the syntax for providing directories to the command as changed slightly.
-
-If you use the `import_files` command, this means you should replace scripts that look like this:
-
-```sh
-python api/manage.py import_files $LIBRARY_ID "/srv/funkwhale/data/music/**/*.ogg" "/srv/funkwhale/data/music/**/*.mp3" --recursive --noinput
-```
-
-By this:
-
-```sh
-python api/manage.py import_files $LIBRARY_ID "/srv/funkwhale/data/music/" --recursive --noinput
-```
-
-And Funkwhale will happily import any supported audio file from the specified directory.
-
-### User management through the server CLI
-
-We now support user creation (incl. non-admin accounts), update and removal directly
-from the server CLI. Typical use cases include:
-
-- Changing a user password from the command line
-- Creating or updating users from deployments scripts or playbooks
-- Removing or granting permissions or upload quota to multiple users at once
-- Marking multiple users as inactive
-
-All user-related commands are available under the `python manage.py fw users` namespace.
-Please refer to the [Admin documentation](https://docs.funkwhale.audio/admin/commands.html#user-management) for
-more information and instructions.
-
-### Progressive web app [Manual action suggested, non-docker only]
-
-We've made Funkwhale's Web UI a Progressive Web Application (PWA), in order to improve the user experience
-during offline use, and on mobile devices.
-
-In order to fully benefit from this change, if your pod isn't deployed using Docker, ensure
-the following instruction is present in your nginx configuration:
-
-```nginx
-location /front/ {
- # Add the following line in the /front/ location
- add_header Service-Worker-Allowed "/";
-}
-```
-
-### Postgres docker changed environment variable [manual action required, docker multi-container only]
-
-If you're running with docker and our multi-container setup, there was a breaking change starting in the 11.7 postgres image (https://github.com/docker-library/postgres/pull/658)
-
-You need to add this to your .env file: `POSTGRES_HOST_AUTH_METHOD=trust`
-
-Newer deployments aren't affected.
-
-### Upgrade from Postgres 10 to 11 [manual action required, docker all-in-one only]
-
-With our upgrade to Alpine 3.10, the `funkwhale/all-in-one` image now includes PostgreSQL 11.
-
-In order to update to Funkwhale 0.21, you will first need to upgrade Funkwhale's PostgreSQL database, following the steps below:
-
-```sh
-# open a shell as the Funkwhale user
-sudo -u funkwhale -H bash
-
-# move to the funkwhale data directory
-# (replace this with your own if you used a different path)
-cd /srv/funkwhale/data
-
-# stop the funkwhale container
-docker stop funkwhale
-
-# backup the database files
-cp -r data/ ../postgres.bak
-
-# Upgrade the database
-docker run --rm \
- -v $(pwd)/data:/var/lib/postgresql/10/data \
- -v $(pwd)/upgraded-postgresql:/var/lib/postgresql/11/data \
- -e PGUSER=funkwhale \
- -e POSTGRES_INITDB_ARGS="-U funkwhale --locale C --encoding UTF8" \
- tianon/postgres-upgrade:10-to-11
-
-# replace the Postgres 10 files with Postgres 11 files
-mv data/ postgres-10
-mv upgraded-postgresql/ data
-```
-
-Once you have completed the Funkwhale upgrade with our regular instructions and everything works properly,
-you can remove the backups/old files:
-
-```sh
-sudo -u funkwhale -H bash
-cd /srv/funkwhale/data
-rm -rf ../postgres.bak
-rm -rf postgres-10
-```
-
-### Full list of changes
-
-Features:
-
-- Support for publishing and subscribing to podcasts (#170)
-- Brand new navigation, queue and player redesign (#594)
-- Can now browse a library content through the UI (#926)
-- Federated reports (#1038)
-- Screening for sign-ups (#1040)
-- Make it possible to enforce email verification (#1039)
-- Added a new radio based on another user listenings (#1060)
-- User management through the server CLI
-
-Enhancements:
-
-- Added ability to reject library follows from notifications screen (#859)
-- Added periodic background task and CLI command to associate genre tags to artists and albums based on identical tags found on corresponding tracks (#988)
-- Added support for CELERYD_CONCURRENCY env var to control the number of worker processes (#997)
-- Added the ability to sort albums by release date (#1013)
-- Added two new radios to play your own content or a given library tracks
-- Advertise list of known nodes on /api/v1/federation/domains and in nodeinfo if stats sharing is enabled
-- Changed footer to use instance name if available, and append ellipses if instance URL/Name is too long (#1012)
-- Favor local uploads when playing a track with multiple uploads (#1036)
-- Include only local content in nodeinfo stats, added downloads count
-- Make media and static files serving more reliable when reverse proxy `X_FORWARDED_*` headers are incorrect (#947)
-- Order the playlist columns by modification date in the Browse tab (#775)
-- Reduced size of funkwhale/funkwhale docker images thanks to multi-stage builds (!1042)
-- Remember display settings in Album, Artist, Radio and Playlist views (#391)
-- Removed unnecessary "Federation music needs approval" setting (#959)
-- Replaced our slow research logic by PostgreSQL full-text search (#994)
-- Support autoplay when loading embed frame from Mastodon and third-party websites (#1041)
-- Support filtering playlist by name and several additional UX improvements in playlists modal (#974)
-- Support modifying album cover art through the web UI (#588)
-- Use a dedicated scope for throttling subsonic to avoid intrusive rate-limiting
-- Use same markdown widget for all content fields (rules, description, reports, notes, etc.)
-- CLI Importer is now more reliable and less resource-hungry on large libraries
-- Add support custom domain for S3 storage
-- Better placeholders for channels when there are no episodes or series
-- Updated documentation for 0.21 release
-- Improved performance and error handling when fetching remote attachments
-
-Bugfixes:
-
-- Added missing manuallyApprovesFollowers entry in JSON-LD contexts (#961)
-- Fix issue with browser shortcuts such as search and focus URL not being recognised (#340, #985)
-- Fixed admin dropdown not showing after login (#1042)
-- Fixed an issue with celerybeat container failing to restart (#1004)
-- Fixed invalid displayed number of tracks in playlist (#986)
-- Fixed issue with recent results not being loaded from the API (#948)
-- Fixed issue with sorting by album name not working (#960)
-- Fixed short audio glitch when switching switching to another track with player paused (#970)
-- Improved deduplication logic to prevent skipped files during import (#348, #474, #557, #740, #928)
-- More resilient tag parsing with empty release date or album artist (#1037)
-- More robust importer against malformed dates (#966)
-- Removed "nodeinfo disabled" setting, as nodeinfo is required for the UI to work (#982)
-- Replaced PDF icon by List icon in playlist placeholder (#943)
-- Resolve an issue where disc numbers were not taken into consideration when playing an album from the album card (#1006)
-- Set correct size for album covers in playlist cards (#680)
-- Remove double spaces in ChannelForm
-- Deduplicate tags in Audio ActivityPub representation
-- Add support custom domain for S3 storage
-- Fix #1079: fixed z-index issues with dropdowns (#1079 and #1075)
-- Exclude external podcasts from library home
-- Fixed broken channel save when description is too long
-- Fixed 500 error when federation is disabled and application+json is requested
-- Fixed minor subsonic API crash
-- Fixed broken local profile page when allow-list is enabled
-- Fixed issue with confirmation email not sending when signup-approval was enabled
-- Ensure 0 quota on user is honored
-- Fixed attachments URL not honoring media URL
-- Fix grammar in msg string in TrackBase.vue
-- Fix typo in SubscribeButton.vue
-
-Translations:
-
-- Arabic
-- Catalan
-- English (United Kingdom)
-- German
-- Hungarian
-- Japanese
-- Occitan
-- Portuguese (Brazil)
-- Russian
-
-Contributors to this release (translation, development, documentation, reviews, design, testing, third-party projects):
-
-- Agate
-- annando
-- Anton Strömkvist
-- Audrey
-- ButterflyOfFire
-- Ciarán Ainsworth
-- Creak
-- Daniele Lira Mereb
-- dashie
-- Eloisa
-- eorn
-- Francesc Galí
-- gerhardbeck
-- GinnyMcQueen
-- guillermau
-- Haelwenn
-- jinxx
-- Jonathan Aylard
-- Keunes
-- M.G
-- marzzzello
-- Mathé Grievink
-- Mélanie Chauvel
-- Mjourdan
-- Morgan Kesler
-- Noe Gaumont
-- Noureddine HADDAG
-- Ollie
-- Peter Wickenberg
-- Quentin PAGÈS
-- Renon
-- Satsuki Yanagi
-- Shlee
-- SpcCw
-- techknowlogick
-- ThibG
-- Tony Wasserka
-- unklebonehead
-- wakest
-- wxcafé
-- Xaloc
-- Xosé M
-
-## 0.20.1 (2019-10-28)
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/administrator/upgrade/index.html
-
-### Denormalized audio permission logic in a separate table to enhance performance
-
-With this release, we're introducing a performance enhancement that should reduce the load on the database and API
-servers (cf https://dev.funkwhale.audio/funkwhale/funkwhale/merge_requests/939).
-
-Under the hood, we now maintain a separate table to link users to the tracks they are allowed to see. This change is **disabled**
-by default, but should be enabled by default starting in Funkwhale 0.21.
-
-If you want to try it now, add
-`MUSIC_USE_DENORMALIZATION=True` to your `.env` file, restart Funkwhale, and run the following command:
-
-```sh
-python manage.py rebuild_music_permissions
-```
-
-This shouldn't cause any regression, but we'd appreciate if you could test this before the 0.21 release and report any unusual
-behaviour regarding tracks, albums and artists visibility.
-
-Enhancements:
-
-- Added a retry option for failed uploads (#942)
-- Added feedback via loading spinner when searching a remote library
-- Denormalized audio permission logic in a separate table to enhance performance
-- Placeholders will now be shown if no content is available across the application (#750)
-- Reduce the number of simultaneous DB connections under some deployment scenario
-- Support byYear filtering in Subsonic API (#936)
-
-Bugfixes:
-
-- Ensure password input doesn't overflow outside of container (#933)
-- Fix audio serving issues under S3/nginx when signatures are enabled
-- Fix import crash when importing M4A file with no embedded cover (#946)
-- Fix tag exclusion in custom radios (#950)
-- Fixed an issue with embed player CSS being purged during build (#935)
-- Fixed escaped pod name displayed on home/about page (#945)
-- Fixed pagination in subsonic getSongsByGenre endpoint (#954)
-- Fixed style glitches in dropdowns
-
-Documentation:
-
-- Documented how to create DB extension by hand in case of permission error during migrations (#934)
-
-Contributors to this release (translation, development, documentation, reviews, design):
-
-- Ciarán Ainsworth
-- Dag Stenstad
-- Daniele Lira Mereb
-- Agate
-- Esteban
-- Johannes H.
-- knuxify
-- Mateus Mattei Garcia
-- Quentin PAGÈS
-
-## 0.20 (2019-10-04)
-
-Upgrade instructions are available at https://docs.funkwhale.audio/admin/upgrading.html
-
-### Support for genres via tags
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/administrator/upgrade/index.html
-
-One of our most requested missing features is now available!
-
-Starting with Funkwhale 0.20,
-Funkwhale will automatically extract genre information from uploaded files and associate it
-with the corresponding tracks in the form of tags (similar to Mastodon or Twitter hashtags).
-Please refer to [our tagging documentation](https://docs.funkwhale.audio/users/upload.html#tagging-files)
-for more information regarding the tagging process.
-
-Tags can also be associated with artists and albums, and updated after upload through the UI using
-the edit system released in Funkwhale 0.19. Tags are also fetched when retrieving content
-via federation.
-
-Tags are used in various places to enhance user experience:
-
-- Tags are listed on tracks, albums and artist profiles
-- Each tag has a dedicated page were you can browse corresponding content and quickly start a radio
-- The custom radio builder now supports using tags
-- Subsonic apps that support genres - such as DSub or Ultrasonic - should display this information as well
-
-If you are a pod admin and want to extract tags from already uploaded content, you run [this snippet](https://dev.funkwhale.audio/funkwhale/funkwhale/snippets/43)
-and [this snippet](https://dev.funkwhale.audio/funkwhale/funkwhale/snippets/44) in a `python manage.py shell`.
-
-### Content and account reports
-
-It is now possible to report content, such as artists, tracks or libraries, as well as user accounts. Such reports are forwarded to the pod moderators,
-who can review it and delete reported content, block accounts or take any other action they deem necessary.
-
-By default, both anonymous and authenticated users can submit these reports. This makes sure moderators can receive and handle
-takedown requests and other reports for illegal content that may be sent by third-parties without an account on the pod. However,
-you can disable anonymous reports completely via your pod settings.
-
-Federation of the reports will be supported in a future release.
-
-For more information about this feature, please check out our documentation:
-
-- [User documentation](https://docs.funkwhale.audio/moderator/reports.html)
-- [Moderator documentation](https://docs.funkwhale.audio/users/reports.html)
-
-### Account deletion
-
-Users can now delete their account themselves, without involving an administrator.
-
-The deletion process will remove any local data and objects associated with the account,
-but the username won't be able to new users to avoid impersonation. Deletion is also broadcasted
-to other known servers on the federation.
-
-For more information about this feature, please check out our documentation:
-
-- [User documentation](https://docs.funkwhale.audio/users/account.html)
-
-### Landing and about page redesign [Manual action suggested]
-
-In this release, we've completely redesigned the landing and about page, by making it more useful and adapted to your pod
-configuration. Among other things, the landing page will now include:
-
-- your pod and an excerpt from your pod's description
-- your pod banner image, if any
-- your contact email, if any
-- the login form
-- the signup form (if registrations are open on your pod)
-- some basic statistics about your pod
-- a widget including recently uploaded albums, if anonymous access is enabled
-
-The landing page will still include some information about Funkwhale, but in a less intrusive and proeminent way than before.
-
-Additionally, the about page now includes:
-
-- your pod name, description, rules and terms
-- your pod banner image, if any
-- your contact email, if any
-- comprehensive statistics about your pod
-- some info about your pod configuration, such as registration and federation status or the default upload quota for new users
-
-With this redesign, we've added a handful of additional pod settings:
-
-- Pod banner image
-- Contact email
-- Rules
-- Terms of service
-
-We recommend taking a few moments to fill these accordingly to your needs, by visiting `/manage/settings`.
-
-### Allow-list to restrict federation to trusted domains
-
-The Allow-Listing feature grants pod moderators
-and administrators greater control over federation
-by allowing you to create a pod-wide allow-list.
-
-When allow-listing is enabled, your pod's users will only
-be able to interact with pods included in the allow-list.
-Any messages, activity, uploads, or modifications to
-libraries and playlists will only be shared with pods
-on the allow-list. Pods which are not included in the
-allow-list will not have access to your pod's content
-or messages and will not be able to send anything to
-your pod.
-
-If you want to enable this feature on your pod, or learn more, please refer to [our documentation](https://docs.funkwhale.audio/moderator/listing.html)!
-
-### Periodic message to incite people to support their pod and Funkwhale
-
-Users will now be reminded on a regular basis that they can help Funkwhale by donating or contributing.
-
-If specified by the pod admin, a separate and custom message will also be displayed in a similar way to provide instructions and links to support the pod.
-
-Both messages will appear for the first time 15 days after signup, in the notifications tab. For each message, users can schedule a reminder for a later time, or disable the messages entirely.
-
-### Replaced Daphne by Gunicorn/Uvicorn [manual action required, non-docker only]
-
-To improve the performance, stability and reliability of Funkwhale's web processes,
-we now recommend using Gunicorn and Uvicorn instead of Daphne. This combination unlock new use cases such as:
-
-- zero-downtime upgrades
-- configurable number of web worker processes
-
-Based on our benchmarks, Gunicorn/Unicorn is also faster and more stable under higher workloads compared to Daphne.
-
-To benefit from this enhancement on existing instances, you need to add `FUNKWHALE_WEB_WORKERS=1` in your `.env` file
-(use a higher number if you want to have more web worker processes).
-
-Then, edit your `/etc/systemd/system/funkwhale-server.service` and replace the `ExecStart=` line with
-`ExecStart=/srv/funkwhale/virtualenv/bin/gunicorn config.asgi:application -w ${FUNKWHALE_WEB_WORKERS} -k uvicorn.workers.UvicornWorker -b ${FUNKWHALE_API_IP}:${FUNKWHALE_API_PORT}`
-
-Then reload the configuration change with `sudo systemctl daemon-reload` and `sudo systemctl restart funkwhale-server`.
-
-### Content-Security-Policy and additional security headers [manual action suggested]
-
-To improve the security and reduce the attack surface in case of a successful exploit, we suggest
-you add the following Content-Security-Policy to your nginx configuration.
-
-````{note}
-If you are using an S3-compatible store to serve music, you will need to specify the URL of your S3 store in the ``media-src`` and ``img-src`` headers
-
-```nginx
-add_header Content-Security-Policy "...img-src 'self' https:// data:;...media-src https:// 'self' data:";
-```
-````
-
-**On non-docker setups**, in `/etc/nginx/sites-available/funkwhale.conf`:
-
-```nginx
-server {
-
- add_header Content-Security-Policy "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; object-src 'none'; media-src 'self' data:";
- add_header Referrer-Policy "strict-origin-when-cross-origin";
-
- location /front/ {
- add_header Content-Security-Policy "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; object-src 'none'; media-src 'self' data:";
- add_header Referrer-Policy "strict-origin-when-cross-origin";
- add_header X-Frame-Options "SAMEORIGIN";
- # … existing content here
- }
-
- # Also create a new location for the embeds to ensure external iframes work
- # Simply copy-paste the /front/ location, but replace the following lines:
- location /front/embed.html {
- add_header X-Frame-Options "ALLOW";
- alias ${FUNKWHALE_FRONTEND_PATH}/embed.html;
- }
-}
-```
-
-Then reload nginx with `systemctl reload nginx`.
-
-**On docker setups**, in `/srv/funkwhalenginx/funkwhale.template`:
-
-```nginx
-server {
-
- add_header Content-Security-Policy "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; object-src 'none'; media-src 'self' data:";
- add_header Referrer-Policy "strict-origin-when-cross-origin";
-
- location /front/ {
- add_header Content-Security-Policy "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; object-src 'none'; media-src 'self' data:";
- add_header Referrer-Policy "strict-origin-when-cross-origin";
- add_header X-Frame-Options "SAMEORIGIN";
- # … existing content here
- }
-
- # Also create a new location for the embeds to ensure external iframes work
- # Simply copy-paste the /front/ location, but replace the following lines:
- location /front/embed.html {
- add_header X-Frame-Options "ALLOW";
- alias /frontend/embed.html;
- }
-}
-
-```
-
-Then reload nginx with `docker-compose restart nginx`.
-
-### Rate limiting
-
-With this release, rate-limiting on the API is enabled by default, with high enough limits to ensure
-regular users of the app aren't affected. Requests beyond allowed limits are answered with a 429 HTTP error.
-
-For anonymous requests, the limit is applied to the IP address of the client, and for authenticated requests, the limit
-is applied to the corresponding user account. By default, anonymous requests get a lower limit than authenticated requests.
-
-You can disable the rate-limiting feature by adding `THROTTLING_ENABLED=false` to your `.env` file and restarting the
-services. If you are using the Funkwhale API in your project or app and want to know more about the limits, please consult https://docs.funkwhale.audio/swagger/.
-
-### Broken audio streaming when using S3/Minio and DSub [manual action required]
-
-Some Subsonic clients, such as DSub, are sending an Authorization headers which was forwarded
-to the S3 storage when streaming, causing some issues. If you are using S3 or a compatible storage
-such as Minio, please add the following in your nginx `~ /_protected/media/(.+)` location:
-
-```nginx
-# Needed to ensure DSub auth isn't forwarded to S3/Minio, see #932
-proxy_set_header Authorization "";
-```
-
-And reload your nginx process.
-
-### Detail
-
-Features:
-
-- Added periodical message to incite people to support their pod and Funkwhale (#839)
-- Admins can now add custom CSS from their pod settings (#879)
-- Allow-list to restrict federation to trusted domains (#853)
-- Content and account reports (#890)
-- Dark theme (#756)
-- Enforce a configurable rate limit on the API to mitigate abuse (#261)
-- Redesign of the landing and about pages (#872)
-- Support for genres, via tags (#432)
-- Users can now delete their account without admin intervention (#852)
-
-Enhancements:
-
-- Added a info message on embed wizard when anonymous access to content is disabled (#878)
-- Added Catalan translation files
-- Added Czech translation (#844)
-- Added field to manage user upload quota in Django backend (#903)
-- Added the option to replace the queue's current contents with a selected album or track (#761)
-- Artists with no albums will now show track count on artist card (#895)
-- Ensure API urls answer with and without a trailing slash (#877)
-- Hardcoded list of supported browsers to avoid unexpected regressions (#854)
-- Hardened security thanks to CSP and additional HTTP headers (#880)
-- Improve display of search results by including artist and album data
-- Increase the security of JWT token generation by using DJANGO_SECRET_KEY as well as user-specific salt for the signature
-- Mods can now change a library visibility through the admin UI (#548)
-- New keyboard shortcuts added for enhanced control over audio player (#866)
-- Now refetch remote ActivityPub artists, albums and tracks to avoid local stale data
-- Numbers on the stats page will now be formatted in a human readable way and will update with the locale (#873)
-- Pickup folder.png and folder.jpg files for cover art when importing from CLI (#898)
-- Prevent usage of too weak passwords (#883)
-- Reduced CSS size by 30% using purgecss
-- Replaced Daphne by Gunicorn/Uvicorn to improve stability, flexibility and performance (#862)
-- Simplified embedded docker reverse proxy IP configuration (#834)
-- Support embeds on public playlists
-- Support for M4A/AAC files (#661)
-- Switched from Semantic-UI to Fomentic-UI
-- Add dropdown menu to track table (#531)
-- Display placeholder on homepage when there are no playlists (#892)
-- Make album cards height independent (#710)
-
-Bugfixes:
-
-- Added context strings to en_GB translations so that picking the language changes the interface as expected
-- Ensure selected locale is not reset to browser default when refreshing app
-- Fix missing license information on track details page (#913)
-- Fix regression to quota bar color (#897)
-- Fixed a responsive display issues on 1024px wide screens (#904)
-- Fixed album art not being retrieved from Ogg/Opus files
-- Fixed broken embedded player layout after dependency update (#875)
-- Fixed broken external HTTPS request under some scenarios, because of missing PyOpenSSL
-- Fixed broken less listened radio (#912)
-- Fixed broken URL to artist and album on album and track pages (#871)
-- Fixed empty contentType causing client crash in some Subsonic payloads (#893)
-- Fixed import crashing with empty cover file or too long values on some fields
-- Fixed in-place imported files not playing under nginx when filename contains ? or % (#924)
-- Fixed remaining transcoding issue with Subsonic API (#867)
-- Fixed search usability issue when browsing artists, albums, radios and playlists (#902)
-- Improved performance of /artists, /albums and /tracks API endpoints by a factor 2 (#865)
-- Updated docs to ensure streaming works when using Minio/S3 and DSub (#932)
-
-Contributors to this release (translation, development, documentation, reviews, design):
-
-- Amaranthe
-- ButterflyOfFire
-- Ciarán Ainsworth
-- Agate
-- Esteban
-- Francesc Galí
-- Freyja Wildes
-- hellekin
-- IISergII
-- jiri-novacek
-- Johannes H.
-- Keunes
-- Koen
-- Manuel Cortez
-- Mehdi
-- Mélanie Chauvel
-- nouts
-- Quentí
-- Reg
-- Rodrigo Leite
-- Romain Failliot
-- SpcCw
-- Sylke Vicious
-- Tobias Reisinger
-- Xaloc
-- Xosé M
-
-## 0.19.1 (2019-06-28)
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/administrator/upgrade/index.html
-
-Enhancements:
-
-- The currently playing track is now highlighted with an orange play icon (#832)
-- Support for importing files with no album tag (#122)
-- Redirect from / to /library when user is logged in (#864)
-- Added a SUBSONIC_DEFAULT_TRANSCODING_FORMAT env var to support clients that don't provide the format parameter (#867)
-- Added button to search for objects on Discogs (#368)
-- Added copy-to-clipboard button with Subsonic password input (#814)
-- Added opus to the list of supported mimetypes and extensions (#868)
-- Aligned search headers with search results in the sidebar (#708)
-- Clicking on the currently selected playlist in the Playlist popup will now close the popup (#807)
-- Favorites radio will not be visible if the user does not have any favorites (#419)
-
-Bugfixes:
-
-- Ensure empty but optional fields in file metadata don't error during import (#850)
-- Fix broken upload for specific files when using S3 storage (#857)
-- Fixed broken translation on home and track detail page (#833)
-- Fixed broken user admin for users with non-digit or letters in their username (#869)
-- Fixed invalid file extension for transcoded tracks (#848)
-- Fixed issue with French translation for "Start radio" (#849)
-- Fixed issue with player changing height when hovering over the volume slider (#838)
-- Fixed secondary menus truncated on narrow screens (#855)
-- Fixed wrong og:image url when using S3 storage (#851)
-- Hide pod statistics on about page if those are disabled (#835)
-- Use ASCII filename before upload to S3 to avoid playback issues (#847)
-
-Contributors to this release (committers and reviewers):
-
-- Ciarán Ainsworth
-- Creak
-- ealgase
-- Agate
-- Esteban
-- Freyja Wildes
-- hellekin
-- Johannes H.
-- Mehdi
-- Reg
-
-## 0.19.0 (2019-05-16)
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/administrator/upgrade/index.html
-
-### Edits on tracks, albums and artists
-
-Funkwhale was a bit annoying when it camed to metadata. Tracks, albums and artists profiles
-were created from audio file tags, but basically immutable after that (unless you had
-admin access to Django's UI, which wasn't ideal to do this kind of changes).
-
-With this release, everyone can suggest changes on track, album and artist pages. Users
-with the "library" permission can review suggested edits in a dedicated interface
-and apply/reject them.
-
-Approved edits are broadcasted via federation, to ensure other instances get the information
-too.
-
-Not all fields are currently modifiable using this feature. Especially, it's not possible
-to suggest a new album cover, or reassign a track to a different album or artist. Those will
-be implemented in a future release.
-
-### Admin UI for tracks, albums, artists, libraries and uploads
-
-As part of our ongoing effort to make Funkwhale easier to manage for instance owners,
-this release includes a brand new administration interface to deal with:
-
-- tracks
-- albums
-- artists
-- libraries
-- uploads
-
-You can use this UI to quickly search for any object, delete objects in batch, understand
-where they are coming from etc. This new UI should remove the need to go through Django's
-admin in the vast majority of cases (but also includes a link to Django's admin when needed).
-
-### Artist hiding in the interface
-
-It's now possible for users to hide artists they don't want to see.
-
-Content linked to hidden artists will not show up in the interface anymore. Especially:
-
-- Hidden artists tracks are removed from the current queue
-- Starting a playlist will skip tracks from hidden artists
-- Recently favorited, recently listened and recently added widgets on the homepage won't include content from hidden artists
-- Radio suggestions will exclude tracks from hidden artists
-- Hidden artists won't appear in Subsonic apps
-
-Results linked to hidden artists will continue to show up in search results and their profile page remains accessible.
-
-### OAuth2 authorization for better integration with third-party apps
-
-Funkwhale now support the OAuth2 authorization and authentication protocol which will allow
-third-party apps to interact with Funkwhale on behalf of users.
-
-This feature makes it possible to build third-party apps that have the same capabilities
-as Funkwhale's Web UI. The only exception at the moment is for actions that requires
-special permissions, such as modifying instance settings or moderation (but this will be
-enabled in a future release).
-
-If you want to start building an app on top of Funkwhale's API, please check-out
-https://docs.funkwhale.audio/api.html and https://docs.funkwhale.audio/developers/authentication.html.
-
-### Better error handling and display during import
-
-Funkwhale should now be more resilient to missing tags in imported files, and give
-you more insights when something goes wrong, including the specific tags that were missing
-or invalid, and additional debug information to share in your support requests.
-
-This information is available in all pages that list uploads, when clicking on the button next to the upload status.
-
-### Support for S3-compatible storages to store media files
-
-Storing all media files on the Funkwhale server itself may not be possible or desirable
-in all scenarios. You can now configure Funkwhale to store those files in a S3
-bucket instead.
-
-Check-out https://docs.funkwhale.audio/admin/external-storages.html if you want to use
-this feature.
-
-### Prune library command
-
-Users are often surprised by Funkwhale's tendency to keep track, album and artist
-metadata even if no associated files exist.
-
-To help with that, we now offer a `prune_library` management command you can run
-to purge your database from obsolete entries. [Please refer to our documentation for usage instructions](https://docs.funkwhale.audio/admin/commands.html#pruning-library).
-
-### Check in-place files command
-
-When using in-place import with a living audio library, you'll quite often rename or
-remove files from the file system. Unfortunately, Funkwhale keeps a reference to those
-files in the database, which results in unplayable tracks.
-
-To help with that, we now offer a `check_inplace_files` management command you can run
-to purge your database from obsolete files. [Please refer to our documentation for usage instructions](https://docs.funkwhale.audio/admin/commands.html#remove-obsolete-files-from-database).
-
-Features:
-
-- Added albums view. Similar to artists view, it's viewable by clicking on the "Albums" link on the top bar. (#356)
-- Allow artists hiding (#701)
-- Change the document title to display current track information. (#359)
-- Display a confirmation dialog when adding duplicate songs to a playlist (#784)
-- Improved error handling and display during import (#252, #718, #583, #501, #544)
-- Support embedding full artist discographies (#747)
-- Support metadata update on tracks, albums and artists and broadcast those on the federation (#689)
-- Support OAuth2 authorization for better integration with third-party apps (#752)
-- Support S3-compatible storages for media files (#565)
-
-Enhancements:
-
-- [Experimental] Added a new "Similar" radio based on users history (suggested by @gordon)
-- Added a "load more" button on artist pages to load more tracks/albums (#719)
-- Added a `check_inplace_files` management command to remove purge the database from references to in-place imported files that don't exist on disk anymore (#781)
-- Added a prune_library management command to remove obsolete metadata from the database (#777)
-- Added admin options to disable login for users, ensure related content is deleted when deleting a user account (#809)
-- Added standardized translation context for all strings in the frontend to give accurate hints to translators.
-- Added twitter:\* meta tags to detect tracks and albums players automatically on more sites (#578)
- Improved responsiveness of embedded player
-- Advertise the list of supported upload extensions in the Nodeinfo endpoint (#808)
-- Better handling of follow/accept messages to avoid and recover from desync between instances (#830)
-- Better workflow for connecting to another instance (#715)
-
- Changing the instance used is now better integrated in the App, and it is checked that the chosen instance and the suggested instances are valid and running Funkwhale servers.
-
-- Bumped dependencies to latest versions (#815)
-- Descriptions will now be shown underneath user libraries (#768)
-- Don't store unhandled ActivityPub messages in database (#776)
-- Enhanced the design of the embed wizard. (!619)
-- Ensure the footer always stays at the bottom of the page
-- Expose an instance-level actor (service@domain) in nodeinfo endpoint (#689)
-- Improved readability of logo (#385)
-- Keep persistent connections to the database instead of recreating a new one for each request
-- Labels for privacy levels are now consistently grabbed from a common source instead of being hardcoded every time they are needed.
-- Merged artist/album buttons with title text on artist and album pages (#725)
-- Now honor maxBitrate parameter in Subsonic API (#802)
-- Preload next track in queue (#572)
-- Reduced app size for regular users by moving admin-related code in a dedicated chunk (#805)
-- Removed broken/instable lyrics feature (#799)
-- Show remaining storage space during import and prevent file upload if not enough space is remaining (#550)
-- The buttons displaying an icon now always show a little divider between the icon and the text. (!620)
-- Use attributedTo instead of actor in library ActivityPub payload (#619)
-- Use network/depends_on instead of links in docker-compose.yml (!716)
-
-Bugfixes:
-
-- Add missing command from contributing file (#754)
-- Add required envvar for dev environment (!668)
-- Added env variable to set AWS region and signature version to serve media without proxy (#826)
-- Allow users with dots in their usernames to request a subsonic password (#798)
-- Better handling of featuring/multi-artist tracks tagged with MusicBrainz (#782)
-- Do not consider tracks as duplicates during import if they have different positions (#740)
-- Ensure all our ActivityPub fetches are authenticated (#758)
-- Ensure correct track duration and playable status when browsing radios (#812)
-- Fixed alignment/size issue with some buttons (#702)
-- Fixed an encoding issue with instance name on about page (#828)
-- Fixed cover not showing in queue/player when playing tracks from "albums" tab (#795)
-- Fixed crashing upload processing on invalid date format (#718)
-- Fixed dev command for fake data creation (!664)
-- Fixed invalid OEmbed URL when using a local FUNKWHALE_SPA_HTML_ROOT (#824)
-- Fixed invalid required fields in Upload django's admin (#819)
-- Fixed issue with querying the albums api endpoint (#356)
-- Fixed non-transparent background for volume range on Firefox (#722)
-- Fixed overflowing input on account detail page (#791)
-- Fixed unplayable radios for anonymous users (#563)
-- Prevent skipping on file import if album_mbid is different (#772)
-- Use proper site name/domain in emails (#806)
-- Width of filter menus for radios has been set to stop text from overlapping the borders
-
-Documentation:
-
-- Document how to use Redis over unix sockets (#770)
-
-Contributors to this release (committers and translators):
-
-- Ale London
-- Alexander
-- Ben Finney
-- ButterflyOfFire
-- Ciarán Ainsworth
-- Damien Nicolas
-- Daniele Lira Mereb
-- Agate
-- Elza Gelez
-- gerry_the_hat
-- gordon
-- interfect
-- jake
-- Jee
-- jovuit
-- Mélanie Chauvel
-- nouts
-- Pierrick
-- Qasim Ali
-- Quentí
-- Renon
-- Rodrigo Leite
-- Sylke Vicious
-- Thomas Brockmöller
-- Tixie
-- Vierkantor
-- Von
-- Zach Halasz
-
-## 0.18.3 (2019-03-21)
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/administrator/upgrade/index.html
-
-### Avoid mixed content when deploying mono-container behind proxy [Manual action required]
-
-_You are only concerned if you use the mono-container docker deployment behind a reverse proxy_
-
-Because of [an issue in our mono-container configuration](https://github.com/thetarkus/docker-funkwhale/issues/19), users deploying Funkwhale via docker
-using our `funkwhale/all-in-one` image could face some mixed content warnings (and possibly other troubles)
-when browsing the Web UI.
-
-This is fixed in this release, but on existing deployments, you'll need to add `NESTED_PROXY=1` in your container
-environment (either in your `.env` file, or via your container management tool), then recreate your funkwhale container.
-
-Enhancements:
-
-- Added title on hover for truncated content (#766)
-- Ask for confirmation before leaving upload page if there is a an upload in process (#630)
-- Exclude in-place imported files from quota computation (#570)
-- Truncate filename in library file table to ensure correct display of the table. (#735)
-
-Bugfixes:
-
-- Avoid mixed content when deploying mono-container behind HTTPS proxy (thetarkus/docker-funkwhale#19)
-- Display new notifications immediately on notifications page (#729)
-- Ensure cover art from uploaded files is picked up properly on existing albums (#757)
-- Fixed a crash when federating a track with unspecified position
-- Fixed broken Activity and Actor modules in django admin (#767)
-- Fixed broken sample apache configuration (#764)
-- Fixed constant and unpredictable reordering during file upload (#716)
-- Fixed delivering of local activities causing unintended side effects, such as rollbacking changes (#737)
-- Fixed escaping issues in translated strings (#652)
-- Fixed saving moderation policy when clicking on "Cancel" (#751)
-- i18n: Update page title when changing the App's language. (#511)
-- Include disc number in Subsonic responses (#765)
-- Do not send notification when rejecting a follow on a local library (#743)
-
-Documentation:
-
-- Added documentation on mono-container docker upgrade (#713)
-- Added documentation to set up let's encrypt certificate (#745)
-
-## 0.18.2 (2019-02-13)
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/administrator/upgrade/index.html
-
-Enhancements:
-
-- Added a 'fix_federation_ids' management command to deal with protocol/domain issues in federation
- IDs after deployments (#706)
-- Can now use a local file with FUNKWHALE_SPA_HTML_ROOT to avoid sending an HTTP request (#705)
-
-Bugfixes:
-
-- Downgraded channels dependency to 2.1.6 to fix denied uploads (#697)
-- Fixed cards display issues on medium/small screens (#707)
-- Fixed Embed component name that could lead to issue when developping on OSX (#696)
-- Fixed resizing issues for album cards on artist pages (#694)
-
-## 0.18.1 (2019-01-29)
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/administrator/upgrade/index.html
-
-### Fix Gzip compression to avoid BREACH exploit [security] [manual action required]
-
-In the 0.18 release, we've enabled Gzip compression by default for various
-content types, including HTML and JSON. Unfortunately, enabling Gzip compression
-on such content types could make BREACH-type exploits possible.
-
-We've removed the risky content-types from our nginx template files, to ensure new
-instances are safe, however, if you already have an instance, you need
-to double check that your host nginx virtualhost do not include the following
-values for the `gzip_types` settings:
-
-```
-application/atom+xml
-application/json
-application/ld+json
-application/activity+json
-application/manifest+json
-application/rss+xml
-application/xhtml+xml
-application/xml
-```
-
-For convenience, you can also replace the whole setting with the following snippet:
-
-```
-gzip_types
-application/javascript
-application/vnd.geo+json
-application/vnd.ms-fontobject
-application/x-font-ttf
-application/x-web-app-manifest+json
-font/opentype
-image/bmp
-image/svg+xml
-image/x-icon
-text/cache-manifest
-text/css
-text/plain
-text/vcard
-text/vnd.rim.location.xloc
-text/vtt
-text/x-component
-text/x-cross-domain-policy;
-```
-
-Many thanks to @jibec for the report!
-
-### Fix Apache configuration file for 0.18 [manual action required]
-
-The way front is served has changed since 0.18. The Apache configuration can't serve 0.18 properly, leading to blank screens.
-
-If you are on an Apache setup, you will have to replace the `` block with the following:
-
-```apache
-
- # similar to nginx 'client_max_body_size 100M;'
- LimitRequestBody 104857600
-
- ProxyPass ${funkwhale-api}/
- ProxyPassReverse ${funkwhale-api}/
-
-```
-
-And add some more `ProxyPass` directives so that the `Alias` part of your configuration file looks this way:
-
-```apache
- ProxyPass "/front" "!"
- Alias /front /srv/funkwhale/front/dist
-
- ProxyPass "/media" "!"
- Alias /media /srv/funkwhale/data/media
-
- ProxyPass "/staticfiles" "!"
- Alias /staticfiles /srv/funkwhale/data/static
-```
-
-In case you are using custom css and theming, you also need to match this block:
-
-```apache2
- ProxyPass "/settings.json" "!"
- Alias /settings.json /srv/funkwhale/custom/settings.json
-
- ProxyPass "/custom" "!"
- Alias /custom /srv/funkwhale/custom
-```
-
-Enhancements:
-
-- Added name attributes on all inputs to improve UX, especially with password managers (#686)
-- Disable makemigrations in production and misleading message when running migrate (#685)
-- Display progress during file upload
-- Hide pagination when there is only one page of results (#681)
-- Include shared/public playlists in Subsonic API responses (#684)
-- Use proper locale for date-related/duration strings (#670)
-
-Bugfixes:
-
-- Fix transcoding of in-place imported tracks (#688)
-- Fixed celery worker defaulting to development settings instead of production
-- Fixed crashing Django admin when loading track detail page (#666)
-- Fixed list icon alignment on landing page (#668)
-- Fixed overescaping issue in notifications and album page (#676)
-- Fixed wrong number of affected elements in bulk action modal (#683)
-- Fixed wrong URL in documentation for funkwhale_proxy.conf file when deploying using Docker
-- Make Apache configuration file work with 0.18 changes (#667)
-- Removed potential BREACH exploit because of Gzip compression (#678)
-- Upgraded kombu to fix an incompatibility with redis>=3
-
-Documentation:
-
-- Added user upload documentation at https://docs.funkwhale.audio/users/upload.html
-
-## 0.18 "Naomi" (2019-01-22)
-
-This release is dedicated to Naomi, an early contributor and beta tester of Funkwhale.
-Her positivity, love and support have been incredibly helpful and helped shape the project
-as you can enjoy it today. Thank you so much Naomi <3
-
-Many thanks to the dozens of people that contributed to this release: translators, developers,
-bug hunters, admins and backers. You made it possible!
-
-Upgrade instructions are available at
-https://docs.funkwhale.audio/administrator/upgrade/index.html, ensure you also execute the instructions
-marked with `[manual action required]` and `[manual action suggested]`.
-
-See `Full changelog` below for an exhaustive list of changes!
-
-### Audio transcoding is back!
-
-After removal of our first, buggy transcoding implementation, we're proud to announce
-that this feature is back. It is enabled by default, and can be configured/disabled
-in your instance settings!
-
-This feature works in the browser, with federated/non-federated tracks and using Subsonic clients.
-Transcoded tracks are generated on the fly, and cached for a configurable amount of time,
-to reduce the load on the server.
-
-### Licensing and copyright information
-
-Funkwhale is now able to parse copyright and license data from file and store
-this information. Apart from displaying it on each track detail page,
-no additional behaviour is currently implemented to use this new data, but this
-will change in future releases.
-
-License and copyright data is also broadcasted over federation.
-
-License matching is done on the content of the `License` tag in the files,
-with a fallback on the `Copyright` tag.
-
-Funkwhale will successfully extract licensing data for the following licenses:
-
-- Creative Commons 0 (Public Domain)
-- Creative Commons 1.0 (All declinations)
-- Creative Commons 2.0 (All declinations)
-- Creative Commons 2.5 (All declinations and countries)
-- Creative Commons 3.0 (All declinations and countries)
-- Creative Commons 4.0 (All declinations)
-
-Support for other licenses such as Art Libre or WTFPL will be added in future releases.
-
-### Instance-level moderation tools
-
-This release includes a first set of moderation tools that will give more control
-to admins about the way their instance federates with other instance and accounts on the network.
-Using these tools, it's now possible to:
-
-- Browse known accounts and domains, and associated data (storage size, software version, etc.)
-- Purge data belonging to given accounts and domains
-- Block or partially restrict interactions with any account or domain
-
-All those features are usable using a brand new "moderation" permission, meaning
-you can appoint one or multiple moderators to help with this task.
-
-I'd like to thank all Mastodon contributors, because some of the these tools are heavily
-inspired from what's being done in Mastodon. Thank you so much!
-
-### Iframe widget to embed public tracks and albums [manual action required]
-
-Funkwhale now supports embedding a lightweight audio player on external websites
-for album and tracks that are available in public libraries. Important pages,
-such as artist, album and track pages also include OpenGraph tags that will
-enable previews on compatible apps (like sharing a Funkwhale track link on Mastodon
-or Twitter).
-
-To achieve that, we had to tweak the way Funkwhale front-end is served. You'll have
-to modify your nginx configuration when upgrading to keep your instance working.
-
-**On docker setups**, edit your `/srv/funkwhale/nginx/funkwhale.template` and replace
-the `location /api/` and `location /` blocks by the following snippets:
-
-```nginx
-location / {
- include /etc/nginx/funkwhale_proxy.conf;
- # this is needed if you have file import via upload enabled
- client_max_body_size ${NGINX_MAX_BODY_SIZE};
- proxy_pass http://funkwhale-api/;
-}
-
-location /front/ {
- alias /frontend/;
-}
-```
-
-The change of configuration will be picked when restarting your nginx container.
-
-**On non-docker setups**, edit your `/etc/nginx/sites-available/funkwhale.conf` file,
-and replace the `location /api/` and `location /` blocks by the following snippets:
-
-```nginx
-location / {
- include /etc/nginx/funkwhale_proxy.conf;
- # this is needed if you have file import via upload enabled
- client_max_body_size ${NGINX_MAX_BODY_SIZE};
- proxy_pass http://funkwhale-api/;
-}
-
-location /front/ {
- alias ${FUNKWHALE_FRONTEND_PATH}/;
-}
-```
-
-Replace `${FUNKWHALE_FRONTEND_PATH}` by the corresponding variable from your .env file,
-which should be `/srv/funkwhale/front/dist` by default, then reload your nginx process with
-`sudo systemctl reload nginx`.
-
-### Alternative docker deployment method
-
-Thanks to the awesome work done by @thetarkus at https://github.com/thetarkus/docker-funkwhale,
-we're now able to provide an alternative and easier Docker deployment method!
-
-In contrast with our current, multi-container offer, this method integrates
-all Funkwhale processes and services (database, redis, etc.) into a single, easier to deploy container.
-
-Both methods will coexist in parallel, as each one has pros and cons. You can learn more
-about this exciting new deployment option by visiting https://docs.funkwhale.audio/installation/docker.html!
-
-### Automatically load .env file
-
-On non-docker deployments, earlier versions required you to source
-the config/.env file before launching any Funkwhale command, with `export $(cat config/.env | grep -v ^# | xargs)`
-This led to more complex and error prone deployment / setup.
-
-This is not the case anymore, and Funkwhale will automatically load this file if it's available.
-
-### Delete pre 0.17 federated tracks [manual action suggested]
-
-If you were using Funkwhale before the 0.17 release and federated with other instances,
-it's possible that you still have some unplayable federated files in the database.
-
-To purge the database of those entries, you can run the following command:
-
-On docker setups:
-
-```sh
-docker-compose run --rm api python manage.py script delete_pre_017_federated_uploads --no-input
-```
-
-On non-docker setups:
-
-```sh
-python manage.py script delete_pre_017_federated_uploads --no-input
-```
-
-### Enable gzip compression [manual action suggested]
-
-Gzip compression will be enabled on new instances by default
-and will reduce the amount of bandwidth consumed by your instance.
-
-If you want to benefit from gzip compression on your instance,
-edit your reverse proxy virtualhost file (located at `/etc/nginx/sites-available/funkwhale.conf`) and add the following snippet
-in the server block, then reload your nginx server:
-
-```nginx
-server {
- # ...
-
- # compression settings
- gzip on;
- gzip_comp_level 5;
- gzip_min_length 256;
- gzip_proxied any;
- gzip_vary on;
-
- gzip_types
- application/javascript
- application/vnd.geo+json
- application/vnd.ms-fontobject
- application/x-font-ttf
- application/x-web-app-manifest+json
- font/opentype
- image/bmp
- image/svg+xml
- image/x-icon
- text/cache-manifest
- text/css
- text/plain
- text/vcard
- text/vnd.rim.location.xloc
- text/vtt
- text/x-component
- text/x-cross-domain-policy;
- # end of compression settings
-}
-```
-
-### Full changelog
-
-Features:
-
-- Allow embedding of albums and tracks available in public libraries via an
Alias /front ${FUNKWHALE_ROOT_PATH}/front/dist
+
+ ProxyPass "!"
+
+ Alias /assets ${FUNKWHALE_ROOT_PATH}/front/dist/assets
+
ProxyPass "!"
diff --git a/deploy/docker-compose.yml b/deploy/docker-compose.yml
index fe32450ad..b947a6dbc 100644
--- a/deploy/docker-compose.yml
+++ b/deploy/docker-compose.yml
@@ -98,8 +98,6 @@ services:
env_file:
- .env
image: typesense/typesense:0.24.0
- networks:
- - internal
volumes:
- ./typesense/data:/data
command: --data-dir /data --enable-cors
diff --git a/deploy/docker.proxy.template b/deploy/docker.proxy.template
index a4b297f20..ff9d5e4fe 100644
--- a/deploy/docker.proxy.template
+++ b/deploy/docker.proxy.template
@@ -1,7 +1,8 @@
upstream fw {
- # depending on your setup, you may want to update this
server ${FUNKWHALE_API_IP}:${FUNKWHALE_API_PORT};
}
+
+# Required for websocket support.
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
@@ -10,15 +11,31 @@ map $http_upgrade $connection_upgrade {
server {
listen 80;
listen [::]:80;
+ # update this to match your instance name
server_name ${FUNKWHALE_HOSTNAME};
- location / { return 301 https://$host$request_uri; }
+
+ # useful for Let's Encrypt
+ location /.well-known/acme-challenge/ {
+ allow all;
+ }
+
+ location / {
+ return 301 https://$host$request_uri;
+ }
}
+
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
+
server_name ${FUNKWHALE_HOSTNAME};
# TLS
+ # Feel free to use your own configuration for SSL here or simply remove the
+ # lines and move the configuration to the previous server block if you
+ # don't want to run funkwhale behind https (this is not recommended)
+ # have a look here for let's encrypt configuration:
+ # https://certbot.eff.org/all-instructions/#debian-9-stretch-nginx
ssl_protocols TLSv1.2;
ssl_ciphers HIGH:!MEDIUM:!LOW:!aNULL:!NULL:!SHA;
ssl_prefer_server_ciphers on;
@@ -29,12 +46,10 @@ server {
# HSTS
add_header Strict-Transport-Security "max-age=31536000";
- # Security related headers
- # If you are using S3 to host your files, remember to add your S3 URL to the
- # media-src and img-src headers (e.g. img-src 'self' https:// data:)
-
- add_header Content-Security-Policy "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; object-src 'none'; media-src 'self' data:";
+ # General configs
+ client_max_body_size ${NGINX_MAX_BODY_SIZE};
+ charset utf-8;
# compression settings
gzip on;
@@ -42,7 +57,6 @@ server {
gzip_min_length 256;
gzip_proxied any;
gzip_vary on;
-
gzip_types
application/javascript
application/vnd.geo+json
@@ -61,10 +75,11 @@ server {
text/vtt
text/x-component
text/x-cross-domain-policy;
+ # end of compression settings
location / {
include /etc/nginx/funkwhale_proxy.conf;
- client_max_body_size ${NGINX_MAX_BODY_SIZE};
- proxy_pass http://fw;
+ proxy_pass http://fw;
}
+
}
diff --git a/deploy/env.prod.sample b/deploy/env.prod.sample
index 0ff7a5be1..1ea36c651 100644
--- a/deploy/env.prod.sample
+++ b/deploy/env.prod.sample
@@ -99,7 +99,7 @@ REVERSE_PROXY_TYPE=nginx
#
# If you want to use Redis over unix sockets, you'll actually need two variables:
# For the cache part:
-# CACHE_URL=redis:///run/redis/redis.sock?db=0
+# CACHE_URL=unix:///run/redis/redis.sock?db=0
# For the Celery/asynchronous tasks part:
# CELERY_BROKER_URL=redis+socket:///run/redis/redis.sock?virtual_host=0
diff --git a/deploy/nginx.template b/deploy/nginx.template
index 5ba2ccfa1..d306f8af4 100644
--- a/deploy/nginx.template
+++ b/deploy/nginx.template
@@ -1,10 +1,15 @@
-# This file was generated from Funkwhale's nginx.template
upstream funkwhale-api {
# depending on your setup, you may want to update this
server ${FUNKWHALE_API_IP}:${FUNKWHALE_API_PORT};
}
+# Required for websocket support.
+map $http_upgrade $connection_upgrade {
+ default upgrade;
+ '' close;
+}
+
server {
listen 80;
listen [::]:80;
@@ -21,16 +26,10 @@ server {
}
}
-# Required for websocket support.
-map $http_upgrade $connection_upgrade {
- default upgrade;
- '' close;
-}
-
server {
listen 443 ssl http2;
listen [::]:443 ssl http2;
- charset utf-8;
+
server_name ${FUNKWHALE_HOSTNAME};
# TLS
@@ -49,12 +48,11 @@ server {
# HSTS
add_header Strict-Transport-Security "max-age=31536000";
- add_header Content-Security-Policy "default-src 'self'; connect-src https: wss: http: ws: 'self' 'unsafe-eval'; script-src 'self' 'wasm-unsafe-eval'; style-src https: http: 'self' 'unsafe-inline'; img-src https: http: 'self' data:; font-src https: http: 'self' data:; media-src https: http: 'self' data:; object-src 'none'";
- add_header Referrer-Policy "strict-origin-when-cross-origin";
- add_header X-Frame-Options "SAMEORIGIN" always;
- add_header Service-Worker-Allowed "/";
+ # General configs
root ${FUNKWHALE_FRONTEND_PATH};
+ client_max_body_size ${NGINX_MAX_BODY_SIZE};
+ charset utf-8;
# compression settings
gzip on;
@@ -62,7 +60,6 @@ server {
gzip_min_length 256;
gzip_proxied any;
gzip_vary on;
-
gzip_types
application/javascript
application/vnd.geo+json
@@ -83,6 +80,12 @@ server {
text/x-cross-domain-policy;
# end of compression settings
+ # headers
+ add_header Content-Security-Policy "default-src 'self'; connect-src https: wss: http: ws: 'self' 'unsafe-eval'; script-src 'self' 'wasm-unsafe-eval'; style-src https: http: 'self' 'unsafe-inline'; img-src https: http: 'self' data:; font-src https: http: 'self' data:; media-src https: http: 'self' data:; object-src 'none'";
+ add_header Referrer-Policy "strict-origin-when-cross-origin";
+ add_header X-Frame-Options "SAMEORIGIN" always;
+ add_header Service-Worker-Allowed "/";
+
location /api/ {
include /etc/nginx/funkwhale_proxy.conf;
# This is needed if you have file import via upload enabled.
@@ -90,17 +93,39 @@ server {
proxy_pass http://funkwhale-api;
}
- location / {
+ location ~ ^/library/(albums|tracks|artists|playlists)/ {
+ include /etc/nginx/funkwhale_proxy.conf;
+ proxy_pass http://funkwhale-api;
+ }
+
+ location /channels/ {
+ include /etc/nginx/funkwhale_proxy.conf;
+ proxy_pass http://funkwhale-api;
+ }
+
+ location ~ ^/@(vite-plugin-pwa|vite|id)/ {
+ include /etc/nginx/funkwhale_proxy.conf;
alias ${FUNKWHALE_FRONTEND_PATH}/;
+ try_files $uri $uri/ /index.html;
+ }
+
+ location /@ {
+ include /etc/nginx/funkwhale_proxy.conf;
+ proxy_pass http://funkwhale-api;
+ }
+
+ location / {
expires 1d;
+ include /etc/nginx/funkwhale_proxy.conf;
+ alias ${FUNKWHALE_FRONTEND_PATH}/;
try_files $uri $uri/ /index.html;
}
location ~ "/(front/)?embed.html" {
+ alias ${FUNKWHALE_FRONTEND_PATH}/embed.html;
add_header Content-Security-Policy "connect-src https: http: 'self'; default-src 'self'; script-src 'self' unpkg.com 'unsafe-inline' 'unsafe-eval'; style-src https: http: 'self' 'unsafe-inline'; img-src https: http: 'self' data:; font-src https: http: 'self' data:; object-src 'none'; media-src https: http: 'self' data:";
add_header Referrer-Policy "strict-origin-when-cross-origin";
- alias ${FUNKWHALE_FRONTEND_PATH}/embed.html;
expires 1d;
}
@@ -158,7 +183,7 @@ server {
# has been checked on API side.
# Set this to the same value as your MUSIC_DIRECTORY_PATH setting.
internal;
- alias ${MUSIC_DIRECTORY_SERVE_PATH}/;
+ alias ${MUSIC_DIRECTORY_PATH}/;
add_header Access-Control-Allow-Origin '*';
}
@@ -166,4 +191,8 @@ server {
# If the reverse proxy is terminating SSL, nginx gets confused and redirects to http, hence the full URL
return 302 ${FUNKWHALE_PROTOCOL}://${FUNKWHALE_HOSTNAME}/api/v1/instance/spa-manifest.json;
}
+
+ location /staticfiles/ {
+ alias ${STATIC_ROOT}/;
+ }
}
diff --git a/dev.yml b/dev.yml
index 95323af8c..9ba73c6d2 100644
--- a/dev.yml
+++ b/dev.yml
@@ -123,9 +123,9 @@ services:
- "${NGINX_PORTS_MAPPING-8000:80}"
environment:
- "NGINX_MAX_BODY_SIZE=${NGINX_MAX_BODY_SIZE-100M}"
- - "FUNKWHALE_API_IP=${FUNKHALE_API_IP-api}"
+ - "FUNKWHALE_API_HOST=${FUNKWHALE_API_HOST-api}"
- "FUNKWHALE_API_PORT=${FUNKWHALE_API_PORT-5000}"
- - "FUNKWHALE_FRONT_IP=${FUNKHALE_FRONT_IP-front}"
+ - "FUNKWHALE_FRONT_IP=${FUNKWHALE_FRONT_IP-front}"
- "FUNKWHALE_FRONT_PORT=${VUE_PORT-8080}"
- "COMPOSE_PROJECT_NAME=${COMPOSE_PROJECT_NAME- }"
- "FUNKWHALE_HOSTNAME=${FUNKWHALE_HOSTNAME-localhost}"
@@ -152,15 +152,6 @@ services:
traefik.frontend.passHostHeader: true
traefik.docker.network: federation
- docs:
- build: docs
- command: python3 serve.py
- volumes:
- - ".:/app/"
- ports:
- - "35730:35730"
- - "8001:8001"
-
api-docs:
image: swaggerapi/swagger-ui:v3.37.2
environment:
diff --git a/docker/nginx/conf.dev b/docker/nginx/conf.dev
index ae3cd3fce..34bca7872 100644
--- a/docker/nginx/conf.dev
+++ b/docker/nginx/conf.dev
@@ -1,6 +1,8 @@
upstream funkwhale-api {
- server ${FUNKWHALE_API_IP}:${FUNKWHALE_API_PORT};
+ # depending on your setup, you may want to update this
+ server ${FUNKWHALE_API_HOST}:${FUNKWHALE_API_PORT};
}
+
upstream funkwhale-front {
server ${FUNKWHALE_FRONT_IP}:${FUNKWHALE_FRONT_PORT};
}
@@ -11,17 +13,17 @@ map $http_upgrade $connection_upgrade {
'' close;
}
+
server {
listen 80;
listen [::]:80;
- charset utf-8;
- client_max_body_size ${NGINX_MAX_BODY_SIZE};
- include /etc/nginx/funkwhale_proxy.conf;
- add_header Content-Security-Policy "default-src 'self'; connect-src https: wss: http: ws: 'self' 'unsafe-eval'; script-src 'self' 'wasm-unsafe-eval'; style-src https: http: 'self' 'unsafe-inline'; img-src https: http: 'self' data:; font-src https: http: 'self' data:; media-src https: http: 'self' data:; object-src 'none'";
- add_header Referrer-Policy "strict-origin-when-cross-origin";
- add_header X-Frame-Options "SAMEORIGIN" always;
- add_header Service-Worker-Allowed "/";
+ server_name _;
+
+ # General configs
+ root /usr/share/nginx/html;
+ client_max_body_size ${NGINX_MAX_BODY_SIZE};
+ charset utf-8;
# compression settings
gzip on;
@@ -29,7 +31,6 @@ server {
gzip_min_length 256;
gzip_proxied any;
gzip_vary on;
-
gzip_types
application/javascript
application/vnd.geo+json
@@ -50,6 +51,12 @@ server {
text/x-cross-domain-policy;
# end of compression settings
+ # headers
+ add_header Content-Security-Policy "default-src 'self'; connect-src https: wss: http: ws: 'self' 'unsafe-eval'; script-src 'self' 'wasm-unsafe-eval'; style-src https: http: 'self' 'unsafe-inline'; img-src https: http: 'self' data:; font-src https: http: 'self' data:; media-src https: http: 'self' data:; object-src 'none'";
+ add_header Referrer-Policy "strict-origin-when-cross-origin";
+ add_header X-Frame-Options "SAMEORIGIN" always;
+ add_header Service-Worker-Allowed "/";
+
location /api/ {
include /etc/nginx/funkwhale_proxy.conf;
# This is needed if you have file import via upload enabled.
@@ -57,16 +64,37 @@ server {
proxy_pass http://funkwhale-api;
}
- location / {
+ location ~ ^/library/(albums|tracks|artists|playlists)/ {
+ include /etc/nginx/funkwhale_proxy.conf;
+ proxy_pass http://funkwhale-api;
+ }
+
+ location /channels/ {
+ include /etc/nginx/funkwhale_proxy.conf;
+ proxy_pass http://funkwhale-api;
+ }
+
+ location ~ ^/@(vite-plugin-pwa|vite|id)/ {
+ include /etc/nginx/funkwhale_proxy.conf;
proxy_pass http://funkwhale-front;
+ }
+
+ location /@ {
+ include /etc/nginx/funkwhale_proxy.conf;
+ proxy_pass http://funkwhale-api;
+ }
+
+ location / {
expires 1d;
+ include /etc/nginx/funkwhale_proxy.conf;
+ proxy_pass http://funkwhale-front;
}
location = /embed.html {
+ proxy_pass http://funkwhale-front;
add_header Content-Security-Policy "connect-src https: http: 'self'; default-src 'self'; script-src 'self' unpkg.com 'unsafe-inline' 'unsafe-eval'; style-src https: http: 'self' 'unsafe-inline'; img-src https: http: 'self' data:; font-src https: http: 'self' data:; object-src 'none'; media-src https: http: 'self' data:";
add_header Referrer-Policy "strict-origin-when-cross-origin";
- proxy_pass http://funkwhale-front;
expires 1d;
}
@@ -88,13 +116,13 @@ server {
# Allow direct access to only specific subdirectories in /media
location /media/__sized__/ {
- alias /protected/media/__sized__/;
+ alias ${MEDIA_ROOT}/__sized__/;
add_header Access-Control-Allow-Origin '*';
}
# Allow direct access to only specific subdirectories in /media
location /media/attachments/ {
- alias /protected/media/attachments/;
+ alias ${MEDIA_ROOT}/attachments/;
add_header Access-Control-Allow-Origin '*';
}
@@ -111,10 +139,10 @@ server {
# if you're storing media files in a S3 bucket.
location ~ /_protected/media/(.+) {
internal;
- alias /protected/media/$1; # NON-S3
+ alias ${MEDIA_ROOT}/$1; # NON-S3
# Needed to ensure DSub auth isn't forwarded to S3/Minio, see #932.
-# proxy_set_header Authorization ""; # S3
-# proxy_pass $1; # S3
+# proxy_set_header Authorization ""; # S3
+# proxy_pass $1; # S3
add_header Access-Control-Allow-Origin '*';
}
@@ -124,7 +152,7 @@ server {
# has been checked on API side.
# Set this to the same value as your MUSIC_DIRECTORY_PATH setting.
internal;
- alias /music/;
+ alias ${MUSIC_DIRECTORY_PATH}/;
add_header Access-Control-Allow-Origin '*';
}
@@ -134,7 +162,6 @@ server {
}
location /staticfiles/ {
- alias /staticfiles/;
+ alias /usr/share/nginx/html/staticfiles/;
}
-
}
diff --git a/docs/Dockerfile b/docs/Dockerfile
deleted file mode 100644
index 370e0b7aa..000000000
--- a/docs/Dockerfile
+++ /dev/null
@@ -1,5 +0,0 @@
-FROM python:3.11
-
-RUN apt-get update && apt-get install -y graphviz
-RUN pip install sphinx livereload sphinx_rtd_theme django-environ django myst-parser sphinx-design sphinx-multiversion sphinxcontrib-mermaid sphinx-copybutton
-WORKDIR /app/docs
diff --git a/docs/Makefile b/docs/Makefile
index 083dae580..13e013261 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -1,20 +1,85 @@
-# Minimal makefile for Sphinx documentation
-#
+SHELL = bash
+UNAME := $(shell uname)
+ifeq ($(UNAME), Linux)
+CPU_CORES = $(shell N=$$(nproc); echo $$(( $$N > 4 ? 4 : $$N )))
+else
+CPU_CORES = $(shell N=$$(sysctl -n hw.physicalcpu); echo $$(( $$N > 4 ? 4 : $$N )))
+endif
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = python3 -msphinx
-SPHINXPROJ = funkwhale
-SOURCEDIR = .
-BUILDDIR = _build
+# Install
+VENV = .venv
+export POETRY_VIRTUALENVS_IN_PROJECT=true
-# Put it first so that "make" without argument is like "make help".
-help:
- @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+$(VENV):
+ $(MAKE) install
-.PHONY: help Makefile
+install:
+ poetry install --no-root
+ poetry run pip install --no-deps --editable ../api
-# Catch-all target: route all unknown targets to Sphinx using the new
-# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile
- @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+clean:
+ git clean -xdf .
+
+# Sphinx
+SPHINX_OPTS = -j $(CPU_CORES)
+SOURCE_DIR = .
+BUILD_DIR = _build
+
+$(BUILD_DIR):
+ mkdir -p $(BUILD_DIR)
+
+# Dev
+dev: $(VENV)
+ poetry run sphinx-autobuild . /tmp/_build/ --port 8001
+
+# I18n
+LOCALES = en_GB en_US fr
+
+locale-generate: $(VENV)
+ poetry run sphinx-build -b gettext $(SOURCE_DIR) locales/gettext $(SPHINX_OPTS)
+
+locale-update: $(VENV)
+ poetry run sphinx-intl update -p locales/gettext $(foreach locale,$(LOCALES),-l $(locale))
+
+locale-prune-untranslated: $(VENV)
+ poetry run _scripts/locale-prune-untranslated.py
+
+# Swagger
+SWAGGER_VERSION = 5.1.2
+SWAGGER_RELEASE_URL = https://github.com/swagger-api/swagger-ui/archive/refs/tags/v$(SWAGGER_VERSION).tar.gz
+SWAGGER_BUILD_DIR = swagger
+
+swagger:
+ mkdir "$(SWAGGER_BUILD_DIR)"
+ curl -sSL "$(SWAGGER_RELEASE_URL)" | \
+ tar --extract \
+ --gzip \
+ --directory="$(SWAGGER_BUILD_DIR)" \
+ --strip-components=2 \
+ "swagger-ui-$(SWAGGER_VERSION)/dist"
+
+ sed -i \
+ "s#https://petstore.swagger.io/v2/swagger.json#schema.yml#g" \
+ "$(SWAGGER_BUILD_DIR)/swagger-initializer.js"
+
+ cp schema.yml "$(SWAGGER_BUILD_DIR)/schema.yml"
+
+# Releases
+$(BUILD_DIR)/releases.json: $(BUILD_DIR)
+ ../scripts/releases.py > "$@"
+
+$(BUILD_DIR)/latest.txt: $(BUILD_DIR)
+ ../scripts/releases.py -r -q latest.id > "$@"
+
+releases: $(BUILD_DIR)/releases.json $(BUILD_DIR)/latest.txt
+
+# Build
+build: $(VENV)
+ poetry run sphinx-build $(SOURCE_DIR) $(BUILD_DIR) $(SPHINX_OPTS)
+
+build-translated: $(VENV) locale-prune-untranslated
+ for locale in $(LOCALES); do \
+ poetry run sphinx-build $(SOURCE_DIR) $(BUILD_DIR)/$$locale $(SPHINX_OPTS) -D language=$$locale; \
+ done
+
+build-all: build build-translated releases swagger
diff --git a/docs/_scripts/locale-prune-untranslated.py b/docs/_scripts/locale-prune-untranslated.py
new file mode 100755
index 000000000..57b4d8c48
--- /dev/null
+++ b/docs/_scripts/locale-prune-untranslated.py
@@ -0,0 +1,19 @@
+#!/usr/bin/env python3
+
+import os
+from subprocess import check_output
+
+
+def main() -> int:
+ output = check_output(["poetry", "run", "sphinx-intl", "stat"], text=True)
+ for line in output.splitlines():
+ path, _, comment = line.partition(":")
+ if "0 untranslated." in comment:
+ print(f"removing untranslated po file: {path}")
+ os.unlink(path)
+
+ return 0
+
+
+if __name__ == "__main__":
+ raise SystemExit(main())
diff --git a/docs/administrator/configuration/instance-settings.md b/docs/administrator/configuration/instance-settings.md
index 51ef4dbda..085be5a04 100644
--- a/docs/administrator/configuration/instance-settings.md
+++ b/docs/administrator/configuration/instance-settings.md
@@ -111,6 +111,9 @@ Transcoding enabled
Transcoding cache duration
The number of minutes you want to store transcoded files on your server. Funkwhale removes transcoded tracks that haven't been downloaded within this duration to save space.
+Only allow MusicBrainz tagged files
+ If enabled, only files tagged with a [MusicBrainz ID](https://musicbrainz.org/doc/MusicBrainz_Identifier) can be uploaded to the server. Users can use [MusicBrainz Picard](https://picard.musicbrainz.org/) to tag their content with a MBID. Enabling this setting **does not** remove files uploaded before the setting was enabled.
+
```
### Channels
diff --git a/docs/administrator/manage-script/mbid_prune.md b/docs/administrator/manage-script/mbid_prune.md
new file mode 100644
index 000000000..2d5c963af
--- /dev/null
+++ b/docs/administrator/manage-script/mbid_prune.md
@@ -0,0 +1,40 @@
+# Delete funkwhale objects that don't have a Musicbrainz id
+
+If you enable the option to [only allow MusicBrainz content](../configuration/instance-settings.md) on your pod after you've uploaded content,you can to use this command to prune content that doesn't have a MusicBrainz ID to make your database more consistent.
+
+```{warning}
+This action **does not** send a notification to your users before content is removed. You may want to warm them before.
+```
+
+```{warning}
+Running `prune_non_mbid_content` with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade/backup.md).
+```
+
+::::{tab-set}
+
+:::{tab-item} Debian
+:sync: debian
+
+```{code-block} sh
+venv/bin/funkwhale-manage prune_non_mbid_content
+```
+
+:::
+
+:::{tab-item} Docker
+:sync: docker
+
+```{code-block} sh
+sudo docker compose run --rm api funkwhale-manage prune_non_mbid_content
+```
+
+:::
+::::
+
+```{note}
+The command excludes tracks that are in users' favorites, playlists, and listen history. To include these tracks, add the corresponding flags:
+
+- `--include-favorites-content`
+- `--include-listened-content`
+- `--include-playlist-content`
+```
diff --git a/docs/administrator/migration.md b/docs/administrator/migration.md
index bed397286..b15d11b9a 100644
--- a/docs/administrator/migration.md
+++ b/docs/administrator/migration.md
@@ -126,6 +126,6 @@ Check the file and remove any duplicated settings after copying.
Once you have imported your database and run migrations, you can start all containers.
-```{code-block} sh
-sudo docker compose up -d
+```console
+# docker compose up -d
```
diff --git a/docs/administrator/upgrade/backup.md b/docs/administrator/upgrade/backup.md
index 6ef6eb0a7..bd5d72fbe 100644
--- a/docs/administrator/upgrade/backup.md
+++ b/docs/administrator/upgrade/backup.md
@@ -9,8 +9,8 @@ Before performing big changes, we recommend you back up your database and media
:::{tab-item} Debian
:sync: debian
- ```{code-block} sh
- sudo -u postgres -H pg_dumpall -c funkwhale > /path/to/your/backup/dump_`date +%d-%m-%Y"_"%H_%M_%S`.sql
+ ```console
+ $ sudo -u postgres -H pg_dumpall -c funkwhale > /path/to/your/backup/dump_`date +%d-%m-%Y"_"%H_%M_%S`.sql
```
:::
@@ -18,8 +18,16 @@ Before performing big changes, we recommend you back up your database and media
:::{tab-item} Docker
:sync: docker
- ```{code-block} sh
- sudo docker compose exec postgres pg_dumpall -c -U postgres > dump_`date +%d-%m-%Y"_"%H_%M_%S`.sql
+ 1. Stop the running containers:
+
+ ```console
+ $ sudo docker compose down
+ ```
+
+ 2. Dump the database to a backup file:
+
+ ```console
+ $ sudo docker compose run --rm postgres pg_dump -U postgres postgres > dump_`date +%d-%m-%Y"_"%H_%M_%S`.sql
```
:::
@@ -32,9 +40,9 @@ Before performing big changes, we recommend you back up your database and media
:::{tab-item} Debian
:sync: debian
- ```{code-block} sh
- rsync -avzhP /srv/funkwhale/data/media /path/to/your/backup/media
- rsync -avzhP /srv/funkwhale/data/music /path/to/your/backup/music
+ ```console
+ $ rsync -avzhP /srv/funkwhale/data/media /path/to/your/backup/media
+ $ rsync -avzhP /srv/funkwhale/data/music /path/to/your/backup/music
```
:::
@@ -42,10 +50,9 @@ Before performing big changes, we recommend you back up your database and media
:::{tab-item} Docker
:sync: docker
- ```{code-block} sh
-
- rsync -avzhP /srv/funkwhale/data/media /path/to/your/backup/media
- rsync -avzhP /srv/funkwhale/data/music /path/to/your/backup/music
+ ```console
+ $ rsync -avzhP /srv/funkwhale/data/media /path/to/your/backup/media
+ $ rsync -avzhP /srv/funkwhale/data/music /path/to/your/backup/music
```
:::
@@ -58,8 +65,8 @@ Before performing big changes, we recommend you back up your database and media
:::{tab-item} Debian
:sync: debian
- ```{code-block} sh
- rsync -avzhP /srv/funkwhale/config/.env /path/to/your/backup/.env
+ ```console
+ $ rsync -avzhP /srv/funkwhale/config/.env /path/to/your/backup/.env
```
:::
@@ -67,8 +74,8 @@ Before performing big changes, we recommend you back up your database and media
:::{tab-item} Docker
:sync: docker
- ```{code-block} sh
- rsync -avzhP /srv/funkwhale/.env /path/to/your/backup/.env
+ ```console
+ $ rsync -avzhP /srv/funkwhale/.env /path/to/your/backup/.env
```
:::
@@ -84,16 +91,16 @@ To restart your files, do the following:
1. Rename your current file directories.
- ```{code-block} sh
- mv /srv/funkwhale/data/media /srv/funkwhale/data/media.bak
- mv /srv/funkwhale/data/music /srv/funkwhale/data/music.bak
+ ```console
+ $ mv /srv/funkwhale/data/media /srv/funkwhale/data/media.bak
+ $ mv /srv/funkwhale/data/music /srv/funkwhale/data/music.bak
```
2. Restore your backed-up files to the original directories.
- ```{code-block} sh
- mv /patht/to/your/backup/media /srv/funkwhale/data/media
- mv /path/to/your/backup/music /srv/funkwhale/data/music
+ ```console
+ $ mv /path/to/your/backup/media /srv/funkwhale/data/media
+ $ mv /path/to/your/backup/music /srv/funkwhale/data/music
```
### Restore the database
@@ -107,15 +114,15 @@ To restore your database, do the following:
1. Restore your database backup:
- ```{code-block} sh
- sudo -u postgres psql -f /path/to/your/backup/dump.sql funkwhale
+ ```console
+ $ sudo -u postgres psql -f /path/to/your/backup/dump.sql funkwhale
```
2. Run the `funkwhale-manage migrate` command to set up the database.
- ```{code-block} sh
- cd /srv/funkwhale
- venv/bin/funkwhale-manage migrate
+ ```console
+ $ cd /srv/funkwhale
+ $ venv/bin/funkwhale-manage migrate
```
:::
@@ -125,14 +132,20 @@ To restore your database, do the following:
1. Restore your database backup.
- ```{code-block} sh
- sudo docker compose run --rm -T postgres psql -U postgres postgres < "/path/to/your/backup/dump.sql"
+ ```console
+ $ sudo docker compose run --rm -T postgres psql -U postgres postgres < "/path/to/your/backup/dump.sql"
```
2. Run the `funkwhale-manage migrate` command to set up the database.
- ```{code-block} sh
- sudo docker compose run --rm api funkwhale-manage migrate
+ ```console
+ $ sudo docker compose run --rm api funkwhale-manage migrate
+ ```
+
+3. Restart the services.
+
+ ```console
+ $ sudo docker compose up -d
```
:::
diff --git a/docs/administrator/upgrade/docker.md b/docs/administrator/upgrade/docker.md
index 0427aee44..d9ed5698d 100644
--- a/docs/administrator/upgrade/docker.md
+++ b/docs/administrator/upgrade/docker.md
@@ -92,7 +92,7 @@ To update your Postgres container, follow these steps:
2. Create a backup of your Funkwhale database. We will import this into the new postgres container later.
```console
- # docker compose exec -i postgres pg_dump -U postgres postgres > db_dump.sql
+ # docker compose run --rm postgres pg_dump -U postgres postgres > db_dump.sql
```
3. Move the {file}`data/postgres` directory to another location to back it up
@@ -136,8 +136,8 @@ To update your Postgres container, follow these steps:
Once you've updated your Postgres containers, you need to migrate your database. To do this:
:::{include} /administrator/migration.md
-:start-line: 112
-:end-line: 129
+:start-line: 105
+:end-line: 132
:::
:::{seealso}
diff --git a/docs/build_docs.sh b/docs/build_docs.sh
deleted file mode 100755
index 6aa719a76..000000000
--- a/docs/build_docs.sh
+++ /dev/null
@@ -1,29 +0,0 @@
-#!/usr/bin/env bash
-
-set -eux
-
-# We clean up translations, only fully translated components are kept
-IFS=$'\n'
-
-for i in $(poetry run sphinx-intl stat); do
- echo "$i"
- if [[ "$i" != *" 0 untranslated." ]]; then
- file=$(echo "$i" | cut -d: -f1)
- echo "delete $file"
- rm "$file"
- fi
-done
-
-# Build sphinx
-poetry run sphinx-build . "$BUILD_PATH"
-for path in locales/*; do
- lang="$(basename "$path")"
- if [[ "$lang" != "gettext" ]]; then
- poetry run sphinx-build -D language="$lang" . "$BUILD_PATH/$lang"
- fi
-done
-
-# Build swagger
-TARGET_PATH="$BUILD_PATH/swagger" ./build_swagger.sh
-python3 ./get-releases-json.py > "$BUILD_PATH/releases.json"
-python3 ./get-releases-json.py --latest > "$BUILD_PATH/latest.txt"
diff --git a/docs/build_swagger.sh b/docs/build_swagger.sh
deleted file mode 100755
index 175e8372a..000000000
--- a/docs/build_swagger.sh
+++ /dev/null
@@ -1,18 +0,0 @@
-#!/usr/bin/env bash
-set -eux
-
-SWAGGER_VERSION="4.15.5"
-TARGET_PATH=${TARGET_PATH-"swagger"}
-
-rm -rf "$TARGET_PATH"
-tmpdir="$(mktemp -d)"
-trap 'rm -rf "$tmpdir"' EXIT
-
-pushd "$tmpdir"
-curl -sSL "https://github.com/swagger-api/swagger-ui/archive/refs/tags/v$SWAGGER_VERSION.tar.gz" -o swagger-ui.tgz
-tar -xzf swagger-ui.tgz
-popd
-mv "$tmpdir/"*/dist "$TARGET_PATH"
-cp schema.yml "$TARGET_PATH"
-
-sed -i "s#https://petstore.swagger.io/v2/swagger.json#schema.yml#g" "$TARGET_PATH/swagger-initializer.js"
diff --git a/docs/changes/funkwhale-0-changelog.md b/docs/changes/funkwhale-0-changelog.md
new file mode 100644
index 000000000..6b19b452c
--- /dev/null
+++ b/docs/changes/funkwhale-0-changelog.md
@@ -0,0 +1,3343 @@
+# Funkwhale 0.x changelog
+
+## 0.21.2 (2020-07-27)
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html
+
+Enhancements:
+
+- Added a new ?related=obj_id filter for artists, albums and tracks, based on tags
+- Can now filter subscribed content through API (#1116)
+- Support ordering=random for artists, albums, tracks and channels endpoints (#1145)
+- Use role=alert on forms/toast message to improve accessibility (#1134)
+
+Bugfixes:
+
+- Fix embedded player not working on channel series/album (#1175)
+- Fixed broken mimetype detection during import (#1165)
+- Fixed crash when loading recent albums via Subsonic (#1158)
+- Fixed crash with null help text in admin (#1161)
+- Fixed invalid metadata when importing multi-artists tracks/albums (#1104)
+- Fixed player crash when using Funkwhale as a PWA (#1157)
+- Fixed wrong convert art displaying in some situations (#1138)
+- Make channel card updated times more humanly readable, add internationalization (#1089)
+
+Contributors to this release (development, documentation, reviews):
+
+- Agate
+- Bheesham Persaud
+- Ciarán Ainsworth
+
+## 0.21.1 (2020-06-11)
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html
+
+Features:
+
+- Support a --watch mode with `import_files` to automatically add, update and remove files when filesystem is updated (#721)
+
+Enhancements:
+
+- Added new channels widget on pod landing page (#1113)
+- Fix HTML not including instance name in some situations (#1107)
+- Make URL-building logic more resilient against reverse proxy misconfiguration (#1085)
+- Removed unused masonry dependency (#1112)
+- Support for specifying itunes:email and itunes:name in channels for compatibility with third-party platforms (#1154)
+- Updated the /api/v1/libraries endpoint to support listing public libraries from other users/pods (#1151)
+
+Bugfixes:
+
+- Added safeguard to ensure local uploads are never purged from cache (#1086)
+- Ensure firefox password manager dont autofill username in search bar (#1090)
+- Ensure player doesn't disappear when last queue track is removed manually (#1092)
+- Ensure tracks linked to skipped upload can be pruned (#1011)
+- Fix playlist modal only listing 50 first playlists (#1087)
+- Fixed a wording issue on artist channel page (#1117)
+- Fixed crash on python 3.5 with cli importer (#1155)
+- Fixed issue when displaying starred tracks on subsonic (#1082)
+- Fixed mimetype detection issue that broke transcoding on some tracks (#1093). Run `python manage.py fix_uploads --mimetype` to set proper mimetypes on existing uploads.
+- Fixed page not refreshing when switching between My Library and Explore sections (#1091)
+- Fixed recursive CLI importing crashing under Python 3.5 (#1148, #1147)
+- Fixed wrong album and track count in admin artist API (#1096)
+- Include tracks by album artist when filtering by artist on /api/v1/tracks (#1078)
+
+### Small API breaking change in `/api/v1/libraries`
+
+To allow easier crawling of public libraries on a pod,we had to make a slight breaking change
+to the behaviour of `GET /api/v1/libraries`.
+
+Before, it returned only libraries owned by the current user.
+
+Now, it returns all the accessible libraries (including ones from other users and pods).
+
+If you are consuming the API via a third-party client and need to retrieve your libraries,
+use the `scope` parameter, like this: `GET /api/v1/libraries?scope=me`
+
+Contributors to this release (development, documentation, reviews, testing):
+
+- Agate
+- Ciarán Ainsworth
+- Creak
+- gisforgabriel
+- Siren
+- Tony Wasserka
+
+## 0.21 "Agate" (2020-04-24)
+
+This 0.21 release is dedicated to Agate, to thank her, for both having created the Funkwhale project, being the current lead developer, and for her courage of coming out. Thank you Agate from all the members of the Funkwhale community <3
+
+We are truly grateful as well to the dozens of people who contributed to this release with translations, development, documentation, reviews, design, testing, feedback, financial support, third-party projects and integrations… You made it possible!
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html, there are also additional operations you need to execute, listed in the changelog below (search "Manual action").
+
+### Channels and podcasts
+
+Funkwhale 0.21 includes a brand new feature: Channels!
+
+Channels can be used as a replacement to public libraries,
+to publish audio content, both musical and non-musical. They federate with other Funkwhale pods, but also other
+fediverse software, in particular Mastodon, Pleroma, Friendica and Reel2Bits, meaning people can subscribe to your channel
+from any of these software. To get started with publication, simply visit your profile and create a channel from there.
+
+Each Funkwhale channel also comes with RSS feed that is compatible with existing podcasting applications, like AntennaPod
+on Android and, within Funkwhale, you can also subscribe to any podcast from its RSS feed!
+
+Many, many thanks to the numerous people who helped with the feature design, development and testing, and in particular
+to the members of the working group who met every week for months in order to get this done, and the members of other third-party
+projects who took the time to work with us to ensure compatibility.
+
+### Redesigned navigation, player and queue
+
+This release includes a full redesign of our navigation, player and queue. Overall, it should provide
+a better, less confusing experience, especially on mobile devices. This redesign was suggested
+14 months ago, and took a while, but thanks to the involvement and feedback of many people, we got it done!
+
+### Improved search bar for searching remote objects
+
+The search bar now support fetching arbitrary objects using a URL. In particular, you can use this to quickly:
+
+- Subscribe to a remote library via its URL
+- Listen a public track from another pod
+- Subscribe to a channel
+
+### Screening for sign-ups and custom sign-up form
+
+Instance admins can now configure their pod so that registrations required manual approval from a moderator. This
+is especially useful on private or semi-private pods where you don't want to close registrations completely,
+but don't want spam or unwanted users to join your pod.
+
+When this is enabled and a new user register, their request is put in a moderation queue, and moderators
+are notified by email. When the request is approved or refused, the user is also notified by email.
+
+In addition, it's also possible to customize the sign-up form by:
+
+- Providing a custom help text, in markdown format
+- Including additional fields in the form, for instance to ask the user why they want to join. Data collected through these fields is included in the sign-up request and viewable by the mods
+
+### Federated reports
+
+It's now possible to send a copy of a report to the server hosting the reported object, in order to make moderation easier and more distributed.
+
+This feature is inspired by Mastodon's current design, and should work with at least Funkwhale and Mastodon servers.
+
+### Improved search performance
+
+Our search engine went through a full rewrite to make it faster. This new engine is enabled
+by default when using the search bar, or when searching for artists, albums and tracks. It leverages
+PostgreSQL full-text search capabilities.
+
+During our tests, we observed huge performance improvements after the switch, by an order of
+magnitude. This should be especially perceptible on pods with large databases, more modest hardware
+or hard drives.
+
+We plan to remove the old engine in an upcoming release. In the meantime, if anything goes wrong,
+you can switch back by setting `USE_FULL_TEXT_SEARCH=false` in your `.env` file.
+
+### Enforced email verification
+
+The brand new `ACCOUNT_EMAIL_VERIFICATION_ENFORCE` setting can be used to make email verification
+mandatory for your users. It defaults to `false`, and doesn't apply to superuser accounts created through
+the CLI.
+
+If you enable this, ensure you have a SMTP server configured too.
+
+### More reliable CLI importer [manual action required]
+
+Our CLI importer is now more reliable and less prone to Out-of-Memory issues, especially when scanning large libraries. (hundreds of GB or bigger)
+
+We've also improved the directory crawling logic, so that you don't have to use glob patterns or specify extensions when importing. As a result, the syntax for providing directories to the command as changed slightly.
+
+If you use the `import_files` command, this means you should replace scripts that look like this:
+
+```sh
+python api/manage.py import_files $LIBRARY_ID "/srv/funkwhale/data/music/**/*.ogg" "/srv/funkwhale/data/music/**/*.mp3" --recursive --noinput
+```
+
+By this:
+
+```sh
+python api/manage.py import_files $LIBRARY_ID "/srv/funkwhale/data/music/" --recursive --noinput
+```
+
+And Funkwhale will happily import any supported audio file from the specified directory.
+
+### User management through the server CLI
+
+We now support user creation (incl. non-admin accounts), update and removal directly
+from the server CLI. Typical use cases include:
+
+- Changing a user password from the command line
+- Creating or updating users from deployments scripts or playbooks
+- Removing or granting permissions or upload quota to multiple users at once
+- Marking multiple users as inactive
+
+All user-related commands are available under the `python manage.py fw users` namespace.
+Please refer to the [Admin documentation](https://docs.funkwhale.audio/admin/commands.html#user-management) for
+more information and instructions.
+
+### Progressive web app [Manual action suggested, non-docker only]
+
+We've made Funkwhale's Web UI a Progressive Web Application (PWA), in order to improve the user experience
+during offline use, and on mobile devices.
+
+In order to fully benefit from this change, if your pod isn't deployed using Docker, ensure
+the following instruction is present in your nginx configuration:
+
+```nginx
+location /front/ {
+ # Add the following line in the /front/ location
+ add_header Service-Worker-Allowed "/";
+}
+```
+
+### Postgres docker changed environment variable [manual action required, docker multi-container only]
+
+If you're running with docker and our multi-container setup, there was a breaking change starting in the 11.7 postgres image (https://github.com/docker-library/postgres/pull/658)
+
+You need to add this to your .env file: `POSTGRES_HOST_AUTH_METHOD=trust`
+
+Newer deployments aren't affected.
+
+### Upgrade from Postgres 10 to 11 [manual action required, docker all-in-one only]
+
+With our upgrade to Alpine 3.10, the `funkwhale/all-in-one` image now includes PostgreSQL 11.
+
+In order to update to Funkwhale 0.21, you will first need to upgrade Funkwhale's PostgreSQL database, following the steps below:
+
+```sh
+# open a shell as the Funkwhale user
+sudo -u funkwhale -H bash
+
+# move to the funkwhale data directory
+# (replace this with your own if you used a different path)
+cd /srv/funkwhale/data
+
+# stop the funkwhale container
+docker stop funkwhale
+
+# backup the database files
+cp -r data/ ../postgres.bak
+
+# Upgrade the database
+docker run --rm \
+ -v $(pwd)/data:/var/lib/postgresql/10/data \
+ -v $(pwd)/upgraded-postgresql:/var/lib/postgresql/11/data \
+ -e PGUSER=funkwhale \
+ -e POSTGRES_INITDB_ARGS="-U funkwhale --locale C --encoding UTF8" \
+ tianon/postgres-upgrade:10-to-11
+
+# replace the Postgres 10 files with Postgres 11 files
+mv data/ postgres-10
+mv upgraded-postgresql/ data
+```
+
+Once you have completed the Funkwhale upgrade with our regular instructions and everything works properly,
+you can remove the backups/old files:
+
+```sh
+sudo -u funkwhale -H bash
+cd /srv/funkwhale/data
+rm -rf ../postgres.bak
+rm -rf postgres-10
+```
+
+### Full list of changes
+
+Features:
+
+- Support for publishing and subscribing to podcasts (#170)
+- Brand new navigation, queue and player redesign (#594)
+- Can now browse a library content through the UI (#926)
+- Federated reports (#1038)
+- Screening for sign-ups (#1040)
+- Make it possible to enforce email verification (#1039)
+- Added a new radio based on another user listenings (#1060)
+- User management through the server CLI
+
+Enhancements:
+
+- Added ability to reject library follows from notifications screen (#859)
+- Added periodic background task and CLI command to associate genre tags to artists and albums based on identical tags found on corresponding tracks (#988)
+- Added support for CELERYD_CONCURRENCY env var to control the number of worker processes (#997)
+- Added the ability to sort albums by release date (#1013)
+- Added two new radios to play your own content or a given library tracks
+- Advertise list of known nodes on /api/v1/federation/domains and in nodeinfo if stats sharing is enabled
+- Changed footer to use instance name if available, and append ellipses if instance URL/Name is too long (#1012)
+- Favor local uploads when playing a track with multiple uploads (#1036)
+- Include only local content in nodeinfo stats, added downloads count
+- Make media and static files serving more reliable when reverse proxy `X_FORWARDED_*` headers are incorrect (#947)
+- Order the playlist columns by modification date in the Browse tab (#775)
+- Reduced size of funkwhale/funkwhale docker images thanks to multi-stage builds (!1042)
+- Remember display settings in Album, Artist, Radio and Playlist views (#391)
+- Removed unnecessary "Federation music needs approval" setting (#959)
+- Replaced our slow research logic by PostgreSQL full-text search (#994)
+- Support autoplay when loading embed frame from Mastodon and third-party websites (#1041)
+- Support filtering playlist by name and several additional UX improvements in playlists modal (#974)
+- Support modifying album cover art through the web UI (#588)
+- Use a dedicated scope for throttling subsonic to avoid intrusive rate-limiting
+- Use same markdown widget for all content fields (rules, description, reports, notes, etc.)
+- CLI Importer is now more reliable and less resource-hungry on large libraries
+- Add support custom domain for S3 storage
+- Better placeholders for channels when there are no episodes or series
+- Updated documentation for 0.21 release
+- Improved performance and error handling when fetching remote attachments
+
+Bugfixes:
+
+- Added missing manuallyApprovesFollowers entry in JSON-LD contexts (#961)
+- Fix issue with browser shortcuts such as search and focus URL not being recognised (#340, #985)
+- Fixed admin dropdown not showing after login (#1042)
+- Fixed an issue with celerybeat container failing to restart (#1004)
+- Fixed invalid displayed number of tracks in playlist (#986)
+- Fixed issue with recent results not being loaded from the API (#948)
+- Fixed issue with sorting by album name not working (#960)
+- Fixed short audio glitch when switching switching to another track with player paused (#970)
+- Improved deduplication logic to prevent skipped files during import (#348, #474, #557, #740, #928)
+- More resilient tag parsing with empty release date or album artist (#1037)
+- More robust importer against malformed dates (#966)
+- Removed "nodeinfo disabled" setting, as nodeinfo is required for the UI to work (#982)
+- Replaced PDF icon by List icon in playlist placeholder (#943)
+- Resolve an issue where disc numbers were not taken into consideration when playing an album from the album card (#1006)
+- Set correct size for album covers in playlist cards (#680)
+- Remove double spaces in ChannelForm
+- Deduplicate tags in Audio ActivityPub representation
+- Add support custom domain for S3 storage
+- Fix #1079: fixed z-index issues with dropdowns (#1079 and #1075)
+- Exclude external podcasts from library home
+- Fixed broken channel save when description is too long
+- Fixed 500 error when federation is disabled and application+json is requested
+- Fixed minor subsonic API crash
+- Fixed broken local profile page when allow-list is enabled
+- Fixed issue with confirmation email not sending when signup-approval was enabled
+- Ensure 0 quota on user is honored
+- Fixed attachments URL not honoring media URL
+- Fix grammar in msg string in TrackBase.vue
+- Fix typo in SubscribeButton.vue
+
+Translations:
+
+- Arabic
+- Catalan
+- English (United Kingdom)
+- German
+- Hungarian
+- Japanese
+- Occitan
+- Portuguese (Brazil)
+- Russian
+
+Contributors to this release (translation, development, documentation, reviews, design, testing, third-party projects):
+
+- Agate
+- annando
+- Anton Strömkvist
+- Audrey
+- ButterflyOfFire
+- Ciarán Ainsworth
+- Creak
+- Daniele Lira Mereb
+- dashie
+- Eloisa
+- eorn
+- Francesc Galí
+- gerhardbeck
+- GinnyMcQueen
+- guillermau
+- Haelwenn
+- jinxx
+- Jonathan Aylard
+- Keunes
+- M.G
+- marzzzello
+- Mathé Grievink
+- Mélanie Chauvel
+- Mjourdan
+- Morgan Kesler
+- Noe Gaumont
+- Noureddine HADDAG
+- Ollie
+- Peter Wickenberg
+- Quentin PAGÈS
+- Renon
+- Satsuki Yanagi
+- Shlee
+- SpcCw
+- techknowlogick
+- ThibG
+- Tony Wasserka
+- unklebonehead
+- wakest
+- wxcafé
+- Xaloc
+- Xosé M
+
+## 0.20.1 (2019-10-28)
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html
+
+### Denormalized audio permission logic in a separate table to enhance performance
+
+With this release, we're introducing a performance enhancement that should reduce the load on the database and API
+servers (cf https://dev.funkwhale.audio/funkwhale/funkwhale/merge_requests/939).
+
+Under the hood, we now maintain a separate table to link users to the tracks they are allowed to see. This change is **disabled**
+by default, but should be enabled by default starting in Funkwhale 0.21.
+
+If you want to try it now, add
+`MUSIC_USE_DENORMALIZATION=True` to your `.env` file, restart Funkwhale, and run the following command:
+
+```sh
+python manage.py rebuild_music_permissions
+```
+
+This shouldn't cause any regression, but we'd appreciate if you could test this before the 0.21 release and report any unusual
+behaviour regarding tracks, albums and artists visibility.
+
+Enhancements:
+
+- Added a retry option for failed uploads (#942)
+- Added feedback via loading spinner when searching a remote library
+- Denormalized audio permission logic in a separate table to enhance performance
+- Placeholders will now be shown if no content is available across the application (#750)
+- Reduce the number of simultaneous DB connections under some deployment scenario
+- Support byYear filtering in Subsonic API (#936)
+
+Bugfixes:
+
+- Ensure password input doesn't overflow outside of container (#933)
+- Fix audio serving issues under S3/nginx when signatures are enabled
+- Fix import crash when importing M4A file with no embedded cover (#946)
+- Fix tag exclusion in custom radios (#950)
+- Fixed an issue with embed player CSS being purged during build (#935)
+- Fixed escaped pod name displayed on home/about page (#945)
+- Fixed pagination in subsonic getSongsByGenre endpoint (#954)
+- Fixed style glitches in dropdowns
+
+Documentation:
+
+- Documented how to create DB extension by hand in case of permission error during migrations (#934)
+
+Contributors to this release (translation, development, documentation, reviews, design):
+
+- Ciarán Ainsworth
+- Dag Stenstad
+- Daniele Lira Mereb
+- Agate
+- Esteban
+- Johannes H.
+- knuxify
+- Mateus Mattei Garcia
+- Quentin PAGÈS
+
+## 0.20 (2019-10-04)
+
+Upgrade instructions are available at https://docs.funkwhale.audio/admin/upgrading.html
+
+### Support for genres via tags
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html
+
+One of our most requested missing features is now available!
+
+Starting with Funkwhale 0.20,
+Funkwhale will automatically extract genre information from uploaded files and associate it
+with the corresponding tracks in the form of tags (similar to Mastodon or Twitter hashtags).
+Please refer to [our tagging documentation](https://docs.funkwhale.audio/users/upload.html#tagging-files)
+for more information regarding the tagging process.
+
+Tags can also be associated with artists and albums, and updated after upload through the UI using
+the edit system released in Funkwhale 0.19. Tags are also fetched when retrieving content
+via federation.
+
+Tags are used in various places to enhance user experience:
+
+- Tags are listed on tracks, albums and artist profiles
+- Each tag has a dedicated page were you can browse corresponding content and quickly start a radio
+- The custom radio builder now supports using tags
+- Subsonic apps that support genres - such as DSub or Ultrasonic - should display this information as well
+
+If you are a pod admin and want to extract tags from already uploaded content, you run [this snippet](https://dev.funkwhale.audio/funkwhale/funkwhale/snippets/43)
+and [this snippet](https://dev.funkwhale.audio/funkwhale/funkwhale/snippets/44) in a `python manage.py shell`.
+
+### Content and account reports
+
+It is now possible to report content, such as artists, tracks or libraries, as well as user accounts. Such reports are forwarded to the pod moderators,
+who can review it and delete reported content, block accounts or take any other action they deem necessary.
+
+By default, both anonymous and authenticated users can submit these reports. This makes sure moderators can receive and handle
+takedown requests and other reports for illegal content that may be sent by third-parties without an account on the pod. However,
+you can disable anonymous reports completely via your pod settings.
+
+Federation of the reports will be supported in a future release.
+
+For more information about this feature, please check out our documentation:
+
+- [User documentation](https://docs.funkwhale.audio/moderator/reports.html)
+- [Moderator documentation](https://docs.funkwhale.audio/users/reports.html)
+
+### Account deletion
+
+Users can now delete their account themselves, without involving an administrator.
+
+The deletion process will remove any local data and objects associated with the account,
+but the username won't be able to new users to avoid impersonation. Deletion is also broadcasted
+to other known servers on the federation.
+
+For more information about this feature, please check out our documentation:
+
+- [User documentation](https://docs.funkwhale.audio/users/account.html)
+
+### Landing and about page redesign [Manual action suggested]
+
+In this release, we've completely redesigned the landing and about page, by making it more useful and adapted to your pod
+configuration. Among other things, the landing page will now include:
+
+- your pod and an excerpt from your pod's description
+- your pod banner image, if any
+- your contact email, if any
+- the login form
+- the signup form (if registrations are open on your pod)
+- some basic statistics about your pod
+- a widget including recently uploaded albums, if anonymous access is enabled
+
+The landing page will still include some information about Funkwhale, but in a less intrusive and proeminent way than before.
+
+Additionally, the about page now includes:
+
+- your pod name, description, rules and terms
+- your pod banner image, if any
+- your contact email, if any
+- comprehensive statistics about your pod
+- some info about your pod configuration, such as registration and federation status or the default upload quota for new users
+
+With this redesign, we've added a handful of additional pod settings:
+
+- Pod banner image
+- Contact email
+- Rules
+- Terms of service
+
+We recommend taking a few moments to fill these accordingly to your needs, by visiting `/manage/settings`.
+
+### Allow-list to restrict federation to trusted domains
+
+The Allow-Listing feature grants pod moderators
+and administrators greater control over federation
+by allowing you to create a pod-wide allow-list.
+
+When allow-listing is enabled, your pod's users will only
+be able to interact with pods included in the allow-list.
+Any messages, activity, uploads, or modifications to
+libraries and playlists will only be shared with pods
+on the allow-list. Pods which are not included in the
+allow-list will not have access to your pod's content
+or messages and will not be able to send anything to
+your pod.
+
+If you want to enable this feature on your pod, or learn more, please refer to [our documentation](https://docs.funkwhale.audio/moderator/listing.html)!
+
+### Periodic message to incite people to support their pod and Funkwhale
+
+Users will now be reminded on a regular basis that they can help Funkwhale by donating or contributing.
+
+If specified by the pod admin, a separate and custom message will also be displayed in a similar way to provide instructions and links to support the pod.
+
+Both messages will appear for the first time 15 days after signup, in the notifications tab. For each message, users can schedule a reminder for a later time, or disable the messages entirely.
+
+### Replaced Daphne by Gunicorn/Uvicorn [manual action required, non-docker only]
+
+To improve the performance, stability and reliability of Funkwhale's web processes,
+we now recommend using Gunicorn and Uvicorn instead of Daphne. This combination unlock new use cases such as:
+
+- zero-downtime upgrades
+- configurable number of web worker processes
+
+Based on our benchmarks, Gunicorn/Unicorn is also faster and more stable under higher workloads compared to Daphne.
+
+To benefit from this enhancement on existing instances, you need to add `FUNKWHALE_WEB_WORKERS=1` in your `.env` file
+(use a higher number if you want to have more web worker processes).
+
+Then, edit your `/etc/systemd/system/funkwhale-server.service` and replace the `ExecStart=` line with
+`ExecStart=/srv/funkwhale/virtualenv/bin/gunicorn config.asgi:application -w ${FUNKWHALE_WEB_WORKERS} -k uvicorn.workers.UvicornWorker -b ${FUNKWHALE_API_IP}:${FUNKWHALE_API_PORT}`
+
+Then reload the configuration change with `sudo systemctl daemon-reload` and `sudo systemctl restart funkwhale-server`.
+
+### Content-Security-Policy and additional security headers [manual action suggested]
+
+To improve the security and reduce the attack surface in case of a successful exploit, we suggest
+you add the following Content-Security-Policy to your nginx configuration.
+
+````{note}
+If you are using an S3-compatible store to serve music, you will need to specify the URL of your S3 store in the ``media-src`` and ``img-src`` headers
+
+```nginx
+add_header Content-Security-Policy "...img-src 'self' https:// data:;...media-src https:// 'self' data:";
+```
+````
+
+**On non-docker setups**, in `/etc/nginx/sites-available/funkwhale.conf`:
+
+```nginx
+server {
+
+ add_header Content-Security-Policy "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; object-src 'none'; media-src 'self' data:";
+ add_header Referrer-Policy "strict-origin-when-cross-origin";
+
+ location /front/ {
+ add_header Content-Security-Policy "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; object-src 'none'; media-src 'self' data:";
+ add_header Referrer-Policy "strict-origin-when-cross-origin";
+ add_header X-Frame-Options "SAMEORIGIN";
+ # … existing content here
+ }
+
+ # Also create a new location for the embeds to ensure external iframes work
+ # Simply copy-paste the /front/ location, but replace the following lines:
+ location /front/embed.html {
+ add_header X-Frame-Options "ALLOW";
+ alias ${FUNKWHALE_FRONTEND_PATH}/embed.html;
+ }
+}
+```
+
+Then reload nginx with `systemctl reload nginx`.
+
+**On docker setups**, in `/srv/funkwhalenginx/funkwhale.template`:
+
+```nginx
+server {
+
+ add_header Content-Security-Policy "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; object-src 'none'; media-src 'self' data:";
+ add_header Referrer-Policy "strict-origin-when-cross-origin";
+
+ location /front/ {
+ add_header Content-Security-Policy "default-src 'self'; script-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:; font-src 'self' data:; object-src 'none'; media-src 'self' data:";
+ add_header Referrer-Policy "strict-origin-when-cross-origin";
+ add_header X-Frame-Options "SAMEORIGIN";
+ # … existing content here
+ }
+
+ # Also create a new location for the embeds to ensure external iframes work
+ # Simply copy-paste the /front/ location, but replace the following lines:
+ location /front/embed.html {
+ add_header X-Frame-Options "ALLOW";
+ alias /frontend/embed.html;
+ }
+}
+
+```
+
+Then reload nginx with `docker-compose restart nginx`.
+
+### Rate limiting
+
+With this release, rate-limiting on the API is enabled by default, with high enough limits to ensure
+regular users of the app aren't affected. Requests beyond allowed limits are answered with a 429 HTTP error.
+
+For anonymous requests, the limit is applied to the IP address of the client, and for authenticated requests, the limit
+is applied to the corresponding user account. By default, anonymous requests get a lower limit than authenticated requests.
+
+You can disable the rate-limiting feature by adding `THROTTLING_ENABLED=false` to your `.env` file and restarting the
+services. If you are using the Funkwhale API in your project or app and want to know more about the limits, please consult https://docs.funkwhale.audio/swagger/.
+
+### Broken audio streaming when using S3/Minio and DSub [manual action required]
+
+Some Subsonic clients, such as DSub, are sending an Authorization headers which was forwarded
+to the S3 storage when streaming, causing some issues. If you are using S3 or a compatible storage
+such as Minio, please add the following in your nginx `~ /_protected/media/(.+)` location:
+
+```nginx
+# Needed to ensure DSub auth isn't forwarded to S3/Minio, see #932
+proxy_set_header Authorization "";
+```
+
+And reload your nginx process.
+
+### Detail
+
+Features:
+
+- Added periodical message to incite people to support their pod and Funkwhale (#839)
+- Admins can now add custom CSS from their pod settings (#879)
+- Allow-list to restrict federation to trusted domains (#853)
+- Content and account reports (#890)
+- Dark theme (#756)
+- Enforce a configurable rate limit on the API to mitigate abuse (#261)
+- Redesign of the landing and about pages (#872)
+- Support for genres, via tags (#432)
+- Users can now delete their account without admin intervention (#852)
+
+Enhancements:
+
+- Added a info message on embed wizard when anonymous access to content is disabled (#878)
+- Added Catalan translation files
+- Added Czech translation (#844)
+- Added field to manage user upload quota in Django backend (#903)
+- Added the option to replace the queue's current contents with a selected album or track (#761)
+- Artists with no albums will now show track count on artist card (#895)
+- Ensure API urls answer with and without a trailing slash (#877)
+- Hardcoded list of supported browsers to avoid unexpected regressions (#854)
+- Hardened security thanks to CSP and additional HTTP headers (#880)
+- Improve display of search results by including artist and album data
+- Increase the security of JWT token generation by using DJANGO_SECRET_KEY as well as user-specific salt for the signature
+- Mods can now change a library visibility through the admin UI (#548)
+- New keyboard shortcuts added for enhanced control over audio player (#866)
+- Now refetch remote ActivityPub artists, albums and tracks to avoid local stale data
+- Numbers on the stats page will now be formatted in a human readable way and will update with the locale (#873)
+- Pickup folder.png and folder.jpg files for cover art when importing from CLI (#898)
+- Prevent usage of too weak passwords (#883)
+- Reduced CSS size by 30% using purgecss
+- Replaced Daphne by Gunicorn/Uvicorn to improve stability, flexibility and performance (#862)
+- Simplified embedded docker reverse proxy IP configuration (#834)
+- Support embeds on public playlists
+- Support for M4A/AAC files (#661)
+- Switched from Semantic-UI to Fomentic-UI
+- Add dropdown menu to track table (#531)
+- Display placeholder on homepage when there are no playlists (#892)
+- Make album cards height independent (#710)
+
+Bugfixes:
+
+- Added context strings to en_GB translations so that picking the language changes the interface as expected
+- Ensure selected locale is not reset to browser default when refreshing app
+- Fix missing license information on track details page (#913)
+- Fix regression to quota bar color (#897)
+- Fixed a responsive display issues on 1024px wide screens (#904)
+- Fixed album art not being retrieved from Ogg/Opus files
+- Fixed broken embedded player layout after dependency update (#875)
+- Fixed broken external HTTPS request under some scenarios, because of missing PyOpenSSL
+- Fixed broken less listened radio (#912)
+- Fixed broken URL to artist and album on album and track pages (#871)
+- Fixed empty contentType causing client crash in some Subsonic payloads (#893)
+- Fixed import crashing with empty cover file or too long values on some fields
+- Fixed in-place imported files not playing under nginx when filename contains ? or % (#924)
+- Fixed remaining transcoding issue with Subsonic API (#867)
+- Fixed search usability issue when browsing artists, albums, radios and playlists (#902)
+- Improved performance of /artists, /albums and /tracks API endpoints by a factor 2 (#865)
+- Updated docs to ensure streaming works when using Minio/S3 and DSub (#932)
+
+Contributors to this release (translation, development, documentation, reviews, design):
+
+- Amaranthe
+- ButterflyOfFire
+- Ciarán Ainsworth
+- Agate
+- Esteban
+- Francesc Galí
+- Freyja Wildes
+- hellekin
+- IISergII
+- jiri-novacek
+- Johannes H.
+- Keunes
+- Koen
+- Manuel Cortez
+- Mehdi
+- Mélanie Chauvel
+- nouts
+- Quentí
+- Reg
+- Rodrigo Leite
+- Romain Failliot
+- SpcCw
+- Sylke Vicious
+- Tobias Reisinger
+- Xaloc
+- Xosé M
+
+## 0.19.1 (2019-06-28)
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html
+
+Enhancements:
+
+- The currently playing track is now highlighted with an orange play icon (#832)
+- Support for importing files with no album tag (#122)
+- Redirect from / to /library when user is logged in (#864)
+- Added a SUBSONIC_DEFAULT_TRANSCODING_FORMAT env var to support clients that don't provide the format parameter (#867)
+- Added button to search for objects on Discogs (#368)
+- Added copy-to-clipboard button with Subsonic password input (#814)
+- Added opus to the list of supported mimetypes and extensions (#868)
+- Aligned search headers with search results in the sidebar (#708)
+- Clicking on the currently selected playlist in the Playlist popup will now close the popup (#807)
+- Favorites radio will not be visible if the user does not have any favorites (#419)
+
+Bugfixes:
+
+- Ensure empty but optional fields in file metadata don't error during import (#850)
+- Fix broken upload for specific files when using S3 storage (#857)
+- Fixed broken translation on home and track detail page (#833)
+- Fixed broken user admin for users with non-digit or letters in their username (#869)
+- Fixed invalid file extension for transcoded tracks (#848)
+- Fixed issue with French translation for "Start radio" (#849)
+- Fixed issue with player changing height when hovering over the volume slider (#838)
+- Fixed secondary menus truncated on narrow screens (#855)
+- Fixed wrong og:image url when using S3 storage (#851)
+- Hide pod statistics on about page if those are disabled (#835)
+- Use ASCII filename before upload to S3 to avoid playback issues (#847)
+
+Contributors to this release (committers and reviewers):
+
+- Ciarán Ainsworth
+- Creak
+- ealgase
+- Agate
+- Esteban
+- Freyja Wildes
+- hellekin
+- Johannes H.
+- Mehdi
+- Reg
+
+## 0.19.0 (2019-05-16)
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html
+
+### Edits on tracks, albums and artists
+
+Funkwhale was a bit annoying when it camed to metadata. Tracks, albums and artists profiles
+were created from audio file tags, but basically immutable after that (unless you had
+admin access to Django's UI, which wasn't ideal to do this kind of changes).
+
+With this release, everyone can suggest changes on track, album and artist pages. Users
+with the "library" permission can review suggested edits in a dedicated interface
+and apply/reject them.
+
+Approved edits are broadcasted via federation, to ensure other instances get the information
+too.
+
+Not all fields are currently modifiable using this feature. Especially, it's not possible
+to suggest a new album cover, or reassign a track to a different album or artist. Those will
+be implemented in a future release.
+
+### Admin UI for tracks, albums, artists, libraries and uploads
+
+As part of our ongoing effort to make Funkwhale easier to manage for instance owners,
+this release includes a brand new administration interface to deal with:
+
+- tracks
+- albums
+- artists
+- libraries
+- uploads
+
+You can use this UI to quickly search for any object, delete objects in batch, understand
+where they are coming from etc. This new UI should remove the need to go through Django's
+admin in the vast majority of cases (but also includes a link to Django's admin when needed).
+
+### Artist hiding in the interface
+
+It's now possible for users to hide artists they don't want to see.
+
+Content linked to hidden artists will not show up in the interface anymore. Especially:
+
+- Hidden artists tracks are removed from the current queue
+- Starting a playlist will skip tracks from hidden artists
+- Recently favorited, recently listened and recently added widgets on the homepage won't include content from hidden artists
+- Radio suggestions will exclude tracks from hidden artists
+- Hidden artists won't appear in Subsonic apps
+
+Results linked to hidden artists will continue to show up in search results and their profile page remains accessible.
+
+### OAuth2 authorization for better integration with third-party apps
+
+Funkwhale now support the OAuth2 authorization and authentication protocol which will allow
+third-party apps to interact with Funkwhale on behalf of users.
+
+This feature makes it possible to build third-party apps that have the same capabilities
+as Funkwhale's Web UI. The only exception at the moment is for actions that requires
+special permissions, such as modifying instance settings or moderation (but this will be
+enabled in a future release).
+
+If you want to start building an app on top of Funkwhale's API, please check-out
+https://docs.funkwhale.audio/api.html and https://docs.funkwhale.audio/developers/authentication.html.
+
+### Better error handling and display during import
+
+Funkwhale should now be more resilient to missing tags in imported files, and give
+you more insights when something goes wrong, including the specific tags that were missing
+or invalid, and additional debug information to share in your support requests.
+
+This information is available in all pages that list uploads, when clicking on the button next to the upload status.
+
+### Support for S3-compatible storages to store media files
+
+Storing all media files on the Funkwhale server itself may not be possible or desirable
+in all scenarios. You can now configure Funkwhale to store those files in a S3
+bucket instead.
+
+Check-out https://docs.funkwhale.audio/admin/external-storages.html if you want to use
+this feature.
+
+### Prune library command
+
+Users are often surprised by Funkwhale's tendency to keep track, album and artist
+metadata even if no associated files exist.
+
+To help with that, we now offer a `prune_library` management command you can run
+to purge your database from obsolete entries. [Please refer to our documentation for usage instructions](https://docs.funkwhale.audio/admin/commands.html#pruning-library).
+
+### Check in-place files command
+
+When using in-place import with a living audio library, you'll quite often rename or
+remove files from the file system. Unfortunately, Funkwhale keeps a reference to those
+files in the database, which results in unplayable tracks.
+
+To help with that, we now offer a `check_inplace_files` management command you can run
+to purge your database from obsolete files. [Please refer to our documentation for usage instructions](https://docs.funkwhale.audio/admin/commands.html#remove-obsolete-files-from-database).
+
+Features:
+
+- Added albums view. Similar to artists view, it's viewable by clicking on the "Albums" link on the top bar. (#356)
+- Allow artists hiding (#701)
+- Change the document title to display current track information. (#359)
+- Display a confirmation dialog when adding duplicate songs to a playlist (#784)
+- Improved error handling and display during import (#252, #718, #583, #501, #544)
+- Support embedding full artist discographies (#747)
+- Support metadata update on tracks, albums and artists and broadcast those on the federation (#689)
+- Support OAuth2 authorization for better integration with third-party apps (#752)
+- Support S3-compatible storages for media files (#565)
+
+Enhancements:
+
+- [Experimental] Added a new "Similar" radio based on users history (suggested by @gordon)
+- Added a "load more" button on artist pages to load more tracks/albums (#719)
+- Added a `check_inplace_files` management command to remove purge the database from references to in-place imported files that don't exist on disk anymore (#781)
+- Added a prune_library management command to remove obsolete metadata from the database (#777)
+- Added admin options to disable login for users, ensure related content is deleted when deleting a user account (#809)
+- Added standardized translation context for all strings in the frontend to give accurate hints to translators.
+- Added twitter:\* meta tags to detect tracks and albums players automatically on more sites (#578)
+ Improved responsiveness of embedded player
+- Advertise the list of supported upload extensions in the Nodeinfo endpoint (#808)
+- Better handling of follow/accept messages to avoid and recover from desync between instances (#830)
+- Better workflow for connecting to another instance (#715)
+
+ Changing the instance used is now better integrated in the App, and it is checked that the chosen instance and the suggested instances are valid and running Funkwhale servers.
+
+- Bumped dependencies to latest versions (#815)
+- Descriptions will now be shown underneath user libraries (#768)
+- Don't store unhandled ActivityPub messages in database (#776)
+- Enhanced the design of the embed wizard. (!619)
+- Ensure the footer always stays at the bottom of the page
+- Expose an instance-level actor (service@domain) in nodeinfo endpoint (#689)
+- Improved readability of logo (#385)
+- Keep persistent connections to the database instead of recreating a new one for each request
+- Labels for privacy levels are now consistently grabbed from a common source instead of being hardcoded every time they are needed.
+- Merged artist/album buttons with title text on artist and album pages (#725)
+- Now honor maxBitrate parameter in Subsonic API (#802)
+- Preload next track in queue (#572)
+- Reduced app size for regular users by moving admin-related code in a dedicated chunk (#805)
+- Removed broken/instable lyrics feature (#799)
+- Show remaining storage space during import and prevent file upload if not enough space is remaining (#550)
+- The buttons displaying an icon now always show a little divider between the icon and the text. (!620)
+- Use attributedTo instead of actor in library ActivityPub payload (#619)
+- Use network/depends_on instead of links in docker-compose.yml (!716)
+
+Bugfixes:
+
+- Add missing command from contributing file (#754)
+- Add required envvar for dev environment (!668)
+- Added env variable to set AWS region and signature version to serve media without proxy (#826)
+- Allow users with dots in their usernames to request a subsonic password (#798)
+- Better handling of featuring/multi-artist tracks tagged with MusicBrainz (#782)
+- Do not consider tracks as duplicates during import if they have different positions (#740)
+- Ensure all our ActivityPub fetches are authenticated (#758)
+- Ensure correct track duration and playable status when browsing radios (#812)
+- Fixed alignment/size issue with some buttons (#702)
+- Fixed an encoding issue with instance name on about page (#828)
+- Fixed cover not showing in queue/player when playing tracks from "albums" tab (#795)
+- Fixed crashing upload processing on invalid date format (#718)
+- Fixed dev command for fake data creation (!664)
+- Fixed invalid OEmbed URL when using a local FUNKWHALE_SPA_HTML_ROOT (#824)
+- Fixed invalid required fields in Upload django's admin (#819)
+- Fixed issue with querying the albums api endpoint (#356)
+- Fixed non-transparent background for volume range on Firefox (#722)
+- Fixed overflowing input on account detail page (#791)
+- Fixed unplayable radios for anonymous users (#563)
+- Prevent skipping on file import if album_mbid is different (#772)
+- Use proper site name/domain in emails (#806)
+- Width of filter menus for radios has been set to stop text from overlapping the borders
+
+Documentation:
+
+- Document how to use Redis over unix sockets (#770)
+
+Contributors to this release (committers and translators):
+
+- Ale London
+- Alexander
+- Ben Finney
+- ButterflyOfFire
+- Ciarán Ainsworth
+- Damien Nicolas
+- Daniele Lira Mereb
+- Agate
+- Elza Gelez
+- gerry_the_hat
+- gordon
+- interfect
+- jake
+- Jee
+- jovuit
+- Mélanie Chauvel
+- nouts
+- Pierrick
+- Qasim Ali
+- Quentí
+- Renon
+- Rodrigo Leite
+- Sylke Vicious
+- Thomas Brockmöller
+- Tixie
+- Vierkantor
+- Von
+- Zach Halasz
+
+## 0.18.3 (2019-03-21)
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html
+
+### Avoid mixed content when deploying mono-container behind proxy [Manual action required]
+
+_You are only concerned if you use the mono-container docker deployment behind a reverse proxy_
+
+Because of [an issue in our mono-container configuration](https://github.com/thetarkus/docker-funkwhale/issues/19), users deploying Funkwhale via docker
+using our `funkwhale/all-in-one` image could face some mixed content warnings (and possibly other troubles)
+when browsing the Web UI.
+
+This is fixed in this release, but on existing deployments, you'll need to add `NESTED_PROXY=1` in your container
+environment (either in your `.env` file, or via your container management tool), then recreate your funkwhale container.
+
+Enhancements:
+
+- Added title on hover for truncated content (#766)
+- Ask for confirmation before leaving upload page if there is a an upload in process (#630)
+- Exclude in-place imported files from quota computation (#570)
+- Truncate filename in library file table to ensure correct display of the table. (#735)
+
+Bugfixes:
+
+- Avoid mixed content when deploying mono-container behind HTTPS proxy (thetarkus/docker-funkwhale#19)
+- Display new notifications immediately on notifications page (#729)
+- Ensure cover art from uploaded files is picked up properly on existing albums (#757)
+- Fixed a crash when federating a track with unspecified position
+- Fixed broken Activity and Actor modules in django admin (#767)
+- Fixed broken sample apache configuration (#764)
+- Fixed constant and unpredictable reordering during file upload (#716)
+- Fixed delivering of local activities causing unintended side effects, such as rollbacking changes (#737)
+- Fixed escaping issues in translated strings (#652)
+- Fixed saving moderation policy when clicking on "Cancel" (#751)
+- i18n: Update page title when changing the App's language. (#511)
+- Include disc number in Subsonic responses (#765)
+- Do not send notification when rejecting a follow on a local library (#743)
+
+Documentation:
+
+- Added documentation on mono-container docker upgrade (#713)
+- Added documentation to set up let's encrypt certificate (#745)
+
+## 0.18.2 (2019-02-13)
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html
+
+Enhancements:
+
+- Added a 'fix_federation_ids' management command to deal with protocol/domain issues in federation
+ IDs after deployments (#706)
+- Can now use a local file with FUNKWHALE_SPA_HTML_ROOT to avoid sending an HTTP request (#705)
+
+Bugfixes:
+
+- Downgraded channels dependency to 2.1.6 to fix denied uploads (#697)
+- Fixed cards display issues on medium/small screens (#707)
+- Fixed Embed component name that could lead to issue when developing on OSX (#696)
+- Fixed resizing issues for album cards on artist pages (#694)
+
+## 0.18.1 (2019-01-29)
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html
+
+### Fix Gzip compression to avoid BREACH exploit [security] [manual action required]
+
+In the 0.18 release, we've enabled Gzip compression by default for various
+content types, including HTML and JSON. Unfortunately, enabling Gzip compression
+on such content types could make BREACH-type exploits possible.
+
+We've removed the risky content-types from our nginx template files, to ensure new
+instances are safe, however, if you already have an instance, you need
+to double check that your host nginx virtualhost do not include the following
+values for the `gzip_types` settings:
+
+```
+application/atom+xml
+application/json
+application/ld+json
+application/activity+json
+application/manifest+json
+application/rss+xml
+application/xhtml+xml
+application/xml
+```
+
+For convenience, you can also replace the whole setting with the following snippet:
+
+```
+gzip_types
+application/javascript
+application/vnd.geo+json
+application/vnd.ms-fontobject
+application/x-font-ttf
+application/x-web-app-manifest+json
+font/opentype
+image/bmp
+image/svg+xml
+image/x-icon
+text/cache-manifest
+text/css
+text/plain
+text/vcard
+text/vnd.rim.location.xloc
+text/vtt
+text/x-component
+text/x-cross-domain-policy;
+```
+
+Many thanks to @jibec for the report!
+
+### Fix Apache configuration file for 0.18 [manual action required]
+
+The way front is served has changed since 0.18. The Apache configuration can't serve 0.18 properly, leading to blank screens.
+
+If you are on an Apache setup, you will have to replace the `` block with the following:
+
+```apache
+
+ # similar to nginx 'client_max_body_size 100M;'
+ LimitRequestBody 104857600
+
+ ProxyPass ${funkwhale-api}/
+ ProxyPassReverse ${funkwhale-api}/
+
+```
+
+And add some more `ProxyPass` directives so that the `Alias` part of your configuration file looks this way:
+
+```apache
+ ProxyPass "/front" "!"
+ Alias /front /srv/funkwhale/front/dist
+
+ ProxyPass "/media" "!"
+ Alias /media /srv/funkwhale/data/media
+
+ ProxyPass "/staticfiles" "!"
+ Alias /staticfiles /srv/funkwhale/data/static
+```
+
+In case you are using custom css and theming, you also need to match this block:
+
+```apache2
+ ProxyPass "/settings.json" "!"
+ Alias /settings.json /srv/funkwhale/custom/settings.json
+
+ ProxyPass "/custom" "!"
+ Alias /custom /srv/funkwhale/custom
+```
+
+Enhancements:
+
+- Added name attributes on all inputs to improve UX, especially with password managers (#686)
+- Disable makemigrations in production and misleading message when running migrate (#685)
+- Display progress during file upload
+- Hide pagination when there is only one page of results (#681)
+- Include shared/public playlists in Subsonic API responses (#684)
+- Use proper locale for date-related/duration strings (#670)
+
+Bugfixes:
+
+- Fix transcoding of in-place imported tracks (#688)
+- Fixed celery worker defaulting to development settings instead of production
+- Fixed crashing Django admin when loading track detail page (#666)
+- Fixed list icon alignment on landing page (#668)
+- Fixed overescaping issue in notifications and album page (#676)
+- Fixed wrong number of affected elements in bulk action modal (#683)
+- Fixed wrong URL in documentation for funkwhale_proxy.conf file when deploying using Docker
+- Make Apache configuration file work with 0.18 changes (#667)
+- Removed potential BREACH exploit because of Gzip compression (#678)
+- Upgraded kombu to fix an incompatibility with redis>=3
+
+Documentation:
+
+- Added user upload documentation at https://docs.funkwhale.audio/users/upload.html
+
+## 0.18 "Naomi" (2019-01-22)
+
+This release is dedicated to Naomi, an early contributor and beta tester of Funkwhale.
+Her positivity, love and support have been incredibly helpful and helped shape the project
+as you can enjoy it today. Thank you so much Naomi <3
+
+Many thanks to the dozens of people that contributed to this release: translators, developers,
+bug hunters, admins and backers. You made it possible!
+
+Upgrade instructions are available at
+https://docs.funkwhale.audio/administrator/upgrade/index.html, ensure you also execute the instructions
+marked with `[manual action required]` and `[manual action suggested]`.
+
+See `Full changelog` below for an exhaustive list of changes!
+
+### Audio transcoding is back!
+
+After removal of our first, buggy transcoding implementation, we're proud to announce
+that this feature is back. It is enabled by default, and can be configured/disabled
+in your instance settings!
+
+This feature works in the browser, with federated/non-federated tracks and using Subsonic clients.
+Transcoded tracks are generated on the fly, and cached for a configurable amount of time,
+to reduce the load on the server.
+
+### Licensing and copyright information
+
+Funkwhale is now able to parse copyright and license data from file and store
+this information. Apart from displaying it on each track detail page,
+no additional behaviour is currently implemented to use this new data, but this
+will change in future releases.
+
+License and copyright data is also broadcasted over federation.
+
+License matching is done on the content of the `License` tag in the files,
+with a fallback on the `Copyright` tag.
+
+Funkwhale will successfully extract licensing data for the following licenses:
+
+- Creative Commons 0 (Public Domain)
+- Creative Commons 1.0 (All declinations)
+- Creative Commons 2.0 (All declinations)
+- Creative Commons 2.5 (All declinations and countries)
+- Creative Commons 3.0 (All declinations and countries)
+- Creative Commons 4.0 (All declinations)
+
+Support for other licenses such as Art Libre or WTFPL will be added in future releases.
+
+### Instance-level moderation tools
+
+This release includes a first set of moderation tools that will give more control
+to admins about the way their instance federates with other instance and accounts on the network.
+Using these tools, it's now possible to:
+
+- Browse known accounts and domains, and associated data (storage size, software version, etc.)
+- Purge data belonging to given accounts and domains
+- Block or partially restrict interactions with any account or domain
+
+All those features are usable using a brand new "moderation" permission, meaning
+you can appoint one or multiple moderators to help with this task.
+
+I'd like to thank all Mastodon contributors, because some of the these tools are heavily
+inspired from what's being done in Mastodon. Thank you so much!
+
+### Iframe widget to embed public tracks and albums [manual action required]
+
+Funkwhale now supports embedding a lightweight audio player on external websites
+for album and tracks that are available in public libraries. Important pages,
+such as artist, album and track pages also include OpenGraph tags that will
+enable previews on compatible apps (like sharing a Funkwhale track link on Mastodon
+or Twitter).
+
+To achieve that, we had to tweak the way Funkwhale front-end is served. You'll have
+to modify your nginx configuration when upgrading to keep your instance working.
+
+**On docker setups**, edit your `/srv/funkwhale/nginx/funkwhale.template` and replace
+the `location /api/` and `location /` blocks by the following snippets:
+
+```nginx
+location / {
+ include /etc/nginx/funkwhale_proxy.conf;
+ # this is needed if you have file import via upload enabled
+ client_max_body_size ${NGINX_MAX_BODY_SIZE};
+ proxy_pass http://funkwhale-api/;
+}
+
+location /front/ {
+ alias /frontend/;
+}
+```
+
+The change of configuration will be picked when restarting your nginx container.
+
+**On non-docker setups**, edit your `/etc/nginx/sites-available/funkwhale.conf` file,
+and replace the `location /api/` and `location /` blocks by the following snippets:
+
+```nginx
+location / {
+ include /etc/nginx/funkwhale_proxy.conf;
+ # this is needed if you have file import via upload enabled
+ client_max_body_size ${NGINX_MAX_BODY_SIZE};
+ proxy_pass http://funkwhale-api/;
+}
+
+location /front/ {
+ alias ${FUNKWHALE_FRONTEND_PATH}/;
+}
+```
+
+Replace `${FUNKWHALE_FRONTEND_PATH}` by the corresponding variable from your .env file,
+which should be `/srv/funkwhale/front/dist` by default, then reload your nginx process with
+`sudo systemctl reload nginx`.
+
+### Alternative docker deployment method
+
+Thanks to the awesome work done by @thetarkus at https://github.com/thetarkus/docker-funkwhale,
+we're now able to provide an alternative and easier Docker deployment method!
+
+In contrast with our current, multi-container offer, this method integrates
+all Funkwhale processes and services (database, redis, etc.) into a single, easier to deploy container.
+
+Both methods will coexist in parallel, as each one has pros and cons. You can learn more
+about this exciting new deployment option by visiting https://docs.funkwhale.audio/installation/docker.html!
+
+### Automatically load .env file
+
+On non-docker deployments, earlier versions required you to source
+the config/.env file before launching any Funkwhale command, with `export $(cat config/.env | grep -v ^# | xargs)`
+This led to more complex and error prone deployment / setup.
+
+This is not the case anymore, and Funkwhale will automatically load this file if it's available.
+
+### Delete pre 0.17 federated tracks [manual action suggested]
+
+If you were using Funkwhale before the 0.17 release and federated with other instances,
+it's possible that you still have some unplayable federated files in the database.
+
+To purge the database of those entries, you can run the following command:
+
+On docker setups:
+
+```sh
+docker-compose run --rm api python manage.py script delete_pre_017_federated_uploads --no-input
+```
+
+On non-docker setups:
+
+```sh
+python manage.py script delete_pre_017_federated_uploads --no-input
+```
+
+### Enable gzip compression [manual action suggested]
+
+Gzip compression will be enabled on new instances by default
+and will reduce the amount of bandwidth consumed by your instance.
+
+If you want to benefit from gzip compression on your instance,
+edit your reverse proxy virtualhost file (located at `/etc/nginx/sites-available/funkwhale.conf`) and add the following snippet
+in the server block, then reload your nginx server:
+
+```nginx
+server {
+ # ...
+
+ # compression settings
+ gzip on;
+ gzip_comp_level 5;
+ gzip_min_length 256;
+ gzip_proxied any;
+ gzip_vary on;
+
+ gzip_types
+ application/javascript
+ application/vnd.geo+json
+ application/vnd.ms-fontobject
+ application/x-font-ttf
+ application/x-web-app-manifest+json
+ font/opentype
+ image/bmp
+ image/svg+xml
+ image/x-icon
+ text/cache-manifest
+ text/css
+ text/plain
+ text/vcard
+ text/vnd.rim.location.xloc
+ text/vtt
+ text/x-component
+ text/x-cross-domain-policy;
+ # end of compression settings
+}
+```
+
+### Full changelog
+
+Features:
+
+- Allow embedding of albums and tracks available in public libraries via an