docs: use hyphen as string separator
Part-of: <https://dev.funkwhale.audio/funkwhale/funkwhale/-/merge_requests/2353>
This commit is contained in:
parent
f917f00b9a
commit
88e7f9cb56
|
@ -8,13 +8,13 @@ caption: Configuration options
|
||||||
maxdepth: 1
|
maxdepth: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
Environment file <env_file>
|
Environment file <env-file>
|
||||||
Instance settings <instance_settings>
|
Instance settings <instance-settings>
|
||||||
object_storage
|
object-storage
|
||||||
Frontend customization <frontend>
|
Frontend customization <frontend>
|
||||||
optimize
|
optimize
|
||||||
ldap
|
ldap
|
||||||
change_url
|
change-url
|
||||||
mrf
|
mrf
|
||||||
rate-limiting
|
rate-limiting
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Rate limit API endpoints
|
# 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
|
## Standard endpoints
|
||||||
|
|
||||||
|
|
|
@ -13,6 +13,6 @@ caption: Administrative tasks
|
||||||
maxdepth: 1
|
maxdepth: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
delete_content
|
delete-content
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -164,7 +164,7 @@ To use the in-place import method, follow these steps:
|
||||||
cd /srv/funkwhale
|
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/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.
|
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
|
```{code-block} sh
|
||||||
|
@ -184,7 +184,7 @@ Funkwhale imports the music in your storage directory into the specified library
|
||||||
:::{tab-item} Docker
|
:::{tab-item} Docker
|
||||||
:sync: 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/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:
|
2. Run your import command against your music storage directory:
|
||||||
|
|
||||||
```{code-block} sh
|
```{code-block} sh
|
||||||
|
|
|
@ -16,8 +16,8 @@ Once you've installed Funkwhale, you can use [the guides in this section](config
|
||||||
|
|
||||||
## Upgrade your Funkwhale pod
|
## Upgrade your Funkwhale pod
|
||||||
|
|
||||||
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).
|
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
|
## Manage your Funkwhale pod
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
|
@ -13,10 +13,10 @@ caption: Choose your installation method
|
||||||
maxdepth: 1
|
maxdepth: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
quick_install
|
quick-install
|
||||||
docker
|
docker
|
||||||
debian
|
debian
|
||||||
third_party
|
third-party
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -8,12 +8,12 @@ caption: Administration tasks
|
||||||
maxdepth: 1
|
maxdepth: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
create_library
|
create-library
|
||||||
Manage users <users>
|
Manage users <users>
|
||||||
Prune library <library>
|
Prune library <library>
|
||||||
Clean database <database>
|
Clean database <database>
|
||||||
Add album and artist tags <tags>
|
Add album and artist tags <tags>
|
||||||
thumbnails
|
thumbnails
|
||||||
fix_uploads
|
fix-uploads
|
||||||
|
|
||||||
```
|
```
|
|
@ -197,4 +197,4 @@ To disable memory tracing:
|
||||||
|
|
||||||
## Get help
|
## 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.
|
||||||
|
|
|
@ -57,4 +57,4 @@ If you are receiving `4XX` or `5XX` responses, this means the API isn't serving
|
||||||
|
|
||||||
## Get help
|
## 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.
|
||||||
|
|
|
@ -18,6 +18,6 @@ maxdepth: 1
|
||||||
|
|
||||||
frontend
|
frontend
|
||||||
backend
|
backend
|
||||||
get_help
|
help
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -12,7 +12,7 @@ caption: Choose your setup
|
||||||
maxdepth: 1
|
maxdepth: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
quick_install
|
quick-install
|
||||||
debian
|
debian
|
||||||
docker
|
docker
|
||||||
|
|
||||||
|
|
|
@ -24,7 +24,7 @@ caption: Choose your installation method
|
||||||
maxdepth: 1
|
maxdepth: 1
|
||||||
---
|
---
|
||||||
|
|
||||||
Quick install script <quick_install>
|
Quick install script <quick-install>
|
||||||
Docker <docker>
|
Docker <docker>
|
||||||
Debian <debian>
|
Debian <debian>
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Upgrade using the quick install script
|
# Upgrade using the quick install script
|
||||||
|
|
||||||
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:
|
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
|
```bash
|
||||||
sudo sh -c "$(curl -sSL https://get.funkwhale.audio/upgrade.sh)".
|
sudo sh -c "$(curl -sSL https://get.funkwhale.audio/upgrade.sh)".
|
|
@ -12,7 +12,7 @@ maxdepth: 1
|
||||||
|
|
||||||
API explorer<https://docs.funkwhale.audio/swagger/>
|
API explorer<https://docs.funkwhale.audio/swagger/>
|
||||||
authentication
|
authentication
|
||||||
rate_limit
|
rate-limit
|
||||||
subsonic
|
subsonic
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
|
@ -38,9 +38,9 @@ administrator/installation/index
|
||||||
administrator/configuration/index
|
administrator/configuration/index
|
||||||
administrator/import
|
administrator/import
|
||||||
administrator/upgrade/index
|
administrator/upgrade/index
|
||||||
administrator/migration_guide
|
administrator/migration
|
||||||
administrator/django/index
|
administrator/django/index
|
||||||
administrator/manage_script/index
|
administrator/manage-script/index
|
||||||
administrator/uninstall/index
|
administrator/uninstall/index
|
||||||
administrator/troubleshooting/index
|
administrator/troubleshooting/index
|
||||||
|
|
||||||
|
@ -55,11 +55,11 @@ hidden: true
|
||||||
|
|
||||||
moderator/index
|
moderator/index
|
||||||
moderator/reports/index
|
moderator/reports/index
|
||||||
moderator/internal_users/index
|
moderator/internal-users/index
|
||||||
moderator/content/index
|
moderator/content/index
|
||||||
moderator/domains/index
|
moderator/domains/index
|
||||||
moderator/external_users/index
|
moderator/external-users/index
|
||||||
moderator/allow_listing/index
|
moderator/allow-listing/index
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
@ -17,7 +17,7 @@ One of the most important duties of a moderator is handling reports. If a user f
|
||||||
|
|
||||||
## Moderate your pod's users
|
## Moderate your pod's users
|
||||||
|
|
||||||
As a moderator, you are responsible for moderating the behavior of users on your pod. Funkwhale provides you with tools to help you handle users that violate your pod's rules. Check out our [Moderate your pod's users](internal_users/index.md) section for more information.
|
As a moderator, you are responsible for moderating the behavior of users on your pod. Funkwhale provides you with tools to help you handle users that violate your pod's rules. Check out our [Moderate your pod's users](internal-users/index.md) section for more information.
|
||||||
|
|
||||||
## Moderate content on your pod
|
## Moderate content on your pod
|
||||||
|
|
||||||
|
@ -29,8 +29,8 @@ As {term}`fediverse` software, Funkwhale interacts with other software over fede
|
||||||
|
|
||||||
## Moderate external users
|
## Moderate external users
|
||||||
|
|
||||||
You can moderate how external users interact with users on your pod. Check out the [Moderate external users](external_users/index.md) guides to learn how to manage users from other servers.
|
You can moderate how external users interact with users on your pod. Check out the [Moderate external users](external-users/index.md) guides to learn how to manage users from other servers.
|
||||||
|
|
||||||
## Manage your allow-list
|
## Manage your allow-list
|
||||||
|
|
||||||
If your pod admin has set up allow-listing, you can add and remove domains from your pod's list. Follow the guides in the [Allow-listing](allow_listing/index.md) section to learn how to handle your allow-list.
|
If your pod admin has set up allow-listing, you can add and remove domains from your pod's list. Follow the guides in the [Allow-listing](allow-listing/index.md) section to learn how to handle your allow-list.
|
||||||
|
|
|
@ -19,7 +19,7 @@ moderator/index.html, ../moderator/index.html
|
||||||
moderator/reports.html, ../moderator/reports/index.html
|
moderator/reports.html, ../moderator/reports/index.html
|
||||||
moderator/domains.html, ../moderator/domains/index.html
|
moderator/domains.html, ../moderator/domains/index.html
|
||||||
moderator/users.html, ../moderator/users/index.html
|
moderator/users.html, ../moderator/users/index.html
|
||||||
moderator/listing.html, ../moderator/allow_listing/index.html
|
moderator/listing.html, ../moderator/allow-listing/index.html
|
||||||
admin/index.html, ../administrator/index.html
|
admin/index.html, ../administrator/index.html
|
||||||
installation/index.html, ../administrator/installation/index.html
|
installation/index.html, ../administrator/installation/index.html
|
||||||
installation/index.html#quick-install, ../administrator/installation/quick_install.html
|
installation/index.html#quick-install, ../administrator/installation/quick_install.html
|
||||||
|
@ -37,7 +37,7 @@ upgrading/index.html, ../administrator/upgrade/index.html
|
||||||
users/django.html, ../administrator/django/index.html
|
users/django.html, ../administrator/django/index.html
|
||||||
backup.html, ../administrator/upgrade/backup.html
|
backup.html, ../administrator/upgrade/backup.html
|
||||||
admin/migration.html, ../administrator/installation/migrate.html
|
admin/migration.html, ../administrator/installation/migrate.html
|
||||||
admin/commands.html, ../administrator/manage_script/index.html
|
admin/commands.html, ../administrator/manage-script/index.html
|
||||||
admin/mrf.html, ../administrator/configuration/mrf.html
|
admin/mrf.html, ../administrator/configuration/mrf.html
|
||||||
admin/url.html, ../administrator/configuration/change_url.html
|
admin/url.html, ../administrator/configuration/change_url.html
|
||||||
admin/optimization.html, ../administrator/configuration/optimize.html
|
admin/optimization.html, ../administrator/configuration/optimize.html
|
||||||
|
|
Loading…
Reference in New Issue