docs: rearrange paths, update links and redirects
Part-of: <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/2353>
This commit is contained in:
parent
54212feb11
commit
65316d43c1
|
@ -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
|
|
@ -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.
|
||||
|
||||
```
|
||||
|
|
@ -84,7 +84,7 @@ API Requires authentication
|
|||
Controls whether {term}`unauthenticated users <Anonymous>` 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`
|
||||
```
|
||||
|
||||
````
|
|
@ -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
|
||||
|
|
@ -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.
|
|
@ -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
|
|
@ -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_guide.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.
|
|
@ -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}
|
|
@ -1,6 +1,6 @@
|
|||
# Create a library
|
||||
|
||||
Use the `create_library` command to create new libraries for a given user.
|
||||
Use the `create` command to create new libraries for a given user.
|
||||
|
||||
```{list-table}
|
||||
:header-rows: 1
|
||||
|
@ -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"`
|
||||
|
@ -38,7 +38,7 @@ Use the following command to create a new library with a custom name and privacy
|
|||
:sync: debian
|
||||
|
||||
```{code-block} sh
|
||||
venv/bin/funkwhale-manage create_library username1 --name="Library 1" --privacy-level="everyone"
|
||||
venv/bin/funkwhale-manage create username1 --name="Library 1" --privacy-level="everyone"
|
||||
```
|
||||
|
||||
:::
|
||||
|
@ -47,7 +47,7 @@ venv/bin/funkwhale-manage create_library username1 --name="Library 1" --privacy-
|
|||
:sync: docker
|
||||
|
||||
```{code-block} sh
|
||||
sudo docker compose run --rm api funkwhale-manage create_library username1 --name="Library 1" --privacy-level="everyone"
|
||||
sudo docker compose run --rm api funkwhale-manage create username1 --name="Library 1" --privacy-level="everyone"
|
||||
```
|
||||
|
||||
:::
|
||||
|
@ -70,7 +70,7 @@ You can create a library using only a username. The script substitutes default v
|
|||
:sync: debian
|
||||
|
||||
```{code-block} sh
|
||||
venv/bin/funkwhale-manage create_library username1
|
||||
venv/bin/funkwhale-manage create username1
|
||||
```
|
||||
|
||||
:::
|
||||
|
@ -79,7 +79,7 @@ venv/bin/funkwhale-manage create_library username1
|
|||
:sync: docker
|
||||
|
||||
```{code-block} sh
|
||||
sudo docker compose run --rm api funkwhale-manage create_library username1
|
||||
sudo docker compose run --rm api funkwhale-manage create username1
|
||||
```
|
||||
|
||||
:::
|
||||
|
@ -102,7 +102,7 @@ If a library with the same name already exists for the given user, the script wi
|
|||
:sync: debian
|
||||
|
||||
```{code-block} sh
|
||||
venv/bin/funkwhale-manage create_library username1 --name="Library 1" --privacy-level="everyone"
|
||||
venv/bin/funkwhale-manage create username1 --name="Library 1" --privacy-level="everyone"
|
||||
```
|
||||
|
||||
:::
|
||||
|
@ -111,7 +111,7 @@ venv/bin/funkwhale-manage create_library username1 --name="Library 1" --privacy-
|
|||
:sync: docker
|
||||
|
||||
```{code-block} sh
|
||||
sudo docker compose run --rm api funkwhale-manage create_library username1 --name="Library 1" --privacy-level="everyone"
|
||||
sudo docker compose run --rm api funkwhale-manage create username1 --name="Library 1" --privacy-level="everyone"
|
||||
```
|
||||
|
||||
:::
|
|
@ -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.
|
|
@ -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
|
|
@ -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
|
|
@ -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.
|
|
@ -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.
|
|
@ -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.
|
|
@ -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
|
||||
|
|
@ -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
|
||||
|
|
@ -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)".
|
|
@ -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
|
|
@ -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.
|
Before Width: | Height: | Size: 87 KiB After Width: | Height: | Size: 87 KiB |
|
@ -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_guide
|
||||
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:
|
||||
|
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
By default, Funkwhale communicates with all reachable pods on the {term}`Fediverse`. If you want to lock down which pods you interact with, your pod admin can enable **allow-listing**. With this enabled, only pods on your allow-list can interact with your pod.
|
||||
|
||||
If you didn't use allow-listing before, you can remove all content from pods not on your list. Check out our guide on [purging content](../domains/purge_domain.md) to remove this content.
|
||||
If you didn't use allow-listing before, you can remove all content from pods not on your list. Check out our guide on [purging content](../domains/purge.md) to remove this content.
|
||||
|
||||
```{toctree}
|
||||
---
|
||||
|
@ -10,7 +10,7 @@ caption: Manage your pod's allow-list
|
|||
maxdepth: 1
|
||||
---
|
||||
|
||||
add_domain
|
||||
remove_domain
|
||||
add
|
||||
remove
|
||||
|
||||
```
|
|
@ -8,8 +8,8 @@ caption: Manage your pod's content
|
|||
maxdepth: 1
|
||||
---
|
||||
|
||||
handle_edits
|
||||
library_visibility
|
||||
delete_content
|
||||
edits
|
||||
library
|
||||
delete
|
||||
|
||||
```
|
|
@ -1,6 +1,6 @@
|
|||
# Add a domain to your pod's domain list
|
||||
|
||||
Funkwhale records the domains of other {term}`Fediverse` servers when users interact with them. Once a domain is in your domains list, you can [add moderation rules](add_rule.md) to it.
|
||||
Funkwhale records the domains of other {term}`Fediverse` servers when users interact with them. Once a domain is in your domains list, you can [add moderation rules](rules/add.md) to it.
|
||||
|
||||
:::{dropdown} Required permissions
|
||||
:icon: key
|
|
@ -8,8 +8,8 @@ caption: Manage external domains
|
|||
maxdepth: 1
|
||||
---
|
||||
|
||||
add_domain
|
||||
purge_domain
|
||||
add
|
||||
purge
|
||||
|
||||
```
|
||||
|
||||
|
@ -19,8 +19,8 @@ caption: Manage moderation rules
|
|||
maxdepth: 1
|
||||
---
|
||||
|
||||
add_rule
|
||||
edit_rule
|
||||
delete_rule
|
||||
rules/add
|
||||
rules/edit
|
||||
rules/delete
|
||||
|
||||
```
|
|
@ -8,7 +8,7 @@ caption: Manage external users
|
|||
maxdepth: 1
|
||||
---
|
||||
|
||||
purge_users
|
||||
purge
|
||||
|
||||
```
|
||||
|
||||
|
@ -18,8 +18,8 @@ caption: Manage moderation rules
|
|||
maxdepth: 1
|
||||
---
|
||||
|
||||
add_rule
|
||||
edit_rule
|
||||
delete_rule
|
||||
rules/add
|
||||
rules/edit
|
||||
rules/delete
|
||||
|
||||
```
|
|
@ -10,7 +10,7 @@ caption: Moderate users
|
|||
maxdepth: 1
|
||||
---
|
||||
|
||||
../reports/handle_users.md
|
||||
../reports/users.md
|
||||
|
||||
```
|
||||
|
||||
|
@ -20,6 +20,6 @@ caption: Handle user registrations
|
|||
maxdepth: 1
|
||||
---
|
||||
|
||||
handle_registration
|
||||
registration
|
||||
|
||||
```
|
|
@ -30,7 +30,7 @@ To handle a content report from the {guilabel}`Reports` page:
|
|||
1. Log in to your {term}`pod`.
|
||||
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
|
||||
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
|
||||
4. [Search for the report](search_reports.md).
|
||||
4. [Search for the report](search.md).
|
||||
5. Select an action from the {guilabel}`Actions` section:
|
||||
- {guilabel}`Resolve` – resolve the report with no further action.
|
||||
- {guilabel}`Delete reported object` – delete the object associated with the report. If you delete an artist or album, this deletes all files associated with the object.
|
||||
|
@ -43,7 +43,7 @@ To handle a content report from the {guilabel}`Reports` page:
|
|||
1. Log in to your {term}`pod`.
|
||||
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
|
||||
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
|
||||
4. [Search for the report](search_reports.md).
|
||||
4. [Search for the report](search.md).
|
||||
5. Select an action from the {guilabel}`Actions` section:
|
||||
- {guilabel}`Resolve` – resolve the report with no further action.
|
||||
- {guilabel}`Delete reported object` – delete the object associated with the report. If you delete an artist or album, this deletes all files associated with the object.
|
||||
|
@ -51,7 +51,7 @@ To handle a content report from the {guilabel}`Reports` page:
|
|||
:::
|
||||
::::
|
||||
|
||||
Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](internal_notes.md) to keep a record of your changes.
|
||||
Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](notes.md) to keep a record of your changes.
|
||||
|
||||
## Edit content in the moderation page
|
||||
|
||||
|
@ -65,7 +65,7 @@ If you want to edit an object to change its metadata:
|
|||
1. Log in to your {term}`pod`.
|
||||
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
|
||||
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
|
||||
4. [Search for the report](search_reports.md).
|
||||
4. [Search for the report](search.md).
|
||||
5. Select {guilabel}`Open in moderation interface` in the {guilabel}`Reported object` section. The object's moderation page opens.
|
||||
6. Select {guilabel}`Edit`. The {guilabel}`Edit` page opens.
|
||||
7. Edit the details on this page. Leave a {guilabel}`Summary` of your changes for reference.
|
||||
|
@ -82,7 +82,7 @@ If you want to edit an object to change its metadata:
|
|||
1. Log in to your {term}`pod`.
|
||||
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
|
||||
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
|
||||
4. [Search for the report](search_reports.md).
|
||||
4. [Search for the report](search.md).
|
||||
5. Select {guilabel}`Open in moderation interface` in the {guilabel}`Reported object` section. The object's moderation page opens.
|
||||
6. Select {guilabel}`Edit`. The {guilabel}`Edit` page opens.
|
||||
7. Edit the details on this page. Leave a {guilabel}`Summary` of your changes for reference.
|
||||
|
@ -94,4 +94,4 @@ If you want to edit an object to change its metadata:
|
|||
:::
|
||||
::::
|
||||
|
||||
Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](internal_notes.md) to keep a record of your changes.
|
||||
Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](notes.md) to keep a record of your changes.
|
|
@ -23,9 +23,9 @@ caption: Use the reports page
|
|||
maxdepth: 1
|
||||
---
|
||||
|
||||
view_reports
|
||||
search_reports
|
||||
internal_notes
|
||||
view
|
||||
search
|
||||
notes
|
||||
|
||||
```
|
||||
|
||||
|
@ -35,7 +35,7 @@ caption: Handle reports
|
|||
maxdepth: 1
|
||||
---
|
||||
|
||||
handle_content
|
||||
handle_users
|
||||
content
|
||||
users
|
||||
|
||||
```
|
|
@ -21,7 +21,7 @@ You can add notes to **Unresolved** and **Resolved** reports. To add an internal
|
|||
1. Log in to your {term}`pod`.
|
||||
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
|
||||
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
|
||||
4. [Search for the report](search_reports.md).
|
||||
4. [Search for the report](search.md).
|
||||
5. {guilabel}`Write` your note in the {guilabel}`Internal notes` section. This input field supports Markdown syntax. You can {guilabel}`Preview` how the note will look to other users.
|
||||
6. Select {guilabel}`Add note` to save your note.
|
||||
|
||||
|
@ -33,7 +33,7 @@ You can add notes to **Unresolved** and **Resolved** reports. To add an internal
|
|||
1. Log in to your {term}`pod`.
|
||||
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
|
||||
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
|
||||
4. [Search for the report](search_reports.md).
|
||||
4. [Search for the report](search.md).
|
||||
5. {guilabel}`Write` your note in the {guilabel}`Internal notes` section. This input field supports Markdown syntax. You can {guilabel}`Preview` how the note will look to other users.
|
||||
6. Select {guilabel}`Add note` to save your note.
|
||||
|
||||
|
@ -56,7 +56,7 @@ You can delete your own notes and the notes of other moderators. You can do this
|
|||
1. Log in to your {term}`pod`.
|
||||
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
|
||||
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
|
||||
4. [Search for the report](search_reports.md).
|
||||
4. [Search for the report](search.md).
|
||||
5. Find the note you want to delete in the {guilabel}`Internal notes` section.
|
||||
6. Select {guilabel}`Delete`
|
||||
|
||||
|
@ -68,7 +68,7 @@ You can delete your own notes and the notes of other moderators. You can do this
|
|||
1. Log in to your {term}`pod`.
|
||||
2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
|
||||
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
|
||||
4. [Search for the report](search_reports.md).
|
||||
4. [Search for the report](search.md).
|
||||
5. Find the note you want to delete in the {guilabel}`Internal notes` section.
|
||||
6. Select {guilabel}`Delete`
|
||||
|
|
@ -42,4 +42,4 @@ The {guilabel}`Reports` page contains filters that enable you to search for repo
|
|||
:::
|
||||
::::
|
||||
|
||||
Once you have found the required report, you can handle the reported [user](handle_users.md) or [content](handle_content.md). You can also update the [internal notes](internal_notes.md) on the report.
|
||||
Once you have found the required report, you can handle the reported [user](users.md) or [content](content.md). You can also update the [internal notes](notes.md) on the report.
|
|
@ -19,7 +19,7 @@ To open a user's moderation page:
|
|||
1. Log in to your {term}`pod`.
|
||||
2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
|
||||
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
|
||||
4. [Search for the report](search_reports.md) and select {guilabel}`Open in moderation interface` under {guilabel}`Reported object`. The user's moderation page opens.
|
||||
4. [Search for the report](search.md) and select {guilabel}`Open in moderation interface` under {guilabel}`Reported object`. The user's moderation page opens.
|
||||
|
||||
:::
|
||||
|
||||
|
@ -29,7 +29,7 @@ To open a user's moderation page:
|
|||
1. Log in to your {term}`pod`.
|
||||
2. Select the wrench icon ({fa}`wrench`) at the top of the page to open the {guilabel}`Administration` menu.
|
||||
3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
|
||||
4. [Search for the report](search_reports.md) and select {guilabel}`Open in moderation interface` under {guilabel}`Reported object`. The user's moderation page opens.
|
||||
4. [Search for the report](search.md) and select {guilabel}`Open in moderation interface` under {guilabel}`Reported object`. The user's moderation page opens.
|
||||
|
||||
:::
|
||||
::::
|
||||
|
@ -40,4 +40,4 @@ You can change the following settings in the moderation interface:
|
|||
- {guilabel}`Permissions` – add or remove permissions associated with the user.
|
||||
- {guilabel}`Upload quota` – change the amount of data (in megabytes) that the user can upload.
|
||||
|
||||
Once you have made your changes, return to the {guilabel}`Reports` page and {guilabel}`Resolve` the report. Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](internal_notes.md) to keep a record of your changes.
|
||||
Once you have made your changes, return to the {guilabel}`Reports` page and {guilabel}`Resolve` the report. Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](notes.md) to keep a record of your changes.
|
|
@ -45,7 +45,7 @@ That's it! A list of unresolved reports appears on the screen. The summary conta
|
|||
- A summary of the {guilabel}`Reported object`.
|
||||
- A list of available {guilabel}`Actions`.
|
||||
|
||||
Use the tools on this page the handle the reported [content](handle_content.md) or [user](handle_users.md).
|
||||
Use the tools on this page the handle the reported [content](content.md) or [user](users.md).
|
||||
|
||||
## Email notifications
|
||||
|
|
@ -1,53 +1,52 @@
|
|||
cli/index.html, ../user_documentation/info/cli.html
|
||||
cli/examples.html, ../user_documentation/info/cli.html#examples
|
||||
installation/optimization.html, ../admin/optimization.html
|
||||
users/create.html, ../user_documentation/accounts/create_account.html
|
||||
users/tagging.html, ../user_documentation/libraries/tag_music.html
|
||||
users/upload.html, ../user_documentation/libraries/upload_content.html
|
||||
users/editing.html, ../user_documentation/libraries/edit_content.html
|
||||
users/account.html, ../user_documentation/accounts/index.html
|
||||
users/queue.html, ../user_documentation/queue/index.html
|
||||
users/managing.html, ../user_documentation/libraries/index.html
|
||||
users/channels.html, ../user_documentation/channels/index.html
|
||||
users/playlists.html, ../user_documentation/radios/index.html
|
||||
users/favorites.html, ../user_documentation/favorites/index.html
|
||||
users/radios.html, ../user_documentation/radios/index.html
|
||||
users/followchannel.html, ../user_documentation/channels/follow_channel.html
|
||||
users/follow.html, ../user_documentation/libraries/follow_library.html
|
||||
users/reports.html, ../user_documentation/reports/index.html
|
||||
users/builtinplugins.html, ../user_documentation/plugins/index.html
|
||||
moderator/index.html, ../moderator_documentation/index.html
|
||||
moderator/reports.html, ../moderator_documentation/reports/index.html
|
||||
moderator/domains.html, ../moderator_documentation/domains/index.html
|
||||
moderator/users.html, ../moderator_documentation/users/index.html
|
||||
moderator/listing.html, ../moderator_documentation/allow_listing/index.html
|
||||
admin/index.html, ../administrator_documentation/index.html
|
||||
installation/index.html, ../administrator_documentation/installation_docs/index.html
|
||||
installation/index.html#quick-install, ../administrator_documentation/installation_docs/quick_install.html
|
||||
installation/docker.html, ../administrator_documentation/installation_docs/docker.html
|
||||
installation/debian.html, ../administrator_documentation/installation_docs/debian.html
|
||||
troubleshooting.html, administrator_documentation/troubleshooting/index.html
|
||||
admin/debugging.html, ../administrator_documentation/troubleshooting/index.html
|
||||
configuration.html, administrator_documentation/configuration_docs/index.html
|
||||
upgrading/index.html, ../administrator_documentation/upgrade_docs/index.html
|
||||
users/django.html, ../administrator_documentation/django/index.html
|
||||
installation/ldap.html, ../administrator_documentation/configuration_docs/ldap.html
|
||||
importing-music.html, administrator_documentation/import_docs/index.html
|
||||
configuration.html, administrator_documentation/configuration_docs/index.html
|
||||
upgrading/index.html, ../administrator_documentation/upgrade_docs/index.html
|
||||
users/django.html, ../administrator_documentation/django/index.html
|
||||
backup.html, ../administrator_documentation/upgrade_docs/backup.html
|
||||
admin/migration.html, ../administrator_documentation/installation_docs/migrate.html
|
||||
admin/commands.html, ../administrator_documentation/manage_script/index.html
|
||||
admin/mrf.html, ../administrator_documentation/configuration_docs/mrf.html
|
||||
admin/url.html, ../administrator_documentation/configuration_docs/change_url.html
|
||||
admin/optimization.html, ../administrator_documentation/configuration_docs/optimize.html
|
||||
architecture.html, ../developer_documentation/architecture.html
|
||||
contributing.html, ../developer_documentation/index.html
|
||||
api.html, ../developer_documentation/api/index.html
|
||||
federation/index.html, ../developer_documentation/federation/index.html
|
||||
developers/subsonic.html, ../developer_documentation/api/subsonic.html
|
||||
developers/plugins.html, ../developer_documentation/plugins/index.html
|
||||
developers/authentication.html, ../developer_documentation/api/authentication.html
|
||||
documentation/index.html, ../contributor_documentation/documentation.html
|
||||
translators.html, ../contributor_documentation/translation.html
|
||||
cli/index.html, ../user/info/cli.html
|
||||
cli/examples.html, ../user/info/cli.html#examples
|
||||
users/create.html, ../user/accounts/create.html
|
||||
users/tagging.html, ../user/libraries/content/tag.html
|
||||
users/upload.html, ../user/libraries/content/upload.html
|
||||
users/editing.html, ../user/libraries/content/edit.html
|
||||
users/account.html, ../user/accounts/index.html
|
||||
users/queue.html, ../user/queue/index.html
|
||||
users/managing.html, ../user/libraries/index.html
|
||||
users/channels.html, ../user/channels/index.html
|
||||
users/playlists.html, ../user/radios/index.html
|
||||
users/favorites.html, ../user/favorites/index.html
|
||||
users/radios.html, ../user/radios/index.html
|
||||
users/followchannel.html, ../user/channels/follow.html
|
||||
users/follow.html, ../user/libraries/follow.html
|
||||
users/reports.html, ../user/reports/index.html
|
||||
users/builtinplugins.html, ../user/plugins/index.html
|
||||
moderator/index.html, ../moderator/index.html
|
||||
moderator/reports.html, ../moderator/reports/index.html
|
||||
moderator/domains.html, ../moderator/domains/index.html
|
||||
moderator/users.html, ../moderator/users/index.html
|
||||
moderator/listing.html, ../moderator/allow_listing/index.html
|
||||
admin/index.html, ../administrator/index.html
|
||||
installation/index.html, ../administrator/installation/index.html
|
||||
installation/index.html#quick-install, ../administrator/installation/quick_install.html
|
||||
installation/docker.html, ../administrator/installation/docker.html
|
||||
installation/debian.html, ../administrator/installation/debian.html
|
||||
troubleshooting.html, administrator/troubleshooting/index.html
|
||||
admin/debugging.html, ../administrator/troubleshooting/index.html
|
||||
configuration.html, administrator/configuration/index.html
|
||||
upgrading/index.html, ../administrator/upgrade/index.html
|
||||
users/django.html, ../administrator/django/index.html
|
||||
installation/ldap.html, ../administrator/configuration/ldap.html
|
||||
importing-music.html, administrator/import.html
|
||||
configuration.html, administrator/configuration/index.html
|
||||
upgrading/index.html, ../administrator/upgrade/index.html
|
||||
users/django.html, ../administrator/django/index.html
|
||||
backup.html, ../administrator/upgrade/backup.html
|
||||
admin/migration.html, ../administrator/installation/migrate.html
|
||||
admin/commands.html, ../administrator/manage_script/index.html
|
||||
admin/mrf.html, ../administrator/configuration/mrf.html
|
||||
admin/url.html, ../administrator/configuration/change_url.html
|
||||
admin/optimization.html, ../administrator/configuration/optimize.html
|
||||
architecture.html, ../developer/architecture.html
|
||||
contributing.html, ../developer/index.html
|
||||
api.html, ../developer/api/index.html
|
||||
federation/index.html, ../developer/federation/index.html
|
||||
developers/subsonic.html, ../developer/api/subsonic.html
|
||||
developers/plugins.html, ../developer/plugins/index.html
|
||||
developers/authentication.html, ../developer/api/authentication.html
|
||||
documentation/index.html, ../contributor/documentation.html
|
||||
translators.html, ../contributor/translation.html
|
||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue