diff --git a/2092.fix b/2092.fix new file mode 100644 index 000000000..0c6089767 --- /dev/null +++ b/2092.fix @@ -0,0 +1 @@ +Allow summary field of actors to be blank. This leaves actors valid that have a blank (`""`) summary field and allows follows from those. diff --git a/CHANGELOG.md b/CHANGELOG.md index a7f0fa76e..064b21927 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,14 @@ This changelog is viewable on the web at https://docs.funkwhale.audio/changelog. +## 1.3.0-rc4 (2023-03-24) + +Update since 1.3.0-rc2: + +- Resolved an issue where queue text with mouse over has dark text on dark background (#2058) (2058) +- Improve signal handling for service and containers +- Fixes an issue which made it possible to download all media files without access control (#2101) + ## 1.3.0-rc3 (2023-01-23) Update since 1.3.0-rc2: @@ -51,17 +59,20 @@ Update instructions: curl -L -o /srv/funkwhale/docker-compose.yml "https://dev.funkwhale.audio/funkwhale/funkwhale/raw/${FUNKWHALE_VERSION}/deploy/docker-compose.yml" ``` - ```{note} - If you need to customize your nginx template, e.g. to work around [problems with Docker's resolver](https://docs.funkwhale.audio/admin/external-storages.html#no-resolver-found), you can mount your + .. note:: + If you need to customize your nginx template, e.g. to work around `problems with Docker's resolver `\_, you can mount your custom nginx configuration into the container. Uncomment the commented volumes in the `nginx` section of your `docker-compose.yml`. Additionally you need to update the paths in `nginx/funkwhale.template`. Replace all occurrences of `/funkwhale` by `/usr/share/nginx/html`. This loads the templates from your `nginx` folder and overrides the template files in the Docker container. - ``` + + ```` ```sh docker-compose up -d - ``` + ```` + +- The Docker instructions now use the updated Docker compose plugin. If you previously used the `docker-compose` standalone installation, do the following while upgrading: - The Docker instructions now use the updated Docker compose plugin. If you previously used the `docker-compose` standalone installation, do the following while upgrading: diff --git a/api/config/settings/common.py b/api/config/settings/common.py index 7ce1085b9..518f85bf8 100644 --- a/api/config/settings/common.py +++ b/api/config/settings/common.py @@ -871,6 +871,7 @@ Example: - ``redis://127.0.0.1:6379/0`` - ``redis+socket:///run/redis/redis.sock?virtual_host=0`` + """ # END CELERY # Location of root django.contrib.admin URL, use {% url 'admin:index' %} diff --git a/api/docker/server.sh b/api/docker/server.sh index 044e584e2..50ec5f7b7 100755 --- a/api/docker/server.sh +++ b/api/docker/server.sh @@ -6,7 +6,7 @@ funkwhale-manage collectstatic --noinput funkwhale-manage migrate # shellcheck disable=SC2086 -gunicorn config.asgi:application \ +exec gunicorn config.asgi:application \ --workers "${FUNKWHALE_WEB_WORKERS-1}" \ --worker-class uvicorn.workers.UvicornWorker \ --bind 0.0.0.0:5000 \ diff --git a/api/funkwhale_api/federation/jsonld.py b/api/funkwhale_api/federation/jsonld.py index 26020b9dd..8f1f362cc 100644 --- a/api/funkwhale_api/federation/jsonld.py +++ b/api/funkwhale_api/federation/jsonld.py @@ -1,5 +1,6 @@ import asyncio import functools +import logging import aiohttp import pyld.documentloader.requests @@ -10,6 +11,8 @@ from rest_framework.fields import empty from . import contexts +logger = logging.getLogger(__name__) + def cached_contexts(loader): functools.wraps(loader) @@ -282,7 +285,8 @@ class JsonLdSerializer(serializers.Serializer): if dereferenced_ids: try: loop = asyncio.get_event_loop() - except RuntimeError: + except RuntimeError as exception: + logger.debug(exception) loop = asyncio.new_event_loop() references = self.context.setdefault("references", {}) loop.run_until_complete( diff --git a/api/funkwhale_api/federation/serializers.py b/api/funkwhale_api/federation/serializers.py index c6e586023..31858f76d 100644 --- a/api/funkwhale_api/federation/serializers.py +++ b/api/funkwhale_api/federation/serializers.py @@ -247,6 +247,7 @@ class ActorSerializer(jsonld.JsonLdSerializer): truncate_length=common_models.CONTENT_TEXT_MAX_LENGTH, required=False, allow_null=True, + allow_blank=True, ) followers = serializers.URLField(max_length=500, required=False) following = serializers.URLField(max_length=500, required=False, allow_null=True) diff --git a/api/pyproject.toml b/api/pyproject.toml index 99bf57b26..cd8f9c0cb 100644 --- a/api/pyproject.toml +++ b/api/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "funkwhale-api" -version = "1.2.9" +version = "1.2.10" description = "Funkwhale API" authors = ["Funkwhale Collective"] diff --git a/changes/changelog.d/2058.bugfix b/changes/changelog.d/2058.bugfix new file mode 100644 index 000000000..ce7947eb2 --- /dev/null +++ b/changes/changelog.d/2058.bugfix @@ -0,0 +1 @@ +Resolved an issue where queue text with mouse over has dark text on dark background (#2058) (2058) diff --git a/changes/changelog.d/improve-signal-handling.bugfix b/changes/changelog.d/improve-signal-handling.bugfix new file mode 100644 index 000000000..733fed50d --- /dev/null +++ b/changes/changelog.d/improve-signal-handling.bugfix @@ -0,0 +1 @@ +Improve signal handling for service and containers diff --git a/changes/changelog.d/public-media.bugfix b/changes/changelog.d/public-media.bugfix new file mode 100644 index 000000000..4fa615c24 --- /dev/null +++ b/changes/changelog.d/public-media.bugfix @@ -0,0 +1 @@ +Fixes an issue which made it possible to download all media files without access control (#2101) diff --git a/deploy/docker-compose.yml b/deploy/docker-compose.yml index 4ad645fd1..282da092b 100644 --- a/deploy/docker-compose.yml +++ b/deploy/docker-compose.yml @@ -32,7 +32,12 @@ services: # of CPUs. You can adjust this, by explicitly setting the --concurrency # flag: # celery -A funkwhale_api.taskapp worker -l INFO --concurrency=4 - command: celery -A funkwhale_api.taskapp worker -l INFO --concurrency=${CELERYD_CONCURRENCY-0} + command: + - celery + - --app=funkwhale_api.taskapp + - worker + - --loglevel=INFO + - --concurrency=${CELERYD_CONCURRENCY-0} environment: - C_FORCE_ROOT=true volumes: @@ -42,11 +47,15 @@ services: celerybeat: restart: unless-stopped image: funkwhale/api:${FUNKWHALE_VERSION:-latest} + command: + - celery + - --app=funkwhale_api.taskapp + - beat + - --loglevel=INFO depends_on: - postgres - redis env_file: .env - command: celery -A funkwhale_api.taskapp beat --pidfile= -l INFO api: restart: unless-stopped diff --git a/deploy/funkwhale-server.service b/deploy/funkwhale-server.service index 688f9c2a8..0a0503d51 100644 --- a/deploy/funkwhale-server.service +++ b/deploy/funkwhale-server.service @@ -9,11 +9,14 @@ User=funkwhale WorkingDirectory=/srv/funkwhale/api EnvironmentFile=/srv/funkwhale/config/.env +Type=notify +KillMode=mixed ExecStart=/srv/funkwhale/venv/bin/gunicorn \ config.asgi:application \ --workers ${FUNKWHALE_WEB_WORKERS} \ --worker-class uvicorn.workers.UvicornWorker \ --bind ${FUNKWHALE_API_IP}:${FUNKWHALE_API_PORT} +ExecReload=/bin/kill -s HUP $MAINPID [Install] WantedBy=multi-user.target diff --git a/deploy/nginx.template b/deploy/nginx.template index 2498a0318..214bc2ca4 100644 --- a/deploy/nginx.template +++ b/deploy/nginx.template @@ -120,8 +120,15 @@ server { proxy_pass http://funkwhale-api; } - location /media/ { - alias ${MEDIA_ROOT}/; + # Allow direct access to only specific subdirectories in /media + location /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 ${MEDIA_ROOT}/attachments/; add_header Access-Control-Allow-Origin '*'; } @@ -145,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_DIRECTORY_SERVE_PATH}; + alias ${MUSIC_DIRECTORY_SERVE_PATH}/; add_header Access-Control-Allow-Origin '*'; } diff --git a/docker/nginx/conf.dev b/docker/nginx/conf.dev index 35c9e8288..9a74f36c5 100644 --- a/docker/nginx/conf.dev +++ b/docker/nginx/conf.dev @@ -112,8 +112,15 @@ http { proxy_pass http://funkwhale-api; } - location /media/ { - alias /protected/media/; + # Allow direct access to only specific subdirectories in /media + location /media/__sized__/ { + alias /protected/media/__sized__/; + add_header Access-Control-Allow-Origin '*'; + } + + # Allow direct access to only specific subdirectories in /media + location /media/attachments/ { + alias /protected/media/attachments/; add_header Access-Control-Allow-Origin '*'; } diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html index d5a1d35f3..32dbf6807 100644 --- a/docs/_templates/layout.html +++ b/docs/_templates/layout.html @@ -2,24 +2,28 @@ {% block document %} - {% if language is not none %} -
- -

Something wrong with the translation?

-

Help us to improve it on our translation platform

-
- {% endif %} +{% if language is not none %} +
+ +

Something wrong with the translation?

+

+ Help us to improve it on our + translation platform +

+
+{% endif %} - {% if current_version and current_version.name == "develop" %} -
-

Warning

-

This documentation only applies for the development version of - Funkwhale! Visit the docs for the latest - release.

-
- {% endif %} +{% if current_version and current_version.name == "develop" %} +
+

Warning

+

+ This documentation only applies for the development version of Funkwhale! + Visit the docs for the latest release. +

