Commit 570ac3ee authored by Ciarán Ainsworth's avatar Ciarán Ainsworth
Browse files

Document fix_uploads

parent ffa4b952
Pipeline #20489 passed with stage
in 16 seconds
# Fix uploads
Use the `fix_uploads` command to let Funkwhale sort out common issues with your audio files.
## Commands
```{warning}
Running `fix_uploads` with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade_docs/backup.md).
```
To ensure you don't change data by accident, this command runs in dry run mode by default. In dry run mode, the command lists the items it will modify. Run the command with the `--no-dry-run` flag to perform the action.
### Fix mimetypes
Check and fix file mimetypes with the `--mimetype` flag. This helps prevent issues with serving music files.
````{tabbed} Debian
```{code} bash
poetry run python manage.py fix_uploads --mimetype
```
````
````{tabbed} Docker
```{code} bash
docker-compose run --rm api python manage.py fix_uploads --mimetype
```
````
### Fix bitrate and duration
Check and fix bitrate and duration with the `--audio-data` flag. This process can take a long time as it needs to access all files.
````{tabbed} Debian
```{code} bash
poetry run python manage.py fix_uploads --audio-data
```
````
````{tabbed} Docker
```{code} bash
docker-compose run --rm api python manage.py fix_uploads --audio-data
```
````
### Fix file size
Check and fix the file size with the `--size` flag.
````{tabbed} Debian
```{code} bash
poetry run python manage.py fix_uploads --size
```
````
````{tabbed} Docker
```{code} bash
docker-compose run --rm api python manage.py fix_uploads --size
```
````
### Fix file checksums
Check and fix file checksums with the `--checksum` flag.
````{tabbed} Debian
```{code} bash
poetry run python manage.py fix_uploads --checksum
```
````
````{tabbed} Docker
```{code} bash
docker-compose run --rm api python manage.py fix_uploads --checksum
```
````
### Change command batch size
Choose the batch size you want to process with the `--batch-size` or -`s` flag. Smaller batches process faster. Defaults to `1000`.
````{tabbed} Debian
```{code} bash
poetry run python manage.py fix_uploads --batch-size 500
```
````
````{tabbed} Docker
```{code} bash
docker-compose run --rm api python manage.py fix_uploads --batch-size 500
```
````
......@@ -13,5 +13,6 @@ Prune library <library>
Clean database <database>
Add album and artist tags <tags>
thumbnails
fix_uploads
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment