novaburst/funquail
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

chore: format files using prettier (pre-commit)

Browse source
This commit is contained in:
jo 2022-11-23 22:42:32 +01:00
commit 6d7dc2f1b5
No known key found for this signature in database
GPG key ID: B2FEC9B22722B984
87 changed files with 4496 additions and 5178 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/administrator_documentation/configuration_docs/env_file.md
View file

@ -9,18 +9,18 @@ You need to restart your Funkwhale services after changing your `.env` file.
:::{tab-item} Debian
:sync: debian
```{code-block} sh
sudo systemctl restart funkwhale.target
```
```{code-block} sh
sudo systemctl restart funkwhale.target
```
:::
:::{tab-item} Docker
:sync: docker
```{code-block} sh
docker-compose restart
```
```{code-block} sh
docker-compose restart
```
:::
::::

1
docs/administrator_documentation/configuration_docs/instance_settings.md
View file

@ -12,6 +12,7 @@ To find your instance settings:
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}`Settings`. The {guilabel}`Instance settings` page opens.
:::
:::{tab-item} Mobile

150
docs/administrator_documentation/configuration_docs/mrf.md
View file

@ -84,123 +84,123 @@ To make the job of writing and debugging MRF policies easier, we provide a manag
- List registered MRF policies.
::::{tab-set}
::::{tab-set}
:::{tab-item} Debian
:sync: debian
:::{tab-item} Debian
:sync: debian
```{code-block} sh
poetry run python manage.py mrf_check --list
```
```{code-block} sh
poetry run python manage.py mrf_check --list
```
:::
:::
:::{tab-item} Docker
:sync: docker
:::{tab-item} Docker
:sync: docker
```{code-block} sh
docker-compose run --rm api python manage.py mrf_check --list
```
```{code-block} sh
docker-compose run --rm api python manage.py mrf_check --list
```
:::
::::
:::
::::
- Check how your MRF policy handles a follow.
::::{tab-set}
::::{tab-set}
:::{tab-item} Debian
:sync: debian
:::{tab-item} Debian
:sync: debian
```{code-block} sh
export MRF_MESSAGE='{"actor": "https://normal.domain/@alice", "type": "Create", "object": {"type": "Follow"}}'
echo $MRF_MESSAGE | poetry run python manage.py mrf_check inbox - -p blocked_follow_domains
```
```{code-block} sh
export MRF_MESSAGE='{"actor": "https://normal.domain/@alice", "type": "Create", "object": {"type": "Follow"}}'
echo $MRF_MESSAGE | poetry run python manage.py mrf_check inbox - -p blocked_follow_domains
```
:::
:::
:::{tab-item} Docker
:sync: docker
:::{tab-item} Docker
:sync: docker
```{code-block} sh
export MRF_MESSAGE='{"actor": "https://normal.domain/@alice", "type": "Create", "object": {"type": "Follow"}}'
echo $MRF_MESSAGE | docker-compose run --rm api python manage.py mrf_check inbox - -p blocked_follow_domains
```
```{code-block} sh
export MRF_MESSAGE='{"actor": "https://normal.domain/@alice", "type": "Create", "object": {"type": "Follow"}}'
echo $MRF_MESSAGE | docker-compose run --rm api python manage.py mrf_check inbox - -p blocked_follow_domains
```
::::
::::
- Check how your MRF handles a problematic follow.
::::{tab-set}
::::{tab-set}
:::{tab-item} Debian
:sync: debian
:::{tab-item} Debian
:sync: debian
```{code-block} sh
export MRF_MESSAGE='{"actor": "https://botdomain.org/@bob", "type": "Create", "object": {"type": "Follow"}}'
echo $MRF_MESSAGE | poetry run python manage.py mrf_check inbox - -p blocked_follow_domains
```
```{code-block} sh
export MRF_MESSAGE='{"actor": "https://botdomain.org/@bob", "type": "Create", "object": {"type": "Follow"}}'
echo $MRF_MESSAGE | poetry run python manage.py mrf_check inbox - -p blocked_follow_domains
```
:::
:::
:::{tab-item} Docker
:sync: docker
:::{tab-item} Docker
:sync: docker
```{code-block} sh
export MRF_MESSAGE='{"actor": "https://botdomain.org/@bob", "type": "Create", "object": {"type": "Follow"}}'
echo $MRF_MESSAGE | docker-compose run --rm api python manage.py mrf_check inbox - -p blocked_follow_domains
```
```{code-block} sh
export MRF_MESSAGE='{"actor": "https://botdomain.org/@bob", "type": "Create", "object": {"type": "Follow"}}'
echo $MRF_MESSAGE | docker-compose run --rm api python manage.py mrf_check inbox - -p blocked_follow_domains
```
:::
::::
:::
::::
- Check a payload against activity already present in the database. You can find the UUID of an activity by visiting `/api/admin/federation/activity`.
::::{tab-set}
::::{tab-set}
:::{tab-item} Debian
:sync: debian
:::{tab-item} Debian
:sync: debian
```{code-block} sh
export ACTIVITY_UUID="06208aea-c687-4e8b-aefd-22f1c3f76039"
echo $MRF_MESSAGE | poetry run python manage.py mrf_check inbox $ACTIVITY_UUID -p blocked_follow_domains
```
```{code-block} sh
export ACTIVITY_UUID="06208aea-c687-4e8b-aefd-22f1c3f76039"
echo $MRF_MESSAGE | poetry run python manage.py mrf_check inbox $ACTIVITY_UUID -p blocked_follow_domains
```
:::
:::
:::{tab-item} Docker
:sync: docker
:::{tab-item} Docker
:sync: docker
```{code-block} sh
```{code-block} sh
export ACTIVITY_UUID="06208aea-c687-4e8b-aefd-22f1c3f76039"
export ACTIVITY_UUID="06208aea-c687-4e8b-aefd-22f1c3f76039"
echo $MRF_MESSAGE | docker-compose run --rm api python manage.py mrf_check inbox $ACTIVITY_UUID -p blocked_follow_domains
echo $MRF_MESSAGE | docker-compose run --rm api python manage.py mrf_check inbox $ACTIVITY_UUID -p blocked_follow_domains
```
```
:::
::::
:::
::::
There are extra options for testing MRF policies. Check the command help for more options.
::::{tab-set}
::::{tab-set}
:::{tab-item} Debian
:sync: debian
:::{tab-item} Debian
:sync: debian
```{code-block} sh
poetry run python manage.py mrf_check --help
```
```{code-block} sh
poetry run python manage.py mrf_check --help
```
:::
:::
:::{tab-item} Docker
:sync: docker
:::{tab-item} Docker
:sync: docker
```{code-block} sh
docker-compose run --rm api python manage.py mrf_check --help
```
```{code-block} sh
docker-compose run --rm api python manage.py mrf_check --help
```
:::
::::
:::
::::