+
+{% endif %} {{ super() }} diff --git a/docs/administrator_documentation/configuration_docs/change_url.md b/docs/administrator/configuration/change-url.md similarity index 97% rename from docs/administrator_documentation/configuration_docs/change_url.md rename to docs/administrator/configuration/change-url.md index 719aa5f3a..b22e13d17 100644 --- a/docs/administrator_documentation/configuration_docs/change_url.md +++ b/docs/administrator/configuration/change-url.md @@ -13,7 +13,7 @@ Your instance URL is your pod's unique identifier in the {term}`fediverse`. If y To clean the database, the `funkwhale-manage` command line interface contains a `fix_federation_ids` command. ```{warning} -Running `fix_federation_ids` with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade_docs/backup.md). +Running `fix_federation_ids` with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade/backup.md). ``` ## Update your instance URL diff --git a/docs/administrator_documentation/configuration_docs/env_file.md b/docs/administrator/configuration/env-file.md similarity index 98% rename from docs/administrator_documentation/configuration_docs/env_file.md rename to docs/administrator/configuration/env-file.md index 3b976d81e..0ac82af01 100644 --- a/docs/administrator_documentation/configuration_docs/env_file.md +++ b/docs/administrator/configuration/env-file.md @@ -83,7 +83,7 @@ value: false Whether to enable LDAP authentication. -See {doc}`/administrator_documentation/configuration_docs/ldap` for more information. +See {doc}`/administrator/configuration/ldap` for more information. ``` diff --git a/docs/administrator_documentation/configuration_docs/frontend.md b/docs/administrator/configuration/frontend.md similarity index 100% rename from docs/administrator_documentation/configuration_docs/frontend.md rename to docs/administrator/configuration/frontend.md diff --git a/docs/administrator_documentation/configuration_docs/index.md b/docs/administrator/configuration/index.md similarity index 79% rename from docs/administrator_documentation/configuration_docs/index.md rename to docs/administrator/configuration/index.md index b593227b0..f194f6e65 100644 --- a/docs/administrator_documentation/configuration_docs/index.md +++ b/docs/administrator/configuration/index.md @@ -8,13 +8,13 @@ caption: Configuration options maxdepth: 1 --- -Environment file -Instance settings -object_storage +Environment file +Instance settings +object-storage Frontend customization optimize ldap -change_url +change-url mrf rate-limiting diff --git a/docs/administrator_documentation/configuration_docs/instance_settings.md b/docs/administrator/configuration/instance-settings.md similarity index 97% rename from docs/administrator_documentation/configuration_docs/instance_settings.md rename to docs/administrator/configuration/instance-settings.md index be32287c9..51ef4dbda 100644 --- a/docs/administrator_documentation/configuration_docs/instance_settings.md +++ b/docs/administrator/configuration/instance-settings.md @@ -84,7 +84,7 @@ API Requires authentication Controls whether {term}`unauthenticated users ` can access content on your pod. If __enabled__, users need to have an account on your pod to access content. If __disabled__, users without an account can listen to content stored in public libraries. ```{seealso} - {doc}`../../moderator_documentation/content/library_visibility`. + {doc}`../../moderator/content/library`. ``` Default permissions @@ -94,7 +94,7 @@ Upload quota The default upload quota for users in MB. You can override this on a per-user basis. ```{seealso} - {doc}`../../moderator_documentation/reports/handle_users` + {doc}`../../moderator/reports/users` ``` ```` diff --git a/docs/administrator_documentation/configuration_docs/ldap.md b/docs/administrator/configuration/ldap.md similarity index 100% rename from docs/administrator_documentation/configuration_docs/ldap.md rename to docs/administrator/configuration/ldap.md diff --git a/docs/administrator_documentation/configuration_docs/mrf.md b/docs/administrator/configuration/mrf.md similarity index 98% rename from docs/administrator_documentation/configuration_docs/mrf.md rename to docs/administrator/configuration/mrf.md index 5564dba92..6de2e76e8 100644 --- a/docs/administrator_documentation/configuration_docs/mrf.md +++ b/docs/administrator/configuration/mrf.md @@ -1,6 +1,6 @@ # Message Rewrite Facility (MRF) -Funkwhale includes a feature that mimics [Pleroma’s Message Rewrite Facility (MRF)](https://docs-develop.pleroma.social/backend/configuration/mrf/). The MRF enables instance admins to create custom moderation rules. You can use these rules to complement Funkwhale's [built-in moderation tools](../../moderator_documentation/index.md). +Funkwhale includes a feature that mimics [Pleroma’s Message Rewrite Facility (MRF)](https://docs-develop.pleroma.social/backend/configuration/mrf/). The MRF enables instance admins to create custom moderation rules. You can use these rules to complement Funkwhale's [built-in moderation tools](../../moderator/index.md). ## Architecture diff --git a/docs/administrator_documentation/configuration_docs/object_storage.md b/docs/administrator/configuration/object-storage.md similarity index 100% rename from docs/administrator_documentation/configuration_docs/object_storage.md rename to docs/administrator/configuration/object-storage.md diff --git a/docs/administrator_documentation/configuration_docs/optimize.md b/docs/administrator/configuration/optimize.md similarity index 100% rename from docs/administrator_documentation/configuration_docs/optimize.md rename to docs/administrator/configuration/optimize.md diff --git a/docs/administrator_documentation/configuration_docs/rate-limiting.md b/docs/administrator/configuration/rate-limiting.md similarity index 97% rename from docs/administrator_documentation/configuration_docs/rate-limiting.md rename to docs/administrator/configuration/rate-limiting.md index 1fa3c928a..f45ae562e 100644 --- a/docs/administrator_documentation/configuration_docs/rate-limiting.md +++ b/docs/administrator/configuration/rate-limiting.md @@ -1,6 +1,6 @@ # Rate limit API endpoints -This article contains a summary of the endpoints you can control using rate-limiting. You can change the rate limits for these endpoints using the [`THROTTLING_RATES`](env_file.md#api-configuration) environment variable. +This article contains a summary of the endpoints you can control using rate-limiting. You can change the rate limits for these endpoints using the [`THROTTLING_RATES`](env-file.md#api-configuration) environment variable. ## Standard endpoints diff --git a/docs/administrator_documentation/django/delete_content.md b/docs/administrator/django/delete-content.md similarity index 96% rename from docs/administrator_documentation/django/delete_content.md rename to docs/administrator/django/delete-content.md index e2e06097b..80436540f 100644 --- a/docs/administrator_documentation/django/delete_content.md +++ b/docs/administrator/django/delete-content.md @@ -1,7 +1,7 @@ # Delete content in the Django dashboard ```{note} -Deleting content using the Django dashboard isn't recommended. Use an object's [moderation page](../../moderator_documentation/content/delete_content.md) where possible. +Deleting content using the Django dashboard isn't recommended. Use an object's [moderation page](../../moderator/content/delete.md) where possible. ``` You can delete content from your pod in the Django dashboard. The dashboard gives you access to all data associated with the content. diff --git a/docs/administrator_documentation/django/index.md b/docs/administrator/django/index.md similarity index 97% rename from docs/administrator_documentation/django/index.md rename to docs/administrator/django/index.md index c2e56d900..522d9a1df 100644 --- a/docs/administrator_documentation/django/index.md +++ b/docs/administrator/django/index.md @@ -13,6 +13,6 @@ caption: Administrative tasks maxdepth: 1 --- -delete_content +delete-content ``` diff --git a/docs/administrator_documentation/import_docs/index.md b/docs/administrator/import.md similarity index 94% rename from docs/administrator_documentation/import_docs/index.md rename to docs/administrator/import.md index a1b8bf02d..abb1a6250 100644 --- a/docs/administrator_documentation/import_docs/index.md +++ b/docs/administrator/import.md @@ -1,6 +1,6 @@ # Import music from your server -You can import music files you have saved on your server. You need to make sure your files have the [required ID3 tags](../../user_documentation/libraries/tag_music.md). We recommend using [Musicbrainz Picard](https://picard.musicbrainz.org/) for tagging. +You can import music files you have saved on your server. You need to make sure your files have the [required ID3 tags](../user/libraries/content/tag.md). We recommend using [Musicbrainz Picard](https://picard.musicbrainz.org/) for tagging. Funkwhale supports the following import methods: @@ -60,7 +60,7 @@ This downloads a set compressed albums to your `data/music` directory and unzips ## Find your library ID -You need to create a library before you can import music. Follow the instructions in [Create a library](../../user_documentation/libraries/create_library.md) to get started. +You need to create a library before you can import music. Follow the instructions in [Create a library](../user/libraries/create.md) to get started. Once you've created your library, you can find its ID by following these steps: @@ -164,7 +164,7 @@ To use the in-place import method, follow these steps: cd /srv/funkwhale ``` -2. Add your storage location to your `.env` file if you don't want to link it to the Funkwhale store. See the [in-place import configuration variables](../configuration_docs/env_file.md#in-place-import-configuration) for more information. +2. Add your storage location to your `.env` file if you don't want to link it to the Funkwhale store. See the [in-place import configuration variables](configuration/env-file.md#in-place-import-configuration) for more information. 3. Export your library ID to reference it later. In this example, the library ID is "769a2bc3". Replace this with your library ID. ```{code-block} sh @@ -184,7 +184,7 @@ Funkwhale imports the music in your storage directory into the specified library :::{tab-item} Docker :sync: docker -1. Add your storage location to your `.env` file if you don't want to bind it to the Funkwhale store. See the [in-place import configuration variables](../configuration_docs/env_file.md#in-place-import-configuration) for more information. +1. Add your storage location to your `.env` file if you don't want to bind it to the Funkwhale store. See the [in-place import configuration variables](configuration/env-file.md#in-place-import-configuration) for more information. 2. Run your import command against your music storage directory: ```{code-block} sh diff --git a/docs/administrator_documentation/index.md b/docs/administrator/index.md similarity index 52% rename from docs/administrator_documentation/index.md rename to docs/administrator/index.md index 5734f950e..f04268a57 100644 --- a/docs/administrator_documentation/index.md +++ b/docs/administrator/index.md @@ -8,16 +8,16 @@ Follow the guides in this section to set up and administrate your pod. ## Install Funkwhale on your server -Funkwhale is self-hosted, meaning you run it on your own server. To set up your own Funkwhale pod, check out [our installation guides](installation_docs/index.md). Choose the installation method that works for you! +Funkwhale is self-hosted, meaning you run it on your own server. To set up your own Funkwhale pod, check out [our installation guides](installation/index.md). Choose the installation method that works for you! ## Configure your Funkwhale pod -Once you've installed Funkwhale, you can use [the guides in this section](configuration_docs/index.md) to configure it. +Once you've installed Funkwhale, you can use [the guides in this section](configuration/index.md) to configure it. ## Upgrade your Funkwhale pod -Funkwhale releases new updates regularly. To keep up-to-date with these changes, check out our [upgrade guides](upgrade_docs/index.md). If you're moving from our deprecated mono-container Docker setup, check out our [migration guide](migration_guide/index.md). +Funkwhale releases new updates regularly. To keep up-to-date with these changes, check out our [upgrade guides](upgrade/index.md). If you're moving from our deprecated mono-container Docker setup, check out our [migration guide](migration.md). ## Manage your Funkwhale pod -Funkwhale provides tools for managing content and users on your Funkwhale pod. In addition to the [frontend moderation tools](../moderator_documentation/index.md), pod admins can use some extra tools for more powerful administration. Check out our [guide to the Django dashboard](django/index.md) and our [management script](manage_script/index.md) to get started. +Funkwhale provides tools for managing content and users on your Funkwhale pod. In addition to the [frontend moderation tools](../moderator/index.md), pod admins can use some extra tools for more powerful administration. Check out our [guide to the Django dashboard](django/index.md) and our [management script](manage-script/index.md) to get started. diff --git a/docs/administrator_documentation/installation_docs/debian.md b/docs/administrator/installation/debian.md similarity index 100% rename from docs/administrator_documentation/installation_docs/debian.md rename to docs/administrator/installation/debian.md diff --git a/docs/administrator_documentation/installation_docs/docker.md b/docs/administrator/installation/docker.md similarity index 100% rename from docs/administrator_documentation/installation_docs/docker.md rename to docs/administrator/installation/docker.md diff --git a/docs/administrator_documentation/installation_docs/index.md b/docs/administrator/installation/index.md similarity index 95% rename from docs/administrator_documentation/installation_docs/index.md rename to docs/administrator/installation/index.md index ff0706675..6358e6cf7 100644 --- a/docs/administrator_documentation/installation_docs/index.md +++ b/docs/administrator/installation/index.md @@ -13,10 +13,10 @@ caption: Choose your installation method maxdepth: 1 --- -quick_install +quick-install docker debian -third_party +third-party ``` diff --git a/docs/administrator_documentation/installation_docs/migrate.md b/docs/administrator/installation/migrate.md similarity index 97% rename from docs/administrator_documentation/installation_docs/migrate.md rename to docs/administrator/installation/migrate.md index f3d343c3b..28860368e 100644 --- a/docs/administrator_documentation/installation_docs/migrate.md +++ b/docs/administrator/installation/migrate.md @@ -14,7 +14,7 @@ Destination server ``` ```{note} -Make sure you [back up your data](../upgrade_docs/backup.md) before proceeding. This ensures you don't lose anything during the migration. +Make sure you [back up your data](../upgrade/backup.md) before proceeding. This ensures you don't lose anything during the migration. ``` ```{contents} diff --git a/docs/administrator_documentation/installation_docs/quick_install.md b/docs/administrator/installation/quick-install.md similarity index 100% rename from docs/administrator_documentation/installation_docs/quick_install.md rename to docs/administrator/installation/quick-install.md diff --git a/docs/administrator_documentation/installation_docs/third_party.md b/docs/administrator/installation/third-party.md similarity index 100% rename from docs/administrator_documentation/installation_docs/third_party.md rename to docs/administrator/installation/third-party.md diff --git a/docs/administrator_documentation/manage_script/create_library.md b/docs/administrator/manage-script/create-library.md similarity index 96% rename from docs/administrator_documentation/manage_script/create_library.md rename to docs/administrator/manage-script/create-library.md index ccabf49b9..06b364a34 100644 --- a/docs/administrator_documentation/manage_script/create_library.md +++ b/docs/administrator/manage-script/create-library.md @@ -19,7 +19,7 @@ Use the `create_library` command to create new libraries for a given user. * - `--privacy-level` - Enum (String) - - The [privacy level](../../user_documentation/libraries/create_library.md) of the library + - The [privacy level](../../user/libraries/create.md) of the library - `"me"` (default) - `"instance"` - `"everyone"` diff --git a/docs/administrator_documentation/manage_script/database.md b/docs/administrator/manage-script/database.md similarity index 93% rename from docs/administrator_documentation/manage_script/database.md rename to docs/administrator/manage-script/database.md index 531271d82..1e938f5ae 100644 --- a/docs/administrator_documentation/manage_script/database.md +++ b/docs/administrator/manage-script/database.md @@ -5,7 +5,7 @@ Funkwhale keeps references to files imported using the in-place method. If you m Use the `check_inplace_files` command to check the database for invalid references. This command loops through all in-place imports and checks if the file is accessible. If the file isn't accessible, the command deletes the database object. ```{warning} -Running `check_inplace_files` with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade_docs/backup.md). +Running `check_inplace_files` with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade/backup.md). ``` To ensure you don't remove data by accident, this command runs in dry run mode by default. In dry run mode, the command lists the items it will delete. Run the command with the `--no-dry-run` flag to perform the pruning action. diff --git a/docs/administrator_documentation/manage_script/fix_uploads.md b/docs/administrator/manage-script/fix-uploads.md similarity index 100% rename from docs/administrator_documentation/manage_script/fix_uploads.md rename to docs/administrator/manage-script/fix-uploads.md diff --git a/docs/administrator_documentation/manage_script/index.md b/docs/administrator/manage-script/index.md similarity index 94% rename from docs/administrator_documentation/manage_script/index.md rename to docs/administrator/manage-script/index.md index 9f8a7c2c7..caa299ed2 100644 --- a/docs/administrator_documentation/manage_script/index.md +++ b/docs/administrator/manage-script/index.md @@ -8,12 +8,12 @@ caption: Administration tasks maxdepth: 1 --- -create_library +create-library Manage users Prune library Clean database Add album and artist tags thumbnails -fix_uploads +fix-uploads ``` diff --git a/docs/administrator_documentation/manage_script/library.md b/docs/administrator/manage-script/library.md similarity index 97% rename from docs/administrator_documentation/manage_script/library.md rename to docs/administrator/manage-script/library.md index 44ff9fbd2..52f701e1c 100644 --- a/docs/administrator_documentation/manage_script/library.md +++ b/docs/administrator/manage-script/library.md @@ -7,7 +7,7 @@ Sometimes you may want to clear out dangling metadata. For example, if you impor To help with this, the `funkwhale-manage` command line interface includes commands to prune dangling metadata from your database. All prune commands are available under the `funkwhale-manage prune_library` namespace. To ensure you don't remove data by accident, all commands run in dry run mode by default. Run commands with the `--no-dry-run` flag to perform the pruning action. ```{warning} -Running `prune_library` commands with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade_docs/backup.md). +Running `prune_library` commands with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade/backup.md). ``` ## Commands diff --git a/docs/administrator_documentation/manage_script/tags.md b/docs/administrator/manage-script/tags.md similarity index 100% rename from docs/administrator_documentation/manage_script/tags.md rename to docs/administrator/manage-script/tags.md diff --git a/docs/administrator_documentation/manage_script/thumbnails.md b/docs/administrator/manage-script/thumbnails.md similarity index 100% rename from docs/administrator_documentation/manage_script/thumbnails.md rename to docs/administrator/manage-script/thumbnails.md diff --git a/docs/administrator_documentation/manage_script/users.md b/docs/administrator/manage-script/users.md similarity index 100% rename from docs/administrator_documentation/manage_script/users.md rename to docs/administrator/manage-script/users.md diff --git a/docs/administrator_documentation/migration_guide/index.md b/docs/administrator/migration.md similarity index 100% rename from docs/administrator_documentation/migration_guide/index.md rename to docs/administrator/migration.md diff --git a/docs/administrator_documentation/troubleshooting/backend.md b/docs/administrator/troubleshooting/backend.md similarity index 95% rename from docs/administrator_documentation/troubleshooting/backend.md rename to docs/administrator/troubleshooting/backend.md index 130eff622..9a065d43c 100644 --- a/docs/administrator_documentation/troubleshooting/backend.md +++ b/docs/administrator/troubleshooting/backend.md @@ -106,7 +106,7 @@ If you're having issues importing files, try the following: ::: - Make sure your files play in another media player. -- Make sure your files are [tagged correctly](../../user_documentation/libraries/tag_music.md). +- Make sure your files are [tagged correctly](../../user/libraries/content/tag.md). - Check the Celery logs for errors during the import. ### Federation issues @@ -197,4 +197,4 @@ To disable memory tracing: ## Get help -If you can't solve the issue yourself, ask the community for help. Check out the [get help](get_help.md) guide for information about where to ask your question and what details to provide. +If you can't solve the issue yourself, ask the community for help. Check out the [get help](help.md) guide for information about where to ask your question and what details to provide. diff --git a/docs/administrator_documentation/troubleshooting/frontend.md b/docs/administrator/troubleshooting/frontend.md similarity index 94% rename from docs/administrator_documentation/troubleshooting/frontend.md rename to docs/administrator/troubleshooting/frontend.md index a969e08a8..6cfd923fa 100644 --- a/docs/administrator_documentation/troubleshooting/frontend.md +++ b/docs/administrator/troubleshooting/frontend.md @@ -57,4 +57,4 @@ If you are receiving `4XX` or `5XX` responses, this means the API isn't serving ## Get help -If you can't solve the issue yourself, ask the community for help. Check out the [get help](get_help.md) guide for information about where to ask your question and what details to provide. +If you can't solve the issue yourself, ask the community for help. Check out the [get help](help.md) guide for information about where to ask your question and what details to provide. diff --git a/docs/administrator_documentation/troubleshooting/get_help.md b/docs/administrator/troubleshooting/help.md similarity index 100% rename from docs/administrator_documentation/troubleshooting/get_help.md rename to docs/administrator/troubleshooting/help.md diff --git a/docs/administrator_documentation/troubleshooting/index.md b/docs/administrator/troubleshooting/index.md similarity index 98% rename from docs/administrator_documentation/troubleshooting/index.md rename to docs/administrator/troubleshooting/index.md index 00a8f17eb..eb962763d 100644 --- a/docs/administrator_documentation/troubleshooting/index.md +++ b/docs/administrator/troubleshooting/index.md @@ -18,6 +18,6 @@ maxdepth: 1 frontend backend -get_help +help ``` diff --git a/docs/administrator_documentation/uninstall_docs/debian.md b/docs/administrator/uninstall/debian.md similarity index 95% rename from docs/administrator_documentation/uninstall_docs/debian.md rename to docs/administrator/uninstall/debian.md index 1f7c1042e..2500cecdf 100644 --- a/docs/administrator_documentation/uninstall_docs/debian.md +++ b/docs/administrator/uninstall/debian.md @@ -3,7 +3,7 @@ To uninstall Funkwhale from your Debian server, follow the instructions in this guide. ```{warning} -Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade_docs/backup.md). +Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade/backup.md). ``` ```{contents} @@ -92,7 +92,7 @@ To stop serving Funkwhale from your web server, you need to remove your reverse ## Remove the Funkwhale database ```{warning} -This action is __irreversible__. Make sure you have [backed up your data](../upgrade_docs/backup.md) before proceeding. +This action is __irreversible__. Make sure you have [backed up your data](../upgrade/backup.md) before proceeding. ``` Once you have stopped the Funkwhale services, you can remove the Funkwhale database. @@ -118,7 +118,7 @@ Once you have stopped the Funkwhale services, you can remove the Funkwhale datab ## Delete the Funkwhale account ```{warning} -This action deletes the `/srv/funkwhale/` directory. Make sure you have [backed up any data](../upgrade_docs/backup.md) you want to keep. +This action deletes the `/srv/funkwhale/` directory. Make sure you have [backed up any data](../upgrade/backup.md) you want to keep. ``` Once you have removed the database, you can delete the `funkwhale` user and all associated data. diff --git a/docs/administrator_documentation/uninstall_docs/docker.md b/docs/administrator/uninstall/docker.md similarity index 95% rename from docs/administrator_documentation/uninstall_docs/docker.md rename to docs/administrator/uninstall/docker.md index 7453b7899..dd63141e9 100644 --- a/docs/administrator_documentation/uninstall_docs/docker.md +++ b/docs/administrator/uninstall/docker.md @@ -3,7 +3,7 @@ To uninstall a Docker-based Funkwhale installation from your server, follow the instructions in this guide. ```{warning} -Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade_docs/backup.md). +Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade/backup.md). ``` ```{contents} @@ -74,7 +74,7 @@ To stop serving Funkwhale from your web server, you need to remove your reverse ## Remove the containers and their volumes ```{warning} -This action is __irreversible__. Make sure you have [backed up your data](../upgrade_docs/backup.md) before proceeding. +This action is __irreversible__. Make sure you have [backed up your data](../upgrade/backup.md) before proceeding. ``` Once you have stopped the containers, you can delete all containers and associated volumes. diff --git a/docs/administrator_documentation/uninstall_docs/index.md b/docs/administrator/uninstall/index.md similarity index 97% rename from docs/administrator_documentation/uninstall_docs/index.md rename to docs/administrator/uninstall/index.md index a4c01251d..c9f4ce8a9 100644 --- a/docs/administrator_documentation/uninstall_docs/index.md +++ b/docs/administrator/uninstall/index.md @@ -12,7 +12,7 @@ caption: Choose your setup maxdepth: 1 --- -quick_install +quick-install debian docker diff --git a/docs/administrator_documentation/uninstall_docs/quick_install.md b/docs/administrator/uninstall/quick-install.md similarity index 95% rename from docs/administrator_documentation/uninstall_docs/quick_install.md rename to docs/administrator/uninstall/quick-install.md index d11ad91b8..8c5a455c0 100644 --- a/docs/administrator_documentation/uninstall_docs/quick_install.md +++ b/docs/administrator/uninstall/quick-install.md @@ -3,7 +3,7 @@ The Funkwhale quick install script doesn't currently offer an uninstall command. This is because you may be using its dependencies for other software. To uninstall a quick install Funkwhale installation, follow the instructions in this guide. ```{warning} -Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade_docs/backup.md). +Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade/backup.md). ``` ```{contents} @@ -92,7 +92,7 @@ To stop serving Funkwhale from your web server, you need to remove your reverse ## Remove the Funkwhale database ```{warning} -This action is __irreversible__. Make sure you have [backed up your data](../upgrade_docs/backup.md) before proceeding. +This action is __irreversible__. Make sure you have [backed up your data](../upgrade/backup.md) before proceeding. ``` Once you have stopped the Funkwhale services, you can remove the Funkwhale database. @@ -118,7 +118,7 @@ Once you have stopped the Funkwhale services, you can remove the Funkwhale datab ## Delete the Funkwhale account ```{warning} -This action deletes the `/srv/funkwhale/` directory. Make sure you have [backed up any data](../upgrade_docs/backup.md) you want to keep. +This action deletes the `/srv/funkwhale/` directory. Make sure you have [backed up any data](../upgrade/backup.md) you want to keep. ``` Once you have removed the database, you can delete the `funkwhale` user and all associated data. diff --git a/docs/administrator_documentation/upgrade_docs/backup.md b/docs/administrator/upgrade/backup.md similarity index 100% rename from docs/administrator_documentation/upgrade_docs/backup.md rename to docs/administrator/upgrade/backup.md diff --git a/docs/administrator_documentation/upgrade_docs/debian.md b/docs/administrator/upgrade/debian.md similarity index 81% rename from docs/administrator_documentation/upgrade_docs/debian.md rename to docs/administrator/upgrade/debian.md index 40d6b40d0..b7e14c745 100644 --- a/docs/administrator_documentation/upgrade_docs/debian.md +++ b/docs/administrator/upgrade/debian.md @@ -1,6 +1,6 @@ # Upgrade your Debian Funkwhale installation -If you installed Funkwhale following the [Debian guide](../installation_docs/debian.md), follow these steps to upgrade. +If you installed Funkwhale following the [Debian guide](../installation/debian.md), follow these steps to upgrade. ## Cleanup old funkwhale files @@ -30,9 +30,9 @@ If you installed Funkwhale following the [Debian guide](../installation_docs/deb export FUNKWHALE_VERSION={sub-ref}`version` ``` -2. Follow the [Download Funkwhale](../installation_docs/debian.md#3-download-funkwhale) instructions in the installation guide. +2. Follow the [Download Funkwhale](../installation/debian.md#3-download-funkwhale) instructions in the installation guide. -3. Follow the [Install the Funkwhale API](../installation_docs/debian.md#4-install-the-funkwhale-api) instructions in the installation guide. +3. Follow the [Install the Funkwhale API](../installation/debian.md#4-install-the-funkwhale-api) instructions in the installation guide. ## Update your Funkwhale instance diff --git a/docs/administrator_documentation/upgrade_docs/docker.md b/docs/administrator/upgrade/docker.md similarity index 98% rename from docs/administrator_documentation/upgrade_docs/docker.md rename to docs/administrator/upgrade/docker.md index c15a2bc8b..aa6954982 100644 --- a/docs/administrator_documentation/upgrade_docs/docker.md +++ b/docs/administrator/upgrade/docker.md @@ -1,6 +1,6 @@ # Upgrade your Docker Funkwhale installation -If you installed Funkwhale following the [Docker guide](../installation_docs/docker.md), follow these steps to upgrade. +If you installed Funkwhale following the [Docker guide](../installation/docker.md), follow these steps to upgrade. ## Upgrade Funkwhale diff --git a/docs/administrator_documentation/upgrade_docs/index.md b/docs/administrator/upgrade/index.md similarity index 93% rename from docs/administrator_documentation/upgrade_docs/index.md rename to docs/administrator/upgrade/index.md index addec0e21..a36439dd1 100644 --- a/docs/administrator_documentation/upgrade_docs/index.md +++ b/docs/administrator/upgrade/index.md @@ -24,7 +24,7 @@ caption: Choose your installation method maxdepth: 1 --- -Quick install script +Quick install script Docker Debian diff --git a/docs/administrator_documentation/upgrade_docs/quick_install.md b/docs/administrator/upgrade/quick-install.md similarity index 66% rename from docs/administrator_documentation/upgrade_docs/quick_install.md rename to docs/administrator/upgrade/quick-install.md index f6299561a..aa3cded2f 100644 --- a/docs/administrator_documentation/upgrade_docs/quick_install.md +++ b/docs/administrator/upgrade/quick-install.md @@ -1,6 +1,6 @@ # Upgrade using the quick install script -If you installed Funkwhale using the [quick install script](../installation_docs/quick_install.md), upgrading your instance is as simple as running the following command on your server: +If you installed Funkwhale using the [quick install script](../installation/quick-install.md), upgrading your instance is as simple as running the following command on your server: ```bash sudo sh -c "$(curl -sSL https://get.funkwhale.audio/upgrade.sh)". diff --git a/docs/conf.py b/docs/conf.py index 095e5042d..59ea6a617 100755 --- a/docs/conf.py +++ b/docs/conf.py @@ -99,7 +99,7 @@ release = version # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. @@ -247,8 +247,8 @@ def setup(app): app.connect("build-finished", copy_legacy_redirects) -smv_tag_whitelist = None -smv_branch_whitelist = r"(stable|develop)$" +smv_tag_whitelist = r"^$" +smv_branch_whitelist = r"^(stable|develop)$" # Internationalization settings locale_dirs = ["locales/"] diff --git a/docs/contributor_documentation/documentation.md b/docs/contributor/documentation.md similarity index 98% rename from docs/contributor_documentation/documentation.md rename to docs/contributor/documentation.md index 7589d786e..16c4b3f22 100644 --- a/docs/contributor_documentation/documentation.md +++ b/docs/contributor/documentation.md @@ -89,7 +89,7 @@ Here's an example of the typical workflow for creating documentation: 3. Make your changes and verify them by running the [Docker container](#local-setup) 4. Add [redirects](#redirects) if required -5. Add a [changelog fragment](../developer_documentation/workflows/changelog.md) +5. Add a [changelog fragment](../developer/workflows/changelog.md) 6. Add your changed files to a commit ```{code-block} sh diff --git a/docs/contributor_documentation/index.md b/docs/contributor/index.md similarity index 92% rename from docs/contributor_documentation/index.md rename to docs/contributor/index.md index 58f51eacc..6ac84dae8 100644 --- a/docs/contributor_documentation/index.md +++ b/docs/contributor/index.md @@ -1,7 +1,7 @@ # Get started ```{note} -Are you a software developer? Check out our [developer documentation](../developer_documentation/index.md) to contribute to our codebase. +Are you a software developer? Check out our [developer documentation](../developer/index.md) to contribute to our codebase. ``` Funkwhale is a community-led software project, so we depend on our community donating their time and skills. Whether you're experienced in a specific field or just starting out, we welcome any contributions and will support you with any task you take on. diff --git a/docs/contributor_documentation/translation.md b/docs/contributor/translation.md similarity index 100% rename from docs/contributor_documentation/translation.md rename to docs/contributor/translation.md diff --git a/docs/developer_documentation/api/authentication.md b/docs/developer/api/authentication.md similarity index 100% rename from docs/developer_documentation/api/authentication.md rename to docs/developer/api/authentication.md diff --git a/docs/developer_documentation/api/index.md b/docs/developer/api/index.md similarity index 98% rename from docs/developer_documentation/api/index.md rename to docs/developer/api/index.md index e5e9ef9b2..63bfef00b 100644 --- a/docs/developer_documentation/api/index.md +++ b/docs/developer/api/index.md @@ -12,7 +12,7 @@ maxdepth: 1 API explorer authentication -rate_limit +rate-limit subsonic ``` diff --git a/docs/developer_documentation/api/rate_limit.md b/docs/developer/api/rate-limit.md similarity index 100% rename from docs/developer_documentation/api/rate_limit.md rename to docs/developer/api/rate-limit.md diff --git a/docs/developer_documentation/api/subsonic.md b/docs/developer/api/subsonic.md similarity index 100% rename from docs/developer_documentation/api/subsonic.md rename to docs/developer/api/subsonic.md diff --git a/docs/developer_documentation/architecture.md b/docs/developer/architecture.md similarity index 100% rename from docs/developer_documentation/architecture.md rename to docs/developer/architecture.md diff --git a/docs/developer_documentation/contribute/api.md b/docs/developer/contribute/api.md similarity index 100% rename from docs/developer_documentation/contribute/api.md rename to docs/developer/contribute/api.md diff --git a/docs/developer_documentation/contribute/copy.md b/docs/developer/contribute/copy.md similarity index 100% rename from docs/developer_documentation/contribute/copy.md rename to docs/developer/contribute/copy.md diff --git a/docs/developer_documentation/contribute/frontend.md b/docs/developer/contribute/frontend.md similarity index 100% rename from docs/developer_documentation/contribute/frontend.md rename to docs/developer/contribute/frontend.md diff --git a/docs/developer_documentation/contribute/index.md b/docs/developer/contribute/index.md similarity index 100% rename from docs/developer_documentation/contribute/index.md rename to docs/developer/contribute/index.md diff --git a/docs/developer_documentation/federation/index.md b/docs/developer/federation/index.md similarity index 100% rename from docs/developer_documentation/federation/index.md rename to docs/developer/federation/index.md diff --git a/docs/developer_documentation/index.md b/docs/developer/index.md similarity index 100% rename from docs/developer_documentation/index.md rename to docs/developer/index.md diff --git a/docs/developer_documentation/plugins/create.md b/docs/developer/plugins/create.md similarity index 100% rename from docs/developer_documentation/plugins/create.md rename to docs/developer/plugins/create.md diff --git a/docs/developer_documentation/plugins/index.md b/docs/developer/plugins/index.md similarity index 100% rename from docs/developer_documentation/plugins/index.md rename to docs/developer/plugins/index.md diff --git a/docs/developer_documentation/plugins/install.md b/docs/developer/plugins/install.md similarity index 100% rename from docs/developer_documentation/plugins/install.md rename to docs/developer/plugins/install.md diff --git a/docs/developer_documentation/setup/docker.md b/docs/developer/setup/docker.md similarity index 100% rename from docs/developer_documentation/setup/docker.md rename to docs/developer/setup/docker.md diff --git a/docs/_static/images/select-gitpod-in-gitlab.png b/docs/developer/setup/gitpod-select-gitpod-in-gitlab.png similarity index 100% rename from docs/_static/images/select-gitpod-in-gitlab.png rename to docs/developer/setup/gitpod-select-gitpod-in-gitlab.png diff --git a/docs/developer_documentation/setup/gitpod.md b/docs/developer/setup/gitpod.md similarity index 97% rename from docs/developer_documentation/setup/gitpod.md rename to docs/developer/setup/gitpod.md index 5fa423840..37fb0b339 100644 --- a/docs/developer_documentation/setup/gitpod.md +++ b/docs/developer/setup/gitpod.md @@ -12,7 +12,7 @@ You can open Gitpod directly by clicking the link below. This checks out the `de If you want to work on a particular branch, commit, or merge request, you can do this straight from the GitLab interface. Select the arrow icon on the {guilabel}`Web IDE` button and select {guilabel}`Gitpod` to open Gitpod with the currently selected branch checked out. -![Select Gitpod as the default web IDE](/_static/images/select-gitpod-in-gitlab.png) +![Select Gitpod as the default web IDE](./gitpod-select-gitpod-in-gitlab.png) When you start Gitpod, it creates the following using the selected branch: diff --git a/docs/developer_documentation/setup/index.md b/docs/developer/setup/index.md similarity index 100% rename from docs/developer_documentation/setup/index.md rename to docs/developer/setup/index.md diff --git a/docs/developer_documentation/setup/vite.md b/docs/developer/setup/vite.md similarity index 100% rename from docs/developer_documentation/setup/vite.md rename to docs/developer/setup/vite.md diff --git a/docs/developer_documentation/workflows/changelog.md b/docs/developer/workflows/changelog.md similarity index 100% rename from docs/developer_documentation/workflows/changelog.md rename to docs/developer/workflows/changelog.md diff --git a/docs/developer_documentation/workflows/git.md b/docs/developer/workflows/git.md similarity index 100% rename from docs/developer_documentation/workflows/git.md rename to docs/developer/workflows/git.md diff --git a/docs/developer_documentation/workflows/index.md b/docs/developer/workflows/index.md similarity index 100% rename from docs/developer_documentation/workflows/index.md rename to docs/developer/workflows/index.md diff --git a/docs/developer_documentation/workflows/pre-commit.md b/docs/developer/workflows/pre-commit.md similarity index 100% rename from docs/developer_documentation/workflows/pre-commit.md rename to docs/developer/workflows/pre-commit.md diff --git a/docs/developer_documentation/workflows/release.md b/docs/developer/workflows/release.md similarity index 100% rename from docs/developer_documentation/workflows/release.md rename to docs/developer/workflows/release.md diff --git a/docs/index.md b/docs/index.md index 76c7dfc02..99f2fc0eb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,18 +11,18 @@ hidden: true caption: User documentation --- -user_documentation/index -user_documentation/accounts/index -user_documentation/channels/index -user_documentation/libraries/index -user_documentation/queue/index -user_documentation/playlists/index -user_documentation/radios/index -user_documentation/favorites/index -user_documentation/reports/index -user_documentation/subsonic/index -user_documentation/plugins/index -user_documentation/info/cli +user/index +user/accounts/index +user/channels/index +user/libraries/index +user/queue/index +user/playlists/index +user/radios/index +user/favorites/index +user/reports/index +user/subsonic/index +user/plugins/index +user/info/cli ``` @@ -33,16 +33,16 @@ caption: Admin documentation hidden: true --- -administrator_documentation/index -administrator_documentation/installation_docs/index -administrator_documentation/configuration_docs/index -administrator_documentation/import_docs/index -administrator_documentation/upgrade_docs/index -administrator_documentation/migration_guide/index -administrator_documentation/django/index -administrator_documentation/manage_script/index -administrator_documentation/uninstall_docs/index -administrator_documentation/troubleshooting/index +administrator/index +administrator/installation/index +administrator/configuration/index +administrator/import +administrator/upgrade/index +administrator/migration +administrator/django/index +administrator/manage-script/index +administrator/uninstall/index +administrator/troubleshooting/index ``` @@ -53,13 +53,13 @@ caption: Moderator documentation hidden: true --- -moderator_documentation/index -moderator_documentation/reports/index -moderator_documentation/internal_users/index -moderator_documentation/content/index -moderator_documentation/domains/index -moderator_documentation/external_users/index -moderator_documentation/allow_listing/index +moderator/index +moderator/reports/index +moderator/internal-users/index +moderator/content/index +moderator/domains/index +moderator/external-users/index +moderator/allow-listing/index ``` @@ -70,14 +70,14 @@ caption: Developer documentation hidden: true --- -developer_documentation/index -developer_documentation/architecture -developer_documentation/setup/index -developer_documentation/contribute/index -developer_documentation/workflows/index -developer_documentation/api/index -developer_documentation/federation/index -developer_documentation/plugins/index +developer/index +developer/architecture +developer/setup/index +developer/contribute/index +developer/workflows/index +developer/api/index +developer/federation/index +developer/plugins/index ``` @@ -88,9 +88,9 @@ caption: Contributor documentation hidden: true --- -contributor_documentation/index -contributor_documentation/documentation -contributor_documentation/translation +contributor/index +contributor/documentation +contributor/translation ``` @@ -128,7 +128,7 @@ Looking to use Funkwhale for your content? Read through our guides to master the +++ -```{button-link} user_documentation/index.html +```{button-link} user/index.html :ref-type: myst :color: primary :outline: @@ -149,7 +149,7 @@ Want to host your own Funkwhale pod? Our admin documentation guides you through +++ -```{button-link} administrator_documentation/index.html +```{button-link} administrator/index.html :ref-type: ref :color: primary :outline: @@ -170,7 +170,7 @@ Keeping your users safe from harassment and spam or clearing illegal content? Ch +++ -```{button-link} moderator_documentation/index.html +```{button-link} moderator/index.html :ref-type: ref :color: primary :outline: @@ -191,7 +191,7 @@ Want to use Funkwhale's API or help with the project? Our developer docs give yo +++ -```{button-link} developer_documentation/index.html +```{button-link} developer/index.html :ref-type: ref :color: primary :outline: @@ -216,7 +216,7 @@ Want to help make Funkwhale even better? Check out these guides for some ideas. +++ -```{button-link} contributor_documentation/index.html +```{button-link} contributor/index.html :ref-type: ref :color: primary :outline: diff --git a/docs/locales/.gitignore b/docs/locales/.gitignore new file mode 100644 index 000000000..79e1d3e66 --- /dev/null +++ b/docs/locales/.gitignore @@ -0,0 +1,2 @@ +.* +_* diff --git a/docs/locales/en_GB/LC_MESSAGES/admin/backup.po b/docs/locales/en_GB/LC_MESSAGES/admin/backup.po deleted file mode 100644 index 21374b75b..000000000 --- a/docs/locales/en_GB/LC_MESSAGES/admin/backup.po +++ /dev/null @@ -1,99 +0,0 @@ -# SOME DESCRIPTIVE TITLE. -# Copyright (C) 2022, The Funkwhale Collective -# This file is distributed under the same license as the funkwhale package. -# FIRST AUTHOR , YEAR. -# -msgid "" -msgstr "" -"Project-Id-Version: funkwhale 1.2.3\n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2022-04-04 09:00+0200\n" -"PO-Revision-Date: 2022-07-03 21:05+0000\n" -"Last-Translator: Ciarán Ainsworth \n" -"Language-Team: English (United Kingdom) \n" -"Language: en_GB\n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Plural-Forms: nplurals=2; plural=n != 1;\n" -"X-Generator: Weblate 4.13\n" - -#: ../../admin/backup.rst:2 -msgid "Backup your Funkwhale instance" -msgstr "Backup your Funkwhale instance" - -#: ../../admin/backup.rst:6 -msgid "Before upgrading your instance, we strongly advise you to make at least a database backup. Ideally, you should make a full backup, including the database and the media files." -msgstr "" -"Before upgrading your instance, we strongly advise you to make at least a " -"database backup. Ideally, you should make a full backup, including the " -"database and the media files." - -#: ../../admin/backup.rst:10 -msgid "Docker setup" -msgstr "Docker setup" - -#: ../../admin/backup.rst:12 -msgid "If you've followed the setup instructions in :doc:`../installation/docker`, here is the backup path:" -msgstr "" -"If you've followed the setup instructions in :doc:`../installation/docker`, " -"here is the backup path:" - -#: ../../admin/backup.rst:15 -msgid "Multi-container installation" -msgstr "Multi-container installation" - -#: ../../admin/backup.rst:18 -#: ../../admin/backup.rst:51 -msgid "Backup the database" -msgstr "Backup the database" - -#: ../../admin/backup.rst:20 -msgid "On docker setups, you have to ``pg_dumpall`` in container ``funkwhale_postgres_1``:" -msgstr "" -"On docker setups, you have to ``pg_dumpall`` in container " -"``funkwhale_postgres_1``:" - -#: ../../admin/backup.rst:27 -#: ../../admin/backup.rst:60 -msgid "Backup the media files" -msgstr "Backup the media files" - -#: ../../admin/backup.rst:29 -msgid "To backup docker data volumes, as the volumes are bound mounted to the host, the ``rsync`` way would go like this:" -msgstr "" -"To backup docker data volumes, as the volumes are bound mounted to the host, " -"the ``rsync`` way would go like this:" - -#: ../../admin/backup.rst:38 -#: ../../admin/backup.rst:70 -msgid "Backup the configuration files" -msgstr "Backup the configuration files" - -#: ../../admin/backup.rst:40 -msgid "On docker setups, the configuration file is located at the root level:" -msgstr "On docker setups, the configuration file is located at the root level:" - -#: ../../admin/backup.rst:48 -msgid "Non-docker setup" -msgstr "Non-docker setup" - -#: ../../admin/backup.rst:53 -msgid "On non-docker setups, you have to ``pg_dump`` as user ``postgres``:" -msgstr "On non-docker setups, you have to ``pg_dump`` as user ``postgres``:" - -#: ../../admin/backup.rst:62 -msgid "A simple way to backup your media files is to use ``rsync``:" -msgstr "A simple way to backup your media files is to use ``rsync``:" - -#: ../../admin/backup.rst:77 -msgid "You may also want to backup your proxy configuration file." -msgstr "You may also want to backup your proxy configuration file." - -#: ../../admin/backup.rst:79 -msgid "For frequent backups, you may want to use deduplication and compression to keep the backup size low. In this case, a tool like ``borg`` will be more appropriate." -msgstr "" -"For frequent backups, you may want to use deduplication and compression to " -"keep the backup size low. In this case, a tool like ``borg`` will be more " -"appropriate." diff --git a/docs/locales/en_GB/LC_MESSAGES/admin/troubleshooting.po b/docs/locales/en_GB/LC_MESSAGES/admin/troubleshooting.po deleted file mode 100644 index 49234fcc3..000000000 --- a/docs/locales/en_GB/LC_MESSAGES/admin/troubleshooting.po +++ /dev/null @@ -1,383 +0,0 @@ -# SOME DESCRIPTIVE TITLE. -# Copyright (C) 2022, The Funkwhale Collective -# This file is distributed under the same license as the funkwhale package. -# FIRST AUTHOR , YEAR. -# -msgid "" -msgstr "" -"Project-Id-Version: funkwhale 1.2.3\n" -"Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2022-04-04 09:00+0200\n" -"PO-Revision-Date: 2022-07-03 21:06+0000\n" -"Last-Translator: Ciarán Ainsworth \n" -"Language-Team: English (United Kingdom) \n" -"Language: en_GB\n" -"MIME-Version: 1.0\n" -"Content-Type: text/plain; charset=UTF-8\n" -"Content-Transfer-Encoding: 8bit\n" -"Plural-Forms: nplurals=2; plural=n != 1;\n" -"X-Generator: Weblate 4.13\n" - -#: ../../admin/troubleshooting.rst:2 -msgid "Troubleshooting" -msgstr "Troubleshooting" - -#: ../../admin/troubleshooting.rst:4 -msgid "Various errors and issues can arise on your Funkwhale instance, caused by configuration errors, deployment/environment specific issues, or bugs in the software itself." -msgstr "" -"Various errors and issues can arise on your Funkwhale instance, caused by " -"configuration errors, deployment/environment specific issues, or bugs in the " -"software itself." - -#: ../../admin/troubleshooting.rst:7 -msgid "On this document, you'll find:" -msgstr "On this document, you'll find:" - -#: ../../admin/troubleshooting.rst:9 -msgid "Tools and commands you can use to better understand the issues" -msgstr "Tools and commands you can use to better understand the issues" - -#: ../../admin/troubleshooting.rst:10 -msgid "A list of common pitfalls and errors and how to solve them" -msgstr "A list of common pitfalls and errors and how to solve them" - -#: ../../admin/troubleshooting.rst:11 -msgid "A collection of links and advice to get help from the community and report new issues" -msgstr "" -"A collection of links and advice to get help from the community and report " -"new issues" - -#: ../../admin/troubleshooting.rst:14 -msgid "Diagnose problems" -msgstr "Diagnose problems" - -#: ../../admin/troubleshooting.rst:16 -msgid "Funkwhale is made of several components, each one being a potential cause for failure. Having an even basic overview of Funkwhale's technical architecture can help you understand what is going on. You can refer to :doc:`the technical architecture <../developers/architecture>` for that." -msgstr "" -"Funkwhale is made of several components, each one being a potential cause " -"for failure. Having an even basic overview of Funkwhale's technical " -"architecture can help you understand what is going on. You can refer to " -":doc:`the technical architecture <../developers/architecture>` for that." - -#: ../../admin/troubleshooting.rst:19 -msgid "Problems usually fall into one of those categories:" -msgstr "Problems usually fall into one of those categories:" - -#: ../../admin/troubleshooting.rst:21 -msgid "**Frontend**: Funkwhale's interface is not loading, not behaving as expected, music is not playing" -msgstr "" -"**Frontend**: Funkwhale's interface is not loading, not behaving as " -"expected, music is not playing" - -#: ../../admin/troubleshooting.rst:22 -msgid "**API**: the interface do not display any data or show errors" -msgstr "**API**: the interface do not display any data or show errors" - -#: ../../admin/troubleshooting.rst:23 -msgid "**Import**: uploaded/imported tracks are not imported correctly or at all" -msgstr "" -"**Import**: uploaded/imported tracks are not imported correctly or at all" - -#: ../../admin/troubleshooting.rst:24 -msgid "**Federation**: you cannot contact other Funkwhale servers, access their library, play federated tracks" -msgstr "" -"**Federation**: you cannot contact other Funkwhale servers, access their " -"library, play federated tracks" - -#: ../../admin/troubleshooting.rst:25 -msgid "**Everything else**" -msgstr "**Everything else**" - -#: ../../admin/troubleshooting.rst:27 -msgid "Each category comes with its own set of diagnose tools and/or commands we will detail below. We'll also give you simple steps for each type of problem. Please try those to see if it fix your issues. If none of those works, please report your issue on our issue tracker." -msgstr "" -"Each category comes with its own set of diagnose tools and/or commands we " -"will detail below. We'll also give you simple steps for each type of " -"problem. Please try those to see if it fix your issues. If none of those " -"works, please report your issue on our issue tracker." - -#: ../../admin/troubleshooting.rst:33 -msgid "To get detailed log messages, set the environment variable ``LOGLEVEL=debug``. If you are using the docker setup you can configure this in the ``.env`` file." -msgstr "" -"To get detailed log messages, set the environment variable ``LOGLEVEL=debug``" -". If you are using the docker setup you can configure this in the ``.env`` " -"file." - -#: ../../admin/troubleshooting.rst:37 -msgid "Backend issues" -msgstr "Backend issues" - -#: ../../admin/troubleshooting.rst:39 -#: ../../admin/troubleshooting.rst:98 -#: ../../admin/troubleshooting.rst:109 -msgid "Diagnostic tools:" -msgstr "Diagnostic tools:" - -#: ../../admin/troubleshooting.rst:42 -msgid "Reverse proxy logs:" -msgstr "Reverse proxy logs:" - -#: ../../admin/troubleshooting.rst:42 -msgid "Apache logs should be available at :file:`/var/log/apache/access.log` and :file:`/var/log/apache/error.log`" -msgstr "" -"Apache logs should be available at :file:`/var/log/apache/access.log` and " -":file:`/var/log/apache/error.log`" - -#: ../../admin/troubleshooting.rst:43 -msgid "Nginx logs should be available at :file:`/var/log/nginx/access.log` and :file:`/var/log/nginx/error.log`" -msgstr "" -"Nginx logs should be available at :file:`/var/log/nginx/access.log` and " -":file:`/var/log/nginx/error.log`" - -#: ../../admin/troubleshooting.rst:46 -#: ../../admin/troubleshooting.rst:112 -msgid "API logs:" -msgstr "API logs:" - -#: ../../admin/troubleshooting.rst:45 -#: ../../admin/troubleshooting.rst:112 -msgid "Docker setup: ``docker-compose logs -f --tail=50 api`` (remove the ``--tail`` flag to get the full logs)" -msgstr "" -"Docker setup: ``docker-compose logs -f --tail=50 api`` (remove the ``--tail``" -" flag to get the full logs)" - -#: ../../admin/troubleshooting.rst:46 -#: ../../admin/troubleshooting.rst:113 -msgid "Non-docker setup: ``journalctl -xn -u funkwhale-server``" -msgstr "Non-docker setup: ``journalctl -xn -u funkwhale-server``" - -#: ../../admin/troubleshooting.rst:50 -msgid "If you edit your .env file to test a new configuration, you have to restart your services to pick up the changes:" -msgstr "" -"If you edit your .env file to test a new configuration, you have to restart " -"your services to pick up the changes:" - -#: ../../admin/troubleshooting.rst:52 -msgid "Docker setup: ``docker-compose up -d``" -msgstr "Docker setup: ``docker-compose up -d``" - -#: ../../admin/troubleshooting.rst:53 -msgid "Non-docker setup: ``systemctl restart funkwhale.target``" -msgstr "Non-docker setup: ``systemctl restart funkwhale.target``" - -#: ../../admin/troubleshooting.rst:56 -#: ../../admin/troubleshooting.rst:119 -msgid "Common problems" -msgstr "Common problems" - -#: ../../admin/troubleshooting.rst:59 -msgid "Instance works properly, but audio files are not served (404 error)" -msgstr "Instance works properly, but audio files are not served (404 error)" - -#: ../../admin/troubleshooting.rst:61 -msgid "If you're using docker, ensure the ``MEDIA_ROOT`` variable is commented in your env file" -msgstr "" -"If you're using docker, ensure the ``MEDIA_ROOT`` variable is commented in " -"your env file" - -#: ../../admin/troubleshooting.rst:62 -msgid "Ensure the ``_protected/media`` block points toward the path where media files are stored (``/srv/funkwhale/data/media``, by default)" -msgstr "" -"Ensure the ``_protected/media`` block points toward the path where media " -"files are stored (``/srv/funkwhale/data/media``, by default)" - -#: ../../admin/troubleshooting.rst:63 -msgid "If you're using in-place import, ensure :data:`MUSIC_DIRECTORY_PATH `, :data:`MUSIC_DIRECTORY_SERVE_PATH ` and :data:`REVERSE_PROXY_TYPE ` are configured properly, and that the files are readable by the webserver" -msgstr "" -"If you're using in-place import, ensure :data:`MUSIC_DIRECTORY_PATH `, :data:`MUSIC_DIRECTORY_SERVE_PATH " -"` and :data:`" -"REVERSE_PROXY_TYPE ` are " -"configured properly, and that the files are readable by the webserver" - -#: ../../admin/troubleshooting.rst:66 -msgid "Weakref error when running ``python manage.py ``" -msgstr "Weakref error when running ``python manage.py ``" - -#: ../../admin/troubleshooting.rst:68 -msgid "On Python <3.6, you may see this kind of errors when running commands like ``python manage.py migrate``::" -msgstr "" -"On Python <3.6, you may see this kind of errors when running commands like ``" -"python manage.py migrate``::" - -#: ../../admin/troubleshooting.rst:75 -msgid "This is caused by a bug in Python (cf https://github.com/celery/celery/issues/3818), and is not affecting in any way the command you execute. You can safely ignore this error." -msgstr "" -"This is caused by a bug in Python (cf https://github.com/celery/celery/" -"issues/3818), and is not affecting in any way the command you execute. You " -"can safely ignore this error." - -#: ../../admin/troubleshooting.rst:79 -msgid "``Your models have changes that are not yet reflected in a migration`` warning" -msgstr "" -"``Your models have changes that are not yet reflected in a migration`` " -"warning" - -#: ../../admin/troubleshooting.rst:81 -msgid "When running ``python manage.py migrate`` (both in docker or non-docker), you may end-up with this::" -msgstr "" -"When running ``python manage.py migrate`` (both in docker or non-docker), " -"you may end-up with this::" - -#: ../../admin/troubleshooting.rst:91 -msgid "This warning can be safely ignored. You should not run the suggested ``manage.py makemigrations`` command." -msgstr "" -"This warning can be safely ignored. You should not run the suggested ``" -"manage.py makemigrations`` command." - -#: ../../admin/troubleshooting.rst:94 -msgid "File import issues" -msgstr "File import issues" - -#: ../../admin/troubleshooting.rst:96 -msgid "Unless you are using the CLI to import files, imports are send as tasks in a queue to a celery worker that will process them." -msgstr "" -"Unless you are using the CLI to import files, imports are send as tasks in a " -"queue to a celery worker that will process them." - -#: ../../admin/troubleshooting.rst:102 -#: ../../admin/troubleshooting.rst:116 -msgid "Celery worker logs:" -msgstr "Celery worker logs:" - -#: ../../admin/troubleshooting.rst:101 -#: ../../admin/troubleshooting.rst:115 -msgid "Docker setup: ``docker-compose logs -f --tail=50 celeryworker`` (remove the ``--tail`` flag to get the full logs)" -msgstr "" -"Docker setup: ``docker-compose logs -f --tail=50 celeryworker`` (remove the " -"``--tail`` flag to get the full logs)" - -#: ../../admin/troubleshooting.rst:102 -#: ../../admin/troubleshooting.rst:116 -msgid "Non-docker setup: ``journalctl -xn -u funkwhale-worker``" -msgstr "Non-docker setup: ``journalctl -xn -u funkwhale-worker``" - -#: ../../admin/troubleshooting.rst:105 -msgid "Federation issues" -msgstr "Federation issues" - -#: ../../admin/troubleshooting.rst:107 -msgid "Received federations messages are sent to a dedicated task queue and processed asynchronously by a celery worker." -msgstr "" -"Received federations messages are sent to a dedicated task queue and " -"processed asynchronously by a celery worker." - -#: ../../admin/troubleshooting.rst:122 -msgid "I have no access to another instance library" -msgstr "I have no access to another instance library" - -#: ../../admin/troubleshooting.rst:124 -msgid "Check if it works with the demo library (library@demo.funkwhale.audio)" -msgstr "Check if it works with the demo library (library@demo.funkwhale.audio)" - -#: ../../admin/troubleshooting.rst:125 -msgid "Check if the remote library received your follow request and approved it" -msgstr "" -"Check if the remote library received your follow request and approved it" - -#: ../../admin/troubleshooting.rst:126 -msgid "Trigger a scan via the interface" -msgstr "Trigger a scan via the interface" - -#: ../../admin/troubleshooting.rst:127 -msgid "Have a look in the celery logs for potential errors during the scan" -msgstr "Have a look in the celery logs for potential errors during the scan" - -#: ../../admin/troubleshooting.rst:130 -msgid "Other problems" -msgstr "Other problems" - -#: ../../admin/troubleshooting.rst:132 -msgid "It's a bit hard to give targeted advice about problems that do not fit in the previous categories. However, we can recommend to:" -msgstr "" -"It's a bit hard to give targeted advice about problems that do not fit in " -"the previous categories. However, we can recommend to:" - -#: ../../admin/troubleshooting.rst:134 -msgid "Try to identify the scope of the issue and reproduce it reliably" -msgstr "Try to identify the scope of the issue and reproduce it reliably" - -#: ../../admin/troubleshooting.rst:135 -msgid "Ensure your instance is configured as detailed in the installation documentation, and if you did not use the default values, to check what you changed" -msgstr "" -"Ensure your instance is configured as detailed in the installation " -"documentation, and if you did not use the default values, to check what you " -"changed" - -#: ../../admin/troubleshooting.rst:137 -msgid "To read the .env file carefully, as most of the options are described in the comments" -msgstr "" -"To read the .env file carefully, as most of the options are described in the " -"comments" - -#: ../../admin/troubleshooting.rst:141 -msgid "Report an issue or get help" -msgstr "Report an issue or get help" - -#: ../../admin/troubleshooting.rst:143 -msgid "Well be more than happy to help you to debug installation and configuration issues. The main channel for receiving support about your Funkwhale installation is the `#funkwhale-troubleshooting:matrix.org `_ Matrix channel." -msgstr "" -"We'll be more than happy to help you to debug installation and configuration " -"issues. The main channel for receiving support about your Funkwhale " -"installation is the `#funkwhale-troubleshooting:matrix.org `_ Matrix channel." - -#: ../../admin/troubleshooting.rst:146 -msgid "Before asking for help, we'd really appreciate if you took the time to go through this document and try to diagnose the problem yourself. But if you don't find anything relevant or don't have the time, we'll be there for you!" -msgstr "" -"Before asking for help, we'd really appreciate if you took the time to go " -"through this document and try to diagnose the problem yourself. But if you " -"don't find anything relevant or don't have the time, we'll be there for you!" - -#: ../../admin/troubleshooting.rst:149 -msgid "Here are a few recommendations on how to structure and what to include in your help requests:" -msgstr "" -"Here are a few recommendations on how to structure and what to include in " -"your help requests:" - -#: ../../admin/troubleshooting.rst:151 -msgid "Give us as much context as possible about your installation (OS, version, Docker/non-docker, reverse-proxy type, relevant logs and errors, etc.)" -msgstr "" -"Give us as much context as possible about your installation (OS, version, " -"Docker/non-docker, reverse-proxy type, relevant logs and errors, etc.)" - -#: ../../admin/troubleshooting.rst:152 -msgid "Including screenshots or small gifs or videos can help us considerably when debugging front-end issues" -msgstr "" -"Including screenshots or small gifs or videos can help us considerably when " -"debugging front-end issues" - -#: ../../admin/troubleshooting.rst:154 -msgid "You can also open issues on our `issue tracker `_. Please have a quick look for similar issues before doing that, and use the issue tracker only to report bugs, suggest enhancements (both in the software and the documentation) or new features." -msgstr "" -"You can also open issues on our `issue tracker `_. Please have a quick look for similar issues " -"before doing that, and use the issue tracker only to report bugs, suggest " -"enhancements (both in the software and the documentation) or new features." - -#: ../../admin/troubleshooting.rst:159 -msgid "If you ever need to share screenshots or urls with someone else, ensure those do not include your personal token. This token is binded to your account and can be used to connect and use your account." -msgstr "" -"If you ever need to share screenshots or urls with someone else, ensure " -"those do not include your personal token. This token is binded to your " -"account and can be used to connect and use your account." - -#: ../../admin/troubleshooting.rst:162 -msgid "Urls that includes your token looks like: ``https://your.instance/api/v1/uploads/42/serve/?jwt=yoursecrettoken``" -msgstr "" -"Urls that includes your token looks like: ``https://your.instance/api/v1/" -"uploads/42/serve/?jwt=yoursecrettoken``" - -#: ../../admin/troubleshooting.rst:165 -msgid "Improving this documentation" -msgstr "Improving this documentation" - -#: ../../admin/troubleshooting.rst:167 -msgid "If you feel like something should be improved in this document (and in the documentation in general), feel free to :doc:`contribute to the documentation <../documentation/creating>`. If you're not comfortable contributing or would like to ask somebody else to do it, feel free to :doc:`request a change in documentation <../documentation/identifying>`." -msgstr "" -"If you feel like something should be improved in this document (and in the " -"documentation in general), feel free to :doc:`contribute to the " -"documentation <../documentation/creating>`. If you're not comfortable " -"contributing or would like to ask somebody else to do it, feel free to :doc:`" -"request a change in documentation <../documentation/identifying>`." diff --git a/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/change-url.po b/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/change-url.po new file mode 100644 index 000000000..b2b26db2d --- /dev/null +++ b/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/change-url.po @@ -0,0 +1,112 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, The Funkwhale Collective +# This file is distributed under the same license as the funkwhale package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: funkwhale 1.3.0-rc3\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-03-01 14:39+0100\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.11.0\n" + +#: ../../administrator/configuration/change-url.md:1 +msgid "Change your instance URL" +msgstr "" + +#: ../../administrator/configuration/change-url.md:4 +msgid "" +"We recommend you don't change your instance URL. Changing it __will__ " +"cause instability and problems with federation. If you change your URL, " +"the Funkwhale project can't offer support for problems that arise." +msgstr "" + +#: ../../administrator/configuration/change-url.md:7 +msgid "" +"Your instance URL is your pod's unique identifier in the " +"{term}`fediverse`. If you want to change it, you need to update a lot of " +"information" +msgstr "" + +#: ../../administrator/configuration/change-url.md:9 +msgid "The instance URL in your {file}`.env` file." +msgstr "" + +#: ../../administrator/configuration/change-url.md:10 +msgid "The instance URL in your webserver config." +msgstr "" + +#: ../../administrator/configuration/change-url.md:11 +msgid "Any references to the old URL in your database." +msgstr "" + +#: ../../administrator/configuration/change-url.md:13 +msgid "" +"To clean the database, the `funkwhale-manage` command line interface " +"contains a `fix_federation_ids` command." +msgstr "" + +#: ../../administrator/configuration/change-url.md:16 +msgid "" +"Running `fix_federation_ids` with the `--no-dry-run` flag is " +"irreversible. Make sure you [back up your data](../upgrade/backup.md)." +msgstr "" + +#: ../../administrator/configuration/change-url.md:19 +msgid "Update your instance URL" +msgstr "" + +#: ../../administrator/configuration/change-url.md:21 +msgid "" +"Change the `FUNKWHALE_HOSTNAME` and `DJANGO_ALLOWED_HOSTS` value in your " +"{file}`.env` file." +msgstr "" + +#: ../../administrator/configuration/change-url.md:22 +msgid "" +"Change the `server_name` values in your {file}`/etc/nginx/sites-" +"enabled/funkwhale.conf` file." +msgstr "" + +#: ../../administrator/configuration/change-url.md:23 +msgid "Run the `fix_federation_ids` command to clean up your database." +msgstr "" + +#: ../../administrator/configuration/change-url.md +msgid "Debian" +msgstr "" + +#: ../../administrator/configuration/change-url.md +msgid "Docker" +msgstr "" + +#: ../../administrator/configuration/change-url.md:46 +msgid "Example output:" +msgstr "" + +#: ../../administrator/configuration/change-url.md:72 +msgid "Restart your webserver to pick up the changes." +msgstr "" + +#: ../../administrator/configuration/change-url.md +msgid "Nginx" +msgstr "" + +#: ../../administrator/configuration/change-url.md +msgid "Apache" +msgstr "" + +#~ msgid "" +#~ "Running `fix_federation_ids` with the " +#~ "`--no-dry-run` flag is irreversible. " +#~ "Make sure you [back up your " +#~ "data](../upgrade_docs/backup.md)." +#~ msgstr "" + diff --git a/docs/locales/en_US/LC_MESSAGES/administrator_documentation/configuration_docs/env_file.po b/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/env-file.po similarity index 81% rename from docs/locales/en_US/LC_MESSAGES/administrator_documentation/configuration_docs/env_file.po rename to docs/locales/en_GB/LC_MESSAGES/administrator/configuration/env-file.po index 2bf4e3495..854b3f4c7 100644 --- a/docs/locales/en_US/LC_MESSAGES/administrator_documentation/configuration_docs/env_file.po +++ b/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/env-file.po @@ -1,65 +1,65 @@ # SOME DESCRIPTIVE TITLE. -# Copyright (C) 2022, The Funkwhale Collective +# Copyright (C) 2023, The Funkwhale Collective # This file is distributed under the same license as the funkwhale package. -# FIRST AUTHOR , 2022. +# FIRST AUTHOR , 2023. # #, fuzzy msgid "" msgstr "" -"Project-Id-Version: funkwhale 1.2.5\n" +"Project-Id-Version: funkwhale 1.3.0-rc3\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2022-07-03 01:39+0200\n" +"POT-Creation-Date: 2023-03-01 14:39+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.10.1\n" +"Generated-By: Babel 2.11.0\n" -#: ../../administrator_documentation/configuration_docs/env_file.md:1 +#: ../../administrator/configuration/env-file.md:1 msgid "Customize your environment file" msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:3 +#: ../../administrator/configuration/env-file.md:3 msgid "" "Your `.env` (environment) file contains variables you can change to " "customize your pod. You can change these variables at any time to alter " "how your pod runs." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:5 +#: ../../administrator/configuration/env-file.md:5 msgid "" "You need to restart your Funkwhale services after changing your `.env` " "file." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md +#: ../../administrator/configuration/env-file.md msgid "Debian" msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md +#: ../../administrator/configuration/env-file.md msgid "Docker" msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:23 +#: ../../administrator/configuration/env-file.md:28 msgid "Variables" msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:27 +#: ../../administrator/configuration/env-file.md:32 msgid "" "Some environment variables accept a URL as a value. To encode URLs and " "avoid problems with special characters, use `urllib.parse` on your URL " "value." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:34 +#: ../../administrator/configuration/env-file.md:39 msgid "" "The [django-environ documentation](https://github.com/joke2k/django-" "environ/blob/main/docs/tips.rst#using-unsafe-characters-in-urls)." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:39 +#: ../../administrator/configuration/env-file.md:44 msgid "Pod configuration" msgstr "" @@ -73,24 +73,22 @@ msgid "" "``https``." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:48 +#: ../../administrator/configuration/env-file.md:53 msgid "Database and redis configuration" msgstr "" #: ../../docstring config.settings.common.DATABASE_URL:1 of -msgid "The URL used to connect to the PostgreSQL database. Examples:" -msgstr "" - -#: ../../docstring config.settings.common.DATABASE_URL:3 of -msgid "``postgresql://funkwhale@:5432/funkwhale``" -msgstr "" - -#: ../../docstring config.settings.common.DATABASE_URL:4 of -msgid "``postgresql://:@:/``" +msgid "" +"The URL used to connect to the PostgreSQL database. Defaults to an auto " +"generated url build using the `DATABASE_HOST`, `DATABASE_PORT`, " +"`DATABASE_USER`, `DATABASE_PASSWORD` and `DATABASE_NAME` variables." msgstr "" #: ../../docstring config.settings.common.DATABASE_URL:5 of -msgid "``postgresql://funkwhale:passw0rd@localhost:5432/funkwhale_database``" +msgid "" +"Examples: - ``postgresql://funkwhale@:5432/funkwhale`` - " +"``postgresql://:@:/`` - " +"``postgresql://funkwhale:passw0rd@localhost:5432/funkwhale_database``" msgstr "" #: ../../docstring config.settings.common.DB_CONN_MAX_AGE:1 of @@ -143,7 +141,7 @@ msgstr "" msgid "``redis+socket:///run/redis/redis.sock?virtual_host=0``" msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:60 +#: ../../administrator/configuration/env-file.md:65 msgid "Accounts and registration" msgstr "" @@ -180,17 +178,15 @@ msgid "" " strings." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:80 +#: ../../administrator/configuration/env-file.md:80 msgid "Whether to enable LDAP authentication." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:82 -msgid "" -"See {doc}`/administrator_documentation/configuration_docs/ldap` for more " -"information." +#: ../../administrator/configuration/env-file.md:82 +msgid "See {doc}`/administrator/configuration/ldap` for more information." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:85 +#: ../../administrator/configuration/env-file.md:90 msgid "Media storage and serving configuration" msgstr "" @@ -256,7 +252,17 @@ msgstr "" msgid "Don't insert a slash at the end of this path." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:106 +#: ../../administrator/configuration/env-file.md:111 +msgid "Controls the maximum size of file that users can upload." +msgstr "" + +#: ../../administrator/configuration/env-file.md:114 +msgid "" +"You can control how much total storage a user can access with the " +":term:`Upload Quota` setting." +msgstr "" + +#: ../../administrator/configuration/env-file.md:118 msgid "S3 storage configuration" msgstr "" @@ -328,7 +334,7 @@ msgid "" " to share the bucket between services." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:125 +#: ../../administrator/configuration/env-file.md:137 msgid "In-place import configuration" msgstr "" @@ -371,7 +377,7 @@ msgid "" "this directory." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:136 +#: ../../administrator/configuration/env-file.md:148 msgid "API configuration" msgstr "" @@ -394,7 +400,7 @@ msgstr "" msgid "``signup=5/d,password-reset=2/d,anonymous-reports=5/d``" msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:146 +#: ../../administrator/configuration/env-file.md:158 msgid "" "See [Rate limit API endpoints](rate-limiting.md) for a list of available " "endpoints and their default limits." @@ -426,7 +432,7 @@ msgstr "" msgid "Default timeout for external requests." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:156 +#: ../../administrator/configuration/env-file.md:168 msgid "Federation configuration" msgstr "" @@ -440,7 +446,7 @@ msgstr "" msgid "The delay in seconds between two manual fetches of the same remote object." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:165 +#: ../../administrator/configuration/env-file.md:177 msgid "Metadata configuration" msgstr "" @@ -469,7 +475,7 @@ msgstr "" msgid "Length of time in seconds to cache MusicBrainz results." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:175 +#: ../../administrator/configuration/env-file.md:187 msgid "Channels and podcast configuration" msgstr "" @@ -498,7 +504,7 @@ msgstr "" msgid "Changing this value only affect new podcasts." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:185 +#: ../../administrator/configuration/env-file.md:197 msgid "Subsonic configuration" msgstr "" @@ -507,7 +513,7 @@ msgstr "" msgid "The default format files are transcoded into when using the Subsonic API." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:193 +#: ../../administrator/configuration/env-file.md:205 msgid "Email configuration" msgstr "" @@ -563,7 +569,7 @@ msgstr "" msgid "Subject prefix for system emails." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:205 +#: ../../administrator/configuration/env-file.md:217 msgid "Plugin configuration" msgstr "" @@ -573,11 +579,11 @@ msgid "" "runtime." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:218 +#: ../../administrator/configuration/env-file.md:226 msgid "List of Funkwhale plugins to load." msgstr "" -#: ../../administrator_documentation/configuration_docs/env_file.md:221 +#: ../../administrator/configuration/env-file.md:233 msgid "Other settings" msgstr "" @@ -612,63 +618,21 @@ msgstr "" msgid "Additional TLDs to support with our markdown linkifier." msgstr "" -#~ msgid "" -#~ "Whether to proxy attachment files hosted" -#~ " on third party pods and and " -#~ "servers. Leaving this set to ``true``" -#~ " is recommended. This reduces the " -#~ "risk of leaking user browsing " -#~ "information and reduces the bandwidth " -#~ "used on remote pods." -#~ msgstr "" +#: ../../docstring config.settings.common.LOGLEVEL:1 of +msgid "str(object='') -> str str(bytes_or_buffer[, encoding[, errors]]) -> str" +msgstr "" -#~ msgid "Disabling this feature is not recommended." -#~ msgstr "" +#: ../../docstring config.settings.common.LOGLEVEL:4 of +msgid "" +"Create a new string object from the given object. If encoding or errors " +"is specified, then the object must expose a data buffer that will be " +"decoded using the given encoding and error handler. Otherwise, returns " +"the result of object.__str__() (if defined) or repr(object). encoding " +"defaults to sys.getdefaultencoding(). errors defaults to 'strict'." +msgstr "" #~ msgid "" -#~ "By default, only people who subscribe" -#~ " to a podcast RSS have access " -#~ "to its episodes. Switch to \"instance\"" -#~ " or \"everyone\" to change the " -#~ "default visibility." -#~ msgstr "" - -#~ msgid "Name and email address used to send system emails." -#~ msgstr "" - -#~ msgid "" -#~ "Both the forms ``Funkwhale " -#~ "`` and ``noreply@yourdomain`` " -#~ "work." -#~ msgstr "" - -#~ msgid "" -#~ "Path to a directory containing Funkwhale" -#~ " plugins. These will be imported at" -#~ " runtime." -#~ msgstr "" - -#~ msgid "" -#~ "The number of days after signup " -#~ "before the \"support your pod\" message" -#~ " is shown." -#~ msgstr "" - -#~ msgid "" -#~ "The number of days after signup " -#~ "before the \"support Funkwhale\" message " -#~ "is shown." -#~ msgstr "" - -#~ msgid "" -#~ "Name and email address used to " -#~ "send system emails. Format is ``Name " -#~ "`` or ``email address``." -#~ msgstr "" - -#~ msgid "Default: ``Funkwhale ``" -#~ msgstr "" - -#~ msgid "````." +#~ "See {doc}`/administrator_documentation/configuration_docs/ldap`" +#~ " for more information." #~ msgstr "" diff --git a/docs/locales/en_US/LC_MESSAGES/administrator_documentation/configuration_docs/frontend.po b/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/frontend.po similarity index 93% rename from docs/locales/en_US/LC_MESSAGES/administrator_documentation/configuration_docs/frontend.po rename to docs/locales/en_GB/LC_MESSAGES/administrator/configuration/frontend.po index 2ca0f5445..ba554ccbe 100644 --- a/docs/locales/en_US/LC_MESSAGES/administrator_documentation/configuration_docs/frontend.po +++ b/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/frontend.po @@ -1,21 +1,21 @@ # SOME DESCRIPTIVE TITLE. -# Copyright (C) 2022, The Funkwhale Collective +# Copyright (C) 2023, The Funkwhale Collective # This file is distributed under the same license as the funkwhale package. -# FIRST AUTHOR , 2022. +# FIRST AUTHOR , 2023. # #, fuzzy msgid "" msgstr "" -"Project-Id-Version: funkwhale 1.2.5\n" +"Project-Id-Version: funkwhale 1.3.0-rc3\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2022-07-23 12:18+0200\n" +"POT-Creation-Date: 2023-03-01 14:05+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.10.3\n" +"Generated-By: Babel 2.11.0\n" #: ../../administrator_documentation/configuration_docs/frontend.md:1 msgid "Customize the Funkwhale frontend" @@ -191,12 +191,3 @@ msgstr "" msgid "Refresh your Funkwhale app. The background should now be red." msgstr "" -#~ msgid "Add the following snippet to your vhost configuration:" -#~ msgstr "" - -#~ msgid "Add the whole {file}`custom` dir to your vhost configuration." -#~ msgstr "" - -#~ msgid "Add the following to your vhost file." -#~ msgstr "" - diff --git a/docs/locales/en_US/LC_MESSAGES/administrator_documentation/configuration_docs/index.po b/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/index.po similarity index 85% rename from docs/locales/en_US/LC_MESSAGES/administrator_documentation/configuration_docs/index.po rename to docs/locales/en_GB/LC_MESSAGES/administrator/configuration/index.po index d617df5de..867a36734 100644 --- a/docs/locales/en_US/LC_MESSAGES/administrator_documentation/configuration_docs/index.po +++ b/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/index.po @@ -1,21 +1,21 @@ # SOME DESCRIPTIVE TITLE. -# Copyright (C) 2022, The Funkwhale Collective +# Copyright (C) 2023, The Funkwhale Collective # This file is distributed under the same license as the funkwhale package. -# FIRST AUTHOR , 2022. +# FIRST AUTHOR , 2023. # #, fuzzy msgid "" msgstr "" -"Project-Id-Version: funkwhale 1.2.5\n" +"Project-Id-Version: funkwhale 1.3.0-rc3\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2022-07-01 10:35+0200\n" +"POT-Creation-Date: 2023-03-01 14:05+0100\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=utf-8\n" "Content-Transfer-Encoding: 8bit\n" -"Generated-By: Babel 2.10.1\n" +"Generated-By: Babel 2.11.0\n" #: ../../administrator_documentation/configuration_docs/index.md:5 msgid "Environment file" diff --git a/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/instance-settings.po b/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/instance-settings.po new file mode 100644 index 000000000..659e4b6c9 --- /dev/null +++ b/docs/locales/en_GB/LC_MESSAGES/administrator/configuration/instance-settings.po @@ -0,0 +1,439 @@ +# SOME DESCRIPTIVE TITLE. +# Copyright (C) 2023, The Funkwhale Collective +# This file is distributed under the same license as the funkwhale package. +# FIRST AUTHOR , 2023. +# +#, fuzzy +msgid "" +msgstr "" +"Project-Id-Version: funkwhale 1.3.0-rc3\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2023-03-01 14:39+0100\n" +"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" +"Last-Translator: FULL NAME \n" +"Language-Team: LANGUAGE \n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=utf-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Generated-By: Babel 2.11.0\n" + +#: ../../administrator/configuration/instance-settings.md:1 +msgid "Instance settings" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:3 +msgid "" +"You can find instance settings on your pod's web interface. These " +"settings control high level pod configuration. You don't need to restart " +"the pod after changing these settings." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:5 +msgid "To find your instance settings:" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "Desktop" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:13 +#: ../../administrator/configuration/instance-settings.md:22 +msgid "Log in to your {term}`pod`." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:14 +msgid "" +"Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open " +"the {guilabel}`Administration` menu." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:15 +#: ../../administrator/configuration/instance-settings.md:24 +msgid "Select {guilabel}`Settings`. The {guilabel}`Instance settings` page opens." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "Mobile" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:23 +msgid "" +"Select the wrench icon ({fa}`wrench`) at the top of the page to open the " +"{guilabel}`Administration` menu." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:28 +msgid "Available settings" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:30 +msgid "Instance information" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "Pod name" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:34 +msgid "" +"The public name of your Funkwhale pod. This is displayed on the \"Home\" " +"and \"About\" pages." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:3 +msgid "Short description" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:37 +msgid "" +"A short description of your pod. Users see this on the pod's \"Home\" " +"page." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:6 +msgid "Long description" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:40 +msgid "" +"A longer description of your pod. Users see this on the pod's \"About\" " +"page. Supports markdown formatting." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:9 +msgid "Contact email" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:43 +msgid "" +"A contact email address that users and visitors can use to contact the " +"pod administrator." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:12 +msgid "Rules" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:46 +msgid "" +"A free text field for you to add your pod's rules and code of conduct. " +"This is seen on the pod's \"About\" page. Supports markdown formatting" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:15 +msgid "Terms of service" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:49 +msgid "" +"A free text field for you to add your pod's terms of service and privacy " +"policy. This is seen on the pod's \"About\" page. Supports markdown " +"formatting." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:18 +msgid "Banner image" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:52 +msgid "" +"A large image seen on the pod's \"Home\" and \"About\" pages. The image " +"should be at least 600x100px." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:21 +msgid "Support message" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:55 +msgid "" +"A short message you can display to your pod's users to ask for support or" +" just send a periodic message. Supports markdown." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:62 +msgid "Sign-ups" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "Open registration to new users" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:66 +msgid "Enable this setting to allow new users to create an account on your pod." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:3 +msgid "Enable manual sign-up validation" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:69 +msgid "" +"Enable this setting to require all new registrations to be validated by a" +" moderator." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:6 +msgid "Sign-up form customization" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:72 +msgid "" +"Use this tool to create a custom sign-up form. New users see this form " +"when creating a new account. Supports markdown" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:79 +msgid "Security" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "API Requires authentication" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:83 +msgid "" +"Controls whether {term}`unauthenticated users ` can access " +"content on your pod. If __enabled__, users need to have an account on " +"your pod to access content. If __disabled__, users without an account can" +" listen to content stored in public libraries." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:86 +msgid "{doc}`../../moderator/content/library`." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:7 +msgid "Default permissions" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:90 +msgid "" +"A list of {term}`permissions` that are added to users by default. If your" +" pod is publicly accessible, you should leave this empty." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:10 +msgid "Upload quota" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:93 +msgid "" +"The default upload quota for users in MB. You can override this on a per-" +"user basis." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:96 +msgid "{doc}`../../moderator/reports/users`" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:104 +msgid "Music" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "Transcoding enabled" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:108 +msgid "" +"Enable this setting to let your server transcode files into a different " +"format if the client requests it. This is useful if a device doesn't " +"support formats like Ogg or FLAC." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:3 +msgid "Transcoding cache duration" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:111 +msgid "" +"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." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:116 +msgid "Channels" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "Enable channels" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:120 +msgid "Whether user channels can be created and followed on your pod." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:3 +msgid "Max channels allowed per user" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:123 +msgid "The maximum number of channels each user can create." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:130 +msgid "Playlists" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "Max tracks per playlist" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:134 +msgid "The maximum number of tracks a user can add to a playlist." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:141 +msgid "Moderation" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "Enable allow-listing" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:145 +msgid "" +"Enable this setting to ensure your pod only communicates with pods you " +"have added to your allow list. When this setting is disabled, your pod " +"will communicate with all other servers not included in your deny list." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:3 +msgid "Publish your allowed-domains list" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:148 +msgid "" +"Whether to make your list of allowed domains public. Enable this if you " +"want users to check who you are federating with." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:6 +msgid "Accountless report categories" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:151 +msgid "" +"A list of {term}`categories ` that {term}`anonymous` " +"users can submit." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:158 +msgid "Federation" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "Federation enabled" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:162 +msgid "Whether to enable federation features on your pod." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:3 +msgid "Enable public index" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:165 +msgid "Whether to allow other pods and bots to index public content on your pod." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:6 +msgid "Federation collection page size" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:168 +msgid "The number of items to display in ActivityPub collections." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:9 +msgid "Music cache duration" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:171 +msgid "" +"The number of minutes you want to store local copies of federated tracks " +"on your server. Funkwhale removes federated tracks that haven't been " +"downloaded within this duration to save space." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:12 +msgid "Federation actor fetch delay" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:174 +msgid "" +"The number of minutes the server waits before refetching actors on " +"request authentication." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:181 +msgid "Subsonic" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "Enabled Subsonic API" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:185 +msgid "" +"Whether to enable the Subsonic API. This controls whether users are able " +"to connect to your pod using Subsonic apps." +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:192 +msgid "User Interface" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md +msgid "Custom CSS code" +msgstr "" + +#: ../../administrator/configuration/instance-settings.md:196 +msgid "" +"Add CSS rules to control the look and feel of your pod. These rules are " +"added to a `