27
docs/administrator_documentation/installation_docs/debian.md
View file

@ -11,16 +11,16 @@ We support [Debian](https://debian.org) and Debian-based Linux distributions. Fo
- Set a `FUNKWHALE_VERSION` variable to the version you want to install. You will use this version for all commands in this guide.
```{parsed-literal}
export FUNKWHALE_VERSION={sub-ref}`version`
```
```{parsed-literal}
export FUNKWHALE_VERSION={sub-ref}`version`
```
- Install `curl`
```{code-block} sh
sudo apt update # update apt cache
sudo apt install curl
```
```{code-block} sh
sudo apt update # update apt cache
sudo apt install curl
```
## 1. Install Funkwhale dependencies
@ -169,18 +169,19 @@ The environment file contains options you can use to control your Funkwhale pod.
```
5. Update the following settings:
- Paste the secret key in the `DJANGO_SECRET_KEY` field.
- Populate the `DATABASE_URL` field:
```{code-block} text
DATABASE_URL=postgresql://funkwhale@:5432/funkwhale
```
```{code-block} text
DATABASE_URL=postgresql://funkwhale@:5432/funkwhale
```
- Populate the `CACHE_URL` field:
```{code-block} text
CACHE_URL=redis://127.0.0.1:6379/0
```
```{code-block} text
CACHE_URL=redis://127.0.0.1:6379/0
```
- Populate the `FUNKWHALE_HOSTNAME` field with the domain name of your server.

19
docs/administrator_documentation/installation_docs/docker.md
View file

@ -14,17 +14,17 @@ This guide assumes you are using a [Debian](https://debian.org)-based system.
- Set a `FUNKWHALE_VERSION` variable to the version you want to install. You will use this version for all commands in this guide.
```{parsed-literal}
export FUNKWHALE_VERSION={sub-ref}`version`
```
```{parsed-literal}
export FUNKWHALE_VERSION={sub-ref}`version`
```
- Install [Docker](https://docs.docker.com/engine/install/) and [Docker Compose](https://docs.docker.com/compose/install/).
- Install `curl`.
```{code-block} sh
sudo apt update # update apt cache
sudo apt install curl
```
```{code-block} sh
sudo apt update # update apt cache
sudo apt install curl
```
## 1. Download the project files
@ -83,8 +83,9 @@ The environment file contains options you can use to control your Funkwhale pod.
```
6. Update the following settings:
- Paste the secret key in the `DJANGO_SECRET_KEY` field.
- Populate the `FUNKWHALE_HOSTNAME` field with the URL of your server.
- Paste the secret key in the `DJANGO_SECRET_KEY` field.
- Populate the `FUNKWHALE_HOSTNAME` field with the URL of your server.
7. Hit {kbd}`ctrl + x` then {kbd}`y` to save the file and close `nano`.

4
docs/administrator_documentation/installation_docs/index.md
View file

@ -4,8 +4,8 @@ Choose your installation method and follow the guides to set up your pod.
Funkwhale requires the following:
- __A dedicated domain or subdomain__ – you can't run Funkwhale in a subdirectory of a domain. You need to run it on a domain or a subdomain. For example: `https://mypod.io` or `https://funkwhale.mysite.io`.
- __Access to ports `80` and `443`__ – Funkwhale uses these ports for federation.
- **A dedicated domain or subdomain** – you can't run Funkwhale in a subdirectory of a domain. You need to run it on a domain or a subdomain. For example: `https://mypod.io` or `https://funkwhale.mysite.io`.
- **Access to ports `80` and `443`** – Funkwhale uses these ports for federation.
```{toctree}
---

2
docs/administrator_documentation/manage_script/create_library.md
View file

@ -94,7 +94,7 @@ Created library default for user username1 with UUID 436da05b-8cb1-4a4d-b870-4a3
### Library with the same name already exists
If a library with the same name already exists for the given user, the script will __not__ create a new library.
If a library with the same name already exists for the given user, the script will **not** create a new library.
::::{tab-set}

48
docs/administrator_documentation/manage_script/tags.md
View file

@ -20,15 +20,15 @@ To add tags to untagged albums:
1. SSH into your Funkwhale server.
2. Navigate to the Funkwhale directory.
```{code-block} sh
cd /srv/funkwhale
```
```{code-block} sh
cd /srv/funkwhale
```
3. Run the `manage.py` script to generate tags for untagged albums.
```{code-block} sh
poetry run python manage.py fw albums add-tags-from-tracks
```
```{code-block} sh
poetry run python manage.py fw albums add-tags-from-tracks
```
:::
@ -38,15 +38,15 @@ To add tags to untagged albums:
1. SSH into your Funkwhale server.
2. Navigate to the Funkwhale directory.
```{code-block} sh
cd /srv/funkwhale
```
```{code-block} sh
cd /srv/funkwhale
```
3. Run the `manage.py` script to generate tags for untagged albums.
```{code-block} sh
docker-compose run --rm api python manage.py fw albums add-tags-from-tracks
```
```{code-block} sh
docker-compose run --rm api python manage.py fw albums add-tags-from-tracks
```
:::
::::
@ -63,15 +63,15 @@ To add tags to untagged artists:
1. SSH into your Funkwhale server.
2. Navigate to the Funkwhale directory.
```{code-block} sh
cd /srv/funkwhale
```
```{code-block} sh
cd /srv/funkwhale
```
3. Run the `manage.py` script to generate tags for untagged artists.
```{code-block} sh
poetry run python manage.py fw artists add-tags-from-tracks
```
```{code-block} sh
poetry run python manage.py fw artists add-tags-from-tracks
```
:::
@ -81,15 +81,15 @@ To add tags to untagged artists:
1. SSH into your Funkwhale server.
2. Navigate to the Funkwhale directory.
```{code-block} sh
cd /srv/funkwhale
```
```{code-block} sh
cd /srv/funkwhale
```
3. Run the `manage.py` script to generate tags for untagged artists.
```{code-block} sh
docker-compose run --rm api python manage.py fw artists add-tags-from-tracks
```
```{code-block} sh
docker-compose run --rm api python manage.py fw artists add-tags-from-tracks
```
:::
::::

36
docs/administrator_documentation/manage_script/thumbnails.md
View file

@ -16,21 +16,21 @@ To generate new thumbnails:
1. SSH into your Funkwhale server.
2. Navigate to your Funkwhale directory.
```{code-block} sh
cd /srv/funkwhale
```
```{code-block} sh
cd /srv/funkwhale
```
3. Delete the `__sized__` directory inside your `MEDIA_ROOT` directory. By default this is `/srv/funkwhale/data/media`. This directory contains the current thumbnails.
```{code-block} sh
rm -r __sized__/
```
```{code-block} sh
rm -r __sized__/
```
4. Run the `manage.py` script to regenerate the thumbnails.
```{code-block} sh
poetry run python manage.py fw media generate-thumbnails
```
```{code-block} sh
poetry run python manage.py fw media generate-thumbnails
```
:::
@ -40,21 +40,21 @@ To generate new thumbnails:
1. SSH into your Funkwhale server.
2. Navigate to your Funkwhale directory.
```{code-block} sh
cd /srv/funkwhale/
```
```{code-block} sh
cd /srv/funkwhale/
```
3. Delete the `__sized__` directory inside your `MEDIA_ROOT` directory. By default this is `/srv/funkwhale/data/media`. This directory contains the current thumbnails.
```{code-block} sh
rm -r data/media/__sized__/
```
```{code-block} sh
rm -r data/media/__sized__/
```
4. Run the `manage.py` script to regenerate the thumbnails.
```{code-block} sh
docker-compose run --rm api python manage.py fw media generate-thumbnails
```
```{code-block} sh
docker-compose run --rm api python manage.py fw media generate-thumbnails
```
:::
::::

6
docs/administrator_documentation/migration_guide/index.md
View file

@ -132,6 +132,6 @@ Check the file and remove any duplicated settings after copying.
Once you have imported your database and run migrations, you can start all containers.
```{code-block} sh
docker-compose up -d
```
```{code-block} sh
docker-compose up -d
```

94
docs/administrator_documentation/troubleshooting/backend.md
View file

@ -6,75 +6,75 @@ The Funkwhale backend is made up of lots of moving parts. This guide shows you h
If you have access to the Funkwhale backend, you can use logs to get more information about an issue.
- __Reverse proxy logs__ – check these logs if you have connectivity issues.
- **Reverse proxy logs** – check these logs if you have connectivity issues.
::::{tab-set}
::::{tab-set}
:::{tab-item} Nginx
:sync: nginx
:::{tab-item} Nginx
:sync: nginx
```{code-block} sh
sudo tail -f /var/log/nginx/access.log # Follow the access log
sudo tail -f /var/log/nginx/error.log # Follow the error log
```
```{code-block} sh
sudo tail -f /var/log/nginx/access.log # Follow the access log
sudo tail -f /var/log/nginx/error.log # Follow the error log
```
:::
:::
:::{tab-item} Apache2
:sync: apache2
:::{tab-item} Apache2
:sync: apache2
```{code-block} sh
sudo tail -f /var/log/apache/access.log # Follow the access log
sudo tail -f /var/log/apache/error.log # Follow the error log
```
```{code-block} sh
sudo tail -f /var/log/apache/access.log # Follow the access log
sudo tail -f /var/log/apache/error.log # Follow the error log
```
````
::::
- __API logs__ – check these if you are having issues with the Funkwhale app, federation, or imports.
- **API logs** – check these if you are having issues with the Funkwhale app, federation, or imports.
::::{tab-set}
::::{tab-set}
:::{tab-item} Debian
:sync: debian
:::{tab-item} Debian
:sync: debian
```{code-block} sh
journalctl -xn -u funkwhale-server
```
```{code-block} sh
journalctl -xn -u funkwhale-server
```
:::
:::
:::{tab-item} Docker
:sync: docker
:::{tab-item} Docker
:sync: docker
```{code-block} sh
docker-compose logs -f --tail=50 api # Follow the last 50 messages
```
```{code-block} sh
docker-compose logs -f --tail=50 api # Follow the last 50 messages
```
:::
::::
:::
::::
- __Celery logs__ – check these if a federation or import task isn't working.
- **Celery logs** – check these if a federation or import task isn't working.
::::{tab-set}
::::{tab-set}
:::{tab-item} Debian
:sync: debian
:::{tab-item} Debian
:sync: debian
```{code-block} sh
journalctl -xn -u funkwhale-worker
```
```{code-block} sh
journalctl -xn -u funkwhale-worker
```
:::
:::
:::{tab-item} Docker
:sync: docker
:::{tab-item} Docker
:sync: docker
```{code-block} sh
docker-compose logs -f --tail=50 celery # Follow the last 50 messages
```
```{code-block} sh
docker-compose logs -f --tail=50 celery # Follow the last 50 messages
```
:::
::::
:::
::::
## Troubleshoot issues
@ -84,7 +84,7 @@ If the API isn't serving audio files, try the following:
- If you’re using Docker, check you have commented out the `MEDIA_ROOT` variable in your `.env` file.
- Check the `_protected/media` block in your webserver points to your media path. This is `/srv/funkwhale/data/media` by default.
- If you’re using the in-place import, check you have configured your media paths. Check the `MUSIC_DIRECTORY_PATH`, `MUSIC_DIRECTORY_SERVE_PATH` and `REVERSE_PROXY_TYPE` variables in your `.env` file. Make sure the webserver can read these directories.
- If you’re using the in-place import, check you have configured your media paths. Check the `MUSIC_DIRECTORY_PATH`, `MUSIC_DIRECTORY_SERVE_PATH` and `REVERSE_PROXY_TYPE` variables in your `.env` file. Make sure the webserver can read these directories.
### Import issues

2
docs/administrator_documentation/uninstall_docs/debian.md
View file

@ -115,7 +115,7 @@ Once you have stopped the Funkwhale services, you can remove the Funkwhale datab
sudo -u postgres psql -c 'DROP USER funkwhale;'
```
## Delete the Funkwhale account
## 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.

2
docs/administrator_documentation/uninstall_docs/quick_install.md
View file

@ -115,7 +115,7 @@ Once you have stopped the Funkwhale services, you can remove the Funkwhale datab
sudo -u postgres psql -c 'DROP USER funkwhale;'
```
## Delete the Funkwhale account
## 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